Comments in topic titles

[Marc]

It seems that comments that are placed within a topic title are ignored when publishing a PDF with the option "Publish PDF for Peer Review" switched on. Is this a bug or is there any option to enable this?

[Tim Green]

Hi Marc,

When you export to PDF only the plain text of the topic header is passed to the PDF template, nothing else. This is because the topic header is formatted entirely by the template, which is necessary to enable different formatting for the headers in topics on different TOC levels in PDF output. Nothing else you include in the header in the project will appear in the header in PDF: In addition to formatting this also includes images, comments and any other constructs that are not the plain text of the title.

Actually, by default not even the text of the title in the topic header is exported, because the standard <%HEADINGx%> variables insert the TOC caption, not the text from the topic header (which may be different/longer). The topic header text is only used with the alternative <%HEADINGLONGx%> variables in the Topics section of the PDF template. But there too, only the plain text is exported.

If you need a comment for the entire topic just put it at the top of the body of the text.

[Marc]

Thanks Tim, I see the reason. Maybe then it would be a good idea to prohibit adding comments in the heading in the first place? Just a suggestion so that no important information intended for reviewers can get lost in the process..