To configure the Documentation server component, enter the mandatory parameter:
If you choose to publish your documentation via an Apache server installed on the same machine as the documentation server, you can enter the Apache installation path parameter. When this setup is entered, the console adds an alias (/AdxDoc_[DocComponentName]) in the httpd.conf of the Apache server.
If the Documentation Server component is located on a Unix server, you must manually restart the Apache server to take this new alias into account.
For the SAFE X3 Client Server client to access the documentation via the Apache server of the documentation server, the value of the Root access for the documentation parameter needs to be: http://[MachineName][HTTPPort]/AdxDoc_[DocComponentName]
Once the parameter(s) is/are entered, click Configure.
You can check the access to the documentation: click Doc. TestClient or Doc. testWeb.
If the application is destined to be used via Web, the documentation format must be ‘decompressed’. To change this format, click “Decompress (HTML)”. button. After the documentation has been decompressed, the value of the Documentation decompressed parameter changes to Yes.
The documentation installed on a UNIX server is always supplied in the decompressed format. It is not useful to perform a Decompress/Compress action.
Important note: no space in the documentation server installation path.
If the application is destined to be used via Web, the documentation format must be ‘decompressed’. To change this format, click "Decompress (HTML)". After the documentation has been decompressed, the value of the Documentation decompressed parameter changes to Yes.
This operation is used to extract all the documentation in HTML format from the CHM file. Once the Documentation decompressed parameter changes to Yes, and thus the generated HTML files as well, it is no longer possible to go back to the compressed documentation status.
The documentation can be decompressed at any time using the Decompress (HTML)button. This operation will nevertheless overwrite the existing HTML files if the documentation has already been decompressed.
It is also possible to "compress" the documentation in order to create a CHM file from the existing HTML files. This operation overwrites the original CHM file and replaces it with the new CHM file generated from the existing HTML files. It is not possible to compress a Documentation that has has not been broken down. To compress a documentation, click Compress (CHM). In order for the CHM generation to take into account new documentation HTML files, these must be indexed in the current documentation. As a matter of fact, the CHM generator works in "spider" mode and finds the new documentations by following the HTML links of the current documentation. Simply add the links in the HTML document of the general index.
Note: These operations can take a while if the documentation is installed in several languages. In effect, the compression or breaking down of the documentation is applied to all the languages installed for the documentation.
To publish the solution on the documentation server, click Documentation Server and then Publish.
Click Add in the toolbar and select the solution to publish in the list of the solutions managed by the console.
Following the publication, the documentation is automatically available in the help menu of the SAFE X3 client.
To update the documentation server, follow these steps:
Note: During the configuration, all the published solutions should be accessible in order to update the documentation information. If some solutions cannot be accessed or are locked, warnings will be sent upon configuration of the Documentation server component.
To unconfigure the Documentation Server component, follow the steps described below: