Caution: This documentation is for eZ Publish legacy, from version 3.x to 6.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

toc

Summary

Inserts a generated table of contents (DEPRECATED).

Usage

pdf(toc, hash( contentText, toc_header_text,
             [ size,        size_array,  ]
             [ dots,        boolean,     ]
             [ indent,      indent_array ] ) )

Parameters

NameTypeDescriptionRequired
contentText string Table of contents header. Yes.
size array An array of numbers, indicating the font sizes for each header level. No.
indent array An array of booleans, indicating whether the title should be indented for each header level. No.
dots boolean Display dots between the titles and page numbers. No.

Description

This function generates and inserts the table of contents after the front page. If the front page is not available, the table of contents is inserted at the beginning of the PDF document.

Examples

Example 1

{pdf( 'toc', hash( 'size', array( 18, 16, 14, 12, 10 ),
      'dots', true(),
      'contentText', 'Content'|wash( 'pdf' ),
      'indent', array( 0, 4, 6, 8, 10 ) ) )}

This example creates a table of contents. The size of the level 1 headers will be 18 and will not indented, level 2 headers will have size 16 and will be indented 4 dots, etc. There will be dots between the headers and the page numbers.

Balazs Halasy (14/05/2004 8:19 am)

Julia Shymova (11/01/2008 1:12 pm)

Balazs Halasy, Julia Shymova

Comments

There are no comments.