General parameters > Chapter Supervisor > Parameter DIRDOC (Final doc directory) 

This setup is used to define the directory where the documentation should be generated. It should be noted that this directory must exist beforehand. The following subdirectories will be used (they will be created if they do not exist yet):

  • FCT  (function help directory)
  • OBJ (object help directory)
  • L4G (language help directory)
  • MCD (dictionary help directory)
  • INSTALLATION (directory of the help relating to the installation procedures)
  • FLD (field help directory)
  • CONSOLE (directory of the help on the administration console).

If need be, an XML directory must also be created, if XML format documentations need to be extracted.

This setup can contain the % character.  Upon help creation, this character is replaced by the language code corresponding to the generation language selected. This is used to generate helps in several languages by separating the created files in different directories. In case of an HTML generation, this character is replaced by the iso code present in the language codes table for the needed language if it exists, otherwise it is replaced by the language code.

This setup can contain a maximum of 250 characters.

The directory can be entered under these 4 different formats:

  • Locally on a client workstation: #@C:\TEMP
  • On the application server. Ex: /app/produits/solution/DOSSIER/tmp
  • On a distant server. Ex : aydaix05:2050@/app/produits/solution/DOSSIER/tmp
  • On a volume of the application server. Ex: [TMP]/repertoire_personalise

Warning: The use of volumes is only possible if the tree structure of the volume is included in the tree structure defined in the SANDBOX so that the Runtime can allow Reading/Writing in this directory.

Level of localization/Global variable

This parameter is defined at the level User.It belongs to Chapter SUP (Supervisor) and the Group DOC (Documentation),The following parameters are also associated with this chapter and group :

The global variable GDIRDOC is associated with it.

Functions concerned

The following functions are associated with this parameter :

 Translations > Documentation > Extract documentation

 Translations > Documentation > Import documentation

 Translations > Documentation > Documentation workbench

 Development > Data and parameters > Documentation > Documentation