Dokumentacja

• Język (pole LAN)

Pole to stanowi odnośnik do tabeli języków i określa język, w jakim napisany jest dany dokument.

• Typ dokumentu (pole TYP)

Pole to określa typ dokumentacji. Każdy typ jest powiązany z typem udokumentowanego elementu (dokumentacją funkcjonalną opisującą rekord w słowniku, wartościami konfiguracji opisującymi strukturę słownika lub pozostałymi elementami).

Gdy typ dokumentu odpowiada kodowi obiektu, tworzony jest automatycznie wpis dokumentu na paskach menu dla przedmiotowego obiektu. Możliwe jest dokumentowanie wprowadzanych rekordów w przedmiotowym obiekcie. Z tego powodu pomoc funkcjonalna oznaczona jest kodem AFC (kod dla obiektu „Funkcje”), a pomoc dla parametrów ogólnych oznaczona jest kodem ADP (kod dla obiektu „Parametry”).

Zasady nazewnictwa dokumentacji zostały określone w załączniku do dokumentacji.

• Kod (pole COD)

Pole to określa kod dla dokumentacji. Głównie odpowiada on kodowi dla rekordu (funkcji, parametru itd.), który jest dokumentowany. Zasady nazewnictwa dokumentacji są określone w załączniku do dokumentacji.

• Poziom (pole LEV)

Poziom ten tworzy hierarchię w akapitach. Każdy pierwszy akapit dla poziomu występuje w podstawowej tabeli materiałów (z wyjątkiem sytuacji, gdy jest on typu MIN).

• Podpoziom (pole SUBLEV)

Podpoziom ten tworzy w akapitach podhierarchię. Jeżeli dla danego dokumentu występuje więcej podpoziomów niż jeden, tworzona jest pomocnicza tabela materiałów w pierwszym podakapicie, w którym wyświetlane są łącza do kolejnych podpoziomów (z wyjątkiem sytuacji, gdy podakapit jest typu MIN).

• Akapit (pole PAR)

Kod akapitu określa sposób, w jaki generowany będzie akapit w ostatecznym dokumencie. Może to być ponowne skopiowanie tekstu lub bardziej zaawansowane generowanie zależnie od słownika. W załączniku do dokumentacji wyszczególnione są kody akapitu, które używane są jako funkcja typu dokumentu.

• Ekran (pole MSK)

Jeżeli w tym polu wprowadzony jest kod ekranu, piktogram, który występuje w tytule akapitu wygenerowanego dokumentu, służy do otwarcia sekcji zawierającej listę pól na ekranie oraz pola powiązanego z plikami pomocy. Zaleca się używanie stylu akapitu o numerze 4 (najbardziej czytelnego rozmiaru w przypadku rozwiniętego piktogramu).

• Opis (pole TIT)

Pole to jest tytułem dla akapitu. Jeżeli jest ono puste, przypisywany jest domyślny tytuł jako funkcja typu akapitu (czy to w trybie tworzenia, czy w trybie modyfikacji).

W przypadku pozostałych akapitów, które nie są wyświetlane w tabelach materiałów (typu MIN), wprowadzenie tytułu ze znakiem „ !” prowadzi do dezaktywacji wstawiania tytułu.

• Kod działań (pole CODACT)

Ten kod czynności, dziedziczony ze słownika podczas odtwarzania, jest w znacznej mierze używany do rozgraniczania rekordów standardowych od rekordów niestandardowych/ szczególnych a także do tworzenia dostosowanej dokumentacji w określonych folderach, tylko poprzez generowanie akapitów i dokumentacji odpowiednich dla kodów czynności, które są aktywne w danym folderze. Należy zauważyć, że kod aktywacji FAL (zawsze fałsz) uwzględniany jest w sposób szczególny. Akapit oznaczony tym kodem nie jest brany pod uwagę podczas procesu generowania, jeżeli wymagane jest kompletne odtwarzanie. Służy to do dezaktywacji wygenerowanych akapitów, które nie są wymagane w dokumentacji.

• Moduł (pole MODULE)

Moduł, którego dotyczą parametry dokumentacji.

• Styl (pole STY)

Styl ten stanowi odniesienie do wartości numerycznej odpowiadającej znacznikom „H1, H2, H3” itd., stosownie do wybranego numeru. Jeżeli pole to jest puste, domyślna wartością jest 3. W przypadku podakapitów zalecane jest używanie wartości 4, 5 lub 6 stosownie do poziomu. Tytuł 4 mieści się w zakresie: piktogram zapewnia dostęp do plików pomocy dla pola w przypadku widocznego pola, jeśli ekran jest powiązany z danym akapitem.

• Priorytet tłumaczenia (pole PRIO)

• Grupa nadrzędna (pole CREGRP)

• Weryfikacja (pole VLDDAT)

Określa dzień, w którym sprawdzono poprawność rekordu.

• pole VLDFLG

Ten wskaźnik informuje o uznaniu rekordu za prawidłowy.

• pole TEXTE

Pole to służy do wprowadzania tekstu dla akapitu, aby pojawił się on w ostatecznym dokumencie. Następujące szczególne przypadki wymagają wzmianki:

• określone akapity nie są wstawiane w postaci, w jakiej występują. Przypadek ten odnosi się w szczególności do akapitów tytułu, które zawierają listę słów kluczowych wstawionych do kodu HTML dokumentu (sekcja „Słowa kluczowe”).
• Określone akapity są generowane ze słownika. Tekst wprowadzony w tym miejscu stanowi uzupełnienie (przed lub po tekście generowanym zgodnie z tym przypadkiem) i generalnie nie jest obowiązkowy.
• W dokumentacji typu APM (streszczeniach dokumentacji odpowiadających poziomom menu) wprowadzony tekst jest interpretowany jako lista dodatkowych łączy do odpowiedniej dokumentacji (generowane są automatyczne łącza).