Dynadoc New Project Preparation

If you are creating a new project, in addition to creating and cloning the project (as described in the previous section about Git Repository Creation / Cloning), you will need to configure DynaDoc to recognize the project and then "push" the www repository to GitHub so that others can keep their system up-to-date with all projects as well.

Configuring DynaDoc for a new project is a semi-automated process which uses the dynadoc_create.php program for these steps. dynadoc_create.php is included in the www repository and is accessed using the dynadoc_manage.php program, which runs when you click on a category link on the home page. If you are creating a new project, these steps will configure DynaDoc and copy the project template files to the project folder.

If you are editing an existing project, you do not need to perform these steps.

1. Ensure that XAMPP is running, and type localhost into your browser's address bar, and press enter. This should load your local home page with the dynadoc category links.
2. Click on the category in which you want the project to reside.
3. You should see a list of various projects in that category.
4. 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 unless there are special requirements.
   • Document Type: This should be "Operator's Manual," "Maintenance Manual" or some other description of the type of document you are creating / editing.
   • 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.
5. 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 information about using DynaDoc to create and edit documents, see the following sections and the DynaDoc Operator's Manual.