Codex

autores (bàsic)

Aquesta característica permet a les autores crear "rutes" per visitar una seqüència de pàgines del wiki. Només s'han d'especificar les pàgines i el seu ordre a l'"índex de la ruta", i aleshores afegir les etiquetes per a la navegació a les pàgines que en formen part.

(No s'ha de confondre la directiva de Llistat de pàgines amb les rutes wiki --tal i com s'explica a les PMF abaix, són animals diferents.)

Creació de rutes

Abans de poder usar una ruta a un grup de pàgines, heu de crear un "índex de la ruta" separat, al qual anomenem "pàgina de l'índex de la ruta". A una pàgina d'índex de ruta, només cal crear una llista? d'enllaços numerada o de punts. (Per tant cada llista numerada o de punts crea implícitament una ruta.) És important que immediatament després de cada punt de la llista hi hage l'enllaç? a la pàgina desitjada; si hi ha qualsevol altre text o marca de format al davant, serà exclòs de la ruta.
Si voleu donar format a la ruta (llista), podeu incloure-hi un CSS.

Una pàgina d'índex de ruta d'exemple pot contindre la llista:

La Filosofia de PmWiki
DesignNotes? (El primer enllaç estarà, però el segon no, a la ruta definida perquè és una (definició))
  • Security? (Aquest no estarà a la ruta perquè està precedit per una àncora (oculta))
  • Enllaços (Aquest no estarà a la rauta perquè està precedit per un estil %newwin% (ocult))
  • Troubleshooting (Aquest no estarà a la ruta perquè està precedit per una marca d'estil cursiva (oculta))

La llista de sobre crearà la següent "ruta wiki", mostrada fent servir Llistats de pàgines:

(:pagelist trail={$FullName}#trailstart#trailend fmt={$FullName}#traillist:)

Observacions

  1. Generalment no importa el nivell de sagnat de la llista de pàgines -- les rutes són una seqüència lineal de pàgines.
  2. Una pàgina forma part de la ruta només si l'enllaç a la pàgina és el primer element que hi ha.
  3. Es poden fer servir ancores per a traçar la llista, permetent més d'una llista per pàgina, o l'exclusió d'elements de la llista.

Tipus de rutes

PmWiki defineix 2 marques per a les rutes:

  • <<|[[Pàgina d'Índex de la Ruta]]|>> es mostrarà com "<< Pàgina anterior | Pàgina d'Índex de la Ruta | Pàgina següent >>".
  • <|[[Pàgina d'Índex de la Ruta]]|> es mostrarà com "< Pàgina anterior | Pàgina d'Índex de la Ruta | Pàgina següent >", tret que la fletxa apropiada s'omet al principi i final de la ruta.

Sintaxis de l'enllaç de la ruta

L'enllaç de la ruta te la mateixa sintaxis que l'enllaços estàndard, això vol dir que podeu especificar, per exemple,

  • <|[[Pàgina d'Índex de la Ruta | +]]|>

Es poden restringir els enllaços amb ancores (enllaços a una part específica d'una pàgina), això vol dir que podeu tenir més d'una ruta dintre d'una pàgina, o començar una ruta des d'una ubicació específica d'una pàgina.

  • <|[[Pàgina de l'Índex de la Ruta#iniciruta#firuta]]|>

Usant la ruta

Allò que "fa funcionar" una ruta, és afegir la marca (o etiqueta) de ruta a les pàgines que hi formen part (i.e. aquelles pàgines que estan llistades a la pàgina d'índex de la ruta).

Per a construir una ruta, afegiu la marca de ruta tal com <<|[[PaginaIndexRuta]]|>> a una pàgina, on PaginaIndexRuta és la pàgina, descrita més amunt, que conté la llista amb les pàgines que formen part de la ruta. PmWiki mostrarà la representació de la ruta amb els enllaços a la pàgina anterior i a la pàgina següent.

Podeu col·locar la marca de ruta a qualsevol lloc de la pàgina, a més a més una pàgina pot contenir diverses marques de ruta. Si esteu afegint una ruta a totes les pàgines d'un grup determinat, considereu la inclusió de la mateixa a les pàgines de capçalera de grup o GroupFooter (peu de pàgina) enlloc de fer-ho individualment a cada pàgina.

Una ruta linial

^|[[PaginaIndexRuta]]|^ estableix una jerarquia a partir dels nivells de la llista i mostra el "camí" per arribar a la pàgina actual (i.e., en forma de barra o "breadcrumb"). En la ruta de l'exemple de dalt, la marca ^|PaginaIndexRuta|^ a PaginaRuta4 es mostraria com "PaginaIndexRuta | PaginaRuta2 | PaginaRuta4".

Les administradores del wiki poden canviar el separador per defecte | de la ruta "lineal" ( ^|[[PaginaIndexRuta]]|^ ) per un altre, configurant la variable $TrailPathSep al fitxer config.php. Per exemple $TrailPathSep = ' > '; mostrarà "PaginaIndexRuta > PaginaRuta2 > PaginaRuta4".

Una ruta circular

Habitualment una ruta és una llista lineal de pàgines amb una primera pàgina i una última pàgina. Tanmateix, la ruta es pot fer "circular" repentint al final de l'índex la primera pàgina:

Si l'índex de la ruta ha de ser visible al públic, podeu fer invisible l'últim element dintre d'un bloc (:if false:) :

Rutes entre grups

Abans de la versió 2.2.1, si la vostra ruta contenia pàgines de diferents grups, calia usar enllaços del tipus [[Grup.Nom]] enlloc del tipus [[Nom]].

Altres notes

  • No hi ha cap espai entre la marca <| i [[enllaç]] i |>; el mateix s'aplica a la resta de marques de ruta.
  • Noteu que les pàgines que no existeixen apareixeran a la RutaWiki? com un enllaç.

L'estil de la ruta

PmWiki encasta la ruta dintre d'una classe css anomenada wikitrail. Açò permet que l'aspecte de la ruta pugui ésser personalitzat? mitjançant la definició d'un estil CSS per a wikitrail al fitxer local.css.

Llistat de pàgines de la ruta

Les rutes d'una sola pàgina només es poden mostrar fent servir el paràmetre ruta de la directiva Llistat de pàgines. Per exemple

(:pagelist trail=PmWikiCa/WikiTrails fmt=PmWikiCa.WikiTrails#traillist order=random count=3:)

Un exemple simple de RutaWiki

1) A la pàgina PaginaIndexRuta:

2) A les pàgines MeuaPaginaRuta1, 2, i 3:

Preguntes

Quina és la diferència entre un Llistat de pàgines i una RutaWiki?

La directiva de Llistat de pàgines genera dinamicament una llista de pàgines. Hi ha moltes maneres de generar la llista, fins i tot fer servir una RutaWiki com a font. La directiva mostra les pàgines que coincideixen amb el criteri de recerca fent servir --opcionalment-- una plantilla; per exemple, la plantilla podria especificar que es mostri el nom de cada pàgina en forma d'enllaç en una línia separada, o incloent-hi el contingut de la pàgina sencera. La directiva de Llistat de pàgines no compta amb una marca que pugueu incloure a les pàgines de la llista. En canvi, les RutesWiki es defineixen només amb enllaços col·locats a una pàgina "índex" i podeu incloure marques de navegació del tipus anterior-següent a cadascuna de les pàgines. Els dos mètodes serveixen per a propòsits distints. Les RutesWiki són útils per a especificar canals web?, per a crear un "tour" a través d'un conjunt predefinit de pàgines, i moltes altres coses.



Traducció de PmWiki.WikiTrails - Pàgina original a PmWikiCa.WikiTrails - Links de retorno