Lines Matching full:generate
3 HTML::Toc - Generate, insert and update HTML Table of Contents.
7 Generate, insert and update HTML Table of Contents.
37 | +generate() | +-----+-----+
81 The code underneath will generate a ToC of the HTML headings C<<h1>>..C<<h6>> from a file C<index.htm>:
111 This code will generate a ToC of HTML headings C<<h1>>..C<<h6>> of file C<index.htm>, and insert the ToC after the C<<body>> tag at the same time:
192 This code will generate a ToC of HTML headings C<<h1>>..C<<h6>> of file C<indexToc.htm>, and insert or update the ToC after the C<<body>> tag at the same time:
254 Normally, the ToC will be made of text between specified ToC tokens. It's also possible to use the attribute value of a token as a ToC text. This can be done by specifying the attribute marked with an L<attributeToTocToken|"attributeToTocToken"> within the L<tokenBegin|"tokenBegin"> token. For example, suppose you want to generate a ToC of the C<alt> attributes of the following image tokens:
291 =head2 Generate single ToC of multiple files
293 Besides generating a ToC of a single file, it's also possible to generate a single ToC of multiple files. This can be done by specifying either an array of files as the file argument and/or by extending an existing ToC.
297 For example, suppose you want to generate a ToC of both C<doc1.htm>:
333 It's also possible to extend an existing ToC. For example, suppose we want the generate a ToC of file C<doc1.htm>:
368 =head2 Generate multiple ToCs
370 It's possible to generate multiple ToCs at once by specifying a C<HTML::Toc> object array as the ToC argument. For example, suppose you want to generate a default ToC of HTML headings <h1>..<h6> as well as a ToC of the C<alt> image attributes of the following text:
421 =head2 Generate multiple groups in one ToC
423 You may want to generate a ToC consisting of multiple ToC groups.
427 Suppose you want to generate a ToC with one group for the normal headings, and one group for the appendix headings, using this source file:
492 Suppose you want to generate a ToC of a document which is divided in multiple parts like this file underneath:
706 Suppose you want to generate a table of contents of the E<lt>titleE<gt> tags of the files in the following directory structure:
763 # Generate ToC of case-insensitively sorted file list
823 =head2 HTML::TocGenerator::generate()
825 syntax: $tocGenerator->generate($toc, $string [, $options])
826 args: - $toc: (reference to array of) HTML::Toc object(s) to generate
830 Generate ToC from specified string. Before generating, the ToC will be cleared. For extending an existing ToC, use the L<HTML::TocGenerator::extend()|"HTML::TocGenerator::extend()"> method. For generator options, see L<HTML::TocGenerator Options|"HTML::TocGenerator Options">.
836 generate
837 - $filename: (reference to array of) file(s) to generate ToC from
840 Generate ToC from specified file. Before generating, the ToC will be cleared. For extending an extisting ToC, use the L<HTML::TocGenerator::extendFromFile()|"HTML::TocGenerator::extendFromFile()"> method. For generator options, see L<HTML::TocGenerator Options|"HTML::TocGenerator Options">.
930 True (1) if group levels must be used globally accross ToCs. False (0) if not. This option only makes sense when an array of ToCs is specified. For example, suppose you want to generate two ToCs, one ToC for '<h1>' tokens and one ToC for '<h2>' tokens, of the file 'index.htm':
1007 =item L<Generate options|"Generate options">
1031 =head2 Generate options
1207 True (1) if groups must be nested in the formatted ToC, False (0) if not. In effect only when multiple groups are specified within the L<tokenToToc|"tokenToToc"> setting. For an example, see L<Generate multiple groups in one ToC|"Generate multiple groups in one ToC">.
1273 Sets the group id attribute of a tokenGroup. With this attribute it's possible to divide the ToC into multiple groups. Each group has its own numbering scheme. For example, to generate a ToC of both normal headings and 'appendix' headings, specify the following ToC settings:
1293 This option is evaluated during both ToC generation and ToC formatting. This enables you to generate a ToC of all groups, but - after generating - format only specified groups:
1361 This option is evaluated during both ToC generation and ToC formatting. This enables you to generate a ToC of all levels, but - after generating - retrieve only specified levels:
1595 See L<Generate multiple ToCs|"Generate multiple ToCs"> for an elaborated example using the C<attributeToTocToken> to generate a ToC of image C<alt> attribute values.
