Development > Data and parameters > Documentation > Documentation links 

This function is used to create documentation links used in the documentation generator. These links complete the dictionary information in order to automates notably the annexes and the prerequisites of the documentation. An annex documentation specifies for each documentation type what links are available and what are the documentation paragraphs loading them.

    Prerequisites

    SEEREFERTTO Refer to documentation Implementation

    Screen management

    The header section contains a documentation type an a corresponding code. The type is attached to a link grid.

    Entry screen

    Presentation

    Each line of the table represents a link used in the documentation generation.

    Close

     

    Fields

    The following fields are present on this tab :

    Block number 1

    This type, defined in table 910, defines the documentation type for which links are being defined.

    • Module (field MODULE)

    [object Object]

    • Code (field COD)

    This code defines the code for the documentation to which the links are attached.

    An activity code is used to:

    • make optional an element in the dictionary if the value associated with the activity code is null.
    • identify the specific/custom elements if they are marked with a code starting with X, Y or Z.
    • size a maximum number of lines when the activity code marks elements from a grid.

    In this way, if the activity code is disabled, the marked element will not be useable, and the associated code (if any) will neither be generated nor can be activated.

    Grid Links

    • Line number (field NUM)

     

    This type of link makes reference to miscellaneous table 913. According to the documentation type different links are authorised.

    • Key (field CLELNK)

    The key for the link is linked to the type previously entered. For example, when the type ADP type (parameter) is used, this field is used to enter the parameter code or the name of a local variable. If the type ATB (table) is used, the code for a table in the database is used. In most cases, a selection window associated with the context opens so that a choice can be made from the possible codes. The list of possible links can be found in the documentation annex.

    • Description (field INTLNK)

    Title associated to the previous code.

    Close

     

    Specific Buttons

    The following fields are included on the window opened through this button :

    Block number 1

    • field OBJET

     

    • field CLES

     

    Block number 2

    • From folder (field DOSORG)

    Indicate the folder from which the record is going be copied. The possible syntaxes are described in the dedicated appendix.

    • All folders (field TOUDOS)

    This option is used to copy the record to all the folders defined in the dictionary (ADOSSIER table from the current solution).

    • To folder (field DOSDES)

    Indicate the folder in which the record is going be copied. The possible syntaxes are described in the dedicated appendix.

    Close

    This button is used to copy the record definition from or to another folder.

    Menu Bar

    Option / Checking links

    The link verification option goes through the existing links and sends a warning message if:

    • the object does not exist,
    • the module differs from the object,
    • the documentation does not exist,
    • the activity code differs from the object.

    Option / Purging links

    The link purge option is used to delete links to:

    • a documentation that does not exist (the code of the header documentation does not exist),
    • an object (links belonging to the link grid).

    Error messages

    The only error messages are the generic ones.

    Tables used

    SEEREFERTTO Refer to documentation Implementation