This page is part of a static HTML representation of the TiddlyWiki at https://tiddlywiki.com/

Macros Tables des matières

21 juin 2015 à 9h23

TiddlyWiki fournit plusieurs macros permettant de générer une arborescence de liens vers des tiddlers à partir de l'analyse des tags :

toc
Un arbre simple
toc-expandable
Un arbre dont les branches peuvent être déployées ou rétractées
toc-selective-expandable
Un arbre dont les branches non-vides peuvent être déployées ou rétractées
toc-tabbed-internal-nav et toc-tabbed-external-nav
Une navigation en deux panneaux :
  • sur la gauche, une arborescence extensible sélectivement se comportant comme un ensemble d'onglets verticaux
  • sur la droite, le contenu du tiddler sélectionné par l'utilisateur dans l'arborescence

La différence entre ces deux derniers provient de ce qu'il advient lors d'un clic de l'utilisateur sur un lien du panneau droit :

toc-tabbed-internal-nav
Le tiddler cible s'affiche dans le panneau droit, remplaçant le tiddler contenant le lien
toc-tabbed-external-nav
Le tiddler cible s'affiche de façon classique (selon la configuration de l'affichage du déroulé par l'utilisateur)

Structure

Le premier niveau de l'arborescence est constitué de tiddlers qui portent une étiquette particulière, appelée tag racine. Les tiddlers marqués par l'un de ceux-là forment le niveau suivant, et ainsi de suite.

À chaque niveau, les tidllers peuvent être ordonnés via le champ list de leur tiddler tag parent. Ils peuvent aussi être triés en paramétrant la macro sort

L'arborescence affiche le champ caption du tiddler s'il en a un, sinon son titre.

Chaque tiddler est affiché comme un lien, mais vous pouvez règler ceci en affectant la valeur no au champ toc-link du tiddler. Ainsi dans cet exemple, le tiddler SecondThree est affecté de la sorte. Cliquer sur un tel tiddler dans l'arborescence permettra de déployer ou rétracter sa branche.

La table des matières génère une liste HTML ordonnée. Les balises <ol> ont toujours la classe tc-toc. Les éléments d'arborescences déployables ont la classe additionnelle tc-toc-expandable. Les arborescence déployables sélectivement (dont celles du deuxième panneau de navigation) sont munies de tc-toc-selective-expandable.

Pour intégrer une table des matières dans le menu latéral, voir un nouvel onglet dans le menu latéral.

Paramètres

tag
Le tag racine indiquant le premier niveau de l'arborescence
sort
Une extra étape de filtre optionelle, e.g. sort[title]

Ces deux paramètres sont combinés en une seule expression de filtre de cette façon :

[tag[$tag$]$sort$]

toc-tabbed-internal-nav et toc-tabbed-external-nav ont, en sus, d'autres paramètres :

selectedTiddler
Le titre du tiddler d'état attribué au tiddler en cours sélectionné, par défaut $:/temp/toc/selectedTiddler. Il est recommandé d'employer un tiddler système
unselectedText
Le texte affiché quand aucun tiddler n'est sélectionné dans l'arborescence
missingText
Le texte affiché si le tiddler sélectionné est manquant
template
De manière optionnelle, le titre du tiddler gabarit lors de la transclusion du tiddler sélectionné dans le panneau de droite

Exemples