Jazz Forum Welcome to the Jazz Community Forum Connect and collaborate with IBM Engineering experts and users

IBM ELO PUB Jazz 7.1 - TOC Behavior with Multiple Heading Styles

We are using Document Studio to generate Word/PDF documents with TOC and hierarchical chapters.

Observations
  • Predefined style "Title" works well , appears in TOC
  • Imported styles from .dotx (Heading_1 to Heading_9) do not appear
  • Manually created styles (Title_1 to Title_9) also fail to appear

Verified behaviors
  • "Title" is always included in TOC
  • Only Text elements trigger TOC entries
  • toc item level = 5 works correctly
  • heading level offset is honored

Unexplained behaviors
  • Heading_01 and similar styles ignored despite valid setup
  • No way to inspect or set Style Type (Paragraph vs. Character) in Document Studio
  • No feedback when TOC fails to include styles
  • Style inclusion seems tied to internal typing logic

Summary
  • Only "Title" style consistently appears in TOC. All other styles fail despite correct configuration.
  • We suspect internal style typing is the root cause.

Questions
  1. How can we mark your own styles as being TOC-effective?
  2. What criteria does PUB check to include styles in the TOC?
  3. What else should we check?
  4. Are there known issues with TOC in Jazz 7.1?
  5. Any workaround or diagnostic tools?
  6. Where can we find deeper documentation on TOC and style handling?

0 votes



4 answers

Permanent link
Analysis results
  • TOC Code doesn't help -> the Styles like Heading_1, Heading_2 and more are not visible in TOC
    • e.g. TOC Code = TOC \t "Heading_1,1,Heading_2,2,Title_01,1" \h \z \u
  • Style is defined correct, also the Style Type = Paragraph 
    •  Style Type = Paragraph in dta-Template.xml result in a  Style Type = Character in generated HTML-Doc (<span>Heading_2</span>)

It looks like an issue in processing Styles for TOC in Jazz 7.1 ELO PUB

0 votes


Permanent link
The TOC is generated using the Word TOC options, which means that, whatever styles you use in PUB, they must be mapped to a style of the same name in the Word document template, and those styles must be mapped to the Heading1-Heading6 levels inside the Word styles.

To make sure this is working, open Word and create a new document from the PUB template you're using, and then insert a TOC element. Then go through adding heading levels using your custom styles. If the TOC doesn't populate properly, then map your heading styles to the heading levels you want them to apply to inside Word. 

Once everything is working well, go back to your PUB template and associate your custom heading styles with the heading levels, and save

0 votes


Permanent link

Thank you, Davyd, for your timely and well-considered reply. We will use this approach to verify the behavior.


Based on our experience with ELO PUB 7.1, we have encountered behavior that appears inconsistent and counterintuitive in non-Word workflows.

In our dta file, we manually assign level-specific paragraph styles, such as Heading_1 or Heading_2, to each doc-chapter. These style names are not used arbitrarily. Both the document block (doc-chapter) and the associated style are configured to reflect a specific structural level, ensuring semantic clarity and consistent styling throughout our documentation.


We do not rely on automatic style detection and we do not use Word templates with mapped styles. Our entire workflow is based on dta and DSX-Launcher.


Despite these level-aware configurations, ELO PUB renders the styles in the HTML output as inline elements rather than semantic block-level headings. As a result, the table of contents generation fails to recognize these entries, even though their levels are explicitly defined in both style metadata and content markup.


From our perspective, this behavior reduces the reliability of structured styling and compromises TOC usability in non-Word scenarios. At the very least, we would expect consistent handling of configured levels during export, especially when defined explicitly in both style and content logic.


If this behavior is intentional, we kindly request clear documentation of this limitation. Otherwise, we hope IBM considers enhancing this aspect of the export mechanism in future releases.

0 votes

Comments
When you say non-Word, what do you mean? You have two basic options in PUB:
 - Word and PDF, which are driven under the covers by Word templates
 - HTML based formats, which are driven by CSS templates

If you're ultimately creating a Word or PDF document then the table of contents is driven by Word styling and you need to work with the styles in the Word template - even if you ultimately do not use a template to generate, you use Word to create the field code that defines the contents and how they look, and you paste this into the TOC element in the DTA

If you're creating HTML based output then the table of contents is driven by both the defined styles in the dta and the CSS template. You firstly have to define the styles that will become the levels in your TOC and then you need to assign these styles to Paragraph elements (not Text)

What elements are you assigning the defined heading styles to? If you're assigning the Heading styles to elements that generate a span (such as text) then maybe that's the issue?

I had a play with this last night:
 - for Word based generation (Word/PDF), if you do not explicitly define styles in your template and map them to heading levels as described above, then you must use the Word default names of "Heading 1", "Heading 2", ... "Heading 6" as your style names in the .dta
 - for HTML based generation, you must use the default HTML heading definitions of "H1", "H2", ... but you can go down an arbitrary number of levels. If you do go further than H6, you need to change settings in the elements and generation


Permanent link

Thanks for your valuable input, Davyd - we have to review your suggestions thoroughly.


In our setup, we have observed that only the predefined "Title" style appears in the Table of Contents (TOC). Even though we have created custom styles and properly classified them as heading styles within the Word template, they are not picked up by PUB for TOC generation.

These styles were manually defined in the template (not imported), and we have ensured they are semantically consistent. However, PUB seems to ignore them in the TOC logic.


So far, we have only tested this behavior with dta/dsx templates, and we have not yet had a chance to explore it with dotx templates via Launcher. We would be very interested to know if there is any internal mapping mechanism or limitation that restricts TOC recognition to specific styles.


Is there a documented mapping or a known way to register custom styles so PUB includes them in the TOC structure?


You: ... then you must use the Word default names of "Heading 1", "Heading 2", "Heading 3", "Heading 4", "Heading 5", "Heading 6"

  • Styles with spaces are not accepted in dta Document Studio

0 votes

Comments
It's best not to keep adding new answers to the topic here as it gets confusing. Couple of points:
 - if you have a Word document as a template, then you don't need to explicitly create the style in the DTA. You can simply type the name in the Property and it'll be applied via the template
 - creating the same style name in the DTA and the template will result in merging of style elements in the document, which could be the issue
 - Word templates can be .doc(x), or .dot(x). I personally always use .doc because you can set up a totally custom front page and front matter section and insert data into it via the DTA Target Region properties. I actually almost never use TOC elements in my DTA, I always put them in my doc template
 - you can type style names with spaces into the properties section of elements

Sorry regarding new answer. It was not possible to comment your post, only my anwer. Think I've got the hang of it now


Based on your response, Davyd, we might interpret that IBM PUB does not currently implement a mechanism to fully translate well-defined styles from dta templates into functional Word styles - for example, the "Paragraph" style seems to be lost in translation.


It also seems that TOC generation may only work reliably when using Word-based templates via the dsx Launcher, as PUB appears to rely on Word's native style mapping rather than its own internal logic.

Disagree - it's actually a pretty cool implementation and there are quite a few articles out there that will give you lots of help.

Best practice in PUB is to, as much as humanly possible, separate the generation from the styling. In fact I'll go one further because of some nightmares I've had with clients adding styling and front matter into DOORS Next modules - separate the content from generation from styling!

This means that, for Word type output (Word and PDF), you create a Word doc/docx and define all your styles there, as well as your cover page, front matter detail, headers and footers. This is usually simple because many organisations already have standard document templates. 

You then replace any document specific content with named bookmarks, or document property values. Then create your PUB dta file and set up text/paragraph/container elements with Target Region set to the Word bookmark names, Document Property elements, and core content with Style property set to the Word style names - no other styling.

Then generate!

The benefit of this is that you can change the style of the document completely without touching the DTA. You can even have the same document generated for different projects by just changing the Word doc template.

For HTML based output, try to follow the same approach. Define a CSS file with style names and use those names in the Style property of content. You will need to manually add TOC and other areas into your DTA when you're generating HTML and this is mainly what the PUB supplied elements are for.

The only time I ever add style info into my DTA is when I explicitly want to enforce the style, but this is the least flexible approach and I try to avoid it whenever I can.

Thanks again, Davyd. That makes perfect sense now. Given our use case — printing risk content with header, footer and TOC from Jazz EWM — requiring dotx templates added complexity, as dta/dsx workflows are more flexible in our setup. We’ve therefore handled TOC manually so far. Considering these constraints, we’ve opted to control TOC visibility and layout via scoped pattern logic and manual style management.

You: "there are quite a few articles out there that will give you lots of help."
I'm still searching ;-)

We configured TOC generation in IBM ELO PUB Jazz 7.1 using Word-based heading styles. Styles like Heading_1 and Heading_2 work when applied to Text elements.

However, the TOC code editor in Document Studio rewrites valid field code incorrectly. For example:

Expected:

TOC \t "Heading_1,1,Heading_2,2,Heading_3,3,Heading_4,4" \h \z \u

After opening the editor:

TOC \t "Heading_11Heading_22Heading_33Heading_44" \h \z \u
     
        

This breaks TOC output silently.

Workaround: Edit the TOC code in an external editor and paste it into the Property dialog—not the editor window.

Would be helpful if this behavior could be clarified or addressed.

showing 5 of 6 show 1 more comments

Your answer

Register or log in to post your answer.

Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.

Search context
Follow this question

By Email: 

Once you sign in you will be able to subscribe for any updates here.

By RSS:

Answers
Answers and Comments
Question details
× 12,125
× 114
× 4
× 3

Question asked: Jul 19 '25, 10:43 a.m.

Question was seen: 1,494 times

Last updated: Jul 28 '25, 8:15 a.m.

Confirmation Cancel Confirm