Dynadoc Project Preparation
Once the repository has been copied to your local computer, DynaDoc may need to be configured to recognize it, and if it is a new document project, the new document template materials need to be copied to the project folder. This process is automated through DynaDoc which uses the dynadoc_create.php program for these steps (dynadoc_create.php is included in the www repository).
 DynaDoc will already be configured for most of the projects that exist at the time you clone the www repository. If you are editing an existing project that is already configured, you do not need to perform these steps. If you are creating a new project, these steps will configure DynaDoc and copy the project template files.
- Ensure that XAMPP is running, and type localhost into your browser's address bar, and press enter. This should load the index file with the dynadoc category links.
- Click on the category in which you want the project to reside.
- You should see a list of various projects in that category.
- Click Create New Document Project at the top. This will display a form for you to fill out.
- Project Type: Select whether this is a new documentation project or you will be editing and existing documentation project.
- Category: This will default to the current category.
- Project Name: This will define the document's title and be displayed at the top of each page.
- Project Folder: This should be the name of the repository you created on GitHub and cloned on your local computer.
- Output Folder: This should be left blank.
- Document Type: This should be "Operator's Manual," "Maintenance Manual" or some other description of the type of document you are creating / editing. This only applies to new documentation projects.
- Quick Start: This setting determines whether or not the document will have a Quick Start section, not have a Quick Start section, or be a blank document. This only applies to new documentation projects
- Click Prepare Documentation Project when all settings are correctly configured.
The dynadoc_create.php program will prepare DyanDoc to work with your document. The next section will describe content creation - for more complete content creation instructions, see the DynaDoc Operator's Manual.
|
