User:Jr/WikiDocGen2
this page details the new generating POV-Ray documentation procedure, revised since the server's crash in the early 20s.
the page is based on J Holsenback's private notes page, which although now mostly obsolete, I have copied "freely" from.
as JH points out, all work happens on the wiki server, so I assume you will be logged (have 'ssh'd) into the account which has been set up by Chris for the purpose.
layout, manifest, setup
the screenshot shows the "work area", a dedicated directory, containing the following when clean:
archives/
contains the files generated by a given './makeDocs all' run.
it will be empty, usually.
common.php
frequently used functions associated with the wikidocgen process.
getStyleSheet.php
gets the 'povray37.css' style sheet and copies it to a given doc set
directory.
getWikiPages.php
gets the files from the POV-Wiki and processes them.
makeDocs
a BASH script, the "driver". generates either a single document set for
preview/checking, or all (three) of them.
makedocs.pl
a Perl script which post-processes the Windows documentation in preparation
of generating the compiled help file, 'povray.chm'.
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.
mkWikiTOC.php
rebuilds the 'Documentation:Contents' listing if any of the 'contents'
pages gets changed.
resources/
this directory is "static" essentially, that is, its contents will not
change.
resources/Arrow{Down,Up}.png
these navigation icons/images are copied into the 'documentation' tree.
resources/favicon.ico
as is our icon/image.
resources/povray.{hhp,js,stp}
these files get copied to the 'output' directory, they're used by the
Windows HTML Help Compiler.
scrubGeneratedFiles
this simple BASH script removes the generated, temporary directories and
their contents.
utilities.php
frequently used functions associated with the wikidocgen process,
an attempt to organize.
the "setup" below, discussed by JH, still exists, but no longer permanently;
the whole of the 'documentation' directory tree now is created and populated
at run-time.
documentationmacimages
unximages
winimages
the procedure
intro, step-by-step, "afterwards". use 'script'.