Inkluderinger

Inkluderinger brukes til å inkludere deler av andre dokumenter i ditt dokument. Kodingen oppgir dokumentet og elementet som skal inkluderes, og før dokumentet vises til brukeren, blir include-elementet erstattet med elementet det refereres til.

Du kan for eksempel ønske å vise en copyright på slutten av hvert hjelpedokument du skaffer. Du kan kopiere og lime inn hvert dokument, men hvis copyright-informasjonen blir endret (for eksempel året), må du endre hvert enkelt av dokumentene.

I stedet kan du legge copyright-informasjonen i en egen XHTML-fil som kalles copyright.xhtml og tildele en unik ID til den, på denne måten:

   <p id="copyright">
      Copyright 2006 My Company. All rights reserved.
   </p>

Deretter inkluderer du copyright-avsnittet for hvert dokument:

   <p>
      Dette er mitt dokument. Det skal ha en copyright på slutten.
   </p>
   <include path="my.plugin.id/path/copyright.xhtml/copyright"/>

Før dokumentet sendes til nettleseren for visning, blir include-elementet erstattet av copyright-avsnittet.

Hvor kan jeg bruke inkluderinger?

Nedenfor finner du en liste over dokumenttyper der det er mulig å bruke inkluderinger. Formatet for path-elementet i inkluderingen avhenger av den typen dokument du inkluderer fra. Som du ser i eksempelet ovenfor, er formatet for XHTML-hjelpedokumentene "<plugin_id>/<path_to_file>/<element_id>". Se linkene nedenfor når du skal finne formatet for din dokumenttype.