Extract documentation
This function is used to extract all the paragraphs of a document in the form of an XML file.
It is necessary to use the documentationn workbench to extract in order to carryout the transaction with the software used to translate the XML files.
The extraction is performed in a default xml directory, created, if it does not exist, in the documentation directory defined by the DIRDOC parameter.
A documentation integration 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 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
|
|
| Defines the translation language. |
|
Extraction
|
| 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, not forgetting that the field helps will be extracted to the FLD sub-directory, and the linked files to the FILE sub-directory. |
|
|
|
Selections
| If this box is checked, all types are taken into account by the operation. Otherwise, the type to be taken into account must be entered. |
| It defines the type of documentation to be processed (if it is unique). |
|
|
| If this box is checked, all the codes are included in the operation (otherwise, only those codes corresponding to the entered ranges will be taken into account). |
| 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. |
|
|
|
|
|
|
|
|
|
|
|
|
Options
| 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 constructed from the the key of the linked file in the ADOCBLB table (this is to ensure the uniqueness of the name).
- 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.