incubator-odf-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "DaLi Liu (JIRA)" <>
Subject [jira] [Created] (ODFTOOLKIT-329) Add a new Simple API to generate a table of content in text document
Date Fri, 03 Aug 2012 01:44:02 GMT
DaLi Liu created ODFTOOLKIT-329:

             Summary: Add a new Simple API to generate a table of content in text document
                 Key: ODFTOOLKIT-329
             Project: ODF Toolkit
          Issue Type: New Feature
          Components: simple api
    Affects Versions: 0.8.6
            Reporter: DaLi Liu
             Fix For: 0.8.6

Dear all,
I want to generate a table of content by ODF toolkit Simple API. But it seems that there doesn't
exist such method. So I proposal to add a new API createTOC to Simple API.
Specification: parameters for the new API are: 1. position/location of TOC, 2. TOC style to
be used
ODFToolkit API: TextDocument.createTOC(positionElement, TOCStyle).

Discuss with Rob Weir:
     Also, it would be good to discuss how you will enter a ToC.   If you
    do this operation in a word processor, like OpenOffice, you see it
    does two things:

    1) Enter the markup for <text:table-of-content> that defines the
    structure and style relations for the table of contents.

    2) Gather the header text from elsewhere in the document and enter
    that, along with page references, into a <text:index-body>

    Doing #1 is easy.  But #2 is very difficult.  Why?  Because until you
    do a full layout of the document, taking into account font metrics,
    line breaking algorithms, hyphenation, image positioning, "orphan and
    widow" rules, etc., you don't know what content is on which page.

DaLi: yeah, you are right, the page number will be difficult issue.

    So the easiest thing is to just do #1 and then have the user do an
    "Update Table" operation in the word process the next time the
    document is loaded.

Dali:I will try to do #1 first.

    Next easiest is to collect the header text to put in the ToC, but not
    try to calculate the page numbers, leaving that to be calculated when
    the document is loaded in a full word processor.
Dali:After finish #1, will consider this.

Any comments are welcome

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:!default.jspa
For more information on JIRA, see:


View raw message