TWiki Text Formatting

Working in TWiki is as easy as typing in text. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all laid out below.

TWiki Editing Shorthand

_Attention : cette traduction est incomplète !

outil de formatage:	Exemple: Vous écrivez:	Résultat:
Paragraphes: une ligne vide crée un nouveau paragraphe.	1er paragraphe 2ème paragraphe	1er paragraphe 2ème paragraphe
les en-têtes: Il faut mettre au moins 3 espaces au début de la ligne, suivis par le(s) signe(s) "plus" et le titre. Un "plus" crée un niveau 1 de titre (ce sera le titre le plus important), deux "plus" crée un niveau 2; le maximum est de 6 niveaux (ex: partie, titre, sous-titre, chapitre, section et paragraphe). Note: un sommaire peut être crée automatiquement avec la variable %TOC% , voir TWikiVariables.	---++ Sushi ---+++ Maguro	Sushi Maguro
Texte en gras: les mots sont en gras en les encadrant d'astérisques *.	*Gras*	Gras
Texte en italiques: Les mots sont en italiques en les encadrant avec des "underscores" _.	_Italiques_	Italiques
En gras et italiques: Les mots sont en gras italiques en les encadrant _ de double-underscores.	__Gras italiques__	Gras italiques
Fixed Font: Les mots apparaissent en police fixe en les entourant de signes d'égalité = .	=Police fixe=	Police fixe
Police fixe en gras: Les mots apparaissent en police fixe en gras en les entourant de signes d'égalité en double .	==Gras fixe==	Gras fixe
Note: Soyez sûr/e/s de coller les signes * _ = == aux mots, par exemple il faut enlever les espaces.	_Cela marche_, _Cela *ne* marche pas _	Cela marche, _Cela ne marche pas _
Eviter le formatage - Mode "mot à mot": Entourer les extraits de code et le texte formaté avec les balises = and = . Note: Utilisez les balises = et = à la place si vous voulez que le code HTML soit interprété. Note: Chaque balise doit avoir une ligne pour elle toute seule.	la classe AnimalChat { nul ronronnement() { <code ici> } }	la classe AnimalChat { nul ronronnement() { <code ici> } }
Séparateur: Au moins 3 tirets au début de la ligne.	-------
Faire une liste: Trois espaces suivis d'un astérisque.	* élément de liste	élément de liste
Liste hiérarchisée : Six, neuf, ... espaces suivi d'un astérisque.	* liste hiérarchisée	liste hiérarchisée
Liste ordonnée : Trois espaces suivi d'un chiffre.	1 Sushi 1 Dim Sum	Sushi Dim Sum
Liste de définitions: 3 espaces, le terme, une colonne, un espace, suivis par la définition. Note: Les termes avec des espaces ne sont pas supportés. Au cas où vous devez avoir un terme avec plus qu'un mot, séparez les mots avec des tiretss ou avec le caractère permettant de casser l'espace :   .	Sushi: Japon Dim Sum: S.F.	Sushi Japon Dim Sum: S.F.
Tableau: Les espaces (facultatifs) sont suivis par des cellules qui sont enfermées par des barres verticales. Note: | *gras* | cellules en tête du tableau. Note: |   spaced   | cellules centrées et alignées. Note: |     spaced | cellules alignées à droite. Note: | 2 colspan || cellules couvrant plusieurs colonnes (voir exemple ci-contre). Note: Au cas où vous avez une longue ligne et que vous la voulez plus lisible quand vous l'éditez, vous pouvez partager cette ligne en plusieurs qui finissent avec une barre oblique inverse '\' .	| *L* | *C* | *R* | | A2 | 2 | 2 | | A3 | 3 | 3 | | multi span ||| | A4 \ | ma phrase est longue\ | celle-ci aussi |	L C R A2 2 2 A3 3 3 multi span A4 ma phrase est longue celle-ci aussi
Les liens MotWiki? : LesMotsAvecCapitalesCollesEnsemble (ou MotsWiki? , "WikiWords") produiront un lien automatiquement. Note: Si vous voulez relier un thème ("topic") qui se trouve dans une autre zone ("web") de TWiki, écrivez NomdelaZone.NomduThème.	WebNotify Know.ReadmeFirst	WebNotify ReadmeFirst?
Liens forcés: Vous pouvez créer un lien interne forcé en encadrant les mots avec des doubles crochets. Note: Le texte dans les crochets peut contenir des espaces, le nom du sujet est formé en enlevant les espaces et en mettant de lettres capitales; exemple [[text formatting FAQ]] lié au sujet TextFormattingFAQ. Vous pouvez aussi vous référer à une zone de TWiki différente et utiliser des ancres (ou liens hypertexte).	[[wiki syntax]] [[Main.TWiki users]]	wiki syntax Main.TWiki users
Liens spécifiques: Créer un lien où vous pouvez spécifier le lien du texte et le lien de référence séparément, par l'utilisation de crochets imbriqués comme [[reference][text]]. Les références d'un lien interne (c-a-d WikiSyntax) et les références d'un lien externe (c-a-d une url, http://TWiki.org/) sont possibles. Les mêmes règles Liens Forcés sont appliquées pour des références de lien interne. Les noms Ancres peuvent être ajoutés assez bien, comme [[TWiki.WebHome#MonAncre][allez à la maison]] et [[http://www.yahoo.com/#somewhere][Yahoo!]].	[[WikiSyntax][syntax]] [[http://gnu.org][GNU]]	syntax GNU
Ancres: Vous pouvez définir un lien dans un sujet (appelé un nom ancré) et attacher à lui. Pour definir une ancre écrire #NomAncre au début de la ligne. Le nom ancré doit être un mot Wiki. Pour relier le nom d'une ancre utiliser cette syntaxe [[MyTopic#MyAnchor]] . Vous pouvez omettre le nom du sujet si vous voulez l'attacher au même sujet.	[[WebHome#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here	TWiki.WebHome#NotThere Jump To here
Empecher un Lien: Empecher qu'un WikiWord deviennent un lien en ajoutant la balise .	SunOS	SunOS

Using HTML

L'utilisation d'HTML

Vous pouvez utiliser n'importe quelle balise HTML sans aucun problème, CEPENDANT, il est recommandé de ne pas le faire. En utilisant les TWikiRaccourcis, vous pouvez faire pratiquement tout ce vous pouviez faire avec le HTML, et cela garde le texte dégagé et facile au gens à modifier et parcourir.

Hyperliens

Etre capable de créer des liens, sans qu'un formatage soit requis, est au coeur de la caractéristique TWiki, possible grâce aux MotsWiki? ? (WikiWords? ). Les nouvelles règles de Twiki pour la création de liens, sont une simple extension de la syntaxe qui fournit un ensembles d'options flexibles.

Liens Internes

• GoodStyle est un WikiWord qui permet d'accéder au thème GoodStyle qui se trouve dans la zone TWiki.

• NExistePasEncore? ? est un thème en attentre d'être écris. Pour le faire, il suffit de cliquer sur le "?" (essayez de cliquer puis faites Cancel (abandonner) car le faire sur ce document détruirait cet exemple!).

Liens Externes

• http://..., https://..., ftp://... and mailto:...@... créés les liens automatiquement.

• Les adresses Email ou courriels nom@domainNOSPAM.com créés des liens automatiquement.

• Les règles des espaces entre crochets? vous permettent de créer facilement des liens sans mots wiki.

Hyperlinks

Being able to create links without any special formatting is a core TWiki feature, made possible with WikiWords and inline URLs.

Internal Links

• GoodStyle is a WikiWord that links to the GoodStyle topic located in the current web.

• NotExistingYet? is a topic waiting to be written. Create the topic by clicking on the ?. (Try clicking, but then, Cancel - creating the topic would wreck this example!)

External Links

• http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://... and mailto:...@... are linked automatically.

• E-mail addresses like name@domain.com are linked automatically.

• [[Square bracket rules]] let you easily create non-WikiWord links.
  • You can also write [[http://yahoo.com Yahoo home page]] as an easier way of doing external links with descriptive text for the link, such as Yahoo home page.

TWiki Variables

WikiVariables sont des noms encadrés par des signes de pourcentage % qui sont remplacées au vol par leur contenu. L'utilisation de variables existantes, ainsi que celles que vous avez créées, ajoute un surprenant niveau supplémentaire au contenu de vos publications. Par exemple:

• : Génère automatiquement un sommaire du contenu à la tête d'un document - voyez le haut de cette page pour avoir un exemple.

• TWiki : La zone que vous utilisez maintenant est Wok.

• TWikiVariablesQuickStart : Le thème que vous utilisez à cet instant est TWikiRaccourcis.

• http://www.alouette-fcrg.fr/pub/TWiki/TWikiVariablesQuickStart : L'attache de l'URL du thème sur lequel vous êtes. Exemple d'utilisation : si vous attachez un fichier à un document vous pouver vous référer à lui

pour montrer l'URL du fichier ou l'image dans votre texte .

Warning: Can't find topic TWiki.SomeTopic : Server side include (lien hypertext sur le serveur) insére un topic. Le site (TWiki web) courant est le site web. Example: *

TWiki Web	Description of Web	Used to...	Links
Main	Bienvenue sur Alouette-FCRG... Users, Groups	...pour voir qui est publié sur cete espace.
TWiki	Welcome, Registration? , and other StartingPoints; TWiki history & Wiki style; All the docs...	...discover TWiki details, and how to start your own site.
Animations	Section Animations	...informations
Atelier_Photo		...collaborate on
Billard		...collaborate on
FootBall		...collaborate on
Gymnastique		...collaborate on
Sandbox	Sandbox test area with all features enabled.	...experiment in an unrestricted hands-on web.
Tennis_de_Table		...collaborate on
Tournoi_Alouette		...collaborate on
You can use color coding by web for identification and reference. This table is updated automatically based on WebPreferences settings of the individual webs. Contact daniel.andron@gmailNOSPAM.com if you need a separate collaboration web for your team. See also AdminToolsCategory.

Legend:

Go to the home of the web

See recent changes in the web

|^| Search the web | Subscribe to get notified of changes by e-mail | (included from SiteMap; change TWikiVariablesQuickStart to include from SiteMap instead of TWikiWebsTable)*

• There are many more variables, see TWiki.TWikiVariables.

TWiki Variables are names enclosed in percent signs that are that are expanded to some other text when the topic is displayed. For example, %TOPIC% is expanded to TWikiVariablesQuickStart. Some variables can take arguments in curly braces - for example, %INCLUDE{"OtherTopic" ARG="arg"}%.

Many TWiki variables are built-in, and others are predefined for your convenience. You can also define your own TWiki Variables at the entire site, individual web, or individual topic level. For more information, go to TWikiVariables

TWiki Variables are fully expanded before any of the TWiki text formatting rules are applied.

Documentation Graphics: There are many graphics available to use in your topics. Use %ICON{"help"}%, %ICON{"tip"}%, and %ICON{"warning"}% to get: , , and , respectively. TWikiDocGraphics lists them all.

To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins can extend the functionality of TWiki into many other areas. There are a huge number of TWiki plugins available from the Plugins web on TWiki.org.

Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

• CommentPlugin (03 Aug 2008, $Rev: 17302 (11 Aug 2008) $): Allows users to quickly post comments to a page without an edit/preview/save cycle
• EditTablePlugin (4.8.4, $Rev: 17302 (11 Aug 2008) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
• InterwikiPlugin (03 Aug 2008, $Rev: 14913 (17 Sep 2007) $): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
• PreferencesPlugin (TWiki-4.2, $Rev: 15487 (11 Aug 2008) $): Allows editing of preferences using fields predefined in a form
• SlideShowPlugin (02 Aug 2008, $Rev: 17260 (11 Aug 2008) $): Create web based presentations based on topics with headings.
• SmiliesPlugin (Dakar, $Rev: 16049 (11 Aug 2008) $): Render smilies as icons, like for  :-) or for  :eek:
• TablePlugin (1.034, $Rev: 17367 (11 Aug 2008) $): Control attributes of tables and sorting of table columns
• TinyMCEPlugin (03 Aug 2008, $Rev: 17302 (11 Aug 2008) $): Integration of TinyMCE? with WysiwygPlugin
• TwistyPlugin (1.4.10, $Rev: 15653 (19 Nov 2007) $): Twisty section JavaScript library to open/close content dynamically
• WysiwygPlugin (03 Aug 2008, $Rev: 17359 (11 Aug 2008) $): Translator framework for Wysiwyg editors

Check on current Plugin status and settings for this site in TWikiPreferences.

Les erreurs d'édition les plus communes

TWiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the TextFormattingFAQ:

• Q: Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is?
  • A: The '<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<', and '>' instead of '>'.
    Example: Type 'prog <filename>' to get 'prog <filename>'.

• Q: Why is the '&' character sometimes not displayed?
  • A: The '&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
    Example: Type 'This & that' to get 'This & that'.

---

-- version anglais: TWikiShorthand

-- version original du Indymedia: http://docs.indymedia.org/view/TWiki/TWikiRaccourcis

-- UweWahser? ? - 06 Apr 2004: adaptation aux besoins du CNLS

-- BarakissaTien? ? - 11 Sep 2004

-- ThierryPasquier? ? - 15 May 2005