/[MITgcm]/manual/tools/test.awk
ViewVC logotype

Contents of /manual/tools/test.awk

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


Revision 1.1 - (show annotations) (download)
Thu Feb 28 19:30:25 2002 UTC (18 years, 3 months ago) by cnh
Branch: MAIN
CVS Tags: checkpoint57l_post, checkpoint01, HEAD
Adding extra online manual customisation tools

1 #
2 # Script to replace the hard-copy manual figure with an on-line
3 # version that may be animated and have a hyperlink to an on-line
4 # database of output (LAS, ingrid etc....)
5 #
6 # l2h creates figures in a table with a <CAPTION> element for the figure
7 # legend. This script does the following on the l2h nodeNN.html
8 # (source originally generated by l2h) files.
9 # 1. Find a special rawhtml marker that brackets a figure to mark it
10 # for replacement as follows
11 # MITGCM_INSERT_FIGURE_BEGIN
12 # figure to be replaced
13 # MITGCM_INSERT_FIGURE_END
14 #
15 # 2. Looks at the argument after MITGCM_INSERT_FIGURE_BEGIN which gives
16 # the name of a directory where the replacement html is found e.g
17 # MITGCM_INSERT_FIGURE_BEGIN ../on-line-figures/sio-adjoint/sio-adjoint.html
18 #
19 # 3. Inserts this html in place of the html selected in 1.
20 # The figure part is formatted
21 # <TR><TD>......
22 # .....</TD></TR>
23 # within this part the attributes WIDTH= and HEIGHT=
24 # may be useful.
25 # A hyperlink for the figure image needs to be inserted within
26 # the <TR><TD>....</TD></TR> section.
27 # e.g. <TR><TD><A href=...><IMG ....></A></TD></TR>.
28 #
29 # 4. Optionally the script can take the full caption from the l2h document
30 # or just the figure number.
31 # The format of this section is
32 # <CAPTION ALIGN="BOTTOM"><STRONG>Figure 2.13:</STRONG>
33 # caption text....
34 # caption text....
35 # caption text....
36 # caption text</CAPTION>
37 #
38 # 5. Document tags for cross-referencing are also copied over from source.
39 # These have the format <A NAME=""></A>. Figures can have several of these
40 # one internal to l2h and one corresponding to the \label{} latex
41 # attribute.
42 #
43 #
44 #
45 #
46 BEGIN{infigblok=0}
47 /MITGCM_INSERT_FIGURE_BEGIN/{ print "Figure html for " $2;infigblock=1}
48 { if ( infigblock == 0 ) print }
49 /MITGCM_INSERT_FIGURE_END/{ infigblock=0}
50 END{}
51

  ViewVC Help
Powered by ViewVC 1.1.22