Folder Structure

Creating an organized folder structure is critical to establishing an efficient and productive environment. Typically, there will be a folder set for each document source, and a another folder set for each output.

An example source folder set is illustrated here:

sourcePath/project_name
    |-- css
    |-- glossary
    |-- htm
    |-- images
    |-- javascript
    |-- My_Notes
    |-- pdf
    |-- videos

An example output folder set is illustrated here:

outputPath/project_name
    |-- css
    |-- html
    |-- images
    |-- javascript
    |-- My_Notes
    |-- pdf
    |-- videos

Items in these folders should be self evident based on the names of the folders.

DynaDoc convention is to name source files ".htm," and output files ".html." The output folder structure would be similar to the above, but the "htm" folder is named "html."

The DynaDoc script would typically be stored in the project_name folder.


VideoRay Documentation Only

[ Help us improve this document ]

DynaDoc Operator's Manual, Version: Version: 1.00.00
Copyright © 2014, VideoRay LLC - The Global Leader in Micro-ROV Technology