Carrefour numérique² - fablab aide

Créer, déplacer, supprimer une page

2017-12-23T02:24:44+02:00

Comment je documente ? Et Pourquoi ?

2018-12-19T17:11:58+02:00

Comment je documente ? Et Pourquoi ?

Le Fab Lab est un atelier contributif et l'accès est gratuit, mais en échange :

Vous vous engagez à participer aux autres projets en cours au moment où vous vous trouvez sur place. Vous faites bénéficier les autres de vos savoirs, et les autres vous font bénéficier de leurs savoirs.
Vous vous engagez à documenter ce que vous réalisez : à savoir, écrire la “recette de cuisine” de votre objet pour que d’autres puissent le refaire. Notez que cela ne vous empêche pas d'en faire une exploitation commerciale, en choisissant une licence adaptée.
Vous vous engagez à partager cette documentation, en la publiant sur notre wiki. Ce partage peut se faire sous une licence qui restreint l’exploitation commerciale de votre projet, mais qui en autorise par défaut la reproduction à titre personnel, et les modifications, comme par exemple une licence Creative Commons.

Documenter son projet c'est réaliser une page dédiée à votre réalisation dans la rubrique Les réalisations du FabLab, avec la description des différentes étapes du projet, les difficulté rencontrées etc.… Mais c'est aussi :

Documenter l'utilisation des machines dans la rubrique dédiée (procédure, astuces, réglages, …)
Documenter les logiciels utilisés (tutoriaux, astuces, plugins utiles, …)
Indiquer dans la rubrique Les ressources/Fournisseurs de matériaux où vous vous êtes procurés vos matériaux et les potentiels bons plans ou remarques que vous auriez à partager.
Ajouter des liens vers les ressources qui vous ont été utiles durant votre projet dans la rubrique Ressources
Rédiger de petits articles sur tel ou tel sujet que vous auriez appris ou approfondi lors votre réalisation, et qui pourraient être utiles pour d'autre projets (comme par exemple l'article sur les Engrenages cylindriques à denture droite)
…

Votre documentation permettra ainsi à d'autres usager·e·s de Fab Labs de refabriquer, d’améliorer ou d'adapter votre réalisation, mais aussi de partager les connaissances que vous aurez acquises lors de votre projet avec les autres utilisateur·trice·s.

N'hésitez pas non plus à corriger ou améliorer le contenu déjà présent dans ce wiki.

Documenter mon projet, mais comment ?

Pour commencer, créez une page pour votre projet dans la section projets. Vous pouvez utiliser le formulaire présent en haut de la rubrique pour créer votre page.

Lorsque vous créez une page dans la rubrique projets un squelette vous est proposé pour vous aider dans la rédaction. Les parties indiquées entre  sont des commentaires, non affichés sur la page, ils vous guideront dans la rédaction et vous pouvez les supprimer.

Voici une présentation des différentes parties que nous vous proposons d’intégrer dans votre documentation. Ces quelques lignes directrices sont bien sur indicatives, et vous pouvez adapter la structure de votre page en fonction de vos besoins. Les éléments proposés nous semblent être une bonne base pour documenter un projet. Vous pouvez commencer la documentation de votre projet même si celui-ci n'est pas encore terminé.

Contenu de ma page

Nom du projet

Indiquez le nom/titre de votre projet en haut de la page, en utilisant un titre de niveau 1 (H1), c'est à dire entouré de ======. Par exemple

===== Goodies Open Bidouille Camp =====

Lorsque vous créez votre page, le titre sera pré-rempli, mais vous pouvez le modifier s'il ne vous convient pas.

Fiche projet

Dans le squelette fourni lors de la création de votre page vous trouverez une fiche projet à compléter :

{{{project
picture:
machines: 
materiaux:
logiciels:
fichiers:
liens:
tags:
usager:
licence:
}}}

Cette fiche contient différents champs qui permettront d'afficher une petit encart de résumé en haut à droite de votre page projet, mais aussi de pouvoir facilement retrouver la réalisation à partir de son contenu. Elle contient différentes informations :

picture : Photo du rendu final de votre projet, vous pouvez l'ajouter en utilisant le bouton Ajout d'image. Exemple :
```
picture:{{:gallerie:boite_crayons_cutters_ciseaux:dsc_3481.jpg?200|}}
```
machines : Liste des machines utilisées lors de la réalisation, séparées par des espaces. Il faut ici, si possible, indiquer l'identifiant de la page de la machine utilisé dans la rubrique machines du wiki. Exemple :
```
machines: impression_3d:orca decoupe_laser vinyle:decoupeuse
```
materiaux : Liste des matériaux utilisés pour votre projet, séparés par des espaces. Ici encore, lorsque cela est possible, utilisez le nom de la page matériaux tel quelle existe dans la rubrique idoine Vous pouvez, bien sur, créer une page si vous utilisez un matériau non encore référencé. Exemple :
```
matériaux: medium pmma abs pla cahoutchouc
```
logiciels : Liste des logiciels utilisés lors de du projet. séparés par des espaces. Ici aussi, lorsque c'est possible, utilisez le nom de la page concernant ce logiciel dans la rubrique logiciels. Exemple :
```
logiciels: inkscape freecad slic3r
```
fichiers : Fichiers sources et fichiers de fabrication du projet(modèles 3d, fichiers svg, codes sources, …) , séparés par des espaces. Vous pouvez ici utiliser le bouton Ajouter des images ou d'autres fichiers pour faire un lien vers des fichiers hébergés sur le wiki, ou bien utiliser des urls vers de fichiers hébergés sur d'autres serveurs. Exemple :
```
fichiers: {{:projets:obc_goodies:mains_obc.svg|}} http://www.thingiverse.com/download:122201
```
liens : Liste de liens vers des ressources intéressantes ou vers d'autre projets qui vous ont inspirés. Vous pouvez utiliser tout type de lien supporté par la syntaxe dokuwiki (lien interne, lien externe ou interwiki). Exemple :
```
liens : [[projets:flocons_laser|]] [[wpfr>Flocon]] http://www.instructables.com/id/Paper-chain-snowflakes/
```
tags : Liste de mots clefs catégorisants votre réalisation, séparés par des espaces. Exemple :
```
tags: boite bois steampunk bijoux
```
usager : Login du ou des usager·e·s ayant participé·e·s à la réalisation, séparés par des espaces. Exemple :
```
usager:bully isa
```
licence : Licence(s) sous laquelle vous souhaitez partager votre projet. Par exemple cc-by-sa, cc-by, cc-by-nc, … pour une Licence Creative common, ou bien encore agpl, gpl, art-libre, etc.… (Pour vous aider dans le choix de votre licence vous pouvez consulter le rubrique Licences libres et de libre diffusion du wiki.)
```
 licence : cc-by
```

Introduction

Juste après la fiche projet, et avant le premier sous-titre, vous pouvez indiquer quelques mots/phrases d'introduction présentant le projet, expliquant d’où est venue l'idée etc.… C'est cette petite introduction qui sera visible dans la liste des projets.

Conception

Vous pouvez dans la rubrique conception détailler la phase de réflexion sur le projet. Comment vous avez conçu votre réalisation, quelles étaient les contraintes à prendre en compte etc.…

Réalisation

Dans la rubrique réalisation vous pouvez expliquer étape par étape comment vous avez concrétisé et fabriqué votre projet. N’hésitez pas à illustrer les différentes étapes par des schémas et/ou photos. Indiquez comment vous avez utilisé les machines et outils, quels réglages etc.…

Difficultés rencontrées

Rien de mieux que de se tromper pour apprendre de ses erreurs. Indiquez les difficultés et problèmes rencontrés durant la conception et le réalisations de votre projet, et comment vous avez résolu ces problèmes, ou ce que vous changeriez si vous aviez à le refaire.

Suites du projet

Vous envisagez une suite à votre projet, vous voyez des améliorations ou compléments qui pourraient y être apportés ? N’hésitez pas à les présenter, qui sait peut être qu'un·e autre utilisateur·trice du Fab Lab pourra s'en emparer ou vous aider.

Quelques remarques

Remarque sur la syntaxe dokuwiki : Essayez d'utiliser les niveau de titres (boutons H dans la barre d'outils) en commençant avec un titre de niveau 1 (H1) comme titre de page. Les fonctions gras, italique, souligné sont à éviter pour les titres et sous-titres.

N'utilisez que des contenus dont la diffusion est autorisée (généralement sous licence libre).

N'oubliez pas d'indiquer vos sources (en note de bas de page, ou bien dans la rubrique liens de la fiche projets, par exemple).

Si aucune fiche de wiki ne correspond au logiciel ou à la machine que vous avez utilisé, c'est l'occasion d'en créer une. Vous pouvez aussi renvoyer vers un autre site.

Pour connaître la syntaxe particulière de DokuWiki (le logiciel utilisé pour ce site), consultez la syntaxe de mise en page.

Pour télécharger un fichier, utilisez le gestionnaire de médias (ouvrez-le dans un nouvel onglet). N’hésitez pas à créer des namespace pour ranger vos images et fichiers plutôt que de les laisser à la racine du wiki ou de la rubrique projets. Pour créer un namespace il convient de préfixer le nom du fichier avec le chemin que l'on souhaite créé après avoir sélectionné ses fichiers. Le nom du fichier s'affiche dans un champ. Il suffit alors de saisir le chemin souhaité, par exemple mon-espace:mon_projet:image.jpg. En cliquant sur “Télécharger”, les images s'enregistreront dans le namespace souhaité. (⇒ Plus de détails dans la rubrique upload_fichiers)

Fiche machine

2013-10-04T18:07:16+02:00

Fiche machine

Voici quelques ligne directrices pour créer au mieux une fiche machine.

Photo
Références exactes
Utilisations possibles
Fonctionnement
Entretien
Logiciels (liens vers les fiches du wiki correspondantes)
Documentation éventuelle

Aide

2013-10-05T17:28:43+02:00

Aide

Créer, déplacer, supprimer une page

Comment je documente ? Et Pourquoi ?

Fiche machine

Syntaxe de mise en page

2014-01-23T17:48:58+02:00

Syntaxe de mise en page

DokuWiki 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.

Essayez d'utiliser les niveau de titres(boutons H dans la bare d'outils) en commençant avec un titre de niveau 1 (H1) comme titre de page. Les fonctions gras, italique, souligné sont à éviter pour les titres et sous-titres.

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 « automatiquement » : 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 : andi@splitbrain.org sont également reconnues.

Les liens externes sont reconnus « automatiquement » : 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 : <andi@splitbrain.org> sont également reconnues.

Internes

Les liens internes sont créés en utilisant les crochets. Vous pouvez soit juste donner un nom de page soit utiliser un texte pour le titre. Les noms de pages (pagenames) wiki 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 un [[nom de page]] soit utiliser un
[[nom de page|texte pour le titre]]. Les noms de pages (//pagenames//) wiki
sont convertis automatiquement en minuscules ; les caractères spéciaux ne
sont pas autorisés.

Vous pouvez utiliser des catégories (namespaces) en utilisant les deux points (:) dans le nom de page pagename.

Vous pouvez utiliser des [[catégories]] (//namespaces//) en utilisant les //deux points// ('':'') dans le nom de page //pagename//.

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

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 [[syntaxe_de_mise_en_page&#internes|cette section]].

Notes :

Les liens vers des pages existantes sont montrés dans un style différent des liens vers des pages inexistantes.
DokuWiki n'utilise pas la syntaxe CamelCase pour utiliser des liens par défaut, mais ce comportement peut être activé dans le fichier de configuration. Astuce : si le mot DokuWiki apparaît sur cette page comme un lien, alors c'est que la syntaxe CamelCase est activée.
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]].

Partages Windows

Les partages Windows tels que ceci sont également reconnus. Veuillez noter qu'ils n'ont un sens que dans un groupe d'utilisateurs homogène tels qu'un Intranet d'entreprise.

Les partages Windows tels que [[\\serveur\partage|ceci]] sont également reconnus.

Notes :

Pour des raisons de sécurité, la navigation directe sur partages Windows ne fonctionne que dans Microsoft Internet Explorer par défaut (et seulement dans la « zone locale »).
Pour Mozilla et Firefox, elle peut être mise en place dans l'option de configuration security.checkloaduri mais ceci n'est pas conseillé.
- Je viens de tester en passant la valeur à “false”, mais cela ne change rien !? (même après redémarrage de FF 2.0.0.6 sous Windows)
- Tiré de l'URL ci-dessus : “This preference only works in Gecko versions before 1.8 (so Firefox 1.0 and Mozilla Suite builds). In Firefox 1.5 and Seamonkey 1.0 this preference no longer has an effect.” (Cette préférence n'est plus disponible dans les versions de Firefox supérieures à 1.5)
Veuillez consulter 151 pour plus d'informations.

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|{{wiki: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 ¹⁾ 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.

Titre niveau 3

Titre niveau 4

Titre niveau 5

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

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

----

Images et autres fichiers

Vous pouvez inclure des images externes et internes avec des accolades. Vous pouvez spécifier leur taille (facultatif).

Taille réelle :

Redimensionnement à une largeur donnée :

Redimensionnement à une largeur et une hauteur données²⁾ :

Image externe redimensionnée :

Taille réelle :                                          {{wiki:dokuwiki-128.png}}
Redimensionnement à une largeur donnée :                 {{wiki:dokuwiki-128.png?50}}
Redimensionnement à une largeur et une hauteur données : {{wiki: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.

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

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

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

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

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

Si vous spécifiez un nom de fichier (externe ou interne) qui n'est pas une image (gif, jpeg, png), alors il sera affiché comme un lien et non comme une image.

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

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

La même liste mais ordonnée
Un autre élément
1. Utilisez simplement l'indentation pour des niveaux plus profonds
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 la 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. Plus d'émoticônes (smileys) peuvent être placées dans le répertoire smiley et configurées dans le fichier conf/smileys.conf. Voici une vue d'ensemble des émoticônes incluses dans DokuWiki.

8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P
:-O
:-X
:-|
;-)
^_^
:?:
:!:
LOL
FIXME
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.

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

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

Il est possible de faire la même chose pour n'importe quelle balise HTML. Il suffit pour cela de rajouter une ligne dans le fichier de motifs.

Il existe trois exceptions à ce mécanisme. le symbole de multiplication (640×480), les 'apostrophes' et les “guillemets”. On peut toutefois désactiver ces trois substitutions par une option de configuration.

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 fusionner des cellules verticalement en ajoutant ::: dans les cellules sous celles avec laquelle elles doivent fusionner. Cette fonctionnalité n'est disponible que pour les versions supérieures à 2009-02-14b

Titre 1	Titre 2	Titre 3
Ligne 1 Col 1	Cette cellule s'étend verticalement	Ligne 1 Col 3
Ligne 2 Col 1		Ligne 2 Col 3
Ligne 3 Col 1		Ligne 3 Col 3

Ces cellules ne doivent rien contenir d'autre que l'indicateur de fusion vertical.

^ Titre 1       ^ Titre 2                                  ^ Titre 3       ^
| Ligne 1 Col 1 |  Cette cellule s'étend\\ verticalement   | Ligne 1 Col 3 |
| Ligne 2 Col 1 | :::                                      | Ligne 2 Col 3 |
| Ligne 3 Col 1 | :::                                      | Ligne 3 Col 3 |

Vous pouvez également aligner les contenus du tableau (uniquement horizontalement). 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

Ceci est pratiquement la même chose, mais vous pouvez l'utiliser pour montrer que vous avez cité un fichier.

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 %%.

<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>

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 implémente 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 identificateurs de langage suivants sont actuellement reconnus : 4cs, abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, ecmascript, eiffel, email, erlang, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lisp, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, plsql, postgresql, povray, powerbuilder, powershell, progress, prolog, properties, providex, purebasic, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, z80

Bloc de code téléchargeables

Quand vous utilisez les balises <code> ou <file>, vous pouvez rendre disponible en téléchargement le code affiché. Il faut alors préciser un nom de fichier juste après le code du langage.

monexemple.php

<?php echo "hello world!"; ?>

<file php monexemple.php>
<?php echo "hello world!"; ?>
</file>

Si vous ne voulez pas de coloration syntaxique, il suffit de fournir un tiret (-) en guise de code de langage :
<code - monfichier.toto>.

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 période 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é si la page a un contenu dynamique externe. Ce paramètre informe DokuWiki qu'il doit reconstruire la page s'il s'est écoulé plus de temps que la période de rafraîchissement depuis la dernière reconstruction.

Exemple :

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

Shuttered Startups Are Selling Old Slack Chats, Emails To AI Companies par BeauHD (2026/04/18 13:00)
NASA Restarts Work To Support Europe's Uncrewed Trip To Mars After Years of Setbacks par BeauHD (2026/04/18 09:00)
Critical Atlantic Current Significantly More Likely To Collapse Than Thought par BeauHD (2026/04/18 05:30)
Online Personalities and Comedians Overtake TV and Newspapers as Primary News Sources par BeauHD (2026/04/18 01:00)
NIST Limits CVE Enrichment After 263% Surge In Vulnerability Submissions par BeauHD (2026/04/18 00:00)

Inclure du code HTML ou PHP

Vous pouvez inclure du code HTML ou PHP pur dans vos documents en utilisant les balises html ou php comme ceci :

<html>
Ceci est du <font color="red" size="+1">HTML</font>
</html>

Ceci est du <font color="red" size="+1">HTML</font>

<php>
echo 'Un logo produit par PHP :';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="Logo PHP !" />';
</php>

echo 'Un logo produit par PHP :'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="Logo PHP !" />';

NB : L'inclusion de code HTML et PHP est désactivée dans la configuration par défaut. Dans ce cas, le code est affiché au lieu d'être exécuté.

Macros

Certains mots-clef 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.

Extensions de syntaxe

La syntaxe de DokuWiki peut être étendue par des extensions. La manière d'utiliser les extensions installées est détaillée dans leurs pages de description respectives. Les extensions de syntaxe suivantes sont disponibles dans cette installation particulière de DokuWiki :

Gallery Plugin 2012-11-25 par Andreas Gohr
Creates a gallery of images from a namespace or RSS/ATOM feed
tag plugin 2012-11-25 par Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
tag wiki pages
Pagelist Plugin 2010-01-07 par Michael Klier, Gina Haeussge
Lists pages in a nice formatted way
Wrap Plugin 2011-05-15 par Anika Henke
Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.
iframe Plugin 2008-10-31 par Christopher Smith
Add an iframe containing the specified url
syntax: {{url>http://www.somesite.com/somepage.htm [w,h]|alternate text}}
externallink 2007-02-26 par Otto Vainio
Inserts a link to a page outside your wiki, but on your server with a style of wikilink. Format is [[@/pagename|optional title]]
include plugin 2012-11-24 par Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
Functions to include another page in a wiki page
Info Plugin 2008-09-12 par Andreas Gohr
Displays information about various DokuWiki internals
fablab plugin 2013-01-31 par Bumblebee
Plugin used to describe en document Fablab project.
OpenAs Plugin 2011-05-29 par Myron Turner
File utility for moving and saving-as, and creating new pages from templates
NsToC Syntax Plugin 2010-02-21 par Matthias Watermann
Add a namespace's table of contents {{nstoc [namespace [maxdepth]]}}
Video Sharing Site Plugin 2012-01-17 par Andreas Gohr
Easily embed videos from various Video Sharing sites. Example: {{youtube>XXXXXX}}
NSDir Plugin 2014-04-09 par Bumblebee
Shows pages in one or namespaces in an html list
Page Redirect 2012-08-16 par Elan Ruusamäe, David Lorentsen
Redirects page requests based on content
Dir Plugin 2008-06-28 par Jacobus Geluk
Shows pages in one or namespaces in a table or list
html5video plugin 2012-12-08 par Jason van Gumster (Fweeb)
Embeds video using HTML5 syntax
Meta plugin 2015-07-24 par Michael Hamann
Set Metadata for the current page. (previous authors: Esther Brunner, Gina Häußge, Michael Klier)
tagfilter 2013-11-27 par lisps
easy tag search
Blog 2013-02-07 par Michael Hamann, Michael Klier, Gina Haeussge
Use DokuWiki as blogging tool. (previous authors: Esther Brunner)
nspages plugin 2013-09-30 par Guillaume Turri
Presents a toc of the selected namespace using <nspages>
imagereference plugin 2014-06-18 par Gerrit Uitslag (previous: Martin Heinemann)
Creates references to images/tables in your text, like the LaTeX figure references.
autolink2 plugin 2011-10-11 par Otto Vainio
Generate automatic links for words defined by add plugin
Note Plugin 2009-06-15 par Olivier Cortès / Eric Hameleers / Christopher Smith / Aurélien Bompard
Add Note/Important/Tip/Warning Capability (DIV+CSS box)
HTML Comment Plugin 2013-03-19 par Christopher Arndt
allows HTML comments to be retained in the output

¹⁾ Ceci est une note de pied de page

²⁾ Si les proportions de l'image ne sont pas respectées, celle-ci sera «découpée» avant redimensionnement selon les nouvelles proportions