Files

We're done with content, but still need to put our files in their final locations.

Final Commit

Perform a final commit to GitHub. You should change the version to 1.0 in the DynaDoc script file if this is the first public release of a document.

Output

  1. Run the Glossary on your project to generate the necessary Glossary htm files.
  2. Run the DynaDoc script on your project to generate the final out file.
  3. On the main DynaDoc page where the button to generate the document is, there is a "Publish" link. This will copy html, images, javascript, and other output files to a publish directory. By default this will be in www/publish
  4. Your final publish directory should have an html folder, and images folder if you included any images, a javascript folder if you included any javascript and an index.html file.

Self Extracting Archive

For ease of use, we also want to create an archive of the project output that automatically extracts itself.

  1. Navigate to your project folder in dynadocs publish directory. This is the parent folder that contains the html, images, and javascript folders.
  2. Right click it and select 7-Zip->Add to Archive.
  3. Leave all of the options as is, but check the box next to "Create SFX archive."

Add Files to Build

The new document must be added to the software build that is distributed with new systems. The build shipped on new systems is kept on a flash drive by support. If your document needs to be added to the build, contact support to update the build.

Upload Files to Web


VideoRay Documentation Only

[ Help us improve this document ]

Document Creation Guide, Version: 0.1
Copyright © 2014, VideoRay LLC - The Global Leader in Micro-ROV Technology