wiki-formats-fr: Difference between revisions

From Microformats Wiki
Jump to navigation Jump to search
m (translation in progress)
 
m (Reverted edits by ElellEtola (Talk) to last version by Brian)
 
(24 intermediate revisions by 7 users not shown)
Line 7: Line 7:




(traduction en cours [[Christophe Ducamp]]
(traduction en cours et localisation francophone [[Christophe Ducamp]])
== Intro ==
== Intro ==


Ian Hickson se plaignait à moi récemment que :  
Ian Hickson se plaignait récemment auprès de moi :
  "Je dois trouver maintenant un wiki qui ait à la fois une belle syntaxe  
  "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  
  (c'est à dire une qui ressemble à du texte/clair à l'opposé de celle qui ressemble  
  simplement à une autre syntaxe obscure -- si vous allez utiliser un balisage,  
  simplement à une autre syntaxe obscure -- si vous comptez utiliser un marquage,  
  pourquoi ne pas utiliser le HTML en premier lieu), et qui produise une syntaxe sémantique
  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")."
  (à 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.
Et en quelque sorte je dois être d'accord avec lui. Mon expérience avec le wiki actuel des formats est qu'il ne fait pas ce bon travail de "paver 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.
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 [[microformats-fr|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).
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 [[microformats-fr|principes des microformats]] peuvent être appliqués pour aboutir peut-être à une meilleure solution que celle utilisée aujourd'hui par les wikis (parce qu'ils semblent tous utiliser en quelque sorte leurs propres variantes).
 


== Logiciel wiki ==
== Logiciel wiki ==
Line 41: Line 40:
** préfixe et suffixe avec le signe "=" pour un titre de niveau 1 heading, "==" pour le titre de niveau 2 etc.
** préfixe et suffixe avec le signe "=" pour un titre de niveau 1 heading, "==" pour le titre de niveau 2 etc.
* littéral
* littéral
** utiliser les tags <pre> ... </pre>
*usage
 
* [[mediawiki-mark-up-issues-fr|mediawiki problématiques de marquage]]
=== MoinMoin ===
 
Celui utilisé [http://developers.technorati.com/ par les développeurs de Technorati]. Commence à la v1.3.2, MoinMoin supporte aussi le reStructuredText.
 
=== Kwiki ===
 
* Voir http://www.kwiki.org/
 
=== Tiki Wiki ===
[http://doc.tikiwiki.org/tiki-index.php?page_ref_id=268 TikiWiki Syntax Reference] et
[http://doc.tikiwiki.org/tiki-index.php?page=Formatting%20Standards 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é::
** 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 <nowiki>[http://example.com]</nowiki>.
** 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
 
 
=== Midgard Wiki (net.nemein.wiki) ===
 
* [http://daringfireball.net/projects/markdown/syntax Markdown] is used by default, but it can be switched to [http://www.dynarch.com/projects/htmlarea/ WYSIWYG HTML]
* Some additional [http://www.midgard-project.org/midcom-permalink-7276f817dcdefcf40d30a9ec69a7241f linking formats] are used
* See [http://www.midgard-project.org/midcom-permalink-5f8044fb6b23322ed3fe2d1ff0e50cf6 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 ( [http://www.maplefish.com/todd/aft-refman.html#Syntax%20Overview 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 [http://yarrr.gnome.org/wiki/index.php/Yarrr_ChatMarkup syntax] used by the [http://yarrr.gnome.org/wiki/index.php/Main_Page 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: "<nowiki>http://www.google.com(Google) is a great search engine.</nowiki>"  would show up as: "[http:www.google.com Google] is a great search engine."
 
== wiki formats ==
 
* [http://www.kwiki.org/?WaflProposal WAFL - Wiki Abstract Formatting Langauage]


== straw proposals ==


What Ian uses in his text/plain documents:
==Commentaires==


* h1:
Guy Fraser : Je suppose que vous n'avez pas regardé Confluence de www.atlassian.com - ce que vous décrivez au-dessus est simplement la façon dont fonctionne Confluence. Confluence a un avantage majeur sur MediaWiki en ce qu'il dispose d'outils de navigation décents - vous pouvez par exemple, voir un index des pages, une cartographie du site, etc. Dans mediawiki, à moins que vous ne sachiez ce que vous cherchez ou à moins que quelqu'un ne passe un lien vers une place importante, le contenu tend à disparaître à moins que nous ne sachiez quoi chercher. commentaire non signé provenant de [[User:Aubergine10]] ]
**
<pre>
first level heading - followed by a line starting with equal signs "="
=============================================
</pre>
* h2:
**
<pre>
second level heading - followed by a line starting dashes "-"
--------
</pre>
* h3:
**
<pre>
THIRD LEVEL HEADING - ALL CAPS ON A LINE
</pre>
* 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.
<pre>
1. Here is one ordered list item
</pre>
** 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.
<pre>
* Here is an unordered list item
</pre>
** 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.
<pre>
_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>


Open issues:
JimMahoney : http://www.wikicreole.org travaille sur un langage de syntaxe wiki commune - la discussion ici semble vraiment proche des problématiques soulevées ici.
* What's this?
** <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:
** 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

Latest revision as of 19:40, 3 January 2009

wiki formats

Auteurs

  • Tantek Çelik
  • Ben West


(traduction en cours et localisation francophone Christophe Ducamp)

Intro

Ian Hickson se plaignait récemment auprès de moi : 

"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 celle qui ressemble 
simplement à une autre syntaxe obscure -- si vous comptez utiliser un marquage, 
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 en quelque sorte je dois être d'accord avec lui. Mon expérience avec le wiki actuel des formats est qu'il ne fait pas ce bon travail de "paver 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 pour aboutir peut-être à une meilleure solution que celle utilisée aujourd'hui par les wikis (parce qu'ils semblent tous utiliser en quelque sorte leurs propres variantes).

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
  • usage
  • mediawiki problématiques de marquage


Commentaires

Guy Fraser : Je suppose que vous n'avez pas regardé Confluence de www.atlassian.com - ce que vous décrivez au-dessus est simplement la façon dont fonctionne Confluence. Confluence a un avantage majeur sur MediaWiki en ce qu'il dispose d'outils de navigation décents - vous pouvez par exemple, voir un index des pages, une cartographie du site, etc. Dans mediawiki, à moins que vous ne sachiez ce que vous cherchez ou à moins que quelqu'un ne passe un lien vers une place importante, le contenu tend à disparaître à moins que nous ne sachiez quoi chercher. commentaire non signé provenant de User:Aubergine10 ]

JimMahoney : http://www.wikicreole.org travaille sur un langage de syntaxe wiki commune - la discussion ici semble vraiment proche des problématiques soulevées ici.

Retrieved from "http://microformats.org/wiki/index.php?title=wiki-formats-fr&oldid=37105"