User:Jholsenback/WikiDocGen
Jump to navigation
Jump to search
The Directories
In the directory /a/home/jholsenback/testbed
this is the expected structure:
documentation
mac
images
unx
images
win
images
The Files
These are the files that make up the povdocgen process:
batchMacFiles
- a bash script that processes the Mac OS documentation set
batchWinFiles
- a bash script that processes the Windows documentation set
batchUnxFiles
- a bash script that processes the Unix documentation set
getWikiPages.php
- gets the files from the POV-Wiki and processes them
mkContentsPages.php
- builds the various table of contents files and an index.html file for a given doc set
mkImagePackage.php
- builds the images directory structure and copies files from the POV-Wiki
common.php
- some common functions associated in the povdocgen process
utilities.php
- some common utilities associated in the povdocgen process
documentation/WikiImages
- a symbolic link to the POV-Wiki images directory
documentation/favicon.ico
- copied to a given doc set directory
documentation/povray37.css
- copied to a given doc set directory
Besides the content files on the POV-Wiki these files are also part of the process:
Notes
Some process notes will go here ....