/[texi2html]/texi2html/doc/texi2html.texi
ViewVC logotype

Diff of /texi2html/doc/texi2html.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.37 by pertusus, Tue Aug 23 06:58:04 2005 UTC revision 1.38 by pertusus, Tue Aug 23 23:51:09 2005 UTC
# Line 1268  If icons are used, the button is an imag Line 1268  If icons are used, the button is an imag
1268  the value associated with the element label in the @variable{%ACTIVE_ICONS}  the value associated with the element label in the @variable{%ACTIVE_ICONS}
1269  hash if the the link really leads to an element, or in the @variable{%PASSIVE_ICONS}  hash if the the link really leads to an element, or in the @variable{%PASSIVE_ICONS}
1270  hash if there is no element to link to. Of course if there is a link to the  hash if there is no element to link to. Of course if there is a link to the
1271  element the icon links to that element.  element the icon links to that element. The button name and
1272    the button description are used in HTML attributes to have a textual
1273    description of the icon. The corresponding strings are in
1274    @variable{%BUTTONS_NAME}  for the button name and  @code{%NAVIGATION_TEXT}
1275    for the description.
1276  @end table  @end table
1277    
1278  @c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=  @c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
# Line 1453  output files. Line 1457  output files.
1457  @end deftypefn  @end deftypefn
1458    
1459  In the default case the @variable{$BODYTEXT} (@pxref{Customizing header})  In the default case the @variable{$BODYTEXT} (@pxref{Customizing header})
1460  and the hashes @variable{%NAVIGATION_TEXT} (@pxref{Button specifications}) and    and the hashes @variable{%NAVIGATION_TEXT},
1461    @variable{%BUTTONS_NAME}  (@pxref{Button specifications}),  
1462  @variable{%BUTTONS_GOTO} (@pxref{About text}) are initialized.  @variable{%BUTTONS_GOTO} (@pxref{About text}) are initialized.
1463    Indeed the initialization of these variables is dependent upon
1464    the document language selection.
1465    
1466  To perform the default initializations and also add more code, you could  To perform the default initializations and also add more code, you could
1467  do as in the following example (save the default function reference and call  do as in the following example (save the default function reference and call
# Line 2301  It should be reasonable to assume that t Line 2308  It should be reasonable to assume that t
2308  @end deftypefn  @end deftypefn
2309    
2310  The formatting of @code{@@image} is controlled by:  The formatting of @code{@@image} is controlled by:
2311  @deftypefn {Function Reference} $image image $file_path $basename $preformatted $file_name  @deftypefn {Function Reference} $image image $file_path $basename $preformatted $file_name $alt_text
2312  @var{$file_path} is the image file name with the path, @var{$basename} is the  @var{$file_path} is the image file name with the path, @var{$basename}  
2313  alternate text or the file name without extension if no alternate text is  the file name without extension. @var{$preformatted} is true if the image
 given. @var{$preformatted} is true if the image  
2314  appears in preformatted text. @var{$file_name} is the file name without path  appears in preformatted text. @var{$file_name} is the file name without path
2315  but with extension.  but with extension. @var{$alt_text} is the alternate text, it may be undefined.
2316  @end deftypefn  @end deftypefn
2317    
2318  The formatting of @code{@@sp} is controlled by:  The formatting of @code{@@sp} is controlled by:
# Line 2325  the explanation, the second arg of the a Line 2331  the explanation, the second arg of the a
2331  true if the second argument of the acronym command is present. If an  true if the second argument of the acronym command is present. If an
2332  explanation exists, coming from previous @code{@@acronym} or as an arg of this  explanation exists, coming from previous @code{@@acronym} or as an arg of this
2333  command, the other args are defined: @var{\@@explanation_lines} is a  command, the other args are defined: @var{\@@explanation_lines} is a
2334  reference on an array containing the unformatted explanation lines,  reference on an array containing the simply fomatted explanation lines,
2335  @var{$explanation_text} is the explanation text formatted,  @var{$explanation_text} is the explanation text formatted,
2336  @var{$explanation_simply_formatted} is the explanation with a light formatting,  @var{$explanation_simply_formatted} is the explanation with a light formatting,
2337  unabling in @acronym{HTML} (or @acronym{XML}) the explanation to be in an  unabling in @acronym{HTML} (or @acronym{XML}) the explanation to be in an
# Line 2339  attribute. Line 2345  attribute.
2345  Some characters are processed especially in text: @samp{---}, @samp{--},  Some characters are processed especially in text: @samp{---}, @samp{--},
2346  @samp{``} and @samp{''}. This is done only if in normal text and not in  @samp{``} and @samp{''}. This is done only if in normal text and not in
2347  some commands (@code{@@code}, @code{@@env}@dots{}). A function reference  some commands (@code{@@code}, @code{@@env}@dots{}). A function reference
2348  is called to process those characters in text  is called to process the text and should take care of those constructs.
2349    It may also be used to transform the text, for example set it in upper
2350  @deftypefn {Function Reference} $processed_text normal_text $text  case if it is in @code{@@sc}. This function should also take care
2351  The function processes @samp{---}, @samp{--}, @samp{``} and @samp{''}  of protecting special characters
2352  in @var{$text} and returns @var{$processed_text}. The default is to  
2353  change @samp{---} to @samp{--}, @samp{--} to @samp{-}, and @samp{``} and  
2354  @samp{''} to @samp{"}.  @deftypefn {Function Reference} $processed_text normal_text $text $in_raw_text $in_preformatted $in_code $style_stack
2355  @end deftypefn  The function processes @var{$text} and returns @var{$processed_text}.
2356    The other arguments give some information about the context of the text.
2357  Some characters are special in @acronym{HTML} (@samp{&}, @samp{"},  @var{$in_raw_text} is true if the text appears in special place where
2358  @samp{<} and @samp{>}) and should be protected.  there is no formatting, typically in comments. @var{$in_preformatted}
2359    is true if in a preformatted environemnt, and @var{$in_code} is true
2360    if in a special command like @code{@@code}, @code{@@env} where
2361    @samp{---}, @samp{--}, @samp{``} and @samp{''} should not be
2362    touched. @var{$style_stack} is an array containing the name of the
2363    formatting @@-command that enclose the text.  
2364    
2365    In the default case the @samp{---}, @samp{--}, @samp{``} and @samp{''}
2366    constructs are expanded if needed and the text is upper-cased if in
2367    @code{@@sc}. Special characters (@samp{&}, @samp{"},
2368    @samp{<} and @samp{>} in @acronym{HTML}) are protected if needed.
2369    @end deftypefn
2370    
2371    Some characters are special, for example we have  @samp{&}, @samp{"},
2372    @samp{<} and @samp{>} in @acronym{HTML}. In some cases some
2373    pieces of text don't go through the above function, but still
2374    needs to be protected to appear in text.
2375  This is done by the function associated with the function reference  This is done by the function associated with the function reference
2376    
2377  @deftypefn {Function Reference} $protected_text protect_text $text  @deftypefn {Function Reference} $protected_text protect_text $text
# Line 2954  The whole quotation is formatted by: Line 2976  The whole quotation is formatted by:
2976  @var{$quotation_text} is the quotation text, formatted, with the text  @var{$quotation_text} is the quotation text, formatted, with the text
2977  prepended by the function above. @var{$argument_text} is the argument  prepended by the function above. @var{$argument_text} is the argument
2978  of the @code{@@quotation}, formatted. @var{$argument_text_texi} is the argument  of the @code{@@quotation}, formatted. @var{$argument_text_texi} is the argument
2979  of the @code{@@quotation}, unformatted.  of the @code{@@quotation}, simply formatted.
2980  @end deftypefn  @end deftypefn
2981    
2982  @ignore  @ignore
# Line 3228  formatting functions. The keys are: Line 3250  formatting functions. The keys are:
3250  @item caption_texi  @item caption_texi
3251  @itemx shortcaption_texi  @itemx shortcaption_texi
3252  A reference on an array containing the caption or shortcaption lines,  A reference on an array containing the caption or shortcaption lines,
3253  unformatted.  with texi @@-commands.
3254  @item style_texi  @item style_texi
3255  The style with texi @@-commands.  The style with texi @@-commands.
3256  @item style_id  @item style_id

Legend:
Removed from v.1.37  
changed lines
  Added in v.1.38

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26