Introduction
Cette section décrit la syntaxe, les raccourcis typographiques, permettant de mettre en forme le contenu d'une page saisie avec UWiKiCMS. Comment faire des paragraphes, des listes, des liens, ce genre de choses. Fondamentalement, toutes les autres opérations (création de pages, d'images) peuvent se "deviner" en triturant l'outil sans lire la documentation, par contre les règles de formattage du contenu peuvent difficilement s'inventer.
D'où l'intérêt de cette documentation.
Noter que la plupart des règles de formattage décrites ici sont héritées de PhpWiki, et pour cause, UWiKiCMS est très largement inspiré (99% de code commun) du moteur de PhpWiki pour ce qui est du formattage HTML. D'ailleurs cette page de documentation est elle-même très largement inspirée de celle de PhpWiki. Rendons à César ce qui est à César.
Règles de base
Tout ceci s'inspire largement des règles de formattage de PhpWiki.
Paragraphes
- Ne pas indenter les paragraphes
- Ne pas s'occuper des retours à la ligne
- Utiliser des lignes vides pour séparer les paragraphes
- Quatre signes moins "-" ou plus pour afficher une "règle" (séparation) horizontale
- %%% force un retour à la ligne (dans les titres et les listes aussi)
Listes
- un astérisque pour une liste de 1er niveau
- deux astérisque pour une liste de 2nd niveau, etc.
- utiliser * pour les listes à puces, # pour les listes numérotées (mélanger à souhait)
- point virgule-terme-deux petits points-définition pour les définitions
- terme ici
- définition ici, comme dans une liste HTML de type <DL><DT><DD>
- Une ligne pour chaque élément.
- Tout caractère blanc en début de ligne marque du texte préformatté, et modifie la police (fixe)
Titres
- '!' en début de ligne pour un petit titre
- '!!' en début de ligne pour un titre moyen
- '!!!' en début de ligne pour un gros titre (équivalent au titre de page)
Polices
- Indenter d'un espace ou plus pour avoir une police fixe
Ceci est en police fixe
Mais pas ça
Indentation des paragraphes
- point virgule-deux petits points -- marche comme <BLOCKQUOTE>
- ceci est un bout de texte indenté
Mise en avant
- Utiliser les doubles guillemets simples ('') pour ce qui est important (habituellement en italiques)
- utiliser les doubles "underscore" (__) pour ce qui est très important (habituellement en gras)
- Mélanger à volonté: en italiques et en gras
- Important peut être utilisé plusieurs fois sur une ligne, mais ne peut pas porter sur plusieurs lignes:
''ceci
ne marchera pas''
Références (un peu différent de PhpWiki)
- Pour faire un lien vers une page externe on peut explicitement placer le lien entre crochets [ http://www.ufoot.org/uwikicms ].
- On peut préciser un nom pour le lien, par exemple [ UWiKiCMS | http://www.ufoot.org/uwikicms ].
- Même en ommettant les crochets, une URL utilisant un protocole connu comme "http:", "ftp:" ou "mailto:" sera automatiquement rendue cliquable.
Langage HTML
- N'en tenez pas compte (du langage HTML)
- < et > sont rendus tels quels
- Idem pour &, c'est un caractère normal
Règles spécifiques à UWiKiCMS
Voici les quelques extensions que j'ai rajoutées pour les besoins d'UWiKiCMS. Elles sont toutes de la même forme, ce sont en fait de nouveaux protocoles de la forme "protocol:" qui peuvent être utilisés dans les liens.
Images
[ img:123 ] inclut l'image 123.
Noter que la liste des images disponibles dans une page apparaît en bas lorsque vous passez la page en mode modification. Il suffit alors de copier/coller le code qui apparaît devant chaque image.
Liens vers d'autres pages UWiKiCMS
[ page:xyz ] ou [ Description de la page | page:xyz ] fait un lien vers une page relative.
Utiliser des liens relatifs. Dans la page "/foo" un lien de type [ Bar | page:bar ] fera pointer vers "/foo/bar". Un lien vers [ Foo2 | page:../foo2 ] fera pointer vers "/foo2". Un lien vers [ Foobug | page:/foobug ] donnera n'importe quoi.
Traductions
[ lang:xy ] ou [ Language | lang:xy ] crée un lien vers la traduction dans le langage spécifié.
Par exemple [ en français | lang:fr ].
