Difference between revisions of "User:Jholsenback/WikiDocGen"
Jholsenback (talk | contribs) m (initial page creation) |
Jholsenback (talk | contribs) m (completed wip) |
||
| Line 1: | Line 1: | ||
| − | ===The | + | ===The Setup=== |
| − | In the directory <code>/a/home/jholsenback/testbed</code> this is the expected structure: | + | In the directory<code> /a/home/jholsenback/testbed </code>this is the expected directory structure: |
: <code>documentation</code> | : <code>documentation</code> | ||
::<code>mac</code> | ::<code>mac</code> | ||
| Line 8: | Line 8: | ||
::<code>win</code> | ::<code>win</code> | ||
:::<code>images</code> | :::<code>images</code> | ||
| + | You should be in the above mentioned directory to run the scripts, however, the batch-files wander a bit but always end up back home. | ||
===The Files=== | ===The Files=== | ||
| Line 55: | Line 56: | ||
<ul> | <ul> | ||
<li>copied to a given doc set directory</li> | <li>copied to a given doc set directory</li> | ||
| + | <p class="Warning">This <em>NEEDS</em> to be on the Wiki so watch the <em>revision</em> control on this file! It's the gospel for now!</p> | ||
</ul> | </ul> | ||
| + | |||
| + | |||
</ol> | </ol> | ||
Besides the <em>content</em> files on the POV-Wiki these files are also part of the process: | Besides the <em>content</em> files on the POV-Wiki these files are also part of the process: | ||
| Line 65: | Line 69: | ||
===Notes=== | ===Notes=== | ||
| − | + | The <em>most</em> important part of this process is that it is driven off these files: | |
| + | <ul> | ||
| + | <li>[[Documentation:Windows Table of Contents|Windows Table of Contents]]</li> | ||
| + | <li>[[Documentation:Mac OS Table of Contents|Mac OS Table of Contents]]</li> | ||
| + | <li>[[Documentation:Unix Table of Contents|Unix Table of Contents]]</li> | ||
| + | <li>[[Documentation:Tutorial Table of Contents|Tutorial Table of Contents]]</li> | ||
| + | <li>[[Documentation:Reference Table of Contents|Reference Table of Contents]]</li> | ||
| + | </li> | ||
| + | </ul> | ||
| + | The <code>GatherTOCfiles</code> and <code>BuildDocMap</code> functions reads and processes those files. They are located in <code>utilities</code> and <code>common</code> respectively, they depend on the <code>class DocumentMap</code> definition located in <code>common</code>. During batch processing if an <em>exception</em> message is seen, most likely something isn't correct with an associated table of contents entry and how it appears in the content body. The title portion of the toc entry and the heading entry in the content body <em>MUST</em> be and exact match. Batch processing will continue and the offender will appear in the content body as wiki markup. | ||
| + | <p class="Hint"><strong>Hint:</strong> look for the wiki tag Documentation:</p> | ||
| + | The content on the Wiki is organized such that a given section can span more than one file, the script <code>getWikiPages.php</code> effectively concatenates the files together, so look near the bottom of that script to find a place to tap into the <em>stream</em> as it were! | ||
Revision as of 17:25, 19 December 2010
The Setup
In the directory /a/home/jholsenback/testbed this is the expected directory structure:
documentationmacimages
unximages
winimages
You should be in the above mentioned directory to run the scripts, however, the batch-files wander a bit but always end up back home.
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
This NEEDS to be on the Wiki so watch the revision control on this file! It's the gospel for now!
Besides the content files on the POV-Wiki these files are also part of the process:
Notes
The most important part of this process is that it is driven off these files:
- Windows Table of Contents
- Mac OS Table of Contents
- Unix Table of Contents
- Tutorial Table of Contents
- Reference Table of Contents
The GatherTOCfiles and BuildDocMap functions reads and processes those files. They are located in utilities and common respectively, they depend on the class DocumentMap definition located in common. During batch processing if an exception message is seen, most likely something isn't correct with an associated table of contents entry and how it appears in the content body. The title portion of the toc entry and the heading entry in the content body MUST be and exact match. Batch processing will continue and the offender will appear in the content body as wiki markup.
Hint: look for the wiki tag Documentation:
The content on the Wiki is organized such that a given section can span more than one file, the script getWikiPages.php effectively concatenates the files together, so look near the bottom of that script to find a place to tap into the stream as it were!