[LON-CAPA-cvs] cvs: doc /help developer.manual.texxml

[bowersj2]

bowersj2		Mon Jul 21 16:26:26 2003 EDT

  Modified files:              
    /doc/help	developer.manual.texxml 
  Log:
  Include an index, and all of the POD files which are currently installed 
  as man pages.
  
  
Index: doc/help/developer.manual.texxml
diff -u doc/help/developer.manual.texxml:1.1 doc/help/developer.manual.texxml:1.2
--- doc/help/developer.manual.texxml:1.1	Fri Jul 18 16:59:27 2003
+++ doc/help/developer.manual.texxml	Mon Jul 21 16:26:26 2003
@@ -2,8 +2,89 @@
 	<title name="LON-CAPA Developer's Manual" />
 	<file name="Developer_Manual_Title_Page.tex"/>
 
-	<section name="Nav Maps rendering and info">	
-		<pod file="interface/lonnavmaps.pm" section="!NAME|SYNOPSIS"  />
+	<section name="LON-CAPA High-Level Overview">
+		<tex content="A high-level overview of all the pieces of all the pieces of LON-CAPA, and how they fit together, goes here." />
 		</section>
+
+	<section name="Introductory Tutorials">
+		<tex content="Some of the tutorials from the Guts manual will go here." />
+		</section>
+
+	<section name="Navigation Maps Rendering and Info">	
+		<pod file="interface/lonnavmaps.pm" section="!NAME|SYNOPSIS" />
+		</section>
+
+	<section name="LON-CAPA Help System">
+		<pod file="../doc/help/texxml2latex.pl"
+			section="!NAME|SYNOPSIS" />
+		</section>
+
+	<section name="Construction Space And Publishing">
+		<subsection name="Handling Uploaded Files">
+			<pod file="publisher/lonupload.pm" section="!NAME|SYNOPSIS" h1level='3' />
+			</subsection>
+		<subsection name="Construction Space Directory Listing">
+			<pod file="publisher/lonpubdir.pm" section="!NAME|SYNOPSIS" h1level='3' />
+			</subsection>
+		<subsection name="Retrieving Old Versions of Published Files">
+			<pod file="publisher/lonretrieve.pm" section="!NAME|SYNOPSIS" h1level='3' />
+			</subsection>
+		<subsection name="Publishing Files">
+			<pod file="publisher/lonpublisher.pm" section="!NAME|SYNOPSIS" h1level='3' />
+			</subsection>
+		</section>
+	
+	<section name="Resource Rendering">
+		<tex content="Note 'rendering' includes the concept of 'rendering an edit form', so the resource editing interface, except the RATs, are actually 'renders' of resources as well." />
+		<subsection name="Editing Homework Support">
+			<pod file="homework/edit.pm" section="!NAME|SYNOPSIS" h1level='3' />
+			</subsection>
+		<subsection name="Rendering Pages">
+			<pod file="../rat/lonpage.pm" section="!NAME|SYNOPSIS" h1level='3' />
+			</subsection>
+		
+		</section>
+
+	<section name="Common HTML routines">
+		<pod file="interface/loncommon.pm" section="!NAME|SYNOPSIS" />
+		</section>
+
+	<section name="Searching LON-CAPA">
+		<pod file="interface/lonsearchcat.pm" section="!NAME|SYNOPSIS" />
+		</section>
+
+	<section name="Parameter Setting">
+		<pod file="interface/lonparmset.pm" section="!NAME|SYNOPSIS" />
+		</section>
+
+	<section name="Preparing User State">
+		<pod file="../rat/lonuserstate.pm" section="!NAME|SYNOPSIS" />
+		</section>
+
+	<section name="Access Control">
+		<subsection name="acc">
+			<pod file="auth/lonacc.pm" section="!NAME|SYNOPSIS" h1level='3' />
+			</subsection>
+		<subsection name="racc">
+			<pod file="auth/lonracc.pm" section="!NAME|SYNOPSIS" h1level='3' />
+			</subsection>
+		<subsection name="cacc">
+			<pod file="auth/loncacc.pm" section="!NAME|SYNOPSIS" h1level='3' />
+			</subsection>
+		</section>
+	
+	<section name="Roles Selection">
+		<pod file="auth/lonroles.pm" section="!NAME|SYNOPSIS" />
+		</section>
+
+	<section name="Indexing">
+		<pod file="interface/lonindexer.pm" section="!NAME|SYNOPSIS" />
+		</section>
+
+	<section name="LON-CAPA Network Access">
+		<pod file="lonnet/perl/lonnet.pm" section="!NAME|SYNOPSIS" />
+		</section>
+
+	<tex content="\printindex{}" />
 
 	</texxml>