La directiva (:include:) possibilita la inserció (o "transclusió") dels continguts d'altres pàgines a la pàgina actual. Totes les directives de sota executen una inclusió directa. En concret, si no s'indica el contrari, s'assumeix que qualsevol enllaç del text inclòs enllaça amb pàgines del grup wiki actual.

Sintaxi

La sintaxi bàsica és

• (:include NomPagina:)

• {Grup/NomPagina$:PTVar}

La sintaxi completa és

• (:include NomComplet#ancora-inici#ancora-fi lines=123 self=0 basepage=abc variable=valor :)

Paràmetres

La directiva pot tenir múltiples paràmetres NomPagina amb o sense àncores, i múltiples variables.

Les pàgines especificades

Podeu usar la característica citada a dalt per a 'mostrar un missatge d'error en cas de que la inclusió falli. Creeu una pàgina, p.ex. Site.IncludeFailed que contingui el missatge d'error. Podeu usar qualsevol nom per a la pàgina. Després afegiu-la al final de la llista de pàgines de l'include:

 (:include Pagina1 Pagina2 Pagina3 Site.IncludeFailed:)

Una aproximació lleugerament més complicada s'explica a la pàgina de discussió.

Àncores

Lines=

Self=

Variables de text d'una pàgina

Basepage=

Per tant, si hom crea PlantillaNom com a

Nom: {$:Nom}
Adreça: {$:Adreça}

aleshores la directiva

recuperarà els continguts de PlantillaNom, tractant les variables de pàgina i els enllaços com si fossin relatius a NomPagina. En concret, els valors de {$:Nom} i {$:Adreça} s'agafaran de NomPagina; passaria el mateix amb altres variables com {$Title} i {$LastModifiedBy}.

Ús de basepage

L'objectiu principal de basepage és permetre la inclusió de pàgines tal i com es feia en les versions 2.1.x, on les variables de pàgina i els enllaços s'interpretaven en relació a la pàgina mostrada. Això s'aconsegueix mitjançant:

  -o-

També permet que les pàgines GroupHeader i GroupFooter tractin les seues variables i enllaços de forma relativa a la pàgina que es mostra (enlloc de fer-ho en relació a GroupHeader i GroupFooter):

  ## PmWiki default $GroupHeaderFmt setting
  $GroupHeaderFmt = 
    '(:include {$Group}.GroupHeader self=0 basepage={*$FullName}:)(:nl:)';

De no ser així, l'ús de la variable IncludeOtherPages dintre de GroupHeader mostraria 'GroupHeader' i no pas el nom de la pàgina mostrada.

El paràmetre basepage= és suficientment general per a fer-se servir com a plantilla, de manera que pot agafar una pàgina --que fem servir com a plantilla-- que contingui variables i emplenar-les al moment amb els valors d'un altra pàgina:

I, com sempre, una única PaginaPlantilla pot contenir diverses plantilles delimitades per àncores, de manera que al final acabem amb una sintaxi misteriosament similar^[1] a la de les plantilles per als llistats de pàgines:

    (:include PaginaPlantilla#abc basepage=PaginaDades :)

Així que PaginaPlantilla pot usar una sintaxi com:

    
    [[#abc]]
    ...ací van les coses de la plantilla...
    [[#abcend]]

i és possible mostrar PaginaPlantilla com una plantilla sense que s'interpreti... el mateix que fem amb Site.PageListTemplates.

Especificar les variables com a paràmetres

Podeu especificar valors per a les variables directament a la sentència d'inclusió, i fer referència a les variables des de la plantilla usant el format {$$variable1}:

Amb això assumim que el lloc té habilitat $EnableRelativePageVars, recomanat des de PmWiki 2.2.0 -- però deshabilitat per defecte en les versions 2.2.8 i anteriors.

Per exemple, a la pàgina inclosa ("plantilla") puc tenir:

[[#ivars]]
Hola, {$$Nom}, com estàs avui?
[[#ivarsend]]

Aleshores, incloent eixa secció de dalt (disponible via {$FullName}#ivars)) obteniu aquest resultat:

(:include {$FullName}#ivars Nom=Mariola:)

Si el valor conté espais, tanqueu-lo entre cometes:

(:include {$FullName}#ivars Nom="el meu amic":)

Vegeu també $EnableUndefinedTemplateVars.

Vegeu també

• Variables de text d'una pàgina Variables d'una pàgina que estan disponibles mitjançant marques de pàgina
• Cookbook:IncludeUrl

Nota sobre l'ús d'estils

Per defecte, les pàgines o línies incloses no es poden distingir de qualsevol altre text de la pàgina. Per tal d'indicar visualment que aquest text és especial, podeu aplicar-hi Estils wiki. Per exemple:

%define=leftborder border-left="2px solid #88f" margin-left="2px" padding="1px 0 3px 10px"%
Què és PmWiki?
>>leftborder<< (:include PmWikiCa.PmWikiCa lines=1..4:) 
>><<
''Que tingueu un bon dia!''

Referències als paràmetres

Es pot accedir a qualsevol paràmetre que se li passa a una sentència d'inclusió des de dintre de la pàgina inclosa com una variable especial {$$...} del mateix nom. Podem usar aquest funcionalitat per a mostrar informació extra a l'hora de mostrar la pàgina inclosa.

Notes

• També podeu usar (:include Meua/Pagina#meuaancora lines=4:) que comença, i inclou, la línia amb l'àncora [[#meuaancora]] i les tres línies següents.

Notes sobre l'ús amb ConditionalMarkup?

La directiva (:include ...:) es processa després que s'avaluïn les sentències condicionals.
Per tant podeu incloure una pàgina o una secció com a part d'una condició, com per exemple

Per contra, (:include AlgunaPagina#seccio:) no comprova si [[#seccio]] forma part d'una condició, com ara bé

(:include AlgunaPagina#seccio:) ignorarà per complet la condició.

Quan s'avaluen variables? a les pàgines incloses, el context de la pàgina (font o objectiu) pot resultar útil. Vegeu referències especials? per a més detalls.

Traducció de PmWiki.IncludeOtherPages - Pàgina original a PmWikiCa.IncludeOtherPages - Référencé par