Return to README_ABOUT_EDITING.txt CVS log

Up to [LON-CAPA] / loncom / html / adm / help / tex

Annotation of loncom/html/adm/help/tex/README_ABOUT_EDITING.txt, revision 1.1

1.1     ! lira        1: Readme about editing help files.
        !             2: 
        !             3: The .tex files here are used for both the user manual and the online help.
        !             4: 
        !             5: The order of files is specified in, respectively
        !             6: doc/help/author.manual.texxml
        !             7: doc/help/course.manual.texxml
        !             8: doc/help/domain.manual.texxml
        !             9: 
        !            10: The accompanying graphics are stored in ../png. They are referenced in the 
        !            11: manuals and pdf by putting the file name (no extension) in the tex. For example
        !            12: 	\begin{figure}
        !            13: 	\begin{center}\includegraphics[width=0.80\paperwidth]{html_page_richtext}\end{center}
        !            14: 
        !            15: 	\caption{Rich Text HTML Editor}\label{Rich Text HTML Editor}
        !            16: 	\end{figure}
        !            17: 
        !            18: Each document is expected to include a label with the file name (no extension). 
        !            19: An error will result when building the manuals if this label is missing.
        !            20: 
        !            21: The headers and footers are in
        !            22: Latex_Header.tex
        !            23: Latex_Footer.tex
        !            24: 
        !            25: When files are added to this folder or the png folder, the file names must
        !            26: also be added to the appropriate help listing in doc/loncapafiles/loncapafiles.lpml.
        !            27: The graphics should be listed as both types .gif and .eps (not .png)
        !            28: 
        !            29: To build the manuals, run loncom/build/buildHelp.sh.
        !            30: This will:
        !            31: convert the png graphics to corrsponding gif and eps files.
        !            32: check for broken cross references or missing labels
        !            33: insert the header and footer and construct the composite .tex files in doc/help
        !            34: create the online help manuals in .tex format in doc/help
        !            35: convert the .tex to pdf and write the result to doc/help
        !            36: