Documentation

DOC xPress Server ›› Features ››
Parent Previous Next

Documentation


The documentation page will show available Solutions and Documents. The top window will show all available solutions available on the server. The available solutions can be sorted by Date Created, Name, Last Refreshed, Last Snapshot, and Last Update. The solutions can then be sorted in Ascending or Descending order.


Table of Contents

  Generating Documentation

  Viewing Documentation

  In-Line Data Dictionary


Important Note:

Documentation can be customized by editing the DefaultTemplates, however these are advanced operation and may result in unexpected documentation outputs for all users moving forward. 


As such, it is recommended to always save a copy of the default templates before proceeding in case the changes negatively impact your documentation.


It is also important to note that changes to the DefaultTemplates will only be applied to newly generated documentation. Previously generated documentation that used the old templates will not be updated to reflect the newly edited templates.


The bottom window will list the recent documents created. These documents can be sorted by Document Title, Date Created, and Solution Name. On each document available you will be able to see a preview of what items are available. You will notice that the document will list the Solution it belongs to, the date and time it was created, as well as the available formats.