Tłumaczenia > Dokumentacja > Ekstrakcja dokumentacji 

Funkcja ta umożliwia wyodrębnienie wszystkich paragrafów dokumentacji w formie plików XML.

Możliwe są trzy opcje wyboru:

  • Eksport dla ponownego tłumaczenia: ten wybór umożliwia wyodrębnienie już przetłumaczonej dokumentacji, tzn. takiej, która nie wyświetla się w planie pracy, ale która wymaga ponownego tłumaczenia, ponieważ dokonano w niej zmian bez zmiany daty weryfikacji. Nagłówki są w języku docelowym wyodrębniania, a zawartość dokumentacji jest w języku referencyjnym. Dokonywana jest kontrola zgodności między językiem docelowym a referencyjnym, ale nie ma kontroli zatwierdzania. Opcja ta umożliwia w ten sposób ponowne przetłumaczenie dokumentacji przy użyciu oprogramowania do tłumaczenia;
  • Eksport dla tłumaczenia: wybór ten opiera się całkowicie na planie pracy. Umożliwia wygenerowanie dokumentacji do tłumaczenia przy użyciu dowolnego oprogramowania do tłumaczenia. Nagłówki są w języku docelowym wyodrębniania, a zawartość dokumentacji jest w języku referencyjnym. Dokonywana jest kontrola zgodności między językiem docelowym a referencyjnym, jak również kontrola zatwierdzania. Opcja ta umożliwia wyodrębnienie np. wszystkich zatwierdzonych dokumentacji do przetłumaczenia na dany język;
  • Eksport wg języka: wybór ten umożliwia wyodrębnienie jednego lub wielu języków. Nagłówki i zawartość dokumentacji są w języku docelowym eksportu. Opcja w tym wyborze umożliwia wybór dokumentacji „Zatwierdzonych”, „Niezatwierdzonych” i „Wszystkich”. Wybór ten umożliwia wyodrębnienie wszystkich języków, np. w celu obliczenia słów.

Aby dokonać eksportu w celu przetłumaczenia oprogramowania do tłumaczenia plików XML, należy skorzystać z funkcji narzędzie dokumentacji.

Wyodrębnianie odbywa się domyślnie w utworzonym folderze XML, a jeśli go nie ma, w katalogu dokumentacji zdefiniowanym przez parametr DIRDOC.

Funkcja integracji dokumentacji umożliwia dokonanie odwrotnej operacji.

    Warunek

    SEEREFERTTO Odniesienie do dokumentacji Implementacja

    Zarządzanie ekranem

    Karta Ekran wpisów

    Prezentacja

    Na ekranie wprowadzane są kryteria wyboru w celu zdefiniowania, co powinno zostać wyodrębnione, biorąc pod uwagę, że wyeksportować można:

    • dokumentację dla funkcji lub obiektu funkcjonalnego lub obiektu (zdefiniowaną przez jej typ),
    • dokumentację dla pola (którą można wyodrębnić osobno lub w połączeniu z dokumentacja funkcji. Pomoc dla pola zawarta w pomocy dla funkcji jest wtedy wyodrębniana w formie osobnych plików.),
    • wszystkie powiązane pliki, które są wyodrębniane takimi, jakie są.

    Zamknij

     

    Pola

    Na tej karcie występują następujące pola :

    Eksport

    • Do przetłumaczenia (pole EXTRETRA)

    Eksport dla ponownego tłumaczenia: wyodrębnienie w celu ponownego przetłumaczenia dokumentacji na język docelowy według języka referencyjnego. W takim przypadku data ważności nie jest sprawdzana.

    • Do tłumaczenia (pole EXTTRA)

    Eksport dla tłumaczenia: wyodrębnianie w celu przetłumaczenia dokumentacji na język docelowy według języka referencyjnego.

    Definiuje język tłumaczenia.

    Definiuje kod języka, na podstawie którego odbędzie się tłumaczenie.

    Eksport

    • Wg języka (pole EXTLAN)

    Eksport wg języka: proste wyodrębnianie wg jednego lub wielu języków wyodrębniania.

    • Wszystkie języki (pole ALLLAN)

    Jeżeli pole to jest zaznaczone, to wszystkie języki są brane pod uwagę podczas tej operacji.

    Służy do określenia kodu języka, który ma zostać przetworzony (jeżeli jest niepowtarzalny).

    • Zestaw również w języku referencyjnym (pole ENLANREF)

     

     

    • Zawarta dokumentacja (pole VALDOC)

     

    Eksport do XML

    • Katalog (pole REPERT)

    Wskazuje katalog, z którego zostanie dokonany eksport dokumentacji zakładając, że pomoc do pola zostanie wyodrębniona w podfolderze FLD, a powiązane pliki w podfolderze FILE.

    Domyślnie parametr użytkownika DIRDOC jest używany w celu zainicjalizowania tego katalogu.

    Format wprowadzania katalogu wyodrębniania odbywa się w 4 formach:

    • Na lokalnej stacji klienta, np.: #@C:\TEMP
    • Na serwerze aplikacji, np.: /app/produits/solution/DOSSIER/tmp
    • Na serwerze zdalnym, np. aydaix05:2050@/app/produits/solution/DOSSIER/tmp
    • Na woluminie serwera aplikacji, np.: [TMP]/personalizowany_katalog

    UWAGA: użycie woluminów jest możliwe wyłącznie, jeśli struktura drzewiasta woluminu stanowi część struktury drzewiastej zdefiniowanej w SANDBOXIE tak, aby opcja Runtime dopuszczała odczyt/zapis w tym katalogu.

    • Podkatalog po typie (pole REPERTTYP)

    Wskazuje, czy podkatalog wg typu dokumentacji zostanie użyty w celu połączenia z katalogiem głównym, na podstawie którego wyeksportowana zostanie dokumentacja.

    Pomoc do pola powiązana z dokumentacją eksportowana jest do podkatalogu wg typu, a następnie FLD.
    Powiązane pliki są wyodrębniane do podkatalogu wg typu, a następnie FILE.

    • Do wszystkich grup (pole ALLCREGRP)

    Pole to umożliwia wybór między:

    • Przetworzeniem wszystkich dokumentacji lub pomocy dla pól, niezależnie od grupy przynależności użytkownika.
    • Przetworzeniem wyłącznie dokumentacji lub pomocy dla pól, których grupa użytkownika odpowiada grupie autora dokumentacji, która znajduje się w tabeli AOBJGRPDEV.

    Wybór

    • Wszystkie typy (pole ALLTYP)

    To pole wyboru należy zaznaczyć, aby uwzględnić wszystkie typy. Aby wykonać proces dla pojedynczego typu należy pozostawić puste.

    Służy do określenia typu dokumentacji, która ma zostać przetworzona (jeżeli jest niepowtarzalny).

    • Wyłącz typy APT, AT*, AML (pole EXCTYP)

     

    • Wszystkie kody (pole ALLCOD)

    Jeśli to pole jest zaznaczone, dla operacji uwzględniane są wszystkie kody, jeśli nie uwzględniane są wyłącznie kody odpowiadające wprowadzonemu zakresowi.

    • Kod od (pole CODDEB)

    Służy do określenia zakresu początkowego dla kryterium, co umożliwi ustalenie, jakie dane mają zostać uwzględnione przez operację.

    • Do (pole CODFIN)

    Służy do określenia zakresu końcowego dla kryterium, co umożliwi ustalenie, jakie dane mają zostać uwzględnione przez operację.

    • Wszytskie kody czynności (pole ALLACV)

     

     

    • Wszystkie moduły (pole ALLMOD)

     

    • Moduł (pole MODULE)

     

    • Wyklucz moduł (pole EXCMOD)

     

    • Moduł (pole MODTOEXC)

     

    Opcje

    • Pliki powiązane (pole HLPFIL)

    Jeśli to pole jest zaznaczone przetwarzane są wyłącznie pliki powiązane z dokumentacją. Te plik to zazwyczaj obrazy.

    • Pomoc dla pola powiązanego (pole HLPLNKFLD)

    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.

    • Pomoc dla pola (pole HLPFLD)

    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ę.

    • Od (pole FLDDEB)

    Służy do nadania zakresu przetwarzania pola pomocy pomiędzy dwoma słowami kluczowymi.

    • pole FILLER6

     

    • Do (pole FLDFIN)

     

    Zamknij

     

    Komunikaty o błędzie

    Jedynymi komunikatami o błędach są komunikaty ogólne.

    Użyte tabele

    SEEREFERTTO Odniesienie do dokumentacji Implementacja

    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.