Online Help

The ClassiX® online documentation is based on HTML.
There is an online help for:

Other than the general path indication in ClassiX® (CX_ROOTDIR), it is possible to define the path CX_HELPROOT especially for the online help. This path specification can be specialized for the documentation on application (CX_APPSWH_HELP), the scripting language InstantView® (CX_IV_HELP) and the company model CyberEnterprise® (CX_CE_HELP).

 

Online Documentation

The environment variable CX_HELPROOT contains the basic path to the ClassiX online documentation (Information Center).
The environment variable CX_HELPROOT_LOCAL contains the basic path to the local customized documentation. Basic path means the documentation directory - the directory, which contains the sub-directories "de" and "en". The single directories for the AppsWarehouse documentation can be found under this path (in the sub-directory "CX_LANG/AppsWH!), as well as for the CyberEnterprise documentation ("CX_LANG/CyberEnterprise"), InstantView ("CX_LANG/InstantView") and the documentation on ClassiX®' problem reports ("CX_LANG/Error").

The following directory types have been tested as CX_HELPROOT content with the specified browser. In general, urls which have been specified as  CX_HELPROOT can also indicate protocols which have not been listed. This however, has not been tested and is therefore not recommended!

Directory type Example Firefox
(version 2.0.0.3)		 Internet Explorer
(version 7.0.5730.11)
local absolute path (with drive indication) c:\classix\doc yes yes
UNC network path (windows network) \\computer1\classix\doc yes yes
file url which represents a local path file:///classix/doc yes yes
file url which represents a windows network path file://///computer1/classix/doc yes yes
http url http://doc yes yes

A http url doesn't work in combination with CX_HELPROOT_LOCAL and CX_APPSWH_HELP, since the HTT protocol doesn't respond to file requests with positive feedback, CX_HELPROOT_LOCAL gets skipped and CX_HELPROOT is directly searched for the help file.

It needs to be considered, that ClassiX® replaces some special strings in this environment variable, to reach the actual documentation location: If "CX_LANG" is located at the end of the CX_HELPROOT content, or "CX_LANG" is directly followed by a backslash, "CX_LANG" will be replaced by the current language (such as "de"). If "CX_ROOTDIR" is at the start of CX_HELPROOT, the string will be replaced by the content of the environment variable CX_ROOTDIR. 

Special Application Online Documentation (AppsWarehouse® Modules)

A documentation file can be specified for each Module. Derived modules inherit the base module documentation file. Window objects which belong to the module refer to the module HTML file via topic specification or they explicitly define another HTML file (with or without topic specification).

In case there is no path specification in front of the file name, the HTML file will be searched as follows:

  1. If the environment variable CX_APPSWH_HELP=p1;p2;... has been defined, the specified paths are searched in the according order. CX_LANG can be specified as a sub-directory in the path specifications p1, p2, ...: according to the current language setting, CX_LANG is replaced by a 2-digit language identifier. The possibility of specifying more than one path makes it easy to divide the documentation into general and customized,
    e.g. CX_APPSWH_HELP=%CX_HELPROOT_LOCAL%\CX_LANG\AppsWH\PROJEKT;%CX_HELPROOT%\CX_LANG\AppsWH
  2. If the environment variable CX_APPSWH_HELP has not been defined whereas the environment variable CX_HELPROOT has been defined, the HTML file gets searched in
    CX_HELPROOT\L0L1\APPSWH.  L0L1 stands for the two-digit identifier of the current language.
  3. If neither CX_APPSWH_HELP nor CX_HELPROOT have been defined, the search will take place in
    CX_ROOTDIR\DOC\L0L1\APPSWH. L0L1 again stands for the two-digit identifier of the current language.

It depends on the window object O, its parameter objects and its module, which information is going to be displayed when pressing F1 for the currently focused window object O:

window object O parent of O module text display
- - - nothing
- - HELP("A.htm") start of 'A.htm'
- HELP(topic1) HELP("A.htm" 'topic1' in 'A.htm'
HELP(topic2) HELP(topic1) HELP("A.htm" 'topic2' in 'A.htm'
HELP("B.htm~topic3" HELP(topic1) HELP("A.htm" 'topic3' in 'A.htm'

The following picture shows again, in which order the help information is searched (red arrow):


 

Spec. InstantView® Documentation

The ClassiX® system holds a fixed assignment between language constructs and HTML files with the according documentation. The file location gets controlled with the following environment variables:

  1. If the environment variable CX_IV_HELP=p1;p2;... has been defined, the specified paths are searched in the according order. CX_LANG can be specified as a sub-directory in the path specifications p1, p2, ...: according to the current language setting, CX_LANG is replaced by a 2-digit language identifier. The possibility of specifying more than one path lets the InstantView developers maintain a personal documentation version extended by notes and comments in a separate directory.
  2. If the environment variable CX_IV_HELP has not been defined whereas the environment variable CX_HELPROOT has been defined, HTML file gets searched in CX_HELPROOT\L0L1\IV.  L0L1 stands for the two-digit identifier of the current language.
  3. If neither CX_IV_HELP nor CX_HELPROOT have been defined, the search will take place in
    CX_ROOTDIR\DOC\L0L1\IV. L0L1 again stands for the two-digit identifier of the current language.

Editing with Eclipse, it is possible to call the InstantView® documentation about the language construct under the cursor with Ctrl-F1.
F1 calls the documentation about the command under the cursor from the monitor window command lines.

Spec. CyberEnterprise® documentation

The meta classes refer indirectly to a name of a file, which contains the according model class. This also applies to the functions entered in the MDI.

The documentation can be called from the ClassiX® system:

  represented on InstantView® level by call help
class their meta-class (object CX_META_CLASS) CX_META_CLASS::DisplayHelp()
class method MDI entry as class object  CX_VESSEL CX_VESSEL::DisplayHelp()

The following environment variables control, where these files are located:

  1. If the environment variable CX_IV_HELP=p1;p2;... has been defined, the specified paths are searched in the according order. CX_LANG can be specified as a sub-directory in the path specifications p1, p2, ...: according to the current language setting, CX_LANG is replaced by a 2-digit language identifier. The possibility of specifying more than one path lets developers maintain a personal documentation version extended by notes and comments in a separate directory.
  2. If the environment variable CX_IV_HELP has not defined whereas the environment variable CX_HELPROOT has been defined, HTML file gets searched in
    CX_HELPROOT\L0L1\CE. L0L1 stands for the two-digit identifier of the current language.
  3. If neither CX_IV_HELP nor CX_HELPROOT have been defined, the search will take place in
    CX_ROOTDIR\DOC\L0L1\CE. L0L1 again stands for the two-digit identifier of the current language.

Latest update: 2007-05-14