Include-element

Include-element är använda include-delar från andra dokument som ingår i ditt dokument. Märkordsuppsättningen anger det dokument och det element som ska ingå och innan dokumentet visas för användaren ersätts Include-elementet med det refererade elementet.

Du kan till exempel visa copyrightinformation i slutet av varje hjälpdokument du tillhandahåller. Du kan kopiera och klistra in det i varje dokument men om copyrightinformationen ändras (till exempel copyrightåret) måste du ändra varje dokument.

I stället kan du placera copyrightinformationen i en separat XHTML-fil med namnet copyright.xhtml och tilldela den ett unikt ID, på följande sätt:

   <p id="copyright">
      Copyright 2006 Mitt företag. Med ensamrätt.
   </p>

Sedan anger du helt enkelt copyrightinformationen för varje dokument:

   <p>
      Det här är mitt dokument. Det ska finnas copyrightinformation i slutet av dokumentet.
   </p>
   <include path="my.plugin.id/path/copyright.xhtml/copyright"/>

Innan dokumentet skickas till webbläsaren för att visas ersätts include-elementet av copyrightinformationen.

Var kan jag använda include-element?

Nedan följer en lista med dokumenttyper där include-element kan användas. Formatet för path-elementet för include-elementet beror på vilken typ av dokument include-elementet hämtas från. Som du kan se i exemplet ovan är formatet för XHTML-hjälpdokument "<plugin_id>/<path_to_file>/<element_id>". Öppna länkarna nedan om du vill ha information om format för olika dokumenttyper.