Requirements

DynaDoc is designed for use in a development environment and requires a web server with PHP enabled. It can be used on an externally hosted server, but this is not conducive to productive creativity and editing cycles. Apache Friends provides a free XAMPP package, which includes everything required to install a local web server with PHP enabled.

Application Requirements

In order to run DynaDoc, you will need the following:

  • Web server with PHP enabled.
  • Access to the root html folder of the web server.
  • dynadoc.php - the DynaDoc PHP script.
  • mkdoc.php - a PHP script to create a new DynaDoc project (new projects can be created manually, but this script automates the process and is extremely valuable once you create more than one document).
  • glossary.php - a PHP script to create links for the glossary/index entries.
  • extra.php - a PHP script to help find content blocks (html files) that are no longer in use
  • style_menu.css - the document uses CSS to display the navigation menu. This file controls the display of the menu and is required. The use of additional CSS is optional.

Experience Requirements

DynaDoc uses commands, scripts and content blocks. This document will provide the information needed to learn how to use these elements and the procedures required to create documents using DynaDoc.

Content blocks are HTML formatted files, so knowledge of HTML is required. However, content blocks can be created using relatively simple HTML, so an advanced knowledge of HTML is generally not required. If you want to modify the layout template, you may need advanced HTML and CSS knowledge.

PHP knowledge is not required, but may be helpful, and is required if you want to customize DynaDoc.


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