User:Jholsenback/WikiDocGen

From POV-Wiki
< User:Jholsenback
Revision as of 16:02, 19 December 2010 by Jholsenback (talk | contribs) (initial page creation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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:

  1. batchMacFiles
    • a bash script that processes the Mac OS documentation set
  2. batchWinFiles
    • a bash script that processes the Windows documentation set
  3. batchUnxFiles
    • a bash script that processes the Unix documentation set
  4. getWikiPages.php
    • gets the files from the POV-Wiki and processes them
  5. mkContentsPages.php
    • builds the various table of contents files and an index.html file for a given doc set
  6. mkImagePackage.php
    • builds the images directory structure and copies files from the POV-Wiki
  7. common.php
    • some common functions associated in the povdocgen process
  8. utilities.php
    • some common utilities associated in the povdocgen process
  9. documentation/WikiImages
    • a symbolic link to the POV-Wiki images directory
  10. documentation/favicon.ico
    • copied to a given doc set directory
  11. 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:

  1. Page Header
  2. Content Header Footer
  3. Index Page

Notes

Some process notes will go here ....