Configuring DynaDoc

All DynaDoc PHP programs can be accessed directly, or through dynadoc_manage.php. dynadoc_manage.php is preferred and provides an easy to use interface with buttons and links on the home and categories pages. Information about creating a new dynadoc environment or setting up your computer to work in an existing DynaDoc environment is provided below.

Creating a New DynaDoc Project Environment

If you are setting up your computer for working in an existing DynaDoc environment (when you have cloned the www repository), you can skip this section.

If starting from scratch, you will need to create a category list file (dynadoc_create.lst) and a dynadoc_catName.lst file for each category. An example category list file is shown below:

    categoryName|displayName|
    _rov|ROVs|

The first line is a header that describes the record format. The second and subsequent lines include a category mnemonic and display name. In this example, _rov is the catName and ROVs is the display name. This file must be created and updated manually to add categories. At least one category must exist, and the trailing "|" is required.

An example category project list file (dyandoc_rov.lst) is shown below:

    Name|Project|Source Dir|Out Dir|List?|

The first line is a header that describes the record format. Additional lines are automatically created by dynadoc_create.php.

• Name is the formal name of the project.
• Project is the name of the project's script.
• Source Dir is the name of the folder for the project.
• Out Dir is the name of the folder for the output. If left blank, it will default to the Source Dir. If defined, it can be used to create separate outputs from the same source.
• List? is either blank or any character. If a character is used, DynaDoc will process a list of documents rather than a single document. Each project script name is placed on a separate line in the list file. The first line of the list file should be blank.
• The trailing "|" is required.

If Name preceded by a space, this row will be indented when displayed. This may be helpful for projects that use multiple concurrent versions in separate html folders. If Name is preceded by a +, a second "view" link we be created to the html folder. See the Advanced Techniques and Multiple Versions Example sections for more information.

The easiest way to use dynadoc_manage.php is to create a link to it in an HTML file such as index.html. An example line in an index.html file is shown below:

    <a href="dynadoc_manage.php?category=_rov">ROVs</a>

Additional lines can be created for each category. This file must be created and updated manually.

Setting Up Your Computer for Working in an Existing DynaDoc Environment

If you are creating a new DynaDoc environment, you can skip this section.

If you are setting up your computer for working in an existing DynaDoc environment, DynaDoc and its utilities are included in the www repository. DynaDoc will already be configured for all of the projects that exist at the time you clone the www repository to your system and will be updated each time you "pull" the www repository to your system. This does not include the actual projects. If you want to edit an existing project, you will need to clone the project repository to your system (as described in the previous section about Git Repository Creation / Cloning). This only needs to be done once for each project. Then as you make changes to the project, you will "push" your changes to the project repository on GitHub.