[LON-CAPA-cvs] cvs: loncom /html/adm/help/tex README_ABOUT_EDITING.txt

[lira]

lira		Wed Jun 26 18:09:34 2013 EDT

  Added files:                 
    /loncom/html/adm/help/tex	README_ABOUT_EDITING.txt 
  Log:
  Adding basic procedures for editing help files.
  
  

Index: loncom/html/adm/help/tex/README_ABOUT_EDITING.txt
+++ loncom/html/adm/help/tex/README_ABOUT_EDITING.txt
Readme about editing help files.

The .tex files here are used for both the user manual and the online help.

The order of files is specified in, respectively
doc/help/author.manual.texxml
doc/help/course.manual.texxml
doc/help/domain.manual.texxml

The accompanying graphics are stored in ../png. They are referenced in the 
manuals and pdf by putting the file name (no extension) in the tex. For example
	\begin{figure}
	\begin{center}\includegraphics[width=0.80\paperwidth]{html_page_richtext}\end{center}

	\caption{Rich Text HTML Editor}\label{Rich Text HTML Editor}
	\end{figure}

Each document is expected to include a label with the file name (no extension). 
An error will result when building the manuals if this label is missing.

The headers and footers are in
Latex_Header.tex
Latex_Footer.tex

When files are added to this folder or the png folder, the file names must
also be added to the appropriate help listing in doc/loncapafiles/loncapafiles.lpml.
The graphics should be listed as both types .gif and .eps (not .png)

To build the manuals, run loncom/build/buildHelp.sh.
This will:
convert the png graphics to corrsponding gif and eps files.
check for broken cross references or missing labels
insert the header and footer and construct the composite .tex files in doc/help
create the online help manuals in .tex format in doc/help
convert the .tex to pdf and write the result to doc/help