Product Documentation
Doc Assistant User Guide
Product Version 2.02, May 2023

How to use CSF search mechanism

Doc Assistant uses the CSF search mechanism to open documentation from custom/user-created help forms. User needs to define their tag files and directory in which these files exist in the way as explained below.

  1. User creates custom help documentation html/s.
  2. User creates <My_Helpdoc>.tgf file which contain entries to custom help documentation html/s mentioned in point 1 according to the format specified in Working with a Tag File
  3. The help documentation html/s and related <My_Helpdoc>.tgf file should be placed in <My_Helpdoc> directory.
  4. <My_Helpdoc> directory should be placed inside doc directory so directory structure looks like <ANY_PATH>/doc/<My_Helpdoc>/...
  5. User can have multiple <My_Helpdoc> like directories in doc folder corresponding to different help forms.
  6. Create a csfLookupConfig named ASCII file which contain entries of all <MY_Helpdoc>.tgf files as
    INCLUDE <MY_Helpdoc1>.tgf
    INCLUDE <MY_Helpdoc2>.tgf
    ..
    ..
    ..
  7. In the setup.loc file located in <INST_DIR>/share/cdssetup/setup.loc add the path where csfLookupConfig file created in above point is located. Also add the path of all <My_Helpdoc> directory in the setup.loc file as 
    <ANY_PATH>/doc/<My_Helpdoc1>
    <ANY_PATH>/doc/<My_Helpdoc2>
    ..
    ..
  8. When user calls a non Cadence supplied <tool>:<tag> from custom help form, it should now use the CSF mechanism to find the <tool>.tgf file and then open the corresponding html entry against that <tag> entry in the <tool>.tgf file.


Alternatively user can also place such created <MY_Helpdoc> directory under the other two locations for custom/user-created documentation if user don’t want to use CSF mechanism.

User must place his documentation in

  1. <doc_assistant_install_directory>/local/doc directory.
  2. $HOME/doc directory OR %userprofile%\doc directory for Windows.




 ⠀
X