Aide sur la notation pour la mise en forme du texte

En-têtes

Pour créer un en-tête, insérez "hn. " au début de la ligne (où n est un nombre compris entre 1 et 6).

Notation Commentaire
h1. En-tête le plus gros possible

En-tête le plus gros possible

h2. En-tête plus gros

En-tête plus gros

h3. En-tête en gros

En-tête en gros

h4. En-tête normal

En-tête normal

h5. En-tête petit
En-tête petit
h6. En-tête le plus petit possible
En-tête le plus petit possible

Effets de texte

Les effets de texte servent à modifier la mise en forme des mots et des phrases.

Notation Commentaire
*gras*
Met le texte en gras.
_italique_
Met le texte en italique..
??citation??
Met le texte en citation.
-supprimé-
Met le texte en style supprimé.
+inséré+
Met le texte en style inséré.
^exposant^
Met le texte en exposant.
~indice~
Met le texte en indice.
{{police à châsse fixe}}
Applique au texte une police à châsse fixe.
bq. Exemple de bloc de texte entre guillemets

Pour mettre un paragraphe entier entre guillemets, faites-le précéder de "bq. ".

Exemple:

Exemple de bloc de texte entre guillemets
{quote}
    voici du 
contenu à mettre entre guillemets {quote}

Met un bloc de texte plus long qu'un paragraphe entre guillemets.

Exemple:

voici du
contenu à mettre entre guillemets
{color:red}
    Regarde le texte en rouge !
{color}

Modifie la couleur d'un bloc de texte.

Exemple:

Regarde le texte en rouge !

Retours à la ligne

Souvent, il n'est pas nécessaire d'insérer des sauts de paragraphe explicites ; Wiki Renderer pagine en effet les paragraphes correctement.

Notation Commentaire
(ligne vide)
Crée un nouveau paragraphe
\\
Crée un saut de ligne. Souvent, le saut de ligne n'est pas nécessaire car Wiki Renderer gère automatiquement la création des lignes.
----
Crée une règle horizontale.
---
Génère un symbole .
--
Génère un symbole .

Liens

Il est important de savoir créer rapidement des liens.

Notation Commentaire
[#anchor]
[^attachment.ext]
Crée un lien hypertexte interne menant à l'ancre ou la pièce jointe spécifiées. L'ajout du symbole '#', suivi du nom d'une ancre, conduit à un signet donné de la page désirée. Le symbole '^' suivi du nom d'une pièce jointe conduit à un lien menant à la pièce jointe de la demande en cours.
[http://jira.atlassian.com]
[Atlassian|http://atlassian.com]

Crée un lien vers une ressource externe ; les caractères spéciaux qui suivent l'URL et qui n'en font pas partie doivent être suivis d'un espace.

Les crochets [] placés de part et d'autre des liens externes sont facultatifs, si vous ne voulez pas utiliser d'alias pour le lien.

Exemples:

http://jira.atlassian.com
Atlassian

[mailto:legendaryservice@atlassian.com]

Crée un lien complet vers une adresse électronique, avec une icône de messagerie.

Exemple:

>>legendaryservice@atlassian.com

[file:///c:/temp/foo.txt]
[file:///z:/file/on/network/share.txt]

Crée un lien de téléchargement vers un fichier sur votre ordinateur ou sur un réseau partagé que vous avez mappé vers un lecteur. Pour accéder au fichier, vous devez faire un clic droit sur le lien et choisir "Save Target As".

Par défaut, cela ne fonctionne qu'avec Internet Explorer mais il est également possible de faire en sorte que cela fonctionne avec Firefox (voir les docs).

{anchor:anchorname}
Crée une ancre de signet au sein de la page. Vous pouvez ensuite créer des liens menant directement à cette ancre. Ainsi, le lien [My Page#here] mènera à l'endroit de "Ma page" où il y a une macro {anchor:here} et le lien [#there] mènera à l'endroit de la page en cours où il y a une macro {anchor:there}.
[~username]
Crée un lien vers la page de profil d'un utilisateur particulier avec une icône utilisateur et le nom complet de l'utilisateur en question.

Listes

Les listes vous permettent de présenter les informations sous forme de série d'éléments ordonnés.

Notation Commentaire
* exemple
* de puce
** indentées
** puces
* puces

Liste à puces (doit apparaître dans la première colonne). L'utilisation de plusieurs symboles (**) vous permet d'obtenir une indentation plus profonde.

Exemple:

  • exemple
  • de puce
    • indentées
    • puces
  • puces
- différents
- de puce
- types de

Elément de liste (précédé de -). Plusieurs lignes vous permettent de créer une liste.

Exemple:

  • différents
  • de puce
  • types de
# une
# numérotée
# liste

Liste numérotée (doit apparaître dans la première colonne). L'utilisation de plusieurs symboles (##, ###) vous permet d'obtenir une indentation plus profonde.

Exemple:

  1. une
  2. numérotée
  3. liste
# une
# numérotée
#* avec
#* imbriqués
#* de puce
# liste
* une
* indentées
*# avec
*# imbriqués
*# numérotée
* liste

Vous pouvez même créer toutes sortes de mélanges de listes imbriquées

Exemple:

  1. une
  2. numérotée
    • avec
    • imbriqués
    • de puce
  3. liste

Exemple:

  • une
  • indentées
    1. avec
    2. imbriqués
    3. numérotée
  • liste

Images

Il est possible d'intégrer des images dans un champ géré par Wiki Renderer à partir d'un fichier joint ou d'une source distance.

Notation Commentaire
!http://www.host.com/image.gif!
ou
!attached-image.gif!

Insère une image dans la page.

Si une URL pleinement qualifiée est indiquée, l'image est affichée à partir de la source distante. Sinon un fichier d'image joint est affiché.

!image.jpg|thumbnail!

Insère une miniature de l'image dans la page (ne fonctionne qu'avec les images jointes à la page).

!image.gif|align=right, vspace=4!

Pour n'importe quelle image, vous pouvez également spécifier les attributs de la balise d'image sous forme de liste séparée par des virgules de paires nom=valeur.

Pièces jointes

Il est également possible d'intégrer des pièces jointes d'un certain type dans un champ géré par Wiki Renderer à partir de fichiers joints.

Notation Commentaire
!quicktime.mov!
!spaceKey:pageTitle^attachment.mov!
!quicktime.mov|width=300,height=400!
!media.wmv|id=media!

Intègre un objet dans une page, avec des propriétés organisées en liste séparée par des virgules.

Formats pris en charge par défaut:

  • Flash (.swf)
  • Animations Quicktime (.mov)
  • Supports Windows Media (.wma, .wmv)
  • Supports Real Media (.rm, .ram)
  • Fichiers MP3 (.mp3)

D'autres types de fichiers peuvent être utilisés mais il peut être nécessaire d'indiquer les propriétés "classid", "codebase" et "pluginspage" pour qu'ils soient reconnus par les navigateurs Web.

Les propriétés courantes sont ::

  • largeur - largeur du fichier
  • hauteur - hauteur du fichier
  • id - ID attribué à l'objet intégré

Pour des raisons de sécurité, les fichiers placés sur des serveurs distants ne sont pas autorisés.Style
Par défaut, chaque objet intégré est placé dans une balise "div". Si vous souhaitez appliquer un style à la balise "div" et à son contenu, redéfinissez la classe "embeddedObject". En spécifiant un ID comme propriété, vous pouvez également appliquer un style différent à divers objets incorporés. Il faut utiliser des noms de classes CSS au format "objetIncorporé-ID".

Tableaux

Les tableaux vous permettent d'organiser le contenu en lignes et colonnes, avec une ligne d'en-tête si nécessaire.

Notation Commentaire
||en-tête 1||en-tête 2||en-tête 3||
|col A1|col A2|col A3|
|col B1|col B2|col B3|

Crée un tableau. Pour créer une ligne d'en-tête pour un tableau, utilisez des doubles barres.

Le code proposé ici génère un tableau qui se présente sous la forme:

en-tête 1 en-tête 2 en-tête 3
col A1 col A2 col A3
col B1 col B2 col B3

Mise en forme avancée

Options de mise en forme de texte plus avancées.

Notation Commentaire
{noformat}
exemple de texte préformaté
ainsi, *aucune* _mise en forme _ supplémentaire n'est effectuée ici {noformat}

Crée un bloc préformaté de texte sans faire ressortir la syntaxe. Tous les paramètres en option de la macro {panel} sont également valides pour {noformat}.

  • nopanel: Place un bloc de texte dans un volet entièrement personnalisable. Les paramètres en option que vous pouvez définir sont les suivants :

Exemple:

exemple de texte préformaté ainsi, *aucune* _mise en forme _ supplémentaire n'est effectuée ici
{panel}
Exemple de texte
{panel}
{panel:title=Mon titre}
Exemple de texte avec un titre
{panel}
{panel:title=Mon titre|borderStyle=dashed|borderColor=#ccc|titleBGColor=#F7D6C1|bgColor=#FFFFCE}
Exemple de texte entouré de *panel*
une _autre_ ligne encore
{panel}

Place un bloc de texte dans un volet entièrement personnalisable. Les paramètres en option que vous pouvez définir sont les suivants :

  • title: Titre du volet
  • borderStyle: Style que la bordure de ce volet utilise (solid, dashed et autres styles de bordure CSS valides)
  • borderColor: Couleur de la bordure que ce volet utilise
  • borderWidth: Largeur de la bordure que ce volet utilise
  • bgColor: Couleur d'arrière-plan de ce volet
  • titleBGColor: Couleur d'arrière-plan de la section de titre de ce volet

Exemple:

Mon titre
Exemple de texte entouré de panel
une autre ligne encore
{code:title=Bar.java|borderStyle=solid}
// Some comments here
public String getFoo()
{
    return foo;
}
{code}
{code:xml}
    <test>
        <another tag="attribute"/>
    </test>
{code}

Crée un bloc préformaté de texte en faisant ressortir la syntaxe. Tous les paramètres en option de la macro {panel} sont également valides pour {noformat}. Le langage par défaut est Java mais vous pouvez en spécifier d'autres, y compris ActionScript, Ada, AppleScript, bash, C, C#, C++, CSS, Erlang, Go, Groovy, Haskell, HTML, JavaScript, JSON, Lua, Nyan, Objc, Perl, PHP, Python, R, Ruby, Scala, SQL, Swift, VisualBasic, XML et YAML.

Exemple:

Bar.java
// Some comments here
public String getFoo()
{
    return foo;
}
<test>
    <another tag="attribute"/>
</test>

Divers

Autres possibilités de mise en évidence de la syntaxe.

Notation Commentaire
\X
Caractère d'échappement spécial (c'est-à-dire {)
:)
,
:(
etc

Emoticônes graphiques (smileys).

Notation :) :( :P :D ;) (y) (n) (i) (/) (x) (!)
Image
Notation (+) (-) (?) (on) (off) (*) (*r) (*g) (*b) (*y) (flag)
Image
Notation (flagoff)
Image