Forums Développement Multimédia

Les formations Mediabox
Les formations Mediabox

Guide de la mise en page

DokuWiki (le système de wiki utilisé pour les Ressources Mediabox) utilise un langage de balisage simple, qui essaie de rendre les fichiers de données aussi lisibles que possible. Cette page contient toutes les syntaxes possibles que vous pouvez utiliser en éditant les pages. Regardez simplement le code source de cette page en cliquant sur le bouton Éditer cette page en haut ou en bas de cette page. Si vous souhaitez essayer quelque chose, rendez-vous dans la page du bac à sable. Les balises les plus simples sont aussi facilement accessibles depuis les raccourcis clavier.


Mise en forme de texte basique

DokuWiki accepte les textes en gras, italique, souligné et à chasse fixe.

DokuWiki accepte les textes en **gras**, //italique//, __souligné__ et ''à chasse fixe''.

Bien sûr, vous pouvez tous les combiner.

Bien sûr, vous pouvez tous les **__//''combiner''//__**.

Vous pouvez aussi utiliser indice et exposant.

Vous pouvez aussi utiliser <sub>indice</sub> et <sup>exposant</sup>.

De plus, vous pouvez marquer un passage comme supprimé.

De plus, vous pouvez marquer un passage comme <del>supprimé</del>.

Les paragraphes sont créés à partir des lignes vides. Si vous souhaitez forcer un saut de ligne sans paragraphe, vous pouvez utiliser deux contre-obliques suivies par un espace ou une fin de ligne.

Voici du texte avec des sauts de ligne
remarquez que les deux contre-obliques sont reconnues uniquement en fin de ligne
ou suivies par
un espace ; \\ceci se produit sinon.

Voici du texte avec des sauts de ligne\\ remarquez que les
deux contre-obliques sont reconnues uniquement en fin de ligne\\
ou suivies par\\ un espace ; \\ceci se produit sinon.

Vous ne devriez forcer des sauts de ligne que si c'est vraiment nécessaire.




Liens

DokuWiki propose plusieurs moyens pour créer des liens.

Externes

Les liens externes sont reconnus « automagiquement » : http://www.google.fr ou simplement www.google.fr - Vous pouvez aussi donner des noms aux liens : Ce lien pointe vers Google. Les adresses de courriel comme celle-ci : ressources@mediabox.fr sont également reconnues.

Les liens externes sont reconnus « automagiquement » : http://www.google.fr 
ou simplement www.google.fr - Vous pouvez aussi donner des noms aux 
liens : [[http://www.google.fr|Ce lien pointe vers Google]]. Les adresses 
de courriel comme celle-ci : <ressources@mediabox.fr> sont également reconnues. 

Si vous souhaitez inclure une iframe dans votre page, par exemple pour intégrer une console de test, un script à exécuter coté client ou coté serveur, utilisez la balise suivante (sans les espaces):

{ { url > http://www.mediabox.fr [100,100] | alternate text } }

Ici l'iframe fera 100 pixels par 100 pixels.

Internes

Les liens internes sont créés en utilisant les crochets. Vous pouvez soit juste donner le nom de page (comme ceci : Les noms de page), soit utiliser un texte pour le titre. Si vous n'utilisez pas de texte pour le titre, c'est le premier titre présent dans la page qui sera affiché. Les noms de pages sont convertis automatiquement en minuscules, les caractères spéciaux ne sont pas autorisés.

Les liens internes sont créés en utilisant les crochets.
Vous pouvez soit juste donner le nom de page (comme ceci : [[pagename]]),
soit utiliser un [[pagename|texte pour le titre]].
Si vous n'utilisez pas de texte pour le titre, c'est le premier titre présent dans la page
qui sera affiché. Les noms de pages sont convertis automatiquement
en minuscules, les caractères spéciaux ne sont pas autorisés.

Vous pouvez utiliser des catégories en utilisant les deux points (:) dans le lien que vous donnez.

Vous pouvez utiliser des [[aide:ecrire:namespaces|catégories]] en utilisant
les //deux points// ('':'') dans le lien que vous donnez.

Pour plus de détails sur les catégories, voir Catégories.

Si vous ne spécifiez pas de catégorie, la page ciblée sera celle contenue dans la même catégorie que celle de votre page. Par exemple ce lien cible la page nouvelle_page de la catégorie aide:ecrire, car la page que vous êtes en train de lire est dans cette catégorie.

Si vous ne spécifiez pas de catégorie, la page ciblée sera celle contenue dans la même catégorie
que celle de votre page. Par exemple [[nouvelle_page|ce lien]] cible la page **nouvelle_page** de
la catégorie **aide:ecrire**, car la page que vous êtes en train de lire est dans cette catégorie.

Si vous spécifiez une catégorie, cela se fait de manière absolue, relativement à la racine des pages des Ressources Mediabox. Par exemple.

Si vous spécifiez une catégorie, cela se fait relativement à la racine des pages des
Ressources Mediabox. [[tutoriaux:flashplatform:gui:interactivite|Par exemple]].

Chemins relatifs

Si vous voulez indiquer une catégorie relative à la catégorie de la page où vous placez le lien, vous pouvez utiliser le point ”.” ou deux points consécutifs ”..” .

Le point fait référence à la catégorie de la page. Par exemple ce lien cible la même page que celui-là, où encore que celui-ci.

Le point fait référence à la catégorie de la page.
Par exemple [[.:pagename|ce lien]] cible la même page que [[aide:ecrire:pagename|celui-là]],
ou encore que [[pagename|celui-ci]].

Le point n'offre vraiment d'intérêt que pour cibler une sous-catégorie de la catégorie de la page. Par exemple, l'auteur de la page tutoriaux:director:3d:shadows qui veut faire un lien vers la page tutoriaux:director:3d:shadows:solid peut utiliser au choix [[tutoriaux:director:3d:shadows:solid]] ou [[.:shadows:solid]]. Dans ce cas, toujours préférer la seconde solution qui est plus concise, et qui permettra de renommer plus facilement toute la catégorie tutoriaux:director:3d, si le besoin s'en fait un jour sentir.

Les deux points ”..”, eux, font référence à la catégorie parente de la catégorie contenant la page. Par exemple ce lien cible la page lire contenue dans la catégorie aide, qui est la catégorie parente de la catégorie aide:ecrire, qui contient la page actuelle.

Les deux points "..", eux, font référence à la catégorie parente de la catégorie contenant la
page. Par exemple [[..:lire|ce lien]] cible la page **lire** contenue dans la
catégorie **aide**, qui est la catégorie parente de la catégorie **aide:ecrire**, qui contient
la page actuelle.

Lien vers un chapitre

Les liens vers une section spécifique sont également possibles. Ajoutez simplement le nom de la section après un caractère dièse (#) comme en HTML. Ce lien renvoie vers cette section.

Ce lien renvoie vers [[syntax#internes|cette section]].

Notes :

  • Les liens vers des pages existantes sont montrés dans un style différent des liens vers des pages inexistantes.
  • Lorsque le titre d'une section est modifié, alors son lien change aussi. Donc ne comptez pas trop sur les liens de section.

Interwiki

DokuWiki propose les liens Interwiki. Ce sont des liens rapides vers d'autres Wikis. Par exemple ceci est un lien vers la définition des Wikis dans Wikipedia en français : Wiki.

DokuWiki propose les liens [[doku>fr:interwiki|Interwiki]]. Ce sont des
liens rapides vers d'autres Wikis. Par exemple ceci est un lien vers la
définition des Wikis dans Wikipedia en français : [[wp>fr:Wiki|Wiki]].

Liens images

Vous pouvez aussi utiliser une image afin de créer un lien vers une autre page interne ou externe en combinant les syntaxes des liens et des images (voir plus bas) comme ceci :

[[http://www.php.net|{{aide:dokuwiki-128.png}}]]

NB : la mise en forme image est la seule syntaxe de mise en forme acceptée comme nom de lien.

Les syntaxes d'image complète et de Liens sont possibles (incluant le redimensionnement d'image, les images internes et externes, les URL et les liens interwikis).




Notes de pied de page

Vous pouvez ajouter des notes de pied de page 1) en utilisant des parenthèses doubles.

Vous pouvez ajouter des notes de pied de page ((Ceci est une note de pied de page))
en utilisant des parenthèses doubles.




Découpage en sections

Vous pouvez utiliser jusqu'à cinq niveaux de titres différents afin de structurer le contenu. Si vous avez plus de trois titres, une table des matières est construite automatiquement – ceci peut être désactivé en incluant la chaîne ~~NOTOC~~ dans le document (à éviter).

Titre niveau 3

Titre niveau 4

Titre niveau 5
==== Titre niveau 3 ====
=== Titre niveau 4 ===
== Titre niveau 5 ==

Le premier titre rencontré dans la page sera utilisé comme “titre de page”. C'est ce titre qui apparaîtra dans les sommaires et dans la barre de navigation hiérarchique, affichée en haut de page.

En utilisant quatre tirets ou plus, vous pouvez créer une ligne horizontale :



----




Images, animations et autres fichiers

Vous pouvez afficher ou proposer au téléchargement différents médias. Des images, des animations Flash ou Shockwave, des archives .zip, des documents .pdf, etc. Ces médias peuvent être externes, c'est-à-dire provenir d'un autre domaine que celui des Ressources Mediabox. Dans ce cas les liens que vous utiliserez seront du type http://adresse-du-media. Vous pouvez également uploader des médias directement dans les Ressources Mediabox. :!: Préférez toujours cette solution, à moins de ne pas en avoir le droit pour des questions de licence. Ceci permet à votre page de rester stable dans le temps, quelques soient les changements qui pourraient intervenir pour des liens externes. Pour savoir comment uploader des medias dans les Ressources Mediabox, voyez cette page.

Images

Vous pouvez inclure des images externes et internes avec des accolades.

Vous pouvez spécifier la taille des images et des animations (facultatif).

Taille réelle :

Redimensionnement à une largeur donnée :

Redimensionnement à une largeur et une hauteur données2) :

Image externe redimensionnée :

Taille réelle :                                          {{aide:dokuwiki-128.png}}
Redimensionnement à une largeur donnée :                 {{aide:dokuwiki-128.png?50}}
Redimensionnement à une largeur et une hauteur données : {{aide:dokuwiki-128.png?200x50}}
Image externe redimensionnée :                           {{http://de3.php.net/images/php.gif?200x50}}

En utilisant des espaces à gauche ou à droite, vous pouvez choisir l'alignement.

{{ aide:dokuwiki-128.png}}
{{aide:dokuwiki-128.png }}
{{ aide:dokuwiki-128.png }}

Bien sûr, vous pouvez aussi ajouter un titre (affiché comme une bulle d'aide par la plupart des navigateurs).

Ceci est le titre

{{ aide:dokuwiki-128.png |Ceci est le titre}}

Pour lier une image à une autre page, voir Liens images ci-dessus.

On peut désactiver le fait que l'image s'affiche seule dans le navigateur quand on clique dessus en mettant ?nolink après le nom de l'image

le logo de DokuWiki

{{aide:dokuwiki-128.png?nolink|le logo de DokuWiki}}

On peut proposer une image en téléchargement sans l'afficher, en utilisant ?linkonly après le nom de l'image

le logo de DokuWiki

{{aide:dokuwiki-128.png?linkonly|le logo de DokuWiki}}

Animations Flash

Utilisez la même syntaxe que pour les images pour afficher une animation flash (.swf). Dans ce cas évidemment, les lecteurs devront avoir ajouté le plugin Flash Player à leur navigateur pour voir l'animation. Dans le cas contraire un avertissement leur sera affiché.

Une différence avec les images, c'est que les dimensions d'un .swf ne sont pas automatiquement détectées. Pour vous assurer que le résultat n'est pas tronqué, ou que des marges ne sont pas ajoutées, précisez la taille en utilisant le point d'interrogation. Par exemple:

{{mon_anim.swf?400x300}}

Si votre .swf charge dynamiquement du contenu (un .xml, une image, un autre .swf, un .txt, …), lisez cette note.

Animations Shockwave

Vous pouvez également afficher des animations conçue avec Adobe Director. La syntaxe est la suivante :

<director source=animation.dcr size=400x300 version=10,0,0,0>

Le paramètre version est facultatif. Par défaut il est fixé à 10,0,0,0.

Les lecteurs doivent avoir installé le plugin sur leur navigateur. Dans le cas inverse, ils auront affiché un message d'avertissement.

Autres fichiers

Si avec les accolades vous spécifiez un nom de fichier (externe ou interne) qui n'est pas une image ou une animation Flash (gif, jpeg, png, swf), alors il sera affiché comme un lien et non comme une image. Choisissez notamment cette solution pour proposer au lecteur de télécharger des fichiers utiles au tutoriel qu'il est en train de lire, comme par exemple les sources compressées.




Listes

DokuWiki accepte les listes ordonnées et non ordonnées. Pour créer un élément de liste, indentez votre texte par deux espaces et utilisez une * pour une liste non ordonnée ou un - pour une liste ordonnée.

  • Ceci est une liste
  • Le second élément
    • Vous pouvez avoir plusieurs niveaux
  • Un autre élément
  1. La même liste mais ordonnée
  2. Un autre élément
    1. Utilisez simplement l'indentation pour des niveaux plus profonds
  3. Et voilà
  * Ceci est une liste
  * Le second élément
    * Vous pouvez avoir plusieurs niveaux
  * Un autre élément

  - La même liste mais ordonnée
  - Un autre élément
    - Utilisez simplement l'indentation pour des niveaux plus profonds
  - Et voilà

Vous pouvez aussi consulter notre FAQ sur les listes




Conversions textuelles

DokuWiki peut convertir certains caractères ou chaînes de caractère prédéfinis en image, autre texte, ou HTML.

Les conversions en image sont principalement utilisée pour les émoticônes (smileys). Les conversions en texte ou HTML sont utilisées pour des raisons de typographie, mais peuvent également être configurées pour utiliser d'autres balises HTML.

Emoticônes (smileys)

DokuWiki transforme les Émoticônes courantes en leurs équivalents graphiques. Voici une vue d'ensemble des émoticônes incluse dans DokuWiki.

  • 8-) 8-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :-\ :-\
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • :mrgreen: :mrgreen:
  • :arrow: :arrow:
  • :idea: :idea:
  • FIXME FIXME
  • DELETEME DELETEME

Typographie

DokuWiki peut convertir de simples caractères de texte brut en leurs entités typographiques correctes. Voici un exemple des caractères reconnus.

→ ← ↔ ⇒ ⇐ ⇔ » « – — © ™ ® “He thought 'It's a man's world'…”

-> <- <-> => <= <=> >> << -- --- (c) (tm) (r)
"He thought 'It's a man's world'..."




Citations

Parfois vous souhaitez marquer du texte afin de montrer que c'est une réponse ou un commentaire. Vous pouvez utiliser la syntaxe suivante :

Je pense que nous devrions le faire

> Non nous ne devrions pas

>> Eh bien, je pense que si

> Vraiment ?

>> Oui !

>>> Alors faisons-le !

Je pense que nous devrions le faire

Non nous ne devrions pas
Eh bien, je pense que si
Vraiment ?
Oui !
Alors faisons-le !




Tableaux

DokuWiki propose une syntaxe simple pour créer des tableaux.

Titre 1 Titre 2 Titre 3
Ligne 1 Col 1 Ligne 1 Col 2 Ligne 1 Col 3
Ligne 2 Col 1 colonnes fusionnées (notez la double barre verticale)
Ligne 3 Col 1 Ligne 2 Col 2 Ligne 2 Col 3

Les lignes de tableau doivent commencer et se terminer avec une barre verticale | pour des lignes normales ou avec un ^ pour les titres.

^ Titre 1         ^ Titre 2           ^ Titre 3                            ^
| Ligne 1 Col 1   | Ligne 1 Col 2     | Ligne 1 Col 3                      |
| Ligne 2 Col 1   | colonnes fusionnées (notez la double barre verticale) ||
| Ligne 3 Col 1   | Ligne 2 Col 2     | Ligne 2 Col 3                      |

Pour fusionner des cellules horizontalement, videz simplement complètement la cellule suivante comme il est montré ci-dessus. Assurez-vous d'avoir toujours le même nombre de séparateurs de cellules !

Les titres de tableau verticaux sont également possibles.

Titre 1 Titre 2
Titre 3 Ligne 1 Col 2 Ligne 1 Col 3
Titre 4 pas de fusion cette fois
Titre 5 Ligne 2 Col 2 Ligne 2 Col 3

Comme vous pouvez le constater, c'est le séparateur ('|' ou '^') précédant une cellule qui détermine le format :

|              ^ Titre 1                  ^ Titre 2          ^
^ Titre 3      | Ligne 1 Col 2            | Ligne 1 Col 3    |
^ Titre 4      | pas de fusion cette fois |                  |
^ Titre 5      | Ligne 2 Col 2            | Ligne 2 Col 3    |

Vous pouvez également aligner les contenus du tableau. Ajoutez simplement au moins deux espaces à l'extrémité opposée de votre texte : ajoutez deux espaces sur la gauche pour aligner à droite, deux espaces sur la droite pour aligner à gauche et deux espaces au moins à chaque extrémité pour centrer le texte.

Tableau avec alignement
droite centré gauche
gauche droite centré
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Voici à quoi ça ressemble dans le code source :

^          Tableau avec alignement         ^^^
|        droite|    centré    |gauche        |
|gauche        |        droite|    centré    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |




Blocs non analysés

Vous pouvez inclure des blocs non analysés dans vos documents soit en les indentant avec au moins deux espaces (comme on peut le voir dans les exemples précédents) soit en utilisant les balises code ou file.

Ceci est du code préformaté, tous les espaces sont préservés : comme           <-ceci
<code>
Ceci est du code préformaté, tous les espaces sont préservés : comme           <-ceci
</code>
Ceci est pratiquement la même chose, mais vous pouvez l'utiliser pour montrer que vous avez cité un fichier. 
<file>
Ceci est pratiquement la même chose, mais vous pouvez l'utiliser pour montrer que vous avez cité un fichier. 
</file>

Pour laisser l'analyseur ignorer complètement un bloc (comme ne pas faire lui appliquer de mise en forme), encadrez ce bloc soit avec des balises nowiki ou, encore plus simple, avec des caractères pourcent doubles %%.

Voici du texte qui contient des adresses comme ceci : http://www.spiltbrain.org et de la **mise en forme**, mais rien ne se passe.

<nowiki>
Voici du texte qui contient des adresses comme ceci : http://www.spiltbrain.org et de
la **mise en forme**, mais rien ne se passe. 
</nowiki>

Ou

%%Voici du texte qui contient des adresses comme ceci : http://www.spiltbrain.org et de
la **mise en forme**, mais rien ne se passe.%%

Consultez le code source de cette page pour voir comment utiliser ces blocs.




Coloration syntaxique

DokuWiki peut mettre en forme et en couleur du code source, ce qui facilite sa lecture. Il utilise le Generic Syntax Highlighter GeSHi – donc n'importe quel langage connu de GeSHi est accepté. La syntaxe est la même que dans le bloc de code de la section précédente, mais cette fois le nom du langage utilisé est inséré dans la balise. Par exemple : <code java>.

/** 
 * La classe HelloWorldApp implemente une application qui
 * affiche simplement "Hello World!" dans la sortie standard.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Affiche la chaîne.
    }
}

Les Ressources Mediabox utilisent notamment les identificateurs de langage suivants: actionscript, css, html, java, javascript, lingo, mxml, xml.

Voici la liste de tous les identificateurs actuellement reconnus : abap, actionscript-french, actionscript, actionscript3 3), ada, apache, applescript, asm, asp, autoit, avisynth, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, cmake, cobol, cpp, cpp-qt, csharp, css, d, dcs, delphi, diff, div, dos, dot, eiffel, email, erlang, fo, fortran, freebasic, genero, glsl, gml, gnuplot, groovy, gettext, haskell, hq9plus, html, idl, ini, inno, intercal, io, java5, java, javascript, kixtart, klonec, klonecpp, latex, lingo, lisp, locobasic, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, make, matlab, mirc, modula3, mpasm, mxml, mysql, nsis, oberon2, objc, ocaml-brief, ocaml, oobas, oracle8, oracle11, pascal, perl, per, php-brief, php, pic16, pixelbender, plsql, povray, powershell, progress, prolog, properties, providex, python, qbasic, rails, rebol, reg, robots, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, tcl, teraterm, text, thinbasic, tsql, typoscript, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xml, xorg_conf, xpp, z80




Agrégation de fils RSS/ATOM

DokuWiki peut agréger les données de fils XML externes. Pour l'analyse des fils XML, SimplePie est utilisé. Tous les formats connus de SimplePie peuvent aussi être utilisés dans DokuWiki. Vous pouvez modifier le comportement en ajoutant plusieurs paramètres séparés par des espaces :

Paramètre Description
tout nombre sera utilisé comme le nombre maximum d'éléments à montrer, 8 par défaut
reverse affiche les derniers éléments en premier dans le fil
author affiche le nom des auteurs des éléments
date affiche les dates des éléments
description affiche les descriptions des éléments. Si HTML est désactivé, toutes les étiquettes (tags) seront enlevées
n[dhm] durée de rafraîchissement, ou d=days (jours), h=heures, m=minutes. (Par exemple 12h = 12 heures).

La durée de rafraîchissement est par défaut de 4 heures. Toute valeur inférieure à 10 minutes sera traitée comme 10 minutes. DokuWiki essaiera en général de fournir une version de la page à partir du cache, évidemment, cela est inadapté quand la page a un contenu dynamique externe. Le paramètre dit à DokuWiki de réengendrer la page s'il y a plus que la durée de rafraîchissement depuis que la page a été engendrée pour la dernière fois.

Exemple :

{{rss>http://slashdot.org/index.rss 5 author date 1h }}




Macros

Certains mots-clés modifient la manière dont DokuWiki génère une page, sans rajouter aucun contenu. Les macros suivantes sont disponibles :

Macro Description
~~NOTOC~~ Si cette macro est présente dans une page, aucune table des matières ne sera générée.
~~NOCACHE~~ Par défaut, DokuWiki met en cache les pages qu'il génère. Parfois, ce n'est pas ce qui est voulu (par exemple quand la syntaxe <php> vue ci dessus est utilisée), ajouter cette macro va forcer DokuWiki à générer une page à chaque appel de celle ci.
1) Ceci est une note de pied de page
2) Si les proportions de l'image ne sont pas respectées, celle-ci sera «découpé» avant redimensionnement selon les nouvelles proportions
3) Pour l'instant le formatage en Actionscript 3 est insatisfaisant, et il vaut mieux utiliser actionscript seul