doc/dot.latex2html-init

   1 #LaTeX2HTML Version 96.1 : dot.latex2html-init
   2 #
   3 ### Command Line Argument Defaults #######################################
   4
   5 # Supplied on the command line in the makefile
   6 $MAX_SPLIT_DEPTH = 3;   # Stop making separate files at this depth
   7
   8 $MAX_LINK_DEPTH = 4;    # Stop showing child nodes at this depth
   9
  10 $NOLATEX = 0;           # 1 = do not pass unknown environments to Latex
  11
  12 $EXTERNAL_IMAGES = 0;   # 1 = leave the images outside the document
  13
  14 $ASCII_MODE = 0;        # 1 = do not use any icons or internal images
  15
  16 # 1 =  use links to external postscript images rather than inlined bitmap
  17 # images.
  18 $PS_IMAGES = 0;
  19
  20 #$TITLE = $default_title;      # The default is "No Title"
  21
  22 $DESTDIR = '';         # Put the result in this directory
  23
  24 # When this is set, the generated HTML files will be placed in the
  25 # current directory. If set to 0 the default behaviour is to create (or reuse)
  26 # another file directory.
  27 $NO_SUBDIR = 0;
  28
  29
  30 # Supply your own string if you don't like the default <Name> <Date>
  31 #$ADDRESS = "<I>$address_data[0] <BR>\n$address_data[1]</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 = 0;              # 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)
  80 #
  81 $WORDS_IN_NAVIGATION_PANEL_TITLES = 4;
  82
  83 # This number will determine the size of the equations, special characters,
  84 # and anything which will be converted into an inlined image
  85 # *except* "image generating environments" such as "figure", "table"
  86 # or "minipage".
  87 # Effective values are those greater than 0.
  88 # Sensible values are between 0.1 - 4.
  89 $MATH_SCALE_FACTOR = 1.6;
  90
  91 # This number will determine the size of
  92 # image generating environments such as "figure", "table" or "minipage".
  93 # Effective values are those greater than 0.
  94 # Sensible values are between 0.1 - 4.
  95 $FIGURE_SCALE_FACTOR = 1.6;
  96
  97
  98 #  If this is set then intermediate files are left for later inspection.
  99 #  This includes $$_images.tex and $$_images.log created during image
 100 #  conversion.
 101 #  Caution: Intermediate files can be *enormous*.
 102 $DEBUG = 0;
 103
 104 #  If both of the following two variables are set then the "Up" button
 105 #  of the navigation panel in the first node/page of a converted document
 106 #  will point to $EXTERNAL_UP_LINK. $EXTERNAL_UP_TITLE should be set
 107 #  to some text which describes this external link.
 108 $EXTERNAL_UP_LINK = "/help";
 109 $EXTERNAL_UP_TITLE = "Other Documentation";
 110
 111 # If this is set then the resulting HTML will look marginally better if viewed
 112 # with Netscape.
 113 $NETSCAPE_HTML = 0;
 114
 115 # Valid paper sizes are "letter", "legal", "a4","a3","a2" and "a0"
 116 # Paper sizes has no effect other than in the time it takes to create inlined
 117 # images and in whether large images can be created at all ie
 118 #  - larger paper sizes *MAY* help with large image problems
 119 #  - smaller paper sizes are quicker to handle
 120 $PAPERSIZE = "letter";
 121
 122 # Replace "english" with another language in order to tell LaTeX2HTML that you
 123 # want some generated section titles (eg "Table of Contents" or "References")
 124 # to appear in a different language. Currently only "english" and "french"
 125 # is supported but it is very easy to add your own. See the example in the
 126 # file "latex2html.config"
 127 $TITLES_LANGUAGE = "english";
 128
 129 ### Navigation Panel ##########################################################
 130 #
 131 # The navigation panel is constructed out of buttons and section titles.
 132 # These can be configured in any combination with arbitrary text and
 133 # HTML tags interspersed between them.
 134 # The buttons available are:
 135 # $PREVIOUS - points to the previous section
 136 # $UP  - points up to the "parent" section
 137 # $NEXT - points to the next section
 138 # $NEXT_GROUP - points to the next "group" section
 139 # $PREVIOUS_GROUP - points to the previous "group" section
 140 # $CONTENTS - points to the contents page if there is one
 141 # $INDEX - points to the index page if there is one
 142 #
 143 # If the corresponding section exists the button will contain an
 144 # active link to that section. If the corresponding section does
 145 # not exist the button will be inactive.
 146 #
 147 # Also for each of the $PREVIOUS $UP $NEXT $NEXT_GROUP and $PREVIOUS_GROUP
 148 # buttons there are equivalent $PREVIOUS_TITLE, $UP_TITLE, etc variables
 149 # which contain the titles of their corresponding sections.
 150 # Each title is empty if there is no corresponding section.
 151 #
 152 # The subroutine below constructs the navigation panels in each page.
 153 # Feel free to mix and match buttons, titles, your own text, your logos,
 154 # and arbitrary HTML (the "." is the Perl concatenation operator).
 155 sub top_navigation_panel {
 156     # Now add a few buttons with a space between them
 157     #"$NEXT $UP $PREVIOUS $CONTENTS $INDEX $CUSTOM_BUTTONS" .
 158     '<ul id="nav-quicklinks">' . "\n" .
 159         # ... and the ``previous'' title
 160     ($PREVIOUS_TITLE ? '<li id="nav-prev">' . $PREVIOUS_TITLE . "</li>\n" : undef) .
 161     # If ``next'' section exists, add its title to the navigation panel
 162     ($NEXT_TITLE ? '<li id="nav-next">' . $NEXT_TITLE . "</li>\n" : undef) .
 163     "</ul>" .
 164
 165     '<div class="manualtitle">' .
 166     ($ENV{'MANUALTITLE'} ? $ENV{'MANUALTITLE'} : undef) .
 167     "</div>\n"
 168 }
 169
 170 sub bot_navigation_panel {
 171 }
 172
 173 # Add more tags etc to the head section of each page
 174 sub replace_morelinks {
 175     $_ =~ s/$more_links_mark/$more_links."\n".&head_tags()/e;
 176 }
 177
 178 sub head_tags {
 179 }
 180
 181 1;      # This must be the last line