Architecture
Dynadoc consists of a series of PHP programs and configuration files that are used to generate and administer projects. DynaDoc programs are designed to be used with arguments, but for easy execution, html files can be created using links or buttons and dynadoc_manage.php is designed to call some of the other programs.
The DynaDoc root folder of the web server should contain these files and each project requires its own folder in the same root.
Document projects can be arranged in categories to make management and operations easier.
Programs include:
- dynadoc.php - The primary program for generating documents
- dynadoc_checklist.php - create a checklist from a Standard Operating Procedures manual
- dynadoc_clean.php - delete all files in the html folder
- dynadoc_create.php - create new projects
- dynadoc_edit.php - allow editing HTM files in the browser (any editor may be used)
- dynadoc_form.php - run dynadoc using a form for input
- dynadoc_glossary.php - generate a page with a linked glossary/index (dynadoc_glossary.php runs dynadoc_clean.php)
- dynadoc_images.php - helps manage document images
- dynadoc_manage.php - facilitates launching DynaDoc programs
- dynadoc_orphan.php - find content blocks (HTM files) that are no longer used in the project
- dynadoc_prepare.php - run orphan, clean, glossary and stage
- dynadoc_projects.php - display a list of existing projects
- dynadoc_stage.php - prepare a document file set for publishing
- dynadoc_view.php - create navigable exploded parts drawings
- dynadoc_vital.php - create an interactive diagnostic troubleshooting tree
- dynadoc_zip.php - create a self extracting zip file of the project
Configuration files include:
- dynadoc_catName.lst - projects in the catName category
- dynadoc_create.lst - categories
- dynadoc_folders.lst - empty folders to create in the project folder
- dynadoc_required.lst - required folders for publishing
- dynadoc_stage.lst - standard folders and files to be staged
- dynadoc_type.lst - document types
Additional information about the DynaDoc environment and working with document projects can be found in the Document Creation manual.
|
