[LON-CAPA-cvs] cvs: doc /help README

[bowersj2]

bowersj2		Tue Dec 10 15:09:34 2002 EDT

  Modified files:              
    /doc/help	README 
  Log:
  Updated information for accuracy.
  
  
Index: doc/help/README
diff -u doc/help/README:1.1 doc/help/README:1.2
--- doc/help/README:1.1	Fri Jul  5 12:12:30 2002
+++ doc/help/README	Tue Dec 10 15:09:34 2002
@@ -10,7 +10,6 @@
 SECTIONS: (dashes to help with using search)
 
 * ---texxml---
-* ---fragmentTopics.gdbm---
 * ---fragmentLabels.gdbm---
 * ---latexSplitter.py---
 * ---simpleEdit.py---
@@ -46,12 +45,9 @@
 outputs the latex to std.output.. Then you can render the resulting .tex
 however you want.
 
----fragmentTopics.gdbm---
-
-The has fragmentTopics.dbm is a DBM hash that maps topics to the files
-that contain those topics. Obviously, the topics are thus case
-sensitive. Each topic can only go to one file, but multiple topics can
-point to the same file.
+Note that the current user needs to be able to read the tex files in
+/home/httpd/html/adm/help/tex/, or the script will not work properly
+(and does not currently have any failure messages).
 
 ---fragmentLabels.gdbm---
 
@@ -113,14 +109,23 @@
 ---texxml files---
 
 * author.manual.texxml - A texxml file for the author's manual.
+* course.manual.texxml - A texxml file for the course coordinator's
+                         manual. 
 
 In order to build this file, execute 
 
 perl texxml2latex.pl authot.manual.texxml > author.manual.tex
 
-In order to build this file with LaTeX correctly, the images used in
-the manual need to be in the current directory. The images will be
-installed in /home/httpd/html/adm/help/eps , so you can either move
-the LaTeX file in to that directory and build the author manual, or
-copy the LaTeX file and the .eps files in that directory to another
-directory to build. The latter is recommended.
\ No newline at end of file
+---Rendering texxml files---
+
+The script render.texxml.pl takes a texxml file on the command line
+and will render it to ps and pdf files in the current directory. Run
+it from this directory, like so:
+
+perl render.texxml.pl -- author.manual.texxml
+
+Wait, and the ps and pdf files will pop out.
+
+This is usually done by the build system, which will rebuild the files
+when the source files have changed.
+