Extract documentation
This function is used to extract all the paragraphs of a documentation in the form of an XML file.
There are 3 possible extraction choices:
- Extraction for (re)translation: This choice makes it possible to extract a documentation that has already been translated and which, as a consequence, does not appear in the documentation workbench, but which needs to be (re)translated because modifications have been introduced while the validity date has not been updated. The headers are in the target extraction language and the contents of the paragraphs are in the reference language. The consistency checks between target language and reference language are conducted but not the validation checks. This option makes it possible to retranslate documentations using the translation software.
- Extraction for translation: This choice is totally identical to what is provided by the documentation workbench. It is used to extract documentations in order to translate them using any translation software. The headers are in the target extraction language and the contents of the paragraphs are in the reference language. The consistency checks between target language and reference language are conducted as well as the validity checks. For instance this option makes it possible to extract all the validated documentations to be translated into a given language.
- Extraction by language: This choice is used to extract all the paragraphs in one or several languages. The headers and content of the documentations are in the target extraction language. An option also enables the selection of the "Validated" or "Not validated" documentations, or "All" of them. This choice is made to extract all the documentations in one specific language, for instance, to count the words.
To extract a documentation for translation via a translation software able to manage XML files, the documentation workbench needs to be used.
The extraction is performed in a default xml directory, created, if it does not exist, in the documentation directory defined by the DIRDOC setup.
A documentation import function is used to perform the reverse operation.
Prerequisite
Refer to documentation Implementation
Screen management
Entry screen
Presentation
The selection criteria are entered in the screen in order to define what must be extracted, remembering that the following elements can be extracted:
- the functional or functional object documentation (defined by its type),
- the field documentation (that can be extracted separately, or at the same time as the functional documentation; the field helps that are part of the functional help are then extracted as separate files),
- any linked file that is then extracted as it is.
Close
Fields
The following fields are present on this tab :
Extraction
| Extraction for (re)translation: extraction for (re)translation of a document in a target language and according to a reference language. In this case the validity date is not tested. |
| Extraction for translation: extraction for translation of a document in a target language and according to a reference language. |
| Defines the translation language. |
| Defines the code of the language from which the translation will be done. |
Extraction
| Extraction by language: simple extraction according to one or more extraction languages. |
| If this box is checked, all languages are taken into account by the operation. |
| It defines the language code to be processed (if it is unique). |
|
|
|
|
|
|
XML extraction
| It indicates the directory from which the documentation export will be carried out, remembering that the field helps will be extracted to the FLD sub-directory, and the linked files to the FILE sub-directory. The DIRDOC user parameter is used by default to select this directory. The extraction directory can be entered under these 4 different formats:
|
| Specifies whether the sub-directory by documentation type will be used to be concatenated with the main directory from which the documents are exported. Linked field helps will be extracted to the sub-directory by type then to FLD. Linked files will be extracted to the sub-directory by type then to FILE. |
|
|
Selections
| Select this check box to include all types. To run this process for a single type, leave clear. |
| It defines the type of documentation to be processed (if it is unique). |
|
|
Options
| Select this check box to include all codes. To run this process for a single or a range of codes, leave clear. |
| It is used to specify a start range for the criterion in order to be able to determine the data to be taken into account by the operation. |
| It is used to specify an end range for the criterion in order to be able to determine the data to be taken into account by the operation. |
|
|
Block number 6
|
|
|
|
Block number 7
|
|
|
|
|
|
|
|
Block number 8
| If this box is checked, the files linked to the documentation are also processed. Usually, these files are images. |
| If this box is checked, the field helps relating to the function or object documentation that are also processed are included. To find out which field helps need to be processed, the screens associated with the corresponding documentation paragraphs can be explored. |
| If this box is checked, the field documentation is also processed. |
| It is used to give a range for the processing of the field help between two key words. |
|
|
Close
Appendix: format of the files created
The format of the XML file of the function or object documentation, as it can be found in the xml directory, is as follows:
- a standardized xml header,
- a DOC tag with the TYPE and NAME attributes (that define the type and code of the documentation),
- inside the DOC tag, for each paragraph, a PAR tag with the LAN, LEV, SUBLEV, PAR, MSK, STY, VLDDAT, VLDFLG, ACT and MOD attributes (that define the language, level, sub-level, paragraph code, screen, style, validity date, validity flag, activity code and module),
- inside the PAR tag, a TIT tag is given for the title of the paragraph (if any),
- inside the PAR tag, an HTML tag contains the text of the paragraph in XHTML format.
The field documentation files are located in the FLD sub-directory of the xml extraction directory. The format is as follows:
- a standardized xml header,
- an FLD tag with the NAME, LAN, MOD, GEN, LNKHLP, LNKORD, CREDAT, UPDDAT attributes (that define the name, language, module, generic attribute of the documentation, linked help, link, creation date and modification date),
- Inside the FLD tag, an HTML tag contains the text of the paragraph in XHTML format.
The files linked to a documentation are located in the FILE sub-directory of the xml extraction directory. The name of the file is constructed in the following fashion:
COD_LAN_TYP_LEV_SUBLEV_LIG_NOMFICHIER_LGCLE.EXT, where:
- COD_LAN_TYP_LEV_SUBLEV_LIG is generated from the the key of the linked file in the ADOCBLB table (this aims at ensuring the name unicity).
- LGCLE contains the length of the previous key in order to be able to correctly extract the documentation code.
- NOMFICHIER and EXT correspond to the name of the file (name and extension) if it is mentioned in the ADOCBLB table, or to a name composed of "IMG" characters, followed by the line number on 3 characters (prefixed with zeros, if necessary), then followed by the ".jpg" extension.