wiki-formats-fr

wiki formats

Auteurs

• Tantek Çelik
• Ben West

(traduction en cours Christophe Ducamp

Intro

Ian Hickson se plaignait à moi récemment que :

"Je dois trouver maintenant un wiki qui ait à la fois une belle syntaxe 
(c'est à dire une qui ressemble à du texte/clair à l'opposé de celui qui ressemble 
simplement à une autre syntaxe obscure -- si vous allez utiliser un balisage, 
pourquoi ne pas utiliser le HTML en premier lieu), et qui produise une syntaxe sémantique
(à l'opposé du fait d'avoir des tags pour "gras" et "italique")."

Et je dois en quelque sorte être d'accord avec lui. Mon expérience avec le wiki actuel des formats est qu'il ne fait pas ce bon travail de "daller les chemins des vaches", ce qui veut dire, prendre ce que les gens écrivent dans des documents en texte clair, et l'interpréter comme une structure, plutôt que de réinventer des nouvelles conventions de texte (par exemple des signes égal pour les titres ?!?) et faire en sorte que les personnes les apprennent.

Cette page est un essai pour cataloguer/documenter le wiki actuel et les formats textes comme wiki pour voir s'il y a quelque chance de résoudre ce problème.

Techniquement un format wiki serait de ne pas être un microformat pare que ce n'est pas exprimé par la construction de blocs XHTML. Néanmoins, bon nombre des autres principes des microformats peuvent être appliqués à peut-être aboutir à une meilleure solution que celle utilisée aujourd'hui par les wikis (parce qu'ils semblent tous utiliser leurs propres variantes en quelque sorte).

Logiciel wiki

MediaWiki

Celui que vous utilisez à cette heure.

• paragraphes
  • une ligne blanche crée un nouveau paragraphe
• listes non numérotées
  • démarrer une ligne avec "* " et cela la mettra dans une liste non numérotée
  • utiliser plusieurs "*", par ex. "** " pour le niveau deux, pour des listes non numérotées imbriquées.
• listes numérotées
  • démarrer une ligne avec "# " et cela la mettra dans une liste numérotée.
  • utiliser plusieurs "#", par ex. "## " pour le niveau deux, pour des listes numérotées imbriquées.
• en-têtes
  • préfixe et suffixe avec le signe "=" pour un titre de niveau 1 heading, "==" pour le titre de niveau 2 etc.
• littéral
  • utiliser les tags <pre> ... </pre>

MoinMoin

Celui utilisé par les développeurs de Technorati. Commence à la v1.3.2, MoinMoin supporte aussi le reStructuredText.

Kwiki

• Voir http://www.kwiki.org/

Tiki Wiki

TikiWiki Syntax Reference et Formatting Guide

Syntaxe Importante :

• Listes
  • * Crée une liste non numérotée.
  • # Crée une liste numérotée
  • ;terme:définition crée un terme et une liste de défintiion.
  • Les fonctionnalités incluent l'imbrication dans une manière prévisible, des sections qui peuvent se cacher/s'affiher avec un symbole +/-, et une continuation de la ligne après les sauts de ligne.
• Liens
  • Les MotsJoints indiquent un lien wiki interne.
  • ((Mots|Description)) entre parenthèses indique aussi un lien interne wiki et peut inclure des espaces et des conventions de liens wiki non standards. Un signe pipe délimite le texte qui va être utilisé pour le lien.
  • ))MotsJoints(( peut empêcher le parsage du lien.
  • Les liens externes vont dans des crochets carrés [ ] avec la même convention eu égard au texte descriptif. Beaucoup de fonctionnalités de ce wiki permettent aussi aux options d'être passées, par ex. nocache, après un pipe.
• Images
  • {img src= width= height= align= desc= link= }
• Mise en forme du texte
  • Le gras est produit en mettant le texte entre une paire de double souligné :__texte graissé__
  • Le texte est centré en plaçant le texte entre deux signes deux-points :  ::texte centré::
  • Le texte est coloré en délimitant le nom de la couleur et le texte par un sgne deux points entouré d'une parie de double tildes. ~~blue:text~~
  • Le texte est mis en italique en entourant le texte par une double paire de guillemets simples : ''italique''.
  • La syntaxe pour le texte à espace fixe/télétype est : -+monospaced text+-
  • Le texte souligné est indiqué avec trois signes égal : ===underlined text===
  • Le texte peut être posé dans une boîte simple en l'entourant avc des circonflexes : ^texte en boîte^
• Titres
  • Les titres sont indiqués par la présence d'un point d'exclamation au début de la ligne : !Mon titre. Les sous-titres et niveau d'imbrication sont indiqués par le nombre de points d'exclamation. (Même principe que l'imbricage de liste). Ceci porte vraiment un intention sémantique dans la documentation Tikiwiki et le module de table des matières "maketoc" utilise cette fonctionnalité afin de produire des tables des matières.

phpwiki

Introduction et règles de syntaxe (lien mort à cette heure)

• La mise en page (copiée à partir de http://wiki.crao.net/index.php/R%E8glesDeFormatageDesTextes)
  • Emphase : _ pour italique, * pour bold, _* pour les deux, = pour chasse fixe.
  • Listes : * pour listes pointées, # pour listes numérotées, Terme:<nouvelle ligne> définition pour les listes de définitions.
  • Texte pré-formaté : enfermer le texte dans
    ou <verbatim></verbatim>.
  • Texte décalé : décaler le paragraphe avec des espaces.
  • Liens : JoindreMotsAvecMajuscules ou utiliser des crochets pour une [page] ou une URL [1].
  • Désactiver les liens : Préfixer avec "~": ~NePasLier, nommer les liens comme [texte | URL].
  • Divers : "!", "!!", "!!!" pour les titres et sous-titres, "%%%" ou "
    " pour aller à la ligne,

"----" fait un trait horizontal.

• • Balises HTML utilisables : b big i small tt em strong abbr acronym cite code dfn kbd samp var sup sub

Midgard Wiki (net.nemein.wiki)

• Markdown est utilisé par défaut, mais il peut être basculé en WYSIWYG HTML
• Quelques formats de liens supplémentaires sont utilisés
• Voir Midgard Wiki documentation

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)

Should plain text formats from other non-wiki systems be included in this exploration? What about phpbb codes? Or certain blogging tools? What about Almost Free Text ( Syntax Overview ) and other plain text processing tools? There is a breed of hybrid wiki-blog systems like http://www.backpackit.com and http://www.basecamphq.com both by 37signals.

Extra-wiki Formatting Conventions

Live Chats

This includes IRC, and sundry chat services such as AIM. There are several popular conventions to indicate a low level of formatting in plain text in various chat services. Text in between a pair of * is understood to either be an emotion or action (eg *grin*) or *emphasized* (perhaps equivalent to bolding). Text in between a pair of /forward slashes/ is many times understood to carry an italicized meaning. Text in between a pair of _underscores_ is understood to be underlined.

For example, the syntax used by the Yarr (☠) in-Wiki chat system.

Other Standards Efforts

• http://tikiwiki.org/RFCWiki An RFC Draft for wiki syntax.
• http://lab.lolipop.jp/fswiki/wiki.cgi/wikistandard An attempt to establish a standard wiki syntax (for Japanese language)
• http://daringfireball.net/projects/markdown/basics This looks like it solves the problem (mostly).

Summary

Apparently most wikis use a * to indicate bulleted lists. Nesting works intuitively. New paragraphs are often indicated with newlines. Several schemes 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.

Asterisks to handle unordered lists and pound signs for numbered lists probably work pretty nicely. It's common to use asterisks for lists in plain text formatting, and using a pound sign typically means "a number", and lets the user know that the system will automatically enumerate the following points. However, indicating that the following line should match the indentation of the preceeding line involves strange notation. Unfortunately, arbitrarily blocked elements such as a simple box will break the nesting and continued parsing of list items several wikis.

Likewise, although one doesn't often see exclamation points used to convey that a given line is a heading, this might work nicely as well. An exclamation point indicates importance and emphasis; having it at the beginning of the line is rare, makes the interface to the nesting behavior monotonous because it is the same as the lists, and seems just as natural (to this writer) as filling the succeeding line with dashes or equals. It also makes a lot more sense than surrounding the headline text with equal signs.

Square brackets are used in most wikis to indicate a link of some kind. However, some wikis split links into external and internal, creating a modal interface to publishing links. Furthermore, despite the standard JoinedCapitalizedWords to create an internal link (and/or create a new page), wiki systems freely allow users to ignore the convention by allowing varied alternate linking methods. An additional failing of internal linking schemes is is that wikis are many times a part of a larger content management system, and full "external" links are required anyway in order to reach components of the site. In plain text documents, it is more common to see a full url accompanied with some explaining text. Of the wikis that allow for a natural rendering of urls as links, they also allow a specialized convention to allow for the substituted text to point to the url. Perhaps a future solution would abolish the internal/external modality, parse in-line urls, and include a simple option for text substitution. For example: "http://www.google.com(Google) is a great search engine." would show up as: "[http:www.google.com Google] is a great search engine."

wiki formats

• WAFL - Wiki Abstract Formatting Langauage

straw proposals

What Ian uses in his text/plain documents:

• h1:

first level heading - followed by a line starting with equal signs "="
=============================================

• h2:

second level heading - followed by a line starting dashes "-"
--------

• h3:

THIRD LEVEL HEADING - ALL CAPS ON A LINE

• p:
  • a blank line to start and finish
• ol / li
  • a line starting with space then a number followed immediately by a period, e.g.

 1. Here is one ordered list item

• • note that such list items may be separated by blank lines.
  • note that paragraphs within a list item will be indented as much as the text after the list item marker.
  • list is terminated by a non-blank line that *doesn't* start with space then a number then a period, and is outdented from where list item paragraphs are.
• ul / li
  • a line starting with space then an asterisk then at least one space, e.g.

 * Here is an unordered list item

• • 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 "-".
• pre / code
  • some amount of nesting with whitespace. pre / code. it's not clear what type of code (e.g. HTML or CSS).
• em
  • text surrounded by a single adjacent underline on both sides, e.g.

_at the moment_

• 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.:

| This is a quote
| and a second line
 -- http://example.com/quotation/

Open issues:

• What's this?
  • -*- Mode: text; -*- 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:
  • strong Use *stars* instead of _underscores_
  • dfn
  • dl/dt/dd
  • h4, h5, h6 There is no H4 in this format. Only H1-H3. Just like HTML has no H7, and is limited to H1-H6.
  • 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 text/plain has no hyperlinks, so I always put them on the next line (pre/code style)
  • hyperlink relationships (rel attribute on hyperlinked text)
  • address (possibly the "Author: " line?)
  • inline code