Import dokumentacji
Funkcja ta służy do integracji wszystkich akapitów dokumentacji uprzednio poddanej ekstrakcji w postaci pliku XML. Głównym celem jest umożliwienie ponownej integracji po tłumaczeniu wspomnianych dokumentów przy użyciu oprogramowania opracowanego do tłumaczenia plików XML.
Integracja jest wykonywana z domyślnego katalogu xml, który tworzony jest, jeśli jeszcze nie istnieje, w katalogu dokumentacji określonym przez parametr DIRDOC.
Pliki muszą być uprzednio poddane ekstrakcji za pomocą narzędzia dokumentacji lub poprzez funkcję eksportu dokumentacji .
Warunek
Odniesienie do dokumentacji Implementacja
Zarządzanie ekranem
Karta Ekran wpisów
Prezentacja
Katalog, w którym można znaleźć dokumentację podlegającą integracji, wypełniany jest na tym ekranie, wraz z kilkoma opcjami. W ten sposób pliki, które istnieją w katalogu, są odczytywane i integrowane.
Zamknij
Pola
Na tej karcie występują następujące pola :
Wybór
| Określa katalog, z którego wykonany będzie import dokumentacji, nie zapominając jednak, że pliki pomocy dla pól będą pozyskiwane z odpowiedniego podkatalogu FLD, a powiązane pliki do podkatalogu FILE, pod warunkiem że będą one zawierać kod wybranego języka w swoich nazwach. |
| Jeżeli wprowadzony został język, wykonana zostanie kontrola, aby sprawdzić, czy zdefiniowany język w znalezionych plikach jest taki sam. |
| Jeśli pole to zostało zaznaczone, przetworzona zostanie także dokumentacja dla pól. Przypadek szczególny opcji „Eksport do ponownego tłumaczenia”.Aby wyodrębnić wiele dokumentacji dla osobnych pól, tzn. niezależnych od dokumentacji dla funkcji, należy odznaczyć opcję Wszystkie typy, kliknąć Tab, a następnie w polu typu wpisać spację. |
| Jeśli to pole zostało zaznaczone przetwarzane są tylko pomoce dla pól dotyczące dokumentacji dla funkcji lub przetwarzanych obiektów. Aby dowiedzieć się, które pomoce dla pola powinny zostać przetworzone, należy przejrzeć ekrany powiązane z odpowiadającymi paragrafami dokumentacji. |
Import
| Upoważnia do importu nowych akapitów. |
|
|
Zamknij
Załącznik: format utworzonych plików
Format pliku XML dokumentacji dla funkcji lub obiektu, taki, jak znajduje się w katalogu XML, jest następujący:
- znormalizowany nagłówek XML,
- tag DOC z atrybutami TYPE, NAME (definiującymi typ i kod dokumentacji).
- zawartość taga DOC dla każdego paragrafu, tag PAR z atrybutami LAN, LEV, SUBLEV, PAR, MSK, STY,VLDDAT, VLDFLG, ACT i MOD (definiującymi odpowiednio: język, poziom, podpoziom, kod paragrafu, ekran, styl, datę ważności, flagę ważności, kod działania i moduł),
- zawartość taga PAR, tag TIT w celu nadania tytułu paragrafowi (jeśli istnieje),
- zawartość taga PAR, tag TIT zawierający tekst paragrafu w XHTML.
Pliki dokumentacji dla pola są umieszczone w podfolderze FLD katalogu xml wyodrębniania. Format jest następujący:
- znormalizowany nagłówek XML,
- tag FLD z atrybutami NAME, LAN, MOD, GEN, LNKHLP, LNKORD, CREDAT, UPDDAT (definiującymi nazwę, język, moduł, atrybut ogólny dokumentacji, powiązaną pomoc, odnośnik, datę utworzenia i datę modyfikacji),
- zawartość taga FLD, tag HTML zawierający tekst paragrafu w XHTML.
Pliki powiązane z dokumentacją są umieszczone w podfolderze FILE katalogu xml wyodrębniania. Nazwa pliku zbudowana jest w następujący sposób:
COD_LAN_TYP_LEV_SUBLEV_LIG_NOMFICHIER_LGCLE.EXT, gdzie:
- COD_LAN_TYP_LEV_SUBLEV_LIG zbudowany jest na podstawie powiązanego klucza pliku w tabeli ADOCBLB (ma to na celu zapewnienie unikalności nazwy),
- LGCLE zawiera długość poprzedniego klucza umożliwiając prawidłowe wyodrębnienie kodu dokumentacji,
- NOMFICHIER i EXT odpowiadają nazwie pliku (nazwie i rozszerzeniu), jeśli wskazano ją w ADOCBLB lub nazwie złożonej ze znaków IMG wraz z 3-znakowym numerem pozycji (poprzedzonym przez zera, jeśli jest to konieczne) oraz z rozszerzeniem .jpg.