Az XML sémából létrehozott
HTML dokumentáció különböző információkat tartalmaz a sémáról,
például a séma nevét, helyét és névterét, valamint információkat
tartalmaz a sémában található különböző komponensekről (például
elemekről vagy összetett típusokról).
Hasznos lehet összegzést biztosítani a séma tartalmáról.
Az alábbi utasítások az Erőforrás perspektívához készültek, de
sok más perspektívákban is használhatók.
HTML dokumentáció előállítása XML séma fájlból:
- A Vázlat nézetben kattintson a jobb egérgombbal az XML sémára.
- Kattintson az
menüpontra. Megjelenik az XML séma dokumentáció előállítása
párbeszédablak.
- Válassza ki a HTML dokumentáció stílusát:
- Ha azt szeretné, hogy egy HTML fájl tartalmazza az összes
információt, akkor válassza ki az Egyetlen HTML fájl
keretek nélkül beállítást.
- Ellenkező esetben válassza ki a Több HTML fájl
keretekkel beállítást. Ha ezt a beállítást választja, akkor nem egy HTML fájl kerül
előállításra, hanem több.
A felépítésük hasonlít a Javadoc fájlokéhoz.
- Ha az Egyetlen HTML keretek nélkül
beállítást választotta, akkor kattintson a
Befejezés gombra, és a rendszer automatikusan
előállítja a HTML fájlt a forrásfájl nevével és a forrásfájl helyén,
vagy kattintson a Tovább gombra, válassza
ki azt a mappát, amelyben a HTML dokumentációt létre szeretné hozni,
adja meg a HTML fájl nevét, majd kattintson a
Befejezés gombra. A HTML fájl létrehozásra került. Most már megnyithatja a HTML szerkesztőben.
- Ha a Több HTML fájl keretekkel beállítást
választotta, akkor kattintson a Tovább gombra,
adja meg a HTML fájlok célmappáját, majd kattintson a
Befejezés gombra. A rendszer létrehozza a HTML fájlokat a megadott helyen.
A HTML dokumentáció az alábbi információkat tartalmazza:
- A séma neve.
- A séma helye.
- A séma cél névtere.
- A sémához tartozó dokumentációk.
- Információk a sémában található komponensekről, például a
komponensek típusa és forráskódja.
A komponenshez további információkat lehet megadni a komponenstől
függően.
Ha a HTML fájlok kódolásához a Héber logikai (ISO-8859-8-I) kódolást
választja
( menüpont a "Fájlok létrehozásakor"
szakaszban), akkor az XML sémából előállított HTML dokumentációs
fájlok UTF-8 kódolással fognak rendelkezni.
Ez egy ismert probléma.