Dokumentacja HTML wygenerowana na podstawie schematu XML
zawiera rozmaite informacje o schemacie, takie jak jego nazwa, położenie i
przestrzeń nazw, a także szczegółowe informacje o rozmaitych komponentach
(na przykład elementach lub typach złożonych) zawartych w tym schemacie. Może
być bardzo przydatna, dostarczając podsumowanie zawartości schematu.
Poniższe instrukcje zostały napisane pod kątem perspektywy Zasób,
lecz można je zastosować również do wielu innych perspektyw.
Aby wygenerować dokumentację HTML na podstawie pliku schematu XML:
- W widoku Schemat prawym przyciskiem myszy kliknij schemat XML.
- Kliknij kolejno opcje: . Otwarte zostanie okno dialogowe Generowanie dokumentacji schematu XML.
- Wybierz styl potrzebnej dokumentacji HTML:
- Jeśli chcesz uzyskać jeden plik HTML zawierający wszystkie informacje,
wybierz opcję Pojedynczy plik HTML bez ramek.
- W przeciwnym razie wybierz opcję Wiele plików HTML z ramkami. Jeśli zostanie wybrana ta opcja, wygenerowanych zostanie kilka plików HTML
zamiast tylko jednego. Będą one skonfigurowane w sposób podobny do plików
dokumentacji Javadoc.
- Jeśli została wybrana opcja Pojedynczy plik HTML bez ramek,
możesz kliknąć przycisk Zakończ, aby
automatycznie wygenerować plik HTML o tej samej nazwie, co plik źródłowy, i w tym
samym miejscu, albo kliknąć przycisk Dalej, aby
wybrać folder, w którym ma zostać utworzona dokumentacja HTML, oraz określić nazwę
pliku HTML, a następnie kliknąć przycisk Zakończ. Utworzony zostanie plik HTML. Teraz będzie go można otworzyć w edytorze HTML.
- Jeśli została wybrana opcja Wiele plików HTML z ramkami,
kliknij przycisk Dalej, aby określić folder docelowy
dla plików HTML, następnie kliknij przycisk Zakończ. Pliki HTML zostaną utworzone w określonym położeniu.
Dokumentacja HTML będzie zawierała następujące informacje:
- Nazwa schematu.
- Położenie schematu.
- Docelowa przestrzeń nazw schematu.
- Wszelka dokumentacja podana w schemacie.
- Informacje o każdym komponencie schematu, takie jak typ komponentu
i jego kod źródłowy. W zależności od komponentu mogą być podane dodatkowe
informacje o komponencie.
Gdy jako
preferowane kodowanie plików HTML ( w sekcji "Podczas tworzenia plików"),
wybrane jest kodowanie Hebrew Logical (ISO-8859-8-I), to mimo to pliki dokumentacji
HTML generowane na podstawie pliku schematu XML będą mieć kodowanie UTF-8.
Jest to znany problem.