/[MITgcm]/manual/tools/README
ViewVC logotype

Annotation of /manual/tools/README

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.1 - (hide annotations) (download)
Thu Feb 28 19:30:25 2002 UTC (22 years, 2 months ago) by cnh
Branch: MAIN
Adding extra online manual customisation tools

1 cnh 1.1
2     Scripts for manipulating and otherwise disassembling l2h output.
3    
4     Driver for generating the latest manual from sources in CVS repo.
5     =================================================================
6     generate_latest_manual.sh - This is coded for running on twain.lcs.mit.edu, which is the
7     only machine (apart from my laptop) with an l2h setup that can
8     cope with the manual.
9     It is run periodically by cron to keep the sealion-manual-latest
10     page up to date.
11    
12     Adding subjects to the mailto: ref.
13     ===================================
14     make_mail_subjects.sh - Find mailto: block and substitutes mailto:support@mitgcm.org?subject=....
15     make_mail_subjects.awk where subject is the files TITLE block.
16    
17     Finding figures and making substitutions in l2h output
18     ======================================================
19    
20     figsub.sh - Finds figures that have been "rawhtml" MITGCM_INSERT_FIGURE_BEGIN
21     figsub.awk marked for substitution.
22     Extracts html and records line numders
23     Output is written to
24     figsub/filename/SUBNUM/extracted_html
25     figsub/filename/SUBNUM/startline
26     figsub/filename/SUBNUM/endline
27     where SUBNUM is the number of the current "rawhtml" marked region
28     from file filename.
29    
30     caption.sh - Finds the caption within "extracted_html"
31     caption_do.sh and writes it to figsub/filename/SUBNUM/extracted_html_caption
32     caption.awk
33    
34     img.sh - Finds the IMG section that follows the CAPTION ( note captions
35     img_do.sh can contain IMG ). This IMG should be the figure.
36     img.awk It is written to figsub/filename/SUBNUM/extracted_html_img
37    
38     labels.sh - Finds the <A NAME=> entries from figsub/filename/SUBNUM/extracted_html.
39     labels_do.sh These are the labels that are used as cross-reference targets within
40     labels.awk the on-line document.
41     The entries are written to figsub/filename/SUBNUM/extracted_html_labels
42    
43     fignum.sh - Finds the <STRONG>...</STRONG> entry at the top of the _catpion extract.
44     fignum_do.sh The text inbetween the markers should be the figure number.
45     fignum.awk The entry is written to figsub/filename/SUBNUM/extracted_html_fignum

  ViewVC Help
Powered by ViewVC 1.1.22