Georgy addition of Context Help documentation; formatting by Andrea
[goodguy/cin-manual-latex.git] / latex2html-init
1 #LaTeX2HTML Version 96.1 : dot.latex2html-init
2 #
3 ### Command Line Argument Defaults #######################################
4
5 $MAX_SPLIT_DEPTH = 3;   # Stop making separate files at this depth
6
7 $MAX_LINK_DEPTH = 3;    # Stop showing child nodes at this depth   
8
9 $NOLATEX = 0;           # 1 = do not pass unknown environments to Latex
10
11 $EXTERNAL_IMAGES = 0;   # 1 = leave the images outside the document 
12
13 $ASCII_MODE = 0;        # 1 = do not use any icons or internal images
14
15 # 1 =  use links to external postscript images rather than inlined bitmap
16 # images.
17 $PS_IMAGES = 0;
18
19 $TITLE = 'Cinelerra-GG Infinity';      # The default is "No Title" 
20
21 $DESTDIR = '';         # Put the result in this directory 
22
23 # When this is set, the generated HTML files will be placed in the 
24 # current directory. If set to 0 the default behaviour is to create (or reuse)
25 # another file directory.
26 $NO_SUBDIR = 0;
27
28
29 # Supply your own string if you don't like the default <Name> <Date>
30 #$ADDRESS = "<I>$address_data[0] <BR>\n$address_data[1]</I>";
31 $ADDRESS = "<I>The CINELERRA-GG Community, 2021<BR><A HREF=\"https://www.cinelerra-gg.org\">https://www.cinelerra-gg.org</A></I>";
32
33 $NO_NAVIGATION = 0;     # 1 = do not put a navigation panel at the top of each page
34
35 # Put navigation links at the top of each  page.  If  the page  exceeds
36 # $WORDS_IN_PAGE  number of words then put one at the bottom of the page.
37 $AUTO_NAVIGATION = 1;
38
39 # Put a link to the index page in  the  navigation  panel
40 $INDEX_IN_NAVIGATION = 1;
41
42 # Put a link to the table of contents  in  the  navigation  panel
43 $CONTENTS_IN_NAVIGATION = 1;
44
45 # Put a link to the next logical page  in  the  navigation  panel
46 $NEXT_PAGE_IN_NAVIGATION = 1;
47
48 # Put a link to the previous logical page  in  the  navigation  panel
49 $PREVIOUS_PAGE_IN_NAVIGATION = 1;
50
51 $INFO = 1;              # 0 = do not make a "About this document..." section 
52
53 # Reuse images generated during previous runs
54 $REUSE = 2;
55
56 # When this is 1, the section numbers are shown. The section numbers should 
57 # then match those that would have bee produced by LaTeX.
58 # The correct section numbers are obtained from the $FILE.aux file generated 
59 # by LaTeX.
60 # Hiding the seciton numbers encourages use of particular sections 
61 # as standalone documents. In this case the cross reference to a section 
62 # is shown using the default symbol rather than the section number.
63 $SHOW_SECTION_NUMBERS = 0;
64
65 ### Other global variables ###############################################
66 $CHILDLINE = "<BR> <HR>\n";
67
68 # This is the line width measured in pixels and it is used to right justify
69 # equations and equation arrays; 
70 $LINE_WIDTH = 500;              
71
72 # Used in conjunction with AUTO_NAVIGATION
73 $WORDS_IN_PAGE = 300;   
74
75 # Affects ONLY the way accents are processed 
76 $default_language = 'english';  
77
78 # The value of this variable determines how many words to use in each 
79 # title that is added to the navigation panel, see below (-1 is no limit).
80 # If $SHOW_SECTION_NUMBERS == 1, then one additional word counts
81 # for the section number.
82
83 $WORDS_IN_NAVIGATION_PANEL_TITLES = 4;
84
85 # The value of this variable determines how many words to use in each 
86 # Index entry (analogous to $WORDS_IN_NAVIGATION_PANEL_TITLES).
87 # If not set, it equals to $WORDS_IN_NAVIGATION_PANEL_TITLES by default.
88
89 #$WORDS_IN_INDEX = 4;
90
91 # This number will determine the size of the equations, special characters,
92 # and anything which will be converted into an inlined image
93 # *except* "image generating environments" such as "figure", "table" 
94 # or "minipage".
95 # Effective values are those greater than 0.
96 # Sensible values are between 0.1 - 4.
97 $MATH_SCALE_FACTOR = 1.6;
98
99 # This number will determine the size of 
100 # image generating environments such as "figure", "table" or "minipage".
101 # Effective values are those greater than 0.
102 # Sensible values are between 0.1 - 4.
103 $FIGURE_SCALE_FACTOR = 1.6;
104
105
106 #  If this is set then intermediate files are left for later inspection.
107 #  This includes $$_images.tex and $$_images.log created during image
108 #  conversion.
109 #  Caution: Intermediate files can be *enormous*.
110 $DEBUG = 0;
111
112 #  If both of the following two variables are set then the "Up" button
113 #  of the navigation panel in the first node/page of a converted document
114 #  will point to $EXTERNAL_UP_LINK. $EXTERNAL_UP_TITLE should be set
115 #  to some text which describes this external link.
116 $EXTERNAL_UP_LINK = "";
117 $EXTERNAL_UP_TITLE = "";
118
119 # If this is set then the resulting HTML will look marginally better if viewed 
120 # with Netscape.
121 $NETSCAPE_HTML = 0;
122
123 # Valid paper sizes are "letter", "legal", "a4","a3","a2" and "a0"
124 # Paper sizes has no effect other than in the time it takes to create inlined
125 # images and in whether large images can be created at all ie
126 #  - larger paper sizes *MAY* help with large image problems 
127 #  - smaller paper sizes are quicker to handle
128 $PAPERSIZE = "a4";
129
130 # Replace "english" with another language in order to tell LaTeX2HTML that you 
131 # want some generated section titles (eg "Table of Contents" or "References")
132 # to appear in a different language. Currently only "english" and "french"
133 # is supported but it is very easy to add your own. See the example in the
134 # file "latex2html.config" 
135 $TITLES_LANGUAGE = "english";
136
137 ### Navigation Panel ##########################################################
138 #
139 # The navigation panel is constructed out of buttons and section titles.
140 # These can be configured in any combination with arbitrary text and 
141 # HTML tags interspersed between them. 
142 # The buttons available are:
143 # $PREVIOUS - points to the previous section
144 # $UP  - points up to the "parent" section
145 # $NEXT - points to the next section
146 # $NEXT_GROUP - points to the next "group" section
147 # $PREVIOUS_GROUP - points to the previous "group" section
148 # $CONTENTS - points to the contents page if there is one
149 # $INDEX - points to the index page if there is one
150 #
151 # If the corresponding section exists the button will contain an
152 # active link to that section. If the corresponding section does
153 # not exist the button will be inactive.
154 #
155 # Also for each of the $PREVIOUS $UP $NEXT $NEXT_GROUP and $PREVIOUS_GROUP
156 # buttons there are equivalent $PREVIOUS_TITLE, $UP_TITLE, etc variables
157 # which contain the titles of their corresponding sections. 
158 # Each title is empty if there is no corresponding section.
159 #
160 # The subroutine below constructs the navigation panels in each page.
161 # Feel free to mix and match buttons, titles, your own text, your logos,
162 # and arbitrary HTML (the "." is the Perl concatenation operator).
163 sub top_navigation_panel {
164     "<!--Navigation Panel-->"
165
166     #  Start with a horizontal rule (3-d dividing line)
167     . "\n<HR>"
168
169     # Now add a few buttons with a space between them
170     . "$NEXT $UP $PREVIOUS $CONTENTS $INDEX $CUSTOM_BUTTONS"
171
172     . "\n<BR>"          # Line break
173
174     # If ``next'' section exists, add its title to the navigation panel
175     . ($NEXT_TITLE ? "\n<B> $next_name:</B> $NEXT_TITLE" : undef)
176
177     # Similarly with the ``up'' title ...
178     . ($UP_TITLE ? "\n<B> $up_name:</B> $UP_TITLE" : undef)
179
180     # ... and the ``previous'' title
181     . ($PREVIOUS_TITLE ? "\n<B> $prev_name:</B> $PREVIOUS_TITLE" : undef)
182
183     # ... and the ``contents'' title
184     . ($CONTENTS_LINK ? "\n &nbsp; <B> $CONTENTS_LINK</B> " : undef)
185
186     # ... and the ``index'' title
187     . ($INDEX_LINK ? "\n &nbsp; <B> $INDEX_LINK</B> " : undef)
188
189     # These <BR>s separate it from the text body.
190     . "\n<BR><HR>"
191 }
192
193 sub bot_navigation_panel {
194
195     #  Start with a horizontal rule (3-d dividing line)
196     "<HR>\n" . "<!--Navigation Panel-->"
197
198     # Now add a few buttons with a space between them
199     . "$NEXT $UP $PREVIOUS $CONTENTS $INDEX $CUSTOM_BUTTONS"
200
201     . "\n<BR>"          # Line break
202
203     # If ``next'' section exists, add its title to the navigation panel
204     . ($NEXT_TITLE ? "\n<B> $next_name:</B> $NEXT_TITLE" : undef)
205
206     # Similarly with the ``up'' title ...
207     . ($UP_TITLE ? "\n<B> $up_name:</B> $UP_TITLE" : undef)
208
209     # ... and the ``previous'' title
210     . ($PREVIOUS_TITLE ? "\n<B> $prev_name:</B> $PREVIOUS_TITLE" : undef)
211
212     # ... and the ``contents'' title
213     . ($CONTENTS_LINK ? "\n &nbsp; <B> $CONTENTS_LINK</B> " : undef)
214
215     # ... and the ``index'' title
216     . ($INDEX_LINK ? "\n &nbsp; <B> $INDEX_LINK</B> " : undef)
217
218     #  Horizontal rule (3-d dividing line)
219     . "\n<HR>"
220 }
221
222 &ignore_commands( <<_IGNORED_CMDS_);
223 captionsetup # {}
224 fboxsep # &ignore_numeric_argument
225 drop # &ignore_numeric_argument
226 AddToShipoutPicture # {}
227 ClearShipoutPicture
228 _IGNORED_CMDS_
229
230 1;      # This must be the last line