diff options
Diffstat (limited to 'ikiwiki/directive')
38 files changed, 1449 insertions, 0 deletions
diff --git a/ikiwiki/directive/aggregate.mdwn b/ikiwiki/directive/aggregate.mdwn new file mode 100644 index 0000000..fd48172 --- /dev/null +++ b/ikiwiki/directive/aggregate.mdwn @@ -0,0 +1,61 @@ +La directive `aggregate` est fournie par le module d'extension [[!iki +plugins/aggregate desc=aggregate]]. Ce greffon demande une configuration +particulière, à savoir une tâche `cron`. Consultez la documention du greffon +pour des précisions. + +Cette directive permet d'assembler les contenus d'autres flux dans le +wiki. Ainsi : + + \[[!aggregate name="example blog" dir="example" + feedurl="http://example.com/index.rss" + url="http://example.com/" updateinterval="15"]] + +Dans cet exemple, les messages du flux RSS indiqué sont assemblés dans le +répertoire example/ du wiki, une page par message. La fréquence de mise à +jour est de 15 minutes (mais moins fréquemment si la tâche cron est exécutée +moins fréquemment). + +Vous pouvez utiliser la directive [[inline]] d'ikiwiki pour créer un blog +avec un ou plusieurs flux assemblés. Par exemple : + + \[[!inline pages="internal(example/*)"]] + +Notez l'utilisation de la fonction `internal()` de [[ikiwiki/PageSpec]] pour +trouver les pages assemblées. Par défaut, les pages assemblées sont des +pages internes, ce qui empêche qu'elles apparaissent directement dans le +wiki. C'est pourquoi la fonction `internal()` est nécessaire dans la +spécification [[PageSpec]] pour les trouver. + +## Usage + +Voici la description de tous les paramètres acceptés par cette directive : + +* `name` - Le nom du flux. Chaque flux doit avoir un nom unique. Paramètre + obligatoire. +* `url` - L'URL de la page web contenant le flux assemblé. Paramètre + obligatoire. +* `dir` - Le répertoire du wiki où seront sauvegardées les pages. Paramètre + facultatif. S'il n'est pas indiqué, le répertoire est construit à partir + du nom du flux. +* `feedurl` - L'URL du flux. Paramètre facultatif. S'il n'est pas indiqué, + ikiwiki cherchera le flux avec le paramètre `url`. Les flux RSS et Atom + sont reconnus. +* `updateinterval` - Fréquence, en minutes, de la recherche des nouveaux + messages. Par défaut, 15 minutes. +* `expireage` - Éliminer les anciens messages du flux si leur ancienneté + est plus grande qu'un nombre de jours donné. Par défaut, aucune + élimination ne se fait sur l'ancienneté. +* `expirecount` - Éliminer les anciens messages du flux si leur nombre est + plus grand qu'un nombre donné. Les messages les plus anciens sont éliminés + en premier. Par défaut, aucune élimination ne se fait sur le nombre. +* `tag` - Représente une étiquette avec laquelle étiqueter chaque message + du flux. Le nom du flux est une bonne étiquette. Ce paramètre peut être + répété. Le greffon [[tag]] doit être activé. +* `template` - Modèle de page à utiliser pour la création des pages + assemblées. Par défaut, c'est "aggregatepost". + +Notez que même si vous utilisez subversion ou un autre système de +versionnement, les pages créées par assemblage *ne* seront *pas* prises en +compte par le système de contrôle de versions. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/brokenlinks.mdwn b/ikiwiki/directive/brokenlinks.mdwn new file mode 100644 index 0000000..91e05d6 --- /dev/null +++ b/ikiwiki/directive/brokenlinks.mdwn @@ -0,0 +1,15 @@ +La directive `brokenlinks` est fournie par le module d'extension [[!iki +plugins/brokenlinks desc=brokenlinks]]. + +Cette directive crée une liste des liens cassés sur les pages du wiki. On +peut ainsi facilement trouver les pages à écrire ou les liens mal trancrits. + +Le paramètre optionnel "pages" peut être une expression [[ikiwiki/PageSpec]] +indiquant dans quelles pages chercher les liens cassés. Par défaut la +recherche se fait dans toutes les pages. + +Exemple : + + \[[!brokenlinks pages="* and !recentchanges"]] + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/calendar.mdwn b/ikiwiki/directive/calendar.mdwn new file mode 100644 index 0000000..07e8d26 --- /dev/null +++ b/ikiwiki/directive/calendar.mdwn @@ -0,0 +1,63 @@ +La directive `calendar` est fournie par le module d'extension [[!iki +plugins/calendar desc=calendar]]. + +Cette directive affiche un calendrier, comparable aux calendriers affichés +par certains blogs. + +# Exemples : + + \[[!calendar ]] + + \[[!calendar type="month" pages="blog/* and !*/Discussion"]] + + \[[!calendar type="year" year="2005" pages="blog/* and !*/Discussion"]] + +## configuration + +L'agenda, habituellement trouvé dans les blogs, est essentiellement une +interface agréable pour l'archive de pages précédentes. Il peut afficher un +calendrier pour un mois donné ou une liste de mois pour une année donnée. Un +calendrier mensuel lie à chaque jour du mois les pages publiées ce jour. Un +calendrier annuel lie aux pages d'archive, avec des noms comme +`archives/2007` (pour tout 2007) et `archives/2007/01` (pour janvier 2007). + +Les directives calendar peuvent être insérées n'importe où dans le wiki, +même dans la barre latérale. Vous devez cependant créer les pages +d'archives. Celles-ci utilisent cette directive pour afficher un calendrier +et aussi la directive [[inline]] pour afficher ou lister les pages créées +dans l'espace de temps donné. + +La commande `ikiwiki-calendar` peut créer automatiquement les pages +d'archives. Elle actualise aussi le wiki, mettant à jour les calendriers +(date du jour en surbrillance). Cette commande est exécutée généralement à +minuit par le programme cron. + +Une crontab possible : + + 0 0 * * * ikiwiki-calendar ~/ikiwiki.setup "posts/* and !*/Discussion" + +## utilisation + +* `type` - Ce paramètre indique le type du calendrier. C'est soit « month » + soit « year », la valeur par défaut étant le calendrier mensuel. +* `pages` - Indique une spécification [[ikiwiki/PageSpec]] pour les pages + qui seront liées au calendrier. La valeur par défaut est « * ». +* `archivebase` - Indique la racine des répertoires d'archives, « archives » + par défaut. On peut changer cette valeur en renseignant `archivebase` dans + le fichier de configuration d'ikiwiki. Les calendriers se lient à des + pages placées là, nommées "2010/04" ou "2010" par exemple. Ces pages + peuvent être créées automatiquement par le programme `ikiwiki-calendar`. +* `year` - Indique l'année pour le calendrier annuel. La valeur par défaut + est l'année en cours. On peut aussi utiliser -1 pour se référer à l'année + dernière, ainsi de suite. +* `month` - Ce paramètre indique le chiffre du mois (1..12) pour le + calendrier. Il n'est utilisé que pour le calendrier mensuel, et la valeur + par défaut est le chiffre du mois en cours. On peut aussi utiliser -1 pour + se référer au mois dernier, ainsi de suite. +* `week_start_day` - Indique le chiffre (0..6) qui représente le jour par + lequel commence la semaine dans le calendrier. Dimanche, c'est 0, lundi, + 1, etc. La valeur par défaut est 0, dimanche. +* `months_per_row` - Ce paramètre indique, dans le calendrier annuel, le + nombre de mois par ligne. La valeur par défaut est 3. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/color.mdwn b/ikiwiki/directive/color.mdwn new file mode 100644 index 0000000..f07e21f --- /dev/null +++ b/ikiwiki/directive/color.mdwn @@ -0,0 +1,27 @@ +La directive `color` est fournie par le module d'extension [[!iki +plugins/color desc=color]]. + +Cette directive permet de mettre en couleur une partie d'un texte sur la +page. On peut ainsi définir la couleur du texte lui-même ou la couleur du +fond sur lequel le texte s'affiche. + +Vous pouvez utiliser le nom de la couleur (par exemple "white") ou bien le +code HTML (`#ffffff`). + +## Exemples : + +Voici comment définir la couleur du texte par un nom et la couleur du fond +par un code HTLM : + + \[[!color foreground=white background=#ff0000 text="White text on red background"]] + +Si la couleur de fond est absente, le texte est affiché sur la couleur de +fond par défaut : + + \[[!color foreground=white text="White text on default color background"]] + +Si la couleur du texte est absente, le texte possède la couleur par défaut : + + \[[!color background=#ff0000 text="Default color text on red background"]] + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/comment.mdwn b/ikiwiki/directive/comment.mdwn new file mode 100644 index 0000000..9e527b5 --- /dev/null +++ b/ikiwiki/directive/comment.mdwn @@ -0,0 +1,39 @@ +La directive `comment` est fournie par le module d'extension [[!iki +plugins/comments desc=comments]]. Elle permet l'ajout d'un commentaire sur +une page. En général, la page ne comporte que la directive et c'est le +greffon lui-même qui remplit la directive quand un utilisateur poste un +commentaire. + +Exemple : + + \[[!comment format=mdwn + username="foo" + subject="Bar" + date="2009-06-02T19:05:01Z" + content=""" + Blah blah. + """ + ]] + +## Usage + +Le seul paramètre obligatoire est `content`. les autres paramètres ajoutent +ou annulent des métadonnées. + +* `content` - Texte du commentaire à afficher. Les + [[directives|ikiwiki/directive]] sont autorisées, ou non, selon la + configuration du greffon « comment ». +* `format` - Indique le balisage utilisé par le commentaire. +* subject` - Sujet du commentaire. +* `date` - Indique la date du commentaire. Cette date peut utiliser presque + tous les formats, puisqu'elle est analysée par [[!cpan TimeDate]]. +* `username` - Sert pour l'enregistrement du nom (ou OpenID) d'un + commentateur présent. +* `nickname` - Name to display for a logged in commenter. (Optional; used + for OpenIDs.) +* `ip` - Permet d'enregistrer l'adresse IP d'un commentateur, s'il envoie + son commentaire de façon anonyme. +* `claimedauthor` - Enregistre le nom donné par l'utilisateur, si les + commentateurs anonymes ont la possibilité d'indiquer un nom (invérifié). + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/cutpaste.mdwn b/ikiwiki/directive/cutpaste.mdwn new file mode 100644 index 0000000..62ea32b --- /dev/null +++ b/ikiwiki/directive/cutpaste.mdwn @@ -0,0 +1,53 @@ +Les directives `copy`, `cut` and `paste` sont fournies par le module +d'extension [[!iki plugins/cutpaste desc=cutpaste]]. + +Ces directives permettent de sauvegarder et rappeler des parties de texte +d'une page. + + * `\[[!cut id=name text="text"]]` garde en mémoire le texte, qui peut être + rappelé grâce à l'id. Le texte coupé n'est pas inclus dans la sortie. + * `\[[!copy id=name text="text"]]` garde en mémoire le texte, qui peut être + rappelé grâce à l'id. Le texte coupé *est* inclus dans la sortie. + * `\[[!paste id=name]]` est remplacé par le texte précédemment mis en + mémoire. + +Le texte coupé, copié ou collé peut être inclus dans une balise wiki, avec +d'autres appels encore aux directives cut, copy et paste. + +Il n'est pas nécessaire de mettre en mémoire le texte avant de +l'utiliser. Une directive « cut » peut suivre une directive « paste » qui +utilise le texte. Pouvoir différer de gros morceaux de texte comme de +longues annotations et pouvoir suivre un cours plus naturel est très +pratique. Par exemple : + + \[[!toggleable id="cut" text="[[!paste id=cutlongdesc]]"]] + \[[!toggleable id="copy" text="[[!paste id=copylongdesc]]"]] + \[[!toggleable id="paste" text="[[!paste id=pastelongdesc]]"]] + + [...some time later...] + + \[[!cut id=cutlongdesc text=""" + blah blah blah + """]] + \[[!cut id=copylongdesc text=""" + blah blah blah + """]] + \[[!cut id=pastelongdesc text=""" + blah blah blah + """]] + +Des boucles peuvent résulter mais ikiwiki est intelligent et les rompt. + +Puisqu'il est possible de coller sans doubler les guillemets, ces directives +copy et paste peuvent servir à emboîter des directives qui demandent des +paramètres à plusieurs lignes insérés l'un dans l'autre : + + \[[!toggleable id=foo text=""" + [[!toggleable id=bar text="[[!paste id=baz]]"]] + """]] + + \[[!cut id=baz text=""" + multiline parameter! + """]] + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/edittemplate.mdwn b/ikiwiki/directive/edittemplate.mdwn new file mode 100644 index 0000000..a4f90c1 --- /dev/null +++ b/ikiwiki/directive/edittemplate.mdwn @@ -0,0 +1,39 @@ +La directive `edittemplate` est fournie par le greffon [[!iki +plugins/edittemplate desc=edittemplate]]. + +Cette directive permet l'enregistrement de modèles de pages, qui proposent +un contenu par défaut aux pages nouvellement créées avec l'interface +web. Pour enregistrer un modèle, il faut insérer une directive +[[ikiwiki/directive/template]] dans une quelconque autre page. + + \[[!edittemplate template="bugtemplate" match="bugs/*"]] + +Dans l'exemple ci-dessus, la page nommée « bugtemplate » est enregistrée +comme modèle de page à utiliser pour toute page nommée « bugs/* » qui sera +créée. Pour éviter que la directive n'affiche une note au sujet de +l'enregistrement du modèle, il suffit d'activer le paramètre « silent=yes ». + +Souvent la page modèle contient le simple squelette d'une page +particulière. Pour le modèle « rapport de bogue » dans l'exemple, ce +squelette pourrait se présenter ainsi : + + Paquet : + Version : + Reproductible : o/n + Détails : + +The template page can also contain [[!cpan HTML::Template]] directives, +like other ikiwiki [[templates]]. Currently only one variable is +set: `<TMPL_VAR name>` is replaced with the name of the page being +created. + +---- + +Ce n'est pas une bonne idée de mettre la directive `edittemplate` dans la +page modèle elle-même. En effet la directive serait alors incluse comme +partie du modèle sur les nouvelles pages, qui seraient à leur tour +enregistrées comme modèles. Si de nombreuses pages sont enregistrées comme +modèles pour une page, un modèle est choisi au hasard et tout devient +confus. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/format.mdwn b/ikiwiki/directive/format.mdwn new file mode 100644 index 0000000..da68ff0 --- /dev/null +++ b/ikiwiki/directive/format.mdwn @@ -0,0 +1,29 @@ +La directive `format` est fournie par le module d'extension [[!iki +plugins/format desc=format]]. + +Cette directive permet de formater un texte avec tout type de format +disponible. Elle possède deux paramètres. Le premier est le format à +utiliser, c'est-à-dire l'extension à donner à un fichier de ce type. Le +second est le texte à formater. + +Par exemple, pour insérer un fichier outline (.otl) dans une page qui +utilise mdwn ou un autre format : + + \[[!format otl """ + foo + 1 + 2 + bar + 3 + 4 + """]] + +Si le greffon highlight est activé, cette directive permet d'afficher un +code dont la syntaxe est mise en évidence. Beaucoup de langages sont +reconnus. Par exemple : + + \[[!format perl """ + print "hello, world\n"; + """]] + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/fortune.mdwn b/ikiwiki/directive/fortune.mdwn new file mode 100644 index 0000000..e52351c --- /dev/null +++ b/ikiwiki/directive/fortune.mdwn @@ -0,0 +1,8 @@ +La directive `fortune` est fournie par le module d'extension [[!iki +plugins/fortune desc=fortune]]. + +Une petite sentence est insérée sur la page grâce au programme `fortune` : + + \[[!fortune ]] + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/graph.mdwn b/ikiwiki/directive/graph.mdwn new file mode 100644 index 0000000..ee92c5f --- /dev/null +++ b/ikiwiki/directive/graph.mdwn @@ -0,0 +1,23 @@ +La directive `graph` est fournie par le module d'extension [[!iki +plugins/graphviz desc=graphviz]]. + +Cette directive permet d'embarquer des graphiques +[graphviz](http://www.graphviz.org/) sur une page. Par exemple : + + \[[!graph src="a -> b -> c; a -> c;"]] + +Vous ne pourrez prévisualiser les graphiques que si le navigateur gère les +[[!wikipedia data: URI]], ou si le même graphique existe déjà sur la page. + +Voici les paramètres de la directive `graph` : + +- `src` - La source graphviz à afficher. +- `type` - Le type de graphique : `graph` ou `digraph`. La valeur par + défaut est `digraph`. +- `prog` - Le programme graphviz à utiliser : `dot`, `neato`, `fdp`, + `twopi`, ou `circo`. La valeur par défaut est `dot`. +- `height`, `width` - Ces paramètres limitent la taille des graphiques, avec + une hauteur et une largeur exprimées en pouce. Vous devez les indiquer + tous les deux. Sinon le programme choisira une valeur sans limites. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/haiku.mdwn b/ikiwiki/directive/haiku.mdwn new file mode 100644 index 0000000..a8b7bd1 --- /dev/null +++ b/ikiwiki/directive/haiku.mdwn @@ -0,0 +1,16 @@ +la directive `haiku` est fournie par le module d'extension [[!iki +plugins/haiku desc=haiku]]. + +Cette directive permet l'insertion d'un haiku créé automatiquement sur une +page du wiki. Il suffit d'écrire : + + \[[!haiku hint="argument"]] + +[[!haiku hint="argument test"]] + +Le paramètre "hint" peut être omis. Il ne donne au générateur qu'une idée du +sujet du haiku. S'il est absent, le sujet est fondé sur le nom de la +page. Comme le vocabulaire du programme est assez pauvre, il est inutile de +donner beaucoups d'indications sur le thème du haiku. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/if.mdwn b/ikiwiki/directive/if.mdwn new file mode 100644 index 0000000..baa629f --- /dev/null +++ b/ikiwiki/directive/if.mdwn @@ -0,0 +1,48 @@ +La directive `if` est fournie par le module d'extension [[!iki +plugins/conditional desc=conditional]]. + +Cette directive permet de faire dépendre l'affichage de texte d'une +condition donnée. Par exemple : + + \[[!if test="enabled(smiley)" + then="Le greffon smiley est activé :-)" + else="Pas de greffon smiley ici..."]] + +Si le `test` réussit, le texte du paramètre `then` est affiché. Sinon, le +texte du paramètre `else` est affiché. La partie `else` du test est +facultative. + +Les valeurs de `then` et `else` peuvent inclure n'importe quelle balise qui +serait autorisée dans les pages du wiki. Tripler les guillemets autour de la +valeur permet même d'y inclure des guillemets. + +Le `test` est une spécification [[ikiwiki/PageSpec]]. Si une page correspond +à l'expression, le test réussit. Vous pouvez ainsi tester l'existence d'une +page ou de plusieurs, tester la date de création, etc. + +Si vous voulez confronter l'expression [[ikiwiki/PageSpec]] uniquement à la +page qui contient la condition plutôt qu'à toutes les pages du wiki, il faut +donner la valeur "no" au paramètre "all". + +Dans une directive `if`, la syntaxe normale d'une spécification +[[ikiwiki/PageSpec]] est étendue avec les tests suivants : + +* enabled(greffon) + + Ce test vérifie si le greffon indiqué est activé. + +* sourcepage(motif) + + Ce test confronte le motif donné au nom de la page qui contient la condition. + +* destpage(motif) + + Ce test confronte le motif donné au nom de la page qui est construite. + Ce nom peut être différent du nom de la page qui contient la condition, + si la page est reliée à une autre page. + +* included() + + Ce test vérifie si la page est incluse dans une autre page. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/img.mdwn b/ikiwiki/directive/img.mdwn new file mode 100644 index 0000000..7f53dd6 --- /dev/null +++ b/ikiwiki/directive/img.mdwn @@ -0,0 +1,42 @@ +La directive `img` est fournie par le module d'extension [[!iki plugins/img +desc=img]]. + +Cette directive est consacrée à la gestion des images. Ikiwiki permet de +relier des images en taille réelle en faisant un [[ikiwiki/WikiLink]] qui +pointe vers l'image. Avec cette directive vous pouvez facilement réduire la +taille de l'image pour permettre son inclusion dans une page, tout en créant +un lien vers l'image en taille réelle. + +## Usage + + \[[!img image1.jpg size="200x200" alt="clouds"]] + +L'image est recherchée selon les mêmes règles utilisées pour chercher un +fichier pointé par un [[ikiwiki/WikiLink]]. + +Le paramètre `size` est facultatif. Par défaut la taille est la taille +réelle. Le format d'image original est toujours respecté, même si cela +signifie qu'il faut rendre l'image plus petite que la taille indiquée. Vous +pouvez spécifier seulement la hauteur ou la largeur, et l'autre valeur sera +calculée selon le format d'image, "200x", "x200". + +You can also pass `alt`, `title`, `class`, `align`, `id`, `hspace`, and +`vspace` parameters. These are passed through unchanged to the html img +tag. If you include a `caption` parameter, the caption will be displayed +centered beneath the image. + +Le paramètre `link` contrôle la liaison entre l'image réduite et l'image à +taille réelle. Par défaut il les relie. Vous pouvez définir "link=somepage" +pour créer un lien vers une autre page, "link=no" pour désactiver le lien ou +encore "link=http://url" pour créer un lien vers une URL. + +Vous pouvez aussi définir des valeurs par défaut qui seront utilisées pour +toutes les images, sauf si ces valeurs sont annulées. C'est très utile quand +on insère beaucoup d'images sur une page. + + \[[!img defaults size=200x200 alt="wedding photo"]] + \[[!img photo1.jpg]] + \[[!img photo2.jpg]] + \[[!img photo3.jpg size=200x600]] + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/inline.mdwn b/ikiwiki/directive/inline.mdwn new file mode 100644 index 0000000..2af6236 --- /dev/null +++ b/ikiwiki/directive/inline.mdwn @@ -0,0 +1,133 @@ +La directive `inline` est fournie par le module d'extension [[!iki +plugins/inline desc=inline]]. + +Cette directive permet l'inclusion d'une page de wiki dans une +autre. L'utilisation la plus fréquente de cette directive est la création de +blog ou de flux Atom ou RSS. + +Exemple : + + \[[!inline pages="blog/* and !*/Discussion" show="10" rootpage="blog"]] + +Toute page correspondant à la spécification, [[PageSpec]], (dans l'exemple, +toute [[SubPage]] de "blog") fera partie du blog et les dix dernières pages +apparaîtront dans la page. Notez que les fichiers qui, sans être des pages, +correspondent à la spécification, seront inclus dans la diffusion par RSS, +ce qui est utile pour le « podcasting ». + +Le paramètre facultatif `rootpage` indique que les nouveaux messages de ce +blog seront des sous-pages [[SubPages|SubPage]] de "blog". Il active aussi +un formulaire en haut de la page du blog qui permet l'écriture de nouveaux +messages. + +Si vous voulez que le blog possède une page d'archive, listant tous les +messages déjà envoyés, voici ce qu'il faut faire : + + \[[!inline pages="blog/* and !*/Discussion" archive="yes"]] + +Vous pouvez même créer une liste de toutes les pages du wiki, les plus +récentes en tête, comme cela : + + \[[!inline pages="* and !*/Discussion" archive="yes"]] + +Vous pouvez aussi ajouter des pages à un blog donné en les étiquetant. Pour +étiqueter une page, il suffit de la lier à une ou plusieurs pages qui +représentent cette étiquette. Puis, il faut utiliser une spécification +[[PageSpec]] avec la fonction spéciale `link()` pour trouver toutes les +pages correspondant à cette étiquette. + + \[[!inline pages="link(rugby)"]] + +Vous pouvez aussi inclure certaines étiquettes et en exclure d'autres : + + \[[!inline pages="link(debian) and !link(social)"]] + +## Usage + +Il est possible d'utiliser beaucoup de paramètres avec la directive +`inline`. Voici les plus communs : + +* `pages` - Une spécification [[PageSpec]] des pages à relier. +* `show` - Indique le nombre maximun de pages correspondantes à relier. Par + défaut, ce nombre vaut 10 sauf pour l'archivage où toutes les pages sont + reliées. La valeur 0 permet d'afficher toutes les pages correspondantes. +* `archive` - Quand ce paramètre vaut "yes", on ne liste que le titre des + pages et certaines métadonnées, pas tout le contenu des pages. +* `description` - donne le nom du flux RSS créé. Par défaut, c'est le nom du + wiki. +* `skip` - Indique un nombre de pages à ne pas afficher. C'est utile pour + produire un flux qui ne montre que les pages archivées. +* `postform` - Quand ce paramètre vaut "yes", le formulaire qui permet de + créer de nouvelles pages sur un blog est activé. +* `postformtext` - Spécifie le texte affiché par le formulaire. +* `rootpage` - Active le formulaire et indique l'endroit où les nouveaux + messages seront placés, en donnant la page dont ils seront des sous-pages. + +Voici quelques paramètres moins nécessaires : + +* `actions` - Quand ce paramètre vaut "yes", des liens permettant la + modification et la discussion sont ajoutés au bas des pages reliées plutôt + qu'en haut. +* `rss` - Contrôler la création d'un flux RSS. Si le wiki est configuré par + défaut pour créer des flux rss, le mettre à "no" désactive la création de + flux. Si le wiki est configuré avec l'option `allowrss`, le mettre à + "yes" active la création de flux rss. +* `atom` - Contrôler la création d'un flux Atom. Si le wiki est configuré + par défaut pour créer des flux Atom, le mettre à "no" désactive la + création de flux. Si le wiki est configuré avec l'option `allowatom`, le + mettre à "yes" active la création de flux Atom. +* `feeds` - Contrôler la création de tout type de flux. Le mettre à "no" + pour désactiver la création de flux. +* `emptyfeeds` - Mettre ce paramètre à "no" pour désactiver toute création + de flux vides. N'a aucun effet si le paramètre `rootpage` ou le paramètre + `postform` est activé. +* `template` - Ce paramètre indique le modèle de page à utiliser pour chaque + page reliée. Par défaut le modèle utilisé est `inlinepage`. Pour les + archives, le modèle utilisé est `archivepage`. Il est possible d'utiliser + d'autres modèles comme `titlepage` qui n'affiche que le titre des + messages, ou `microblog`, optimisé pour le « microblogging », et même de + créer vos propres modèles. Notez que vous devez quand même activer le + paramètre archive, `archive=yes`, si votre modèle n'inclut pas le contenu + de la page. +* `raw` - Si ce paramètre vaut "yes", la page sera incluse sous sa forme + « brute », sans balisage supplémentaire, comme si elle faisait partie de + la source de la page dans laquelle elle est incluse. Le comportement par + défaut de ce paramètre est de créer un blog. +* `sort` - permet d'indiquer comment les pages liées sont triées + [[sorted|pagespec/sorting]]. Par défaut, les pages les plus récentes sont + triées en premier. +* `reverse` - Si ce paramètre vaut "yes", l'ordre de classement est + renversé. +* `feedshow` - Indique le nombre maximun de pages à inclure dans le flux + RSS/Atom. La valeur par défaut est la même que celle du paramètre `show`. +* `feedonly` - Ne créer que le flux, ne pas afficher les pages reliées sur + la page. +* `quick` - Construire l'archive en mode rapide, sans chercher les + métadonnées dans le contenu des pages. Cela désactive la création de flux. +* `timeformat` - Ce paramètre permet d'indiquer la manière d'afficher + l'heure ou la date dans les pages de blog. Le format est passé à la + fonction strftime(3). +* `feedpages` - Une spécification [[PageSpec]] des pages à inclure dans le + flux rss/atom. Par défaut, cette valeur est la même que celle du paramètre + `pages` et seules les pages correspondantes sont incluses, mais une + spécification plus précise peut en exclure certaines. +* `guid` - Si une URI est donnée (peut-être un UUID préfixé, `urn:uuid:`), + le flux Atom aura cet identifiant, son `<id>`. Par défaut, l'URL de la + page contenant la directive `inline` est utilisée. +* `feedfile` - On peut utiliser ce paramètre pour changer le nom du fichier + créé pour le flux. C'est très utile dans le cas d'une page qui contient + plusieurs flux. Par exemple, indiquez "feedfile=feed" pour créer un + fichier `page/feed.atom` ou `page/feed.rss`. Si le wiki est configuré pour + ne pas utiliser `usedirs`, ce paramètre ne fonctionne pas. +* `pagenames` - Si ce paramètre est utilisé à la place de `pages`, il est + interprété comme une liste de liens, séparés par des espaces, avec les + mêmes règles [[SubPage/LinkingRules]] que dans un + [[ikiwiki/WikiLink]]. Ces liens sont reliés dans l'ordre dans lequel ils + sont listés : les paramètres `sort` et `pages` ne peuvent pas être + utilisés en même temps. + +[[!meta robots="noindex, follow"]] + +Une directive apparentée à cette directive est +[[ikiwiki/directive/edittemplate]], qui permet d'indiquer un texte par +défaut pour la nouvelle page. diff --git a/ikiwiki/directive/linkmap.mdwn b/ikiwiki/directive/linkmap.mdwn new file mode 100644 index 0000000..cc5e369 --- /dev/null +++ b/ikiwiki/directive/linkmap.mdwn @@ -0,0 +1,31 @@ +"La directive `linkmap` est fournie par le module d'extension [[!iki +plugins/linkmap desc=linkmap]]. + +Cette directive utilise le programme [graphviz](http://www.graphviz.org/) +pour créer un graphique montrant les liens existants entre certaines pages +du wiki. Par exemple : + + \[[!linkmap pages="* and !blog/* and !*/Discussion"]] + +Seuls les liens entre les pages recherchées sont montrés. Des liens +existants entre des pages non recherchées sont ignorés. Si les pages à +rechercher ne sont pas spécifiées, les liens entre toutes les pages (et tous +les fichiers) du wiki seront affichés. + +Voici la description des paramètres de la directive `linkmap` : + +* `pages` - Une spécification [[ikiwiki/PageSpec]] des pages à rechercher. +* `height`, `width` - Ces paramètres limitent la taille du diagramme, avec + une hauteur et une largeur exprimées en pouce. Vous devez les indiquer + tous les deux. Sinon le programme choisira une valeur sans limites. +* `connected` - permet d'indiquer si l'on inclut les pages sans lien à + d'autres pages (connected=no, par défaut), ou si l'on ne montre que les + pages liées à d'autres pages (connected=yes). + +Pour des résultats corrects, il vaut mieux définir l'ensemble des pages à +rechercher. Sinon, le diagramme deviendra très grand, illisible et +compliqué. Si l'on inclut trop de pages, le diagramme deviendra si grand que +graphviz ne pourra pas l'afficher. Le paramètre `connected` permet de se +débarrasser des pages qui encombrent le diagramme. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/listdirectives.mdwn b/ikiwiki/directive/listdirectives.mdwn new file mode 100644 index 0000000..fee0118 --- /dev/null +++ b/ikiwiki/directive/listdirectives.mdwn @@ -0,0 +1,21 @@ +La directive `listdirectives` est fournie par le module d'extension [[!iki +plugins/listdirectives desc=listdirectives]]. + +Cette directive crée une liste des [[directives|ikiwiki/directive]] +disponibles. + + \[[!listdirectives]] + +Il n'y a qu'un seul paramètre facultatif, `generated`. Toutes les directives +internes et les directives déclarées par les greffons seront listées. Avec +ce paramètre, `listdirectives` listera aussi les directives qui viendront à +être créées. Par exemple, tous les raccourcis [[shortcuts]] sont des +directives créées par la directive `shortcut`. Ils seront listés si le +paramètre `generated` est fourni. + + \[[!listdirectives generated]] + +Cette liste est souvent très longue. Elle contient aussi beaucoup de +directives non documentées. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/map.mdwn b/ikiwiki/directive/map.mdwn new file mode 100644 index 0000000..f8ef0e6 --- /dev/null +++ b/ikiwiki/directive/map.mdwn @@ -0,0 +1,25 @@ +La directive `map` est fournie par le module d'extension [[!iki plugins/map +desc=map]]. + +Cette directive crée une représentation hiérarchisée des pages du +wiki. Voici un exemple d'utilisation : + + \[[!map pages="* and !blog/* and !*/Discussion"]] + +Si les pages à inclure ne sont pas spécifiées, toutes les pages (et tous les +fichiers) sont pris en compte. + +Par défaut, les noms des pages sont utilisés dans la représentation. Le +paramètre `show` permet d'utiliser à la place le titre des pages ou leur +description lorsqu'ils ont été définis avec la directive [[meta]]. Par +exemple : + + \[[!map pages="* and !blog/* and !*/Discussion" show=title]] + + \[[!map pages="* and !blog/* and !*/Discussion" show=description]] + +Pour n'afficher les pages que jusqu'à un certain niveau de profondeur, vous +pouvez utiliser une spécification [[ikiwiki/PageSpec]] comme celle-ci : +`pages=\"* and !*/*/*\"`. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/meta.mdwn b/ikiwiki/directive/meta.mdwn new file mode 100644 index 0000000..32997d8 --- /dev/null +++ b/ikiwiki/directive/meta.mdwn @@ -0,0 +1,171 @@ +La directive `meta` est fournie par le module d'extension [[!iki +plugins/meta desc=meta]]. + +Cette directive permet l'insertion de métadonnées quelconques dans la source +d'une page. Voici comment procéder : + + \[[!meta field="valeur"]] + \[[!meta field="valeur" param="valeur" param="valeur"]] + +La première expression donne une valeur à un champ, tandis que la seconde +définit également des sous-paramètres. + +La valeur d'un champ est traitée comme du texte codé en HTML. Vous pouvez +inclure un guillemet en écrivant `"` par exemple. + +Champs reconnus : + +* title + + La valeur de ce champ remplace le titre d'une page, qui est en général + le nom de la page. + + Si le titre est remplacé, une variable « title_overridden » est définie avec une valeur *true* + dans le modèle de page. On peut se servir de cette variable pour formater le texte différemment. + + An optional `sortas` parameter will be used preferentially when + [[ikiwiki/pagespec/sorting]] by `meta(title)`: + + \[[!meta title="The Beatles" sortas="Beatles, The"]] + + \[[!meta title="David Bowie" sortas="Bowie, David"]] + +* license + + Indique la license de la page, par exemple « GPL ». Peut contenir des WikiLinks + et des balises quelconques. + +* copyright + + Indique le copyright de la page, par exemple « Copyright 2007 by Joey Hess ». + Peut contenir des WikiLinks et des balises quelconques. + +* author + + L'auteur de la page. + + An optional `sortas` parameter will be used preferentially when + [[ikiwiki/pagespec/sorting]] by `meta(author)`: + + \[[!meta author="Joey Hess" sortas="Hess, Joey"]] + +* authorurl + + Indique une URL pour l'auteur de la page. + +* description + + Donne une courte description de la page qui sera placée dans l'en-tête html + et qui peut être affichée par la directive [[map]]. + +* permalink + + Indique un lien permanent vers la page, si différent de la page créée par ikiwiki. + +* date + + Indique la date de création de la page. Tous les formats de date sont reconnus, puisque la valeur + de ce champ est analysée par [[!cpan TimeDate]]. + +* stylesheet + + Ajoute une feuille de style à la page. La feuille de style est traitée + comme un lien wiki vers un fichier `.css` dans le wiki. On ne peut donc pas + ajouter de liens vers des feuilles de style externes. Par exemple : + + \[[!meta stylesheet=somestyle rel="alternate stylesheet" + title="somestyle"]] + +* openid + + Ajoute des balises HTML <link> pour réaliser une délégation OpenID + à un serveur OpenID externe. Cela permet d'utiliser une page de wiki comme + votre identifiant OpenID. + + Par défaut la délégation se fera pour `openid` et `openid2`. Pour n'en choisir qu'un, + ajoutez par exemple ce paramètre : `delegate=openid`. + + Un paramètre facultatif `xrds-location` permet d'indiquer l'adresse de tout + [eXtensible Resource DescriptorS](http://www.windley.com/archives/2007/05/using_xrds.shtml). + + Exemple : + + \[[!meta openid="http://joeyh.myopenid.com/" + server="http://www.myopenid.com/server" + xrds-location="http://www.myopenid.com/xrds?username=joeyh.myopenid.com""]] + +* link + + Indique un lien vers une autre page. C'est une façon de lier deux pages + sans afficher un [[ikiwiki/WikiLink]] qui serait visible par l'utilisateur : + + \[[!meta link=otherpage]] + + On peut aussi s'en servir pour insérer une balise HTML <link>. Par exemple : + + \[[!meta link="http://joeyh.myopenid.com/" rel="openid.delegate"]] + + Cependant cette expression ne sera pas permise si le greffon + [[!iki plugins/htmlscrubber desc=htmlscrubber]] est activé, + car il permet d'insérer des contenus non sécurisés. + +* redir + + Rend possible la redirection d'une page vers une autre dans le wiki. + + \[[!meta redir=otherpage]] + + Un délai (en seconde) peut être indiqué. Par défaut, il n'y a pas de délai. + + Une redirection vers une URL externe est aussi possible. Par exemple : + + \[[!meta redir="http://example.com/"]] + + Cependant cette expression ne sera pas permise si le greffon + [[!iki plugins/htmlscrubber desc=htmlscrubber]] est activé, + car il permet d'insérer des contenus non sécurisés. + + Dans les deux cas, on peut indiquer une ancre à l'intérieur de la page visée, + avec la syntaxe habituelle `#ANCHOR`. + +* robots + + Permet l'écriture de l'étiquette robots : + + \[[!meta robots="index, nofollow"]] + + L'attribut peut prendre les valeurs suivantes : "index", "noindex", "follow" + et "nofollow". On peut indiquer plusieurs valeurs, séparées par une virgule. + Seules quelques combinaisons cependant ont du sens. Si l'étiquette robots + n'existe pas, "index, follow" est utilisée par défaut. + + La valeur est protégée mais son contenu n'est pas vérifié. + +* guid + + Indique l'identificateur unique (*GUID*) d'une page. Cet identificateur + doit être un URI, en particulier, il peut être de la forme `urn:uuid:` suivi + d'un UUID, comme indiqué dans le [[!rfc 4122]]). Il permet l'identification d'une + page pour un flux RSS ou Atom. S'il n'est pas donné, l'URL de la page + est utilisée comme GUID. + + Sa principale utilisation est de garder inchangés les identificateurs des pages + qui ont été déplacées, évitant ainsi l'engorgement des agrégateurs. + Consultez [[!iki tips/howto_avoid_flooding_aggregators]]). + +* updated + + Indique une date de modification fausse pour une page qui doit être affichée + dans les flux RSS ou Atom. Cela permet d'éviter l'engorgement des agrégateurs + qui classent les pages par date de modification, comme Planet par exemple. + Pour ajouter des étiquettes à un ancien message, vous pouvez mettre une valeur + supérieure d'une seconde à l'ancienne valeur. Tous les formats de date reconnus par + [[!cpan TimeDate]] sont acceptés, tout comme pour le paramètre `date`. + +Si le paramètre n'est pas l'un de ceux définis précédemment, les métadonnées +seront écrites sur la page HTML créée sous forme d'en-tête +<meta>. Cependant cette expression ne sera pas permise si le greffon +[[!iki plugins/htmlscrubber desc=htmlscrubber]] est activé, car il permet +d'insérer des contenus non sécurisés. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/more.mdwn b/ikiwiki/directive/more.mdwn new file mode 100644 index 0000000..2f61266 --- /dev/null +++ b/ikiwiki/directive/more.mdwn @@ -0,0 +1,18 @@ +La directive `more` est fournie par le module d'extension [[!iki +plugins/more desc=more]]. + +Cette directive permet d'insérer un lien "more" sur le message d'un blog. Ce +lien pointe vers la version complète de la page. Voici comment l'utiliser : + + \[[!more linktext="click for more" text=""" + Voici la suite du message. Ce n'est pas à l'intention des gens rattrapant + leur retard dans la lecture de leurs blogs à 10000 mètres d'altitude. Parce que + j'aime rendre les choses difficiles. + """]] + +Si le paramètre `linktext` est omis, la valeur par défaut du lien est +"more". + +Vous pouvez obtenir quelque chose de semblable avec [[toggle]]. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/orphans.mdwn b/ikiwiki/directive/orphans.mdwn new file mode 100644 index 0000000..90f653d --- /dev/null +++ b/ikiwiki/directive/orphans.mdwn @@ -0,0 +1,17 @@ +La directive `orphans` est fournie par le module d'extension [[!iki +plugins/orphans desc=orphans]]. + +Cette directive crée une liste des pages probablement orphelines, +c'est-à-dire des pages qui ne sont liées à aucune autre page. Exemple : + + \[[!orphans pages="* and !blog/*"]] + +Le paramètre facultatif "pages" peut être une spécification +[[ikiwiki/PageSpec]] indiquant un ensemble de pages à vérifier. Par défaut +la recherche se fait dans toutes les pages. + +Notez que les rétroliens sont pris en compte. Mais relier une page à une +autre n'est pas considéré comme un lien et les pages d'un blog seront +comptées parmi les pages orphelines. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/pagecount.mdwn b/ikiwiki/directive/pagecount.mdwn new file mode 100644 index 0000000..be299b9 --- /dev/null +++ b/ikiwiki/directive/pagecount.mdwn @@ -0,0 +1,12 @@ +La directive `pagecount` est fournie par le module d'extension [[!iki +plugins/pagecount desc=pagecount]]. + +Cette directive compte les pages du wiki. Exemple : + + \[[!pagecount pages="*"]] + +Le paramètre facultatif "pages" peut être une spécification +[[ikiwiki/PageSpec]] indiquant un ensemble de pages à compter. Par défaut +toutes les pages du wiki sont comptées. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/pagestats.mdwn b/ikiwiki/directive/pagestats.mdwn new file mode 100644 index 0000000..c1d78f9 --- /dev/null +++ b/ikiwiki/directive/pagestats.mdwn @@ -0,0 +1,42 @@ +La directive `pagestats` est fournie par le module d'extension [[!iki +plugins/pagestats desc=pagestats]]. + +Cette directive permet de créer des statistiques sur les pages et la façon +dont elles sont liées. Elle affiche soit un nuage d'étiquettes, soit un +tableau montrant le nombre de liens de chaque page. + +Here's how to use it to create a [[tag]] cloud, with tags sized based on +frequency of use: + + \[[!pagestats pages="tags/*"]] + +Voici comment afficher une liste d'étiquettes, avec la taille des étiquettes +proportionnelle à la fréquence d'utilisation, comme pour un nuage : + + \[[!pagestats style="list" pages="tags/*"]] + +Et voici comment créer un tableau de toutes les pages du wiki : + + \[[!pagestats style="table"]] + +Le paramètre facultatif `among` permet de limiter l'ensemble des pages à +considérer. Par exemple, pour afficher un nuage avec les étiquettes +utilisées dans un blog, tout en ignorant les autres pages qui ont ces +étiquettes, on peut écrire : + + \[[!pagestats pages="tags/*" among="blog/posts/*"]] + +Pour afficher un nuage avec les étiquettes consacrées à Linux, écrivez : + + \[[!pagestats pages="tags/* and not tags/linux" among="tagged(linux)"]] + +Le paramètre optionnel `show` permet d'afficher un nombre déterminé de +pages. Par exemple, pour afficher les dix premières pages en terme de nombre +de liens : + + \[[!pagestats style="table" show="10"]] + +The optional `class` parameter can be used to control the class of the +generated tag cloud `div` or page stats `table`. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/pagetemplate.mdwn b/ikiwiki/directive/pagetemplate.mdwn new file mode 100644 index 0000000..6a10114 --- /dev/null +++ b/ikiwiki/directive/pagetemplate.mdwn @@ -0,0 +1,14 @@ +La directive `pagetemplate` est fournie par le module d'extension [[!iki +plugins/pagetemplate desc=pagetemplate]]. + +This directive allows a page to be displayed using a different +[[template|templates]] than the default `page.tmpl` template. + +Le texte de la page est inséré dans le modèle. Ainsi le modèle commande +l'allure générale de la page. Cette directive agit différemment de la +directive [[ikiwiki/directive/template]] qui permet d'insérer des modèles _à +l'intérieur_ du corps d'une page. + + \[[!pagetemplate template="my_fancy.tmpl"]] + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/ping.mdwn b/ikiwiki/directive/ping.mdwn new file mode 100644 index 0000000..9b1c55a --- /dev/null +++ b/ikiwiki/directive/ping.mdwn @@ -0,0 +1,20 @@ +La directive `ping` est fournie par le module d'extension [[!iki +plugins/pinger desc=pinger]]. + +Cette directive permet de configurer ikiwiki pour qu'il visite une URL à +chaque mise à jour du wiki. Utilisée avec le greffon [[!iki plugins/pingee +desc=pingee]], elle permet de mettre en place un réseau avec des miroirs +couplés ou une version « branche » d'un wiki. En visitant le miroir ou la +branche à chaque modification du wiki principal, ils peuvent être gardés à +jour. + + \[[!ping from="http://mywiki.com/" + to="http://otherwiki.com/ikiwiki.cgi?do=ping"]] + +Le paramètre "from" doit être identique à l'URL du wiki qui effectue le +*ping*, de manière à éviter les boucles. + +Le paramètre "to" est l'URL à visiter. L'exemple montre comment visiter une +autre instance d'ikiwiki. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/poll.mdwn b/ikiwiki/directive/poll.mdwn new file mode 100644 index 0000000..8eb3592 --- /dev/null +++ b/ikiwiki/directive/poll.mdwn @@ -0,0 +1,28 @@ +La directive `poll` est fournie par le module d'extension [[!iki +plugins/poll desc=poll]]. + +Cette directive permet d'organiser des sondages en ligne sur le wiki. Voici +un exemple d'utilisation : + + \[[!poll 0 "red" 0 "green" 0 "blue"]] + +Chaque chiffre indique le nombre d'utilisateurs qui ont voté pour ce +choix. Quand quelqu'un vote pour un choix, la page est modifiée et le nombre +augmente. + +Des précautions élémentaires sont prises pour éviter qu'on puisse voter deux +fois. Cependant ce type de consultation n'est pas très précis et les +préventions habituelles contre les sondages en ligne s'appliquent +aussi. Quand la page du sondage n'est pas verrouillée, les utilisateurs +peuvent même modifier la page et changer les chiffres ! + +Paramètres : + +* `open` - Indique s'il est possible de voter. Il faut indiquer la valeur + "no" pour terminer la consultation. +* `total` - Affiche le nombre total de votes au bas de la consultation. La + valeur par défaut est "yes". +* `percent` - Indique s'il faut montrer des pourcentages. La valeur par + défaut est "yes". + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/polygen.mdwn b/ikiwiki/directive/polygen.mdwn new file mode 100644 index 0000000..fb662e1 --- /dev/null +++ b/ikiwiki/directive/polygen.mdwn @@ -0,0 +1,12 @@ +La directive `polygen` est fournie par le module d'extension [[!iki +plugins/polygen desc=polygen]]. + +Cette directive permet l'insertion d'un texte créé par polygen dans une page +de wiki. Par exemple : + + \[[!polygen grammar="genius"]] + +Il est aussi possible d'indiquer un symbole non-terminal pour la grammaire +en incluant `symbol="text"` dans la directive. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/postsparkline.mdwn b/ikiwiki/directive/postsparkline.mdwn new file mode 100644 index 0000000..6b9bd0a --- /dev/null +++ b/ikiwiki/directive/postsparkline.mdwn @@ -0,0 +1,49 @@ +La directive `postsparkline` est fournie par le module d'extension [[!iki +plugins/postsparkline desc=postsparkline]. + +Cette directive se sert du greffon [[!iki plugins/sparkline desc=sparkline]] +pour créer une [[sparkline]], c'est-à-dire un mini graphique de statistiques +au sujet d'un ensemble de pages, comme par exemple les messages d'un blog. + +# Exemples + + Post interval: + \[[!postsparkline pages="blog/* and !*/Discussion" max=100 + formula=interval style=bar barwidth=2 barspacing=1 height=13]] + + Posts per month this year: + \[[!postsparkline pages="blog/* and !*/Discussion" max=12 + formula=permonth style=bar barwidth=2 barspacing=1 height=13]] + +# Usage + +Toutes les options, à part les options `pages`, `max`, `formula`, `time` et +`color` sont les mêmes que dans la directive [[sparkline]]. + +Vous n'avez pas besoin d'indiquer des points de données. Mais c'est possible +si vous le souhaitez. En fait, les points de données sont automatiquement +créés à partir des dates de création des pages correspondant à la +spécification [[ikiwiki/PageSpec]] `pages`. Un maximum de `max` points de +données sont créés. + +Le paramètre `formula` précise la formule utilisée pour créer les points de +données. Les formules disponibles sont les suivantes : + +* `interval` - La hauteur de chaque point représente la durée depuis le + précédent message. +* `perday` - Chaque point représente un jour. La hauteur représente le + nombre de messages envoyés ce jour-là. +* `permonth` - Chaque point représente un mois. La hauteur représente le + nombre de messages envoyés pendant ce mois. +* `peryear` - Chaque point représente une année. La hauteur représente le + nombre de messages envoyés pendant cette année. + +Le paramètre `time` possède une valeur par défaut, "ctime", puisque les +formules utilisent par défaut la date de création des pages. Si vous +préférez qu'elles utilisent la date de modification, passez la valeur du +paramètre à "mtime". + +Pour modifier la couleur de la ligne-étincelle, utilisez le paramètre +`color`. Par exemple, "color=red". + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/progress.mdwn b/ikiwiki/directive/progress.mdwn new file mode 100644 index 0000000..c809b99 --- /dev/null +++ b/ikiwiki/directive/progress.mdwn @@ -0,0 +1,20 @@ +La directive `progress` est fournie par le module d'extension [[!iki +plugins/progress desc=progress]]. + +Cette directive affiche une barre de progression. + +Deux ensembles de paramètres sont disponibles. le premier est composé d'un +seul paramètre "percent" qui indique le pourcentage de remplissage de la +barre. + +Le second ensemble est composé de deux spécifications [[ikiwiki/PageSpec]], +`totalpages` et `donepages`. La directive compte le nombre de pages +correspondant à chaque spécification et affiche le pourcentage de pages déjà +traitées. + +Par exemple, pour afficher le pourcentage de pages qui possèdent des pages +discussion : + + \[[!progress totalpages="* and !*/Discussion" donepages="*/Discussion"]] + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/shortcut.mdwn b/ikiwiki/directive/shortcut.mdwn new file mode 100644 index 0000000..845e2f2 --- /dev/null +++ b/ikiwiki/directive/shortcut.mdwn @@ -0,0 +1,10 @@ +La directive `shortcut` est fournie par le module d'extension [[!iki +plugins/shortcut desc=shortcut]]. + +Cette directive permet l'utilisation de raccourcis. Un raccourci est un lien +externe qui permet de renvoyer facilement à des sites connus. + +Les raccourcis disponibles sont définis sur la page [[shortcuts]] du +wiki. La directive `shortcut` ne peut être utilisée que sur cette page. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/sparkline.mdwn b/ikiwiki/directive/sparkline.mdwn new file mode 100644 index 0000000..a6edb6a --- /dev/null +++ b/ikiwiki/directive/sparkline.mdwn @@ -0,0 +1,58 @@ +La directive `sparkline` est fournie par le module d'extension [[!iki +plugins/sparkline desc=sparkline]]. + +Cette directive permet d'embarquer des lignes-étincelles (*sparklines*) ou +mini graphiques dans les pages d'un wiki. Une ligne-étincelle est un mini +graphique, simple et proche d'un mot, affichable au fil du texte. + +# Exemples + + \[[!sparkline 1 3 5 -3 10 0 width=40 height=16 + featurepoint="4,-3,red,3" featurepoint="5,10,green,3"]] + +Cet exemple affiche un mini graphique de plusieurs points. Sa largeur est de +40 pixels et sa hauteur, 16 pixels. Le *haut* est désigné par un point vert +et le *bas* par un point rouge. + + \[[!sparkline 1 -1(red) 1 -1(red) 1 1 1 -1(red) -1(red) style=bar barwidth=2 + barspacing=1 height=13]] + +Cet exemple plus complexe engendre un histogramme. La largeur des barres est +de 2 pixels avec une séparation de 1 pixel et la hauteur du graphique est de +13 pixels. La largeur de l'histogramme est déterminée automatiquement. Les +points dont la valeur est négative sont en rouge, au lieu de noir, valeur +par défaut. + +# Usage + +Le format des points de données est "x,y" ou simplement "y" si la valeur "x" +n'importe pas. On peut aussi ajouter un paramètre "(color)" pour spécifier +la couleur d'une barre. + +Les paramètres suivants sont reconnus. La plupart d'entre eux sont les mêmes +que ceux de la bibliothèque sparkline sous-jacente et sont documentés avec +plus de précisions dans [son wiki](http://sparkline.wikispaces.com/usage). + +* `style` - soit "line" (valeur par défaut) ou "bar". +* `width` - largeur du graphique en pixels. Nécessaire seulement pour les + graphiques ligne. +* `height` - Hauteur du graphique en pixels. La valeur par défaut est 16. +* `barwidth` - Largeur des barres dans un histogramme. La valeur par défaut + est 1 pixel. +* `barspacing` - Espacement entre les barres dans un histogramme. La valeur + par défaut est 1 pixel. +* `ymin`, `ymax` - Valeurs minimum et maximum pour l'axe des Y. Elles sont + normalement calculées automatiquement mais on peut vouloir les préciser + pour obtenir les mêmes valeurs pour plusieurs graphiques apparentés. +* `featurepoint` - Ajoute un cercle sur un graphique ligne, avec un texte + facultatif. On peut ainsi mettre en évidence certains points + significatifs. + + La valeur est une liste de paramètres, séparés par des virgules, spécifiant + le point à cercler : valeur X, valeur Y, couleur, diamètre du cercle, texte (facultatif), + et position du texte (facultatif). Exemple : `featurepoint="3,5,blue,3"`. + + Les valeurs disponibles pour la position du texte sont : "top", "right", "bottom" + et "left". + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/table.mdwn b/ikiwiki/directive/table.mdwn new file mode 100644 index 0000000..9631008 --- /dev/null +++ b/ikiwiki/directive/table.mdwn @@ -0,0 +1,51 @@ +La directive `table` est fournie par le module d'extension [[!iki +plugins/table desc=table]]. + +Cette directive permet l'affichage de tableau HTML à partir de données au +format CSV (comma-separated values) ou DSV (delimiter-separated values). + +## exemples + + \[[!table data=""" + Customer |Amount + Fulanito |134,34 + Menganito|234,56 + Menganito|234,56 + """]] + + \[[!table class="book_record" format=csv file="data/books/record1"]] + +Dans cet exemple, la page `record1` devrait ressembler à : + + "Title","Perl Best Practices" + "Author","Damian Conway" + "Publisher","O’Reilly" + +Pour qu'une cellule s'étende sur plusieurs colonnes, il faut la faire suivre +par une cellule vide, ou plusieurs. Par exemple : + + \[[!table data=""" + left||right| + a|b|c|d + cette cellule prend 4 colonnes||| + """]] + +## Usage + +* `data` - Valeurs pour le tableau. +* `file` - Fichier dans le wiki contenant les données. +* `format` - Le format des données, "csv", "dsv", ou "auto" (valeur par + défaut). +* `delimiter` - Le caractère servant à délimiter les champs. Par défaut, le format CSV utilise une virgule (`,`) + et le format DSV utilise une barre verticale (`|`). +* `class` - Une classe CSS pour l'élément HTML table. +* `header` - Par défaut, ou si sa valeur est "row", la première ligne des données est utilisée + comme en-tête du tableau. Si la valeur est "no", le tableau n'a pas d'en-tête et si la valeur + est "column", la première colonne constitue l'en-tête. + +For tab-delimited tables (often obtained by copying and pasting from HTML or +a spreadsheet), `delimiter` must be set to a literal tab character. These +are difficult to type in most web browsers - copying and pasting one from +the table data is likely to be the easiest way. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/tag.mdwn b/ikiwiki/directive/tag.mdwn new file mode 100644 index 0000000..01fab40 --- /dev/null +++ b/ikiwiki/directive/tag.mdwn @@ -0,0 +1,37 @@ +Les directives `tag` et `taglink` sont fournies par le module d'extension +[[!iki plugins/tag desc=tag]]. + +Elles permettent d'étiqueter les pages. Ainsi : + + \[[!tag tech life linux]] + +Les étiquettes sont comme des [[ikiwiki/WikiLink]] (cachés) sur une +page. Vous pouvez donc utiliser une spécification [[ikiwiki/PageSpec]] pour +trouver toutes les pages possédant une étiquette particulière. Les +étiquettes apparaissent sur les messages des blogs, au bas des pages +étiquetées ainsi que dans les flux RSS et Atom. + +Si vous voulez que l'étiquette soit visible comme un [[ikiwiki/WikiLink]], +utilisez taglink : + + \[[!taglink foo]] + \[[!taglink tagged_as_foo|foo]] + +Note that if the wiki is configured to use a tagbase, then the tags will be +located under a base directory, such as "tags/". This is a useful way to +avoid having to write the full path to tags, if you want to keep them +grouped together out of the way. Also, since ikiwiki then knows where to put +tags, it will automatically create tag pages when new tags are used. + +S'il existe un répertoire d'étiquettes, vous devrez le spécifier dans la +fonction spéciale `link()` d'une [[ikiwiki/PageSpec]] : par exemple, si le +répertoire d'étiquettes est `tag`, vous chercherez les pages étiquetées +« foo » avec `link(tag/foo)`. + +Si pour une étiquette vous voulez éviter le répertoire d'étiquettes, vous +pouvez écrire quelque chose comme ça : + + \[[!tag /foo]] + \[[!taglink /foo]] + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/template.mdwn b/ikiwiki/directive/template.mdwn new file mode 100644 index 0000000..e4f3a93 --- /dev/null +++ b/ikiwiki/directive/template.mdwn @@ -0,0 +1,85 @@ +La directive `template` est fournie par le module d'extension [[!iki +plugins/template desc=template]]. + +Cette directive permet d'utiliser des pages de wiki comme modèles. Ces +modèles peuvent être remplis et insérés dans d'autres pages du wiki. La page +[[templates]] liste les modèles utilisables avec cette directive. + +Cette directive possède un paramètre `id` qui identifie le modèle à +utiliser. Les autres paramètres servent à remplir le modèle. + +## Exemple : + + \[[!template id=note text="""Here is the text to insert into my note."""]] + +Cette expression remplit le modèle `note`, remplaçant le champ `text` par la +valeur spécifiée, et insérant le résultat dans la page. + +## Utilisation d'un modèle + +Une valeur peut contenir tout marquage autorisé dans une page de wiki +externe au modèle. On peut même inclure des guillemets dans la valeur, en +les triplant. Avec des valeurs sur plusieurs lignes entre guillemets, on +peut ainsi insérer de longs passages de texte dans un modèle. + + \[[!template id=foo name="Sally" color="green" age=8 notes=""" + * \[[Charley]]'s sister. + * "I want to be an astronaut when I grow up." + * Really 8 and a half. + """]] + +## Création d'un modèle + +Le modèle est une simple page de wiki, située dans le sous-répertoire +`templates/` du répertoire source du wiki. + +Il est aussi possible de conserver les modèles dans un répertoire extérieur +au wiki, comme des fichiers avec l'extension ".tmpl". Par défaut ces +fichiers sont recherchés dans `/usr/share/ikiwiki/templates`. Le paramètre +`templatedir` peut être utilisé pour commencer la recherche dans un autre +répertoire. + +Le modèle utilise la syntaxe du module Perl [[!cpan HTML::Template]] qui +permet de faire des choses assez compliquées. Consultez la documentation +mais vous n'avez besoin de connaître que peu de choses : + +* Chaque paramètre passé à la directive template créera une variable pour le + modèle. Certaines variables sont prédéfinies comme PAGE et BASENAME. +* Pour insérer la valeur d'une variable, utilisez `<TMPL_VAR variable>`. Le + marquage wiki dans la valeur sera d'abord converti en HTML. +* Pour insérer la valeur brute d'une variable, sans conversion en HTML du + marquage wiki, utilisez `<TMPL_VAR raw_variable>`. +* Pour rendre un texte dépendant d'une variable, utilisez `<TMPL_IF + variable>text</TMPL_IF>` +* Pour utiliser un texte quand une variable est définie et un autre texte + quand elle n'est pas définie, utilisez `<TMPL_IF + variable>text<TMPL_ELSE>other text</TMPL_IF>` + +Voici un exemple : + + <span class="infobox"> + Name: \[[<TMPL_VAR raw_name>]]<br /> + Age: <TMPL_VAR age><br /> + <TMPL_IF color> + Favorite color: <TMPL_VAR color><br />" + <TMPL_ELSE> + No favorite color.<br /> + </TMPL_IF> + <TMPL_IF notes> + <hr /> + <TMPL_VAR notes> + </TMPL_IF> + </span> + +Le modèle rempli sera formaté comme le reste de la page dans laquelle il se +trouve. Vous pouvez donc inclure des WikiLinks ou d'autres marquages wiki +dans le modèle. Cependant ces WikiLinks n'apparaîtront pas comme des +rétroliens vers la page qui utilise ce modèle. + +Remarquez l'utilisation de "raw_name" dans [[ikiwiki/WikiLink]] de l'exemple +ci-dessus. Ainsi, si le nom peut être confondu avec un marquage wiki, il +n'est pas converti en html avant d'être créé en tant que +[[ikiwiki/WikiLink]]. + + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/testpagespec.mdwn b/ikiwiki/directive/testpagespec.mdwn new file mode 100644 index 0000000..9ce2308 --- /dev/null +++ b/ikiwiki/directive/testpagespec.mdwn @@ -0,0 +1,28 @@ +La directive `testpagespec` est fournie par le module d'extension [[!iki +plugins/testpagespec desc=testpagespec]]. + +Cette directive permet de confronter une spécification [[ikiwiki/PageSpec]] +et une page, puis de voir quelle partie correspond ou quelle partie provoque +l'échec du test. + +Exemples : + + \[[!testpagespec pagespec="foopage and barpage" match="foopage"]] + + Cette expression affichera quelque chose comme "no match: barpage does not +match foopage", mettant en évidence la partie de la spécification +[[ikiwiki/PageSpec]] qui provoque l'échec. + + \[[!testpagespec pagespec="foopage or !bar*" match="barpage"]] + +Cette expression affichera quelque chose comme "no match: bar* matches +barpage", puisque la partie de la spécification [[ikiwiki/PageSpec]] qui +fait échouer le test est le motif nié. + + \[[!testpagespec pagespec="foopage or barpage" match="barpage"]] + +Cette expression affichera quelque chose comme "match: barpage matches +barpage", indiquant la partie de la spécification [[ikiwiki/PageSpec]] qui +fait réussir le test. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/teximg.mdwn b/ikiwiki/directive/teximg.mdwn new file mode 100644 index 0000000..f2ba164 --- /dev/null +++ b/ikiwiki/directive/teximg.mdwn @@ -0,0 +1,24 @@ +La directive `teximg` est fournie par le module d'extension [[!iki +plugins/teximg desc=teximg]]. + +Cette directive transforme les formules LaTeX en images. + +## Exemples : + + \[[!teximg code="\frac{1}{2}"]] + \[[!teximg code="E = - \frac{Z^2 \cdot \mu \cdot e^4}{32\pi^2 \epsilon_0^2 \hbar^2 n^2}" ]] + +Pour ajuster une image, utilisez height=x : + + \[[!teximg code="\frac{1}{2}" height="17"]] + \[[!teximg code="\frac{1}{2}" height="8"]] + +Si aucune hauteur n'est choisie, la valeur par défaut est 12. Voici les +valeurs reconnues : 8, 9, 10, 11, 12, 14, 17, 20. Si une autre valeur est +donnée, la valeur la plus proche est choisie. + +Pour ajouter un texte à l'image, utilisez alt="text" : + + \[[!teximg code="\frac{1}{2}" alt="1/2"]] + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/toc.mdwn b/ikiwiki/directive/toc.mdwn new file mode 100644 index 0000000..a52e856 --- /dev/null +++ b/ikiwiki/directive/toc.mdwn @@ -0,0 +1,29 @@ +La directive `toc` est fournie par le module d'extension [[!iki plugins/toc +desc=toc]]. + +Voici comment ajouter une table des matières sur une page : + + \[[!toc ]] + +La table des matières sera automatiquement créée à partir des titres de la +page. Par défaut seuls les plus grands titres présents sur la page sont +affichés. Pour choisir un niveau de titre, il faut utiliser le paramètre +`levels` : + + \[[!toc levels=2]] + +La directive `toc` choisit le niveau du premier titre comme le premier +niveau, même si des niveaux plus élévés sont rencontrés plus tard dans le +fichier. + +Pour créer une table des matières qui ne liste que les titres d'un certain +niveau, vous pouvez utiliser le paramètre `startlevel`. Par exemple, pour ne +montrer que les titres h2 et plus petits : + + \[[!toc startlevel=2]] + +La table des matières est une liste ordonnée. Si vous voulez une liste non +numérotée, il faut changer le style de liste dans la feuille de style +locale. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/toggle.mdwn b/ikiwiki/directive/toggle.mdwn new file mode 100644 index 0000000..fe77519 --- /dev/null +++ b/ikiwiki/directive/toggle.mdwn @@ -0,0 +1,38 @@ +Les directives `toggle` et `toggleable` sont fournies par le module +d'extension [[!iki plugins/toggle desc=toggle]]. + +Ces directives permettent de créer des liens qui, lorsque vous cliquez +dessus, basculent l'affichage sur d'autres parties de la page. + +Javascript est nécessaire pour cela. Les navigateurs qui ne disposent pas de +javascript affichent toujours la page entière. + +Exemple : + + \[[!toggle id="ipsum" text="show"]] + + \[[!toggleable id="ipsum" text=""" + Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do + eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim + ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut + aliquip ex ea commodo consequat. + + [[!toggle id="ipsum" text="hide"]] + """]] + +Vous pouvez inclure des balises wiki dans le texte du lien, et même d'autres +liens de ce type, comme le montre l'exemple ci-dessus. + +Il n'est pas nécessaire que les textes des directives toggle et togglable +soient proches, ils peuvent être partout sur la page. Il peut même y avoir +de multiples textes qui renvoient tous à un seul texte de la directive +toggleable. + +La valeur par défaut du paramètre « id » est "default", et peut être omis +dans les cas les plus simples. + +Si vous voulez un affichage d'un texte par défaut et qui bascule vers un +état caché, il suffit de passer le paramètre "open=yes" quand vous +définissez la directive toggleable. + +[[!meta robots="noindex, follow"]] diff --git a/ikiwiki/directive/version.mdwn b/ikiwiki/directive/version.mdwn new file mode 100644 index 0000000..eb4c37b --- /dev/null +++ b/ikiwiki/directive/version.mdwn @@ -0,0 +1,13 @@ +La directive `version` est fournie par le module d'extension [[!iki +plugins/version desc=version]]. + +Cette directive permet d'insérer la version d'ikiwiki sur une page. + +À chaque mise à niveau d'ikiwiki, la page est reconstruite, modifiant par là +le numéro de version. + +Simple est son utilisation : + + \[[!version ]] + +[[!meta robots="noindex, follow"]] |