HTML dokumentáció létrehozása XML sémafájlból

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.

Mielőtt elkezdené

Erről a feladatról

Az alábbi utasítások az Erőforrás perspektívához készültek, de számos más perspektívában is felhasználhatók.

HTML dokumentáció előállítása XML sémafájlból:

Eljárás

  1. A Projektböngészőben kattintson a jobb egérgombbal az XML sémára.
  2. Kattintson az Előállítás > HTML menüpontra. Megjelenik az XML séma dokumentáció előállítása párbeszédablak.
  3. Válassza ki a HTML dokumentáció stílusát:
    1. Ha egy HTML fájlt szeretne sémánként, akkor válassza az XSD dokumentáció előállítása keretek nélkül lehetőséget.
    2. Ellenkező esetben válassza ki az XSD dokumentáció előállítása keretekkel beállítást. Ha ezt a beállítást választja, akkor számos HTML fájl kerül előállításra. A felépítésük hasonlít a Javadoc fájlokéhoz.
  4. Kattintson a Tovább gombra, hogy megadja a HTMl fájlok célmappáját.
  5. Kattintson a Befejezés gombra. A rendszer létrehozza a HTML fájlokat a megadott helyen.

Eredmények

Az előállított HTML fájlok tartalmazhatják a következő részleteket:

Részletek Leírás
Séma Az XML séma neve, helye és a cél névtartomány.
Névtartomány Az XML sémakomponens cél névtartománya.
Diagram Az XML sémakomponensek vizuális modellje (mint az elemek vagy a komplex típusok). Kattinthat egy szülőkomponens fejlécére a komponens dokumentációrészleteihez. Összetett típusok esetén, kattinthat az elem típusának nevére a típus dokumentáció részleteinek megtekintéséhez.
Típus Egy komponens típusa (például, egy összetett típus).
Öröklési hierarchia Örökölt típusú komponens hierarchiája. Rákattinthat egy örökölt típusra, hogy a típus dokumentáció részleteihez eljusson.
Tartalom részletek Az elemek listája egy összetett típusban és bármely dokumentáció, amely ezekkel az elemekkel van kapcsolatban, ahogy az az XML sémafájlban meg van adva.
Megengedhető értékek A megengedhető értékek listája (vagy felsorolásai) egy egyszerű típushoz és a kapcsolódó dokumentációhoz.
Forrás Az XML sémakomponens XML forráskódja.

Ha a HTML fájlok kódolásához a Héber logikai (ISO-8859-8-I) kódolást választja (Ablak > Beállítások > Web és XML fájlok > HTML fájlok 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.

Mi a következő lépés?


Visszajelzés