doc/dot.latex2html-init

   1 #LaTeX2HTML Version 96.1 : dot.latex2html-init
   2 #
   3 ### Command Line Argument Defaults #######################################
   4
   5 # $MAX_SPLIT_DEPTH = 5; # Stop making separate files at this depth
   6
   7 $MAX_LINK_DEPTH = 4;    # 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 = $default_title;      # 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
  32 $NO_NAVIGATION = 0;     # 1 = do not put a navigation panel at the top of each page
  33
  34 # Put navigation links at the top of each  page.  If  the page  exceeds
  35 # $WORDS_IN_PAGE  number of words then put one at the bottom of the page.
  36 $AUTO_NAVIGATION = 1;
  37
  38 # Put a link to the index page in  the  navigation  panel
  39 $INDEX_IN_NAVIGATION = 1;
  40
  41 # Put a link to the table of contents  in  the  navigation  panel
  42 $CONTENTS_IN_NAVIGATION = 1;
  43
  44 # Put a link to the next logical page  in  the  navigation  panel
  45 $NEXT_PAGE_IN_NAVIGATION = 1;
  46
  47 # Put a link to the previous logical page  in  the  navigation  panel
  48 $PREVIOUS_PAGE_IN_NAVIGATION = 1;
  49
  50 $INFO = 1;              # 0 = do not make a "About this document..." section
  51
  52 # Reuse images generated during previous runs
  53 $REUSE = 2;
  54
  55 # When this is 1, the section numbers are shown. The section numbers should
  56 # then match those that would have bee produced by LaTeX.
  57 # The correct section numbers are obtained from the $FILE.aux file generated
  58 # by LaTeX.
  59 # Hiding the seciton numbers encourages use of particular sections
  60 # as standalone documents. In this case the cross reference to a section
  61 # is shown using the default symbol rather than the section number.
  62 #$SHOW_SECTION_NUMBERS = 0;
  63
  64 ### Other global variables ###############################################
  65 $CHILDLINE = "<BR> <HR>\n";
  66
  67 # This is the line width measured in pixels and it is used to right justify
  68 # equations and equation arrays;
  69 $LINE_WIDTH = 500;
  70
  71 # Used in conjunction with AUTO_NAVIGATION
  72 $WORDS_IN_PAGE = 300;
  73
  74 # Affects ONLY the way accents are processed
  75 $default_language = 'english';
  76
  77 # The value of this variable determines how many words to use in each
  78 # title that is added to the navigation panel (see below)
  79 #
  80 $WORDS_IN_NAVIGATION_PANEL_TITLES = 4;
  81
  82 # This number will determine the size of the equations, special characters,
  83 # and anything which will be converted into an inlined image
  84 # *except* "image generating environments" such as "figure", "table"
  85 # or "minipage".
  86 # Effective values are those greater than 0.
  87 # Sensible values are between 0.1 - 4.
  88 $MATH_SCALE_FACTOR = 1.6;
  89
  90 # This number will determine the size of
  91 # image generating environments such as "figure", "table" or "minipage".
  92 # Effective values are those greater than 0.
  93 # Sensible values are between 0.1 - 4.
  94 $FIGURE_SCALE_FACTOR = 1.6;
  95
  96
  97 #  If this is set then intermediate files are left for later inspection.
  98 #  This includes $$_images.tex and $$_images.log created during image
  99 #  conversion.
 100 #  Caution: Intermediate files can be *enormous*.
 101 $DEBUG = 0;
 102
 103 #  If both of the following two variables are set then the "Up" button
 104 #  of the navigation panel in the first node/page of a converted document
 105 #  will point to $EXTERNAL_UP_LINK. $EXTERNAL_UP_TITLE should be set
 106 #  to some text which describes this external link.
 107 $EXTERNAL_UP_LINK = "/manuals/";
 108 $EXTERNAL_UP_TITLE = "Other Manuals";
 109
 110 # If this is set then the resulting HTML will look marginally better if viewed
 111 # with Netscape.
 112 $NETSCAPE_HTML = 0;
 113
 114 # Valid paper sizes are "letter", "legal", "a4","a3","a2" and "a0"
 115 # Paper sizes has no effect other than in the time it takes to create inlined
 116 # images and in whether large images can be created at all ie
 117 #  - larger paper sizes *MAY* help with large image problems
 118 #  - smaller paper sizes are quicker to handle
 119 $PAPERSIZE = "letter";
 120
 121 # Replace "english" with another language in order to tell LaTeX2HTML that you
 122 # want some generated section titles (eg "Table of Contents" or "References")
 123 # to appear in a different language. Currently only "english" and "french"
 124 # is supported but it is very easy to add your own. See the example in the
 125 # file "latex2html.config"
 126 $TITLES_LANGUAGE = "english";
 127
 128 ### Navigation Panel ##########################################################
 129 #
 130 # The navigation panel is constructed out of buttons and section titles.
 131 # These can be configured in any combination with arbitrary text and
 132 # HTML tags interspersed between them.
 133 # The buttons available are:
 134 # $PREVIOUS - points to the previous section
 135 # $UP  - points up to the "parent" section
 136 # $NEXT - points to the next section
 137 # $NEXT_GROUP - points to the next "group" section
 138 # $PREVIOUS_GROUP - points to the previous "group" section
 139 # $CONTENTS - points to the contents page if there is one
 140 # $INDEX - points to the index page if there is one
 141 #
 142 # If the corresponding section exists the button will contain an
 143 # active link to that section. If the corresponding section does
 144 # not exist the button will be inactive.
 145 #
 146 # Also for each of the $PREVIOUS $UP $NEXT $NEXT_GROUP and $PREVIOUS_GROUP
 147 # buttons there are equivalent $PREVIOUS_TITLE, $UP_TITLE, etc variables
 148 # which contain the titles of their corresponding sections.
 149 # Each title is empty if there is no corresponding section.
 150 #
 151 # The subroutine below constructs the navigation panels in each page.
 152 # Feel free to mix and match buttons, titles, your own text, your logos,
 153 # and arbitrary HTML (the "." is the Perl concatenation operator).
 154 sub top_navigation_panel {
 155     "<!--#include virtual=\"/includes/top.shtml\"-->" .
 156     "<style type=\"text/css\"><!--@import url(\"manual.css\");--></style>" .
 157
 158     "<DIV class=\"ManualTitle\"><!--#include virtual=\"title.html\"--></DIV>\n" .
 159
 160     # Now add a few buttons with a space between them
 161     #"$NEXT $UP $PREVIOUS $CONTENTS $INDEX $CUSTOM_BUTTONS" .
 162
 163     #"<BR>\n" .         # Line break
 164
 165     "<center><table border=0 cellpadding=10><tr>" .
 166
 167     # ... and the ``previous'' title
 168     ($PREVIOUS_TITLE ? "<td><B> Previous:</B> $PREVIOUS_TITLE</td>\n" : undef) .
 169
 170     # Similarly with the ``up'' title ...
 171     ($UP_TITLE ? "<td><B>Up:</B> $UP_TITLE</td>\n" : undef) .
 172
 173     # If ``next'' section exists, add its title to the navigation panel
 174     ($NEXT_TITLE ? "<td><B> Next:</B> $NEXT_TITLE</td>\n" : undef) .
 175
 176     "</tr></table></center>" .
 177
 178     #  Line Break, horizontal rule (3-d dividing line) and new paragraph
 179     "<BR> <P>\n"
 180 }
 181
 182 sub bot_navigation_panel {
 183
 184     #  Start with a horizontal rule (3-d dividing line)
 185     "<HR>".
 186
 187     # Now add a few buttons with a space between them
 188     #"$NEXT $UP $PREVIOUS $CONTENTS $INDEX $CUSTOM_BUTTONS" .
 189
 190     #"<BR>\n" .         # Line break
 191
 192     "<center><table border=0 cellpadding=10><tr>" .
 193
 194     # ... and the ``previous'' title
 195     ($PREVIOUS_TITLE ? "<td><B> Previous:</B> $PREVIOUS_TITLE</td>\n" : undef) .
 196
 197     # Similarly with the ``up'' title ...
 198     ($UP_TITLE ? "<td><B>Up:</B> $UP_TITLE</td>\n" : undef) .
 199
 200     # If ``next'' section exists, add its title to the navigation panel
 201     ($NEXT_TITLE ? "<td><B> Next:</B> $NEXT_TITLE</td>\n" : undef) .
 202
 203     "</tr></table></center>"
 204
 205 }
 206
 207 1;      # This must be the last line