Cross-references in Word template

[alph-beta-gamma]

Hey,

When generating a .docx report, I create two main components:

1. A table of findings that includes columns such as the finding title and severity.
2. A dedicated section for each finding containing all relevant fields (scope, description, severity, impact, etc.).

I would like to know whether it is possible to add a cross-reference to each finding title within the table. This cross-reference should link directly to the corresponding detailed section of that specific finding in the document.

Thanks for your feedback.

[chrismaddalena]

The exact answer to this question depends on how you want to set up this document.

You can create cross-references within Ghostwriter, but you need to know the reference ID for the target bookmark. Usually, Word creates an ID value when you create a cross-reference in the application. There's no way to predict these, so you need to know it ahead of time for Ghostwriter to create a valid bookmark. For example, you can create a caption for a table or image, assign a bookmark ID that Ghostwriter sets in the output OpenXML, and then create a bookmark that references that ID. In the final Word doc, you'd be able to click the reference and jump to the caption.

There's also an option to create a heading and set a bookmark. We're working on something related to that in #707 .

So, it's theoretically possible to arrange something like what you're after, but I think it'd require some effort and could be a pain.

It sounds like you have a table and want to link to the finding titles in that table to the finding titles that appear as headings later in the document. For that you might want a link. When placing the link in Word, you'd select "Place in Document" and select your heading or a bookmark for that finding. Currently, when you create a link in Ghostwriter, the resulting link in Word assumes it's a web address, so that won't work for you unless you do it in Word after generating the document. We may explore making "Place in Document" links possible for the future.

The cleanest solution would be using Word's Table of Contents options. You can configure the ToC to include the heading type used for your findings. When you generate your document, Word generate the ToC for you, including all your finding titles with clickable bookmarks that jump to that finding (same as every other heading in the ToC).

[github-actions]

This issue has been labeled as stale because it has been open for 30 days with no activity.