Sisällytykset

Sisällytysten avulla asiakirjaan sisällytetään osia muista asiakirjoista. Merkinnät määrittävät sisällytettävän asiakirjan ja elementin, ja ennen kuin käyttäjä näkee asiakirjan, sisällytyselementti korvataan elementillä, johon on viitattu.

Esimerkiksi tekijänoikeustiedot kannattaa näyttää jokaisen tuottamasi ohjeen lopussa. Ne voisi kopioida ja liittää jokaiseen asiakirjaan erikseen, mutta jos kyseiset tiedot muuttuvat (esim. tekijänoikeustietojen vuosi), ne olisi muutettava jokaiseen asiakirjaan erikseen.

Vaihtoehtoisesti voit sijoittaa tekijänoikeustiedot erilliseen XHTML-tiedostoon nimeltään copyright.xhtml ja määrittää sen yksilölliseksi tunnukseksi, kuten seuraavassa esimerkissä on tehty:

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

Tämän jälkeen tarvitsee vain sisällyttää copyright-kappale jokaiseen asiakirjaan:

   <p>
      This is my document. It should have a copyright at the end.
   </p>
   <include path="my.plugin.id/path/copyright.xhtml/copyright"/>

Ennen kuin asiakirja lähetetään selaimen näytettäväksi, copyright-kappale korvaa include-elementin.

Missä yhteydessä voin käyttää sisällytyksiä?

Edempänä on luettelo asiakirjalajeista, joissa sisällytyksiä voi käyttää. Sisällytyksen path-elementin muotoilu riippuu sen asiakirjan lajista, josta sisällytys tehdään. Kuten edellinen esimerkki osoittaa, XHTML-ohjeiden muotoilu on "<plugin_id>/<path_to_file>/<element_id>". Seuraavista linkeistä saat tietoja asiakirjalajeista.