wiki-formats

(Difference between revisions)

Jump to: navigation, search
m (straw proposals)
m (straw proposals)
Line 87: Line 87:
** same notes apply respectively as those for ordered list items above.
** same notes apply respectively as those for ordered list items above.
** nested unordered list items are similar, except that their marker is further indented, and in addition to "*", other list item markers may be used such as "+" and "-".
** nested unordered list items are similar, except that their marker is further indented, and in addition to "*", other list item markers may be used such as "+" and "-".
-
* blockquote or pre / code
+
* pre / code
-
** some amount of nesting with whitespace.  it is ambiguous whether this indicates a blockquote or pre / code.  have emailed Ian to ask his clarification.
+
** some amount of nesting with whitespace.  pre / code.  it's not clear what type of code (e.g. HTML or CSS).
* em
* em
** text surrounded by a single adjacent underline on both sides, e.g.
** text surrounded by a single adjacent underline on both sides, e.g.
<pre>
<pre>
-
_definitely_
+
_at the moment_
 +
</pre>
 +
* blockquote and cite attribute
 +
** a set of lines that being with "| ", and after the last one, a line that starts with " -- ", followed by the citation URL, e.g.:
 +
<pre>
 +
| This is a quote
 +
| and a second line
 +
-- http://example.com/quotation/
</pre>
</pre>

Revision as of 06:08, 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/
wiki-formats was last modified: Wednesday, December 31st, 1969

Views