Publishing

After completing the edit and review cycles, we have to get our document into a state where others can actually access it. The following steps are required.

Staging

  1. Run dynadoc_manage.php using the appropriate category link on the home page.
  2. Set the version number for this release in the script file.
  3. Run dynadoc.php using the projectName button to generate the document.
  4. Run LinkChecker.exe in Windows to validate links (fix any broken links and start over). The Google, pdf and zip file errors are acceptable at this time.
  5. Run dynadoc_prepare.php using the Prepare button. This will execute the following programs. You can run these programs individually if you prefer.
    1. Run dynadoc_orphan.php using the Find Orphans button to check for unused (orphan) .htm files and clean up and unnecessary source files.
    2. Run dynadoc_clean.php using the Clean HTML to delete all html files in the html folder.
    3. Run dynadoc_glossary.php using the Glossary button to generate the glossary.
    4. Run dynadoc.php using the projectName button to generate a release candidate with the glossary included.
    5. Run dynadoc_stage.php using the Stage button to create the distribution set of files. This will copy html, images, javascript, and other selected folders and files to the staging folder. By default this will be in www/stage.
  6. Review the release candidate for any errors (fix any errors and start over at "Run dynadoc.php").
  7. Create the pdf of the print file.
  8. Create the self extracting zip file of the staged folder.
  9. Publish the distribution set to the distribution locations.
  10. Commit and Push the repository to GitHub to save the state of the project.
Document Creation Manual, Version: 1.00.00
Copyright © 2022, VideoRay LLC - The Global Leader in Micro-ROV Technology