User:Jholsenback/WikiDocGen - Revision history

Jholsenback: added new section

2011-10-24T21:08:27Z

added new section

2011-10-24T20:13:56Z

minor corrections

2011-10-24T20:05:25Z

2010-12-22T10:40:21Z

updates

2010-12-22T10:25:47Z

updates

2010-12-21T00:19:21Z

Protected "User:Jholsenback/PovDocGen": part of povdocgen ([edit=sysop] (indefinite) [move=sysop] (indefinite))

2010-12-20T17:12:40Z

updates

2010-12-20T14:28:10Z

updated info

2010-12-19T17:28:45Z

minor wording

2010-12-19T17:25:05Z

completed wip

@@ Line 69: / Line 69: @@
    <li>[[Documentation:Index Page|Index Page]]</li>
 </ol>
 ===Notes===

@@ Line 11: / Line 11: @@
 ===The Files===
-These are the files that make up the povdocgen process:
+These are the files that make up the wikidocgen process:
 <ol>
    <li><code>batchMacFiles</code></li>
@@ Line 47: / Line 47: @@
    <li><code>common.php</code></li>
      <ul>
-       <li>frequently used functions associated with the povdocgen process</li>
+       <li>frequently used functions associated with the wikidocgen process</li>
      </ul>
    <li><code>utilities.php</code></li>
      <ul>
-       <li>frequently used functions associated with the povdocgen process, an attempt to organize</li>
+       <li>frequently used functions associated with the wikidocgen process, an attempt to organize</li>
      </ul>
    <li><code>documentation/WikiImages</code></li>

← Older revision		Revision as of 10:40, 22 December 2010
Line 83:		Line 83:
	<p class="Hint"><strong>Hint:</strong> look for the wiki tag  Documentation:</p>		<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!		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!
		+
		+	The file that <code>mkWikiTOC.php</code> produces needs to be copied into the [[Documentation:Contents\|table of contents]] file. Since this file spans several sections, you need to edit the <em>entire</em> page (top most edit button). Look for these comments embedding in the file delimiting where the changes should go.
		+	<pre>
		+	<!--BEGIN CHANGES BETWEEN HERE--->
		+	<!--END CHANGES BETWEEN HERE--->
		+	</pre>

@@ Line 32: / Line 32: @@
      <ul>
        <li>builds the various table of contents files and an <em>index.html</em> file for a given doc set</li>
      </ul>
    <li><code>mkImagePackage.php</code></li>

@@ Line 36: / Line 36: @@
      <ul>
        <li>builds the <em>images</em> directory structure and copies files from the POV-Wiki</li>
      </ul>
    <li><code>common.php</code></li>

← Older revision	Revision as of 20:05, 24 October 2011
(No difference)

← Older revision	Revision as of 00:19, 21 December 2010
(No difference)

@@ Line 1: / Line 1: @@
-===The Directories===
+===The Setup===
-In the directory <code>/a/home/jholsenback/testbed</code> this is the expected structure:
+In the directory<code>&nbsp;&nbsp;/a/home/jholsenback/testbed&nbsp;&nbsp;</code>this is the expected directory structure:
 : <code>documentation</code>
 ::<code>mac</code>
@@ Line 8: / Line 8: @@
 ::<code>win</code>
 :::<code>images</code>
 ===The Files===
@@ Line 55: / Line 56: @@
        <ul>
          <li>copied to a given doc set directory</li>
        </ul>
 </ol>
 Besides the <em>content</em> files on the POV-Wiki these files are also part of the process:
@@ Line 65: / Line 69: @@
 ===Notes===
-Some process notes will go here ....
+The <em>most</em> important part of this process is that it is driven off these files: