Difference between revisions of "User:Jr/WikiDocGen2"
(more adding ...) |
(added last "new" content.) |
||
| Line 83: | Line 83: | ||
typically you will need to re-generate the docs after some detail or other in the online POV-Ray documentation was edited or updated. | typically you will need to re-generate the docs after some detail or other in the online POV-Ray documentation was edited or updated. | ||
| − | at this point, only make one platform-specific set of the docs, the one you are most familiar with | + | at this point, only make one platform-specific set of the docs, the one you are most familiar with; ie 'mac' or 'unx' or 'win'. |
| − | + | double-check, visually, your edit(s) in the generated set, in a browser of choice. | |
| − | generating even | + | generating even a single set of the docs outputs a fair amount of progress information, hence the use of the 'script' utility is recommended. |
typically: | typically: | ||
| Line 103: | Line 103: | ||
</pre> | </pre> | ||
| − | to | + | to create the three documentation sets, plus the corresponding archives and the updated TOC. |
using the script utility as suggested above ensures the same name prefix is given to the recording as is used for the archives. | using the script utility as suggested above ensures the same name prefix is given to the recording as is used for the archives. | ||
| − | + | updating the table of contents, while not "onerous", requires a quiet moment and due care. | |
| + | also bear in mind that you will, to quote JH, "need to edit the ''entire page'' (top most edit button)". | ||
| + | the contents of the <code>newWikiTOC</code> file (prefixed by the date, stored in 'archives', 1100+ lines) need to be transferred/copied '''as is''' to the wiki's '[[Documentation:Contents]]' page, replacing the existing lines between the two identifier comment lines shown below. | ||
| + | |||
<pre> | <pre> | ||
<!--BEGIN CHANGES BETWEEN HERE---> | <!--BEGIN CHANGES BETWEEN HERE---> | ||
| Line 112: | Line 115: | ||
</pre> | </pre> | ||
| + | after that, all that remains is to contact/notify Chris regarding the update and new archives; currently there "is talk" of possible git pull requests being placed instead. | ||
| − | + | == the future == | |
| − | |||
| − | < | + | the PHP could do with another "attempt to organize".. any such work should be carried out in a copy of the 'docgen2' directory, suitably renamed. |
| − | </ | + | either remove the <code>.git*</code> directory and files, or start a new branch ? the only change required is updating the 'workdir' variable in 'makeDocs' line 30, to its new value. |
Revision as of 10:14, 31 May 2026
this page details the new procedure for generating the POV-Ray documentation, 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 layout of docgen2, aka the "work area",
a dedicated directory containing the following when clean:
archives/
this directory 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 'povray.css' style sheet from the wiki 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". it generates either a single document set for preview/checking, or all (three) of them.
makedocs.pl
a Perl script, it post-processes the Microsoft Windows version of the 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 were 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 the POV-Ray 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.
not shown are the .git* files and directory.
the "setup" discussed by JH and replicated below 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
whereas the previous method required several manual steps to update the POV-Ray documentation, there are basically just two now: generate the archives and update the wiki's docs table of contents. note, the work area must be clean, that is, not contain files generated in a previous run. a dedicated command is provided for the purpose.
typically you will need to re-generate the docs after some detail or other in the online POV-Ray documentation was edited or updated. at this point, only make one platform-specific set of the docs, the one you are most familiar with; ie 'mac' or 'unx' or 'win'. double-check, visually, your edit(s) in the generated set, in a browser of choice.
generating even a single set of the docs outputs a fair amount of progress information, hence the use of the 'script' utility is recommended.
typically:
$ cd ~/docgen2 $ script ~/tmp/unixscript ./makeDocs unx $ ./scrubGeneratedFiles
after generating the 'unix' version assess the results under 'documentation/unx/', and in the "log" file created; if making the 'win' version look in the 'output' directory, as this contains the post-processed HTML.
when all "looks good", do a:
$ script ~/tmp/$(date +%d%b%Y)script ./makeDocs all
to create the three documentation sets, plus the corresponding archives and the updated TOC. using the script utility as suggested above ensures the same name prefix is given to the recording as is used for the archives.
updating the table of contents, while not "onerous", requires a quiet moment and due care.
also bear in mind that you will, to quote JH, "need to edit the entire page (top most edit button)".
the contents of the newWikiTOC file (prefixed by the date, stored in 'archives', 1100+ lines) need to be transferred/copied as is to the wiki's 'Documentation:Contents' page, replacing the existing lines between the two identifier comment lines shown below.
<!--BEGIN CHANGES BETWEEN HERE---> <!--END CHANGES BETWEEN HERE--->
after that, all that remains is to contact/notify Chris regarding the update and new archives; currently there "is talk" of possible git pull requests being placed instead.
the future
the PHP could do with another "attempt to organize".. any such work should be carried out in a copy of the 'docgen2' directory, suitably renamed.
either remove the .git* directory and files, or start a new branch ? the only change required is updating the 'workdir' variable in 'makeDocs' line 30, to its new value.