Bookmarks broken in the latest update

[domwhewell-sage]

Describe the bug
When you add a heading, you can use the "Set Bookmark" button to add a bookmark to the heading.

However when you generate the docx the bookmark does not exist

When generating an exportable json report the data-bookmark attribute exists

Expected Behavior
The bookmark should be added to the docx

Server Specs:

• Ghostwriter v6.0.4

[domwhewell-sage]

Removing "_Ref" from https://github.com/GhostManager/Ghostwriter/blob/master/ghostwriter/modules/reportwriter/richtext/docx.py#L122 and https://github.com/GhostManager/Ghostwriter/blob/master/ghostwriter/modules/reportwriter/richtext/docx.py#L128 seems to work

I am unsure why it works for figures and not the heading paragraph

[ColonelThirtyTwo]

ce71e1b adds the _Ref prefix to match what {{.ref}} looks for.

[github-actions]

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

[chrismaddalena]

Do you still have an issue @domwhewell-sage?

[domwhewell-sage]

Hi @chrismaddalena,
Yes the bookmarks do not apply in v6.1.1

For example: I have added a bookmark called test to this document

In word the document shows as having no bookmarks

[ColonelThirtyTwo]

The problem is that I'm not sure the best way to solve this, especially while retaining backwards compatibility. Bookmarks from captions always had the _Ref prefix and thus never appeared in the bookmark list, and so {{.ref}} prepends that prefix in the given ID. Headers initially lacked the prefix, so {{.ref}} didn't refer to them properly, which ce71e1b fixed, but during that time where it wasn't fixed, they appeared in bookmarks.

So the options are:

• Keep the _Ref prefix on everything (i.e. how it is now). Nothing appears in bookmarks list and {{.ref}} still works.
• Remove the _Ref prefix from everything. Headings will appear in the bookmarks list, but so will captions, unless the templater manually adds the _Ref prefix themselves. {{.ref}} still works (with the bonus that it takes the bookmark ID directly and can therefore more easily refer to bookmarks in the template itself).
• Keep _Ref for captions but remove from headers and {{.ref}}. Headings will appear in the bookmarks but captions won't. People using {{.ref}} will need to change and remember to use the _Ref prefix for captions but not for headings, which is IMO a big footgun.

[domwhewell-sage]

Ah so word interprets # as an internal hyperlink to a bookmark (#706) not a reference