wiki-formats

(Difference between revisions)

Jump to: navigation, search
m (straw proposals)
(answers to some questions)
Line 104: Line 104:
Open issues:
Open issues:
* What's this?
* What's this?
-
** <code>-*- Mode: text; -*-</code>
+
** <code>-*- Mode: text; -*-</code> '''It's the Emacs mode line. Just ignore anything starting with one or more spaces and then having the form -*- ... -*-'''
* how do you encode in text/plain the semantics of:
* how do you encode in text/plain the semantics of:
-
** strong
+
** strong '''Same as <pre><em></pre> except that you use *stars* instead of _underscores_'''
** dfn
** dfn
** dl/dt/dd
** dl/dt/dd
** h4, h5, h6
** h4, h5, h6
-
** table / thead, tbody, tfoot, caption / tr / td, th
+
** table / thead, tbody, tfoot, caption / tr / td, th '''I have some pages that do tables, you just do an actual ASCII art table with proper ASCII art lines'''
-
** hyperlinked text
+
** hyperlinked text '''text/plain has no hyperlinks, so I always put them on the next line (pre/code style)'''
** hyperlink relationships (rel attribute on hyperlinked text)
** hyperlink relationships (rel attribute on hyperlinked text)
** address (possibly the "Author: " line?)
** address (possibly the "Author: " line?)
** inline code
** inline code

Revision as of 11:18, 4 July 2005

Contents

wiki formats

Authors

Intro

Ian Hickson recently lamented to me that:

"I have yet to find a wiki that has both a nice syntax (i.e. one that looks 
like text/plain as opposed to one that looks like just another obscure 
markup language -- if you're going to use markup, why not just use HTML 
in the first place), and that produces semantic markup (as opposed to 
having tags for "bold" and "italics")."

And I have to kind of agree with him. My experience with current wiki formats is that they haven't done that good a job of "paving the cowpaths", that is, taking what people write in plain text documents, and interpreting them as structure, rather than inventing new text conventions (e.g. equal signs for headings?!?) and getting people to learn them.

This page is an attempt to catalog/document current wiki and wiki-like text formats to see if there is any chance of solving this problem.

Technically a wiki format would not be a microformat because it is not expressed in XHTML building blocks. However, many of the other principles of microformats can be applied to perhaps come up with a better solution that what wikis use today (since they all seem to use their own variant formats anyway).


wiki software

MediaWiki

What you're using now.

MoinMoin

What the Technorati Developer's Wiki uses.

Kwiki

wiki formats

straw proposals

What Ian uses in his text/plain documents:

first level heading - followed by a line starting with equal signs "="
=============================================
second level heading - followed by a line starting dashes "-"
--------
THIRD LEVEL HEADING - ALL CAPS ON A LINE
 1. Here is one ordered list item
 * Here is an unordered list item
_at the moment_
| This is a quote
| and a second line
 -- http://example.com/quotation/

Open issues:

wiki-formats was last modified: Wednesday, December 31st, 1969

Views