Inkluderinger

Inkluderinger anvendes til at inkludere dele af andre dokumenter i et dokument. Markup'en angiver det dokument og element, der skal inkluderes, og før dokumentet vises til brugeren, vil inkluderingselementet blive erstattet med det element, der henvises til.

Du vil f.eks. vise copyright-oplysninger i slutningen af hvert hjælpedokument. Du kan kopiere og indsætte oplysningerne i hvert dokument, men hvis oplysningerne ændres (f.eks. udgivelsesåret), skal du ændre alle dokumenterne.

Du kan i stedet placere copyright-oplysningerne i en separat XHTML-fil ved navn copyright.xhtml og tildele den en entydig id. Eksempel:

   <p id="copyright">
      Copyright 2006 Mit firma. All rights reserved.
</p>
  

Inkludér derefter copyright-afsnittet i alle dokumenter:

   <p>
        Dette er mit dokument. Det skal have copyright-oplysninger til sidst.
</p>
     <include path="my.plugin.id/path/copyright.xhtml/copyright"/>

Før dokumentet sendes til browseren for at blive vist, vil inkluderingselementet blive erstattet af copyright-afsnittet.

Anvendelse af inkluderinger

Nedenfor er en liste over de dokumenttyper, hvor inkluderinger kan anvendes. Formatet for elementet sti for en inkludering afhænger af den type dokument, du inkluderer fra. Som vist i eksemplet neden er formatet for XHTML-hjælpedokumenter "<plugin_id>/<path_to_file>/<element_id>". Brug linkene nedenfor til at finde formatet for din dokumenttype.