wiki-formats

(Difference between revisions)

Jump to: navigation, search
m (MediaWiki)
(wiki software)
Line 47: Line 47:
* See http://www.kwiki.org/
* See http://www.kwiki.org/
 +
 +
=== Tiki Wiki ===
 +
[http://doc.tikiwiki.org/tiki-index.php?page_ref_id=268 TikiWiki Syntax Reference] and
 +
[http://doc.tikiwiki.org/tiki-index.php?page=Formatting%20Standards Formatting Guide]
 +
 +
Important Syntax:
 +
 +
* Lists
 +
** * Creates an unordered list.
 +
** # Creates a numbered list.
 +
** ;term:definition creates a term and definition list.
 +
** Features include nesting in a predictable manner, sections that can hide/display with a +/- symbol, and line continuation after breaks.
 +
* Links
 +
** JoinedWords indicate an internal wiki link.
 +
** ((Words|Description)) inside parenthesis also indicates an internal wiki link and can include spaces and non-standard wiki link conventions.  A pipe delimits the text to be used for the link.
 +
** ))JoinedWords(( can escape the link parsing.
 +
** External links go inside square brackets [ ] with the same convention regarding the descriptive text.  Many features of this wiki also allow options to be passed, eg. nocache, after a pipe.
 +
* Images
 +
**  {img src= width= height= align= desc= link= }
 +
* Text formatting
 +
** Bolding is done by placing text in between a pair of double underscores: __bolded text__
 +
** Text is centered by placing text in between two colons: ::centered text::
 +
** Text is colored by delimiting the color name and the text with a colon surrounded by a pair of double tildes. ~~blue:text~~
 +
** Text is italicized by surounding the text with a double pair of single quotes: <nowiki>''italicized''</nowiki>.
 +
** The syntax for monospaced/teletype text is: -+monospaced text+-
 +
** Underlined text is indicated with 3 equal signs: ===underlined text===
 +
** Text can be put in a simple box by surrounding it with the carrot: ^boxed text^
 +
* Headings
 +
** Headings are indicated by the presence of an exclamation mark at the beginning of the line: !My heading.  Sub headings and level of nesting is indicated by the number of exclamation marks. (Same way that lists nest.)  This does carry semantic purpose in the TikiWiki documentation and the maketoc module uses this feature in order to make tables of contents.
 +
 +
=== phpwiki ===
 +
[http://phpwiki.sourceforge.net/phpwiki/HowToUseWiki Introduction]
 +
and [http://phpwiki.sourceforge.net/phpwiki/TextFormattingRules Syntax Rules].
 +
 +
* Formatting (copied from http://phpwiki.sourceforge.net/phpwiki/TextFormattingRules, edited to make a list)
 +
** Emphasis: _ for italics, * for bold, _* for both, = for fixed width.
 +
** Lists: * for bullet lists, # for numbered lists, Term:<new-line> definition for definition lists.
 +
** Preformatted text: Enclose text in <nowiki><pre></pre></nowiki> or <verbatim></verbatim>.
 +
** Indented text: Indent the paragraph with whitespaces.
 +
** References: JoinCapitalizedWords or use square brackets for a [page link] or URL [http://cool.wiki.int/].
 +
** Preventing linking: Prefix with "~": ~DoNotHyperlink, name links like [text | URL].
 +
** Misc: "!", "!!", "!!!" make headings, "%%%" or "<br>" makes a linebreak, "----" makes a horizontal rule.
 +
** Allowed HTML tags: b big i small tt em strong abbr acronym cite code dfn kbd samp var sup sub
 +
 +
== Other Resources ==
 +
* See http://c2.com/cgi/wiki?WikiEngines for a list of known wikis.
 +
* See http://tavi.sourceforge.net/WikiEngines/ComparingWikis for a table comparing wiki features (no syntax information).
 +
 +
== Other Standards Efforts ==
 +
* http://tikiwiki.org/RFCWiki An RFC Draft for wiki syntax.
 +
 +
== Summary ==
 +
Apparently most wikis use a * to indicate bulleted lists.  Nesting works intuitively.  New paragraphs are often indicated with newlines.  Several scheme uses capitalized JoinedWords to indicate an internal link, and square brackets [ ] to indicate an external link.  Common problems include unexpected failure to handle nesting within certain syntax, competing formatting rules, varying degrees of semantic meaning, and arbitrary formatting codes.
== wiki formats ==
== wiki formats ==

Revision as of 08:45, 6 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

Tiki Wiki

TikiWiki Syntax Reference and Formatting Guide

Important Syntax:

phpwiki

Introduction and Syntax Rules.

Other Resources

Other Standards Efforts

Summary

Apparently most wikis use a * to indicate bulleted lists. Nesting works intuitively. New paragraphs are often indicated with newlines. Several scheme uses capitalized JoinedWords to indicate an internal link, and square brackets [ ] to indicate an external link. Common problems include unexpected failure to handle nesting within certain syntax, competing formatting rules, varying degrees of semantic meaning, and arbitrary formatting codes.

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