/[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.35 by pertusus, Fri Aug 19 12:14:46 2005 UTC revision 1.36 by pertusus, Sun Aug 21 21:31:55 2005 UTC
# Line 2533  the item in the list, @var{$enumerate_st Line 2533  the item in the list, @var{$enumerate_st
2533  @deftypefn {Function Reference} $preformatted_text preformatted $text $style $region_name $formatting_command $formatting_command_formatted \$preformatted_number $format $item_number $enumerate_style $number  @deftypefn {Function Reference} $preformatted_text preformatted $text $style $region_name $formatting_command $formatting_command_formatted \$preformatted_number $format $item_number $enumerate_style $number
2534  This function formats a preformatted region. @var{$text} is the text of the  This function formats a preformatted region. @var{$text} is the text of the
2535  preformatted region, @var{$style} is the css style associated with that  preformatted region, @var{$style} is the css style associated with that
2536  preformatted region (@xref{css}). @var{$region_name} is the  preformatted region (@pxref{css}). @var{$region_name} is the
2537  name of the command opening          name of the command opening        
2538  the preformatted region (@code{example}@dots{}, see @ref{Complex formats})  the preformatted region (@code{example}@dots{}, see @ref{Complex formats})
2539  or a identifier for the preformatted context (for example  or a identifier for the preformatted context (for example
# Line 2590  of the complex format commands (@code{ex Line 2590  of the complex format commands (@code{ex
2590  @code{lisp}, @code{smalllisp}, @code{display}, @code{smalldisplay},  @code{lisp}, @code{smalllisp}, @code{display}, @code{smalldisplay},
2591  @code{format}, @code{smallformat}).  @code{format}, @code{smallformat}).
2592    
2593  The associated value is also a reference on a hash. The keys are @code{begin}  The associated value is also a reference on a hash. The keys are:
2594  and @code{end}. An eval of @code{begin} should lead to the beginning of the  
2595  formatted @acronym{HTML}, an eval of @code{end} should lead to the end of the  @table @code
2596  formatted @acronym{HTML}. The enclosed text will be formatted as described in  @item begin
2597    An eval of @code{begin} should lead to the beginning of the
2598    formatted @acronym{HTML}.
2599    @item end
2600    An eval of @code{end} should lead to the end of the
2601    formatted @acronym{HTML}.
2602    @item class
2603    The @acronym{HTML} class. If not defined, the command name.
2604    @item pre_style
2605    The preformatted style. If not defined the corresponding @acronym{CSS} style
2606    is used.
2607    @end table
2608    The enclosed text will be formatted as described in
2609  @ref{Paragraph and preformatted region}, and the name of the complex  @ref{Paragraph and preformatted region}, and the name of the complex
2610  format will be available to the function formatting the text.  format will be available to the function formatting the text.
2611    
# Line 2944  an identifier which can be used as an @a Line 2956  an identifier which can be used as an @a
2956  @node Menus  @node Menus
2957  @section Menu formatting  @section Menu formatting
2958    
2959    There are two possibilities for menu formatting:
2960    
2961    @itemize @bullet
2962    @item format the whole menu in a preformatted environment, like
2963    in @ref{Complex formats};
2964    @item format the menu in table with more specialized formatting for each
2965    part of the menu;
2966    @end itemize
2967    
2968    The simple formatting is used if @variable{$SIMPLE_MENU} is true,
2969    otherwise the format with tables is used (this is the default).
2970    
2971  To understand how the formatting of menus is controlled, the different  To understand how the formatting of menus is controlled, the different
2972  parts of a menu are first described, then how to control the formatting  parts of a menu are first described, then how to control the formatting
2973  of each of these parts.  of each of these parts, for each possible formatting.
2974    
2975  @menu  @menu
2976  * Menu parts::                 A menu consists in menu entry and menu  * Menu parts::                  A menu consists in menu entry and menu
2977                                 comments                                  comments
2978  * Menu formatting::  * Menu components formatting::  
2979    * Simple menu formatting::      formatting of a whole menu in a simple
2980                                    preformatted environement
2981    * Table menu formatting::       formatting of a whole menu in a
2982                                    table environment
2983  @end menu  @end menu
2984    
2985  @c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=  @c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
# Line 2961  of each of these parts. Line 2989  of each of these parts.
2989  In @command{texi2html}, a menu is considered to be composed of 2 parts, the  In @command{texi2html}, a menu is considered to be composed of 2 parts, the
2990  @dfn{menu entries} and the @dfn{menu comments}. Menu entries are further  @dfn{menu entries} and the @dfn{menu comments}. Menu entries are further
2991  divided in an @dfn{entry link} and optionnaly an @dfn{entry description}.  divided in an @dfn{entry link} and optionnaly an @dfn{entry description}.
2992  The entry link consists in a node name and an optionnal  menu entry  The entry link consists in a node name and an optionnal menu entry
2993  name.  name.
2994    
2995  A menu entry begins with @samp{*} at the beginning of the line. It begins  A menu entry begins with @samp{*} at the beginning of the line. It begins
# Line 2975  Here is an illustration of these rules: Line 3003  Here is an illustration of these rules:
3003    
3004  @example  @example
3005  @@menu  @@menu
3006  * node name: entry name.        description begins  * entry name: node name.        description begins
3007     description continues     description continues
3008  * another menu entry::  * another menu entry::
3009     description begins     description begins
# Line 2986  Here is an illustration of these rules: Line 3014  Here is an illustration of these rules:
3014  * node::                        description begins  * node::                        description begins
3015  A menu comment. The line starts at the first character  A menu comment. The line starts at the first character
3016    
3017  * last entry::         description begins @emph{text  * last entry::         description begins @@emph@{text
3018  of the description, even if the line begins at the first character,  of the description, even if the line begins at the first character,
3019  because we are in @@emph}.  because we are in @@emph@}.
3020  @@end menu  @@end menu
3021  @end example  @end example
3022    
3023  @c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=  @c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
3024  @node Menu formatting  @node Menu components formatting
3025  @subsection The formatting of the different menu components  @subsection The formatting of the different menu components
3026    
 In the default case, the name of the section corresponding with the  
 node is used instead of the node name. If @variable{$NODE_NAME_IN_MENU} is  
 true, however, node names are used. If @variable{$AVOID_MENU_REDUNDANCY}  
 is true and menu entry equal menu description the description isn't printed.  
 This is the default. Likewise, if node or section name equal entry name,  
 do not print entry name.  
   
 A symbol, @variable{$MENU_SYMBOL} is put at the beginning of menu entries  
 when the node name is used. The default is @samp{•}.  
 If @variable{$UNNUMBERED_SYMBOL_IN_MENU} is true it is  
 also put at the beginning of unnumbered section names. This is not  
 done by default.  
   
 The menu comments are considered to be preformatted text. The style  
 associated with this preformatted text is determined by  
 @variable{$MENU_PRE_STYLE}. Default is @samp{font-family: serif}.  
 The css class associated with menu comments is @code{menu-comments}.  
   
3027  Three function references are associated with the formatting of the  Three function references are associated with the formatting of the
3028  different parts of a menu:  different parts of a menu:
3029  @deftypefn {Function Reference} $link menu_link $section \%state $href $node $name $ending  @deftypefn {Function Reference} $link menu_link $section \%state $href $node $name $ending
# Line 3023  holds informations about the current con Line 3033  holds informations about the current con
3033  of interest is @code{preformatted}, true if the context is a preformatted  of interest is @code{preformatted}, true if the context is a preformatted
3034  context. @xref{Three contexts}.  context. @xref{Three contexts}.
3035  @var{$node} is the node name, @var{$name} is the  @var{$node} is the node name, @var{$name} is the
3036  name of the node, and @var{$ending} is the text ending the link entry.  name of the node. @var{$ending} is the text ending the link entry,
3037    in general @samp{::} followed by some spaces.
3038  @end deftypefn  @end deftypefn
3039    
3040  @deftypefn {Function Reference} $description menu_description $description_text \%state  @deftypefn {Function Reference} $description menu_description $description_text \%state
# Line 3032  should be used similarly than for the me Line 3043  should be used similarly than for the me
3043  @end deftypefn  @end deftypefn
3044    
3045  @deftypefn {Function Reference} $menu_comment menu_comment $text  @deftypefn {Function Reference} $menu_comment menu_comment $text
3046  @var{$text} is the text of the menu comment. It is in a preformatted  @var{$text} is the text of the menu comment. It is always in a preformatted
3047  environment.  environment.
3048  @end deftypefn  @end deftypefn
3049    
3050  The following function reference controls the formatting of a wole menu:  Another function reference corresponds with a special case. It
   
 @deftypefn {Function Reference} $menu menu $menu_components_text  
 @var{$menu_components_text} is the formatted menu components text, obtained  
 as explained above.  
 @end deftypefn  
   
 The last function reference corresponds with a special case. It  
3051  is used when a menu entry appears within another block command, to  is used when a menu entry appears within another block command, to
3052  avoid the possibilities of invalid @acronym{HTML} production.  avoid the possibilities of invalid @acronym{HTML} production.
3053  In that case the menu description and menu comments are not formatted  In that case the menu description and menu comments are not formatted
# Line 3055  is the link hypertextual reference. Line 3059  is the link hypertextual reference.
3059  name of the node, and @var{$ending} is the text ending the link entry.  name of the node, and @var{$ending} is the text ending the link entry.
3060  @end deftypefn  @end deftypefn
3061    
3062    @c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
3063    @node Simple menu formatting
3064    @subsection  Simple menu formatting in a preformatted environment
3065    
3066    If the menu is to be formatted in a single preformatted environment,
3067    an entry for @samp{menu} should be added to the @code{$complex_format_map}
3068    hash reference (@pxref{Complex formats}).
3069    In the default case, if the user didn't add an entry himself, a very simple
3070    entry is used, with:
3071    
3072    @example
3073    $complex_format_map->@{'menu'@} = @{ 'begin' => q@{''@} , 'end' => q@{''@},
3074        'pre_style' => "$MENU_PRE_STYLE", 'class' => 'menu-preformatted' @};
3075    @end example
3076    
3077    @c -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
3078    @node Table menu formatting
3079    @subsection The formatting of the menu in a table
3080    
3081    In the default case, the name of the section corresponding with the
3082    node is used instead of the node name. If @variable{$NODE_NAME_IN_MENU} is
3083    true, however, node names are used. If @variable{$AVOID_MENU_REDUNDANCY}
3084    is true and menu entry equal menu description the description isn't printed.
3085    This is the default. Likewise, if node or section name equal entry name,
3086    do not print entry name.
3087    
3088    A symbol, @variable{$MENU_SYMBOL} is put at the beginning of menu entries
3089    when the node name is used. The default is @samp{•}.
3090    If @variable{$UNNUMBERED_SYMBOL_IN_MENU} is true it is
3091    also put at the beginning of unnumbered section names. This is not
3092    done by default.
3093    
3094    The menu comments are considered to be preformatted text. The style
3095    associated with this preformatted text is determined by
3096    @variable{$MENU_PRE_STYLE}. Default is @samp{font-family: serif}.
3097    The css class associated with menu comments is @code{menu-comments}.
3098    
3099    The following function reference controls the formatting of a wole menu
3100    in that case:
3101    
3102    @deftypefn {Function Reference} $menu menu $menu_components_text
3103    @var{$menu_components_text} is the formatted menu components text, obtained
3104    as explained above.
3105    @end deftypefn
3106    
3107  @c --------------------------------------------------------  @c --------------------------------------------------------
3108  @node Indices  @node Indices
3109  @section Indices formatting  @section Indices formatting

Legend:
Removed from v.1.35  
changed lines
  Added in v.1.36

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