Contents of /manual/tools/README


#eh3

Without any tweaking, "make all" seems to produce good output and no
(fatal) errors on a RH 9 system using LaTeX and LaTeX2HTML as provided
by the following RH-provided tetex RPMs:

  tetex-xdvi-1.0.7-66
  tetex-afm-1.0.7-66
  tetex-dvips-1.0.7-66
  tetex-fonts-1.0.7-66
  tetex-latex-1.0.7-66
  tetex-1.0.7-66

#eh3


Scripts for manipulating and otherwise disassembling l2h output.

Driver for generating the latest manual from sources in CVS repo.
=================================================================
generate_latest_manual.sh  - This is coded for running on twain.lcs.mit.edu, which is the
                             only machine (apart from my laptop) with an l2h setup that can
                             cope with the manual.
                             It is run periodically by cron to keep the sealion-manual-latest
                             page up to date.

Adding subjects to the mailto: ref.
===================================
make_mail_subjects.sh   - Find mailto: block and substitutes a javascript block for
make_mail_subjects.awk    mailto:MITgcm-support@mitgcm.org?subject=....
                          where subject is the files TITLE block.

Finding figures and making substitutions in l2h output
======================================================

figsub.sh        - Finds figures that have been "rawhtml" MITGCM_INSERT_FIGURE_BEGIN
figsub.awk            marked for substitution.
                      Extracts html and records line numders
                      Output is written to 
                      figsub/filename/SUBNUM/extracted_html
                      figsub/filename/SUBNUM/startline
                      figsub/filename/SUBNUM/endline
                      where SUBNUM is the number of the current "rawhtml" marked region 
                      from file filename.

caption.sh       - Finds the caption within "extracted_html"
caption_do.sh      and writes it to figsub/filename/SUBNUM/extracted_html_caption
caption.awk     

img.sh           - Finds the IMG section that follows the CAPTION ( note captions
img_do.sh          can contain IMG ). This IMG should be the figure.
img.awk            It is written to figsub/filename/SUBNUM/extracted_html_img

labels.sh        - Finds the <A NAME=> entries from figsub/filename/SUBNUM/extracted_html.
labels_do.sh       These are the labels that are used as cross-reference targets within
labels.awk         the on-line document.
                   The entries are written to figsub/filename/SUBNUM/extracted_html_labels

fignum.sh        - Finds the <STRONG>...</STRONG> entry at the top of the _catpion extract.
fignum_do.sh       The text inbetween the markers should be the figure number.
fignum.awk         The entry is written to figsub/filename/SUBNUM/extracted_html_fignum
1
2	#eh3
3
4	Without any tweaking, "make all" seems to produce good output and no
5	(fatal) errors on a RH 9 system using LaTeX and LaTeX2HTML as provided
6	by the following RH-provided tetex RPMs:
7
8	tetex-xdvi-1.0.7-66
9	tetex-afm-1.0.7-66
10	tetex-dvips-1.0.7-66
11	tetex-fonts-1.0.7-66
12	tetex-latex-1.0.7-66
13	tetex-1.0.7-66
14
15	#eh3
16
17
18	Scripts for manipulating and otherwise disassembling l2h output.
19
20	Driver for generating the latest manual from sources in CVS repo.
21	=================================================================
22	generate_latest_manual.sh - This is coded for running on twain.lcs.mit.edu, which is the
23	only machine (apart from my laptop) with an l2h setup that can
24	cope with the manual.
25	It is run periodically by cron to keep the sealion-manual-latest
26	page up to date.
27
28	Adding subjects to the mailto: ref.
29	===================================
30	make_mail_subjects.sh - Find mailto: block and substitutes a javascript block for
31	make_mail_subjects.awk mailto:MITgcm-support@mitgcm.org?subject=....
32	where subject is the files TITLE block.
33
34	Finding figures and making substitutions in l2h output
35	======================================================
36
37	figsub.sh - Finds figures that have been "rawhtml" MITGCM_INSERT_FIGURE_BEGIN
38	figsub.awk marked for substitution.
39	Extracts html and records line numders
40	Output is written to
41	figsub/filename/SUBNUM/extracted_html
42	figsub/filename/SUBNUM/startline
43	figsub/filename/SUBNUM/endline
44	where SUBNUM is the number of the current "rawhtml" marked region
45	from file filename.
46
47	caption.sh - Finds the caption within "extracted_html"
48	caption_do.sh and writes it to figsub/filename/SUBNUM/extracted_html_caption
49	caption.awk
50
51	img.sh - Finds the IMG section that follows the CAPTION ( note captions
52	img_do.sh can contain IMG ). This IMG should be the figure.
53	img.awk It is written to figsub/filename/SUBNUM/extracted_html_img
54
55	labels.sh - Finds the <A NAME=> entries from figsub/filename/SUBNUM/extracted_html.
56	labels_do.sh These are the labels that are used as cross-reference targets within
57	labels.awk the on-line document.
58	The entries are written to figsub/filename/SUBNUM/extracted_html_labels
59
60	fignum.sh - Finds the <STRONG>...</STRONG> entry at the top of the _catpion extract.
61	fignum_do.sh The text inbetween the markers should be the figure number.
62	fignum.awk The entry is written to figsub/filename/SUBNUM/extracted_html_fignum