[OASIS Issue Tracker] (MQTT-496) Use hyperlink rather than cross reference

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

Ken Borgendale created MQTT-496:
-----------------------------------

             Summary: Use hyperlink rather than cross reference
                 Key: MQTT-496
                 URL: https://issues.oasis-open.org/browse/MQTT-496
             Project: OASIS Message Queuing Telemetry Transport (MQTT) TC
          Issue Type: Bug
          Components: edits
    Affects Versions: 5, CSD01
            Reporter: Ken Borgendale
            Assignee: Ken Borgendale
             Fix For: 5


The TAB is busy producing a handbook for OASIS spec editors with the goal of providing practical advice to help them get specs together efficiently. 

However, we identified one tip that, because it is so black and white, we wanted to get out immediately. 

When creating links in Word or Open Office, whether intra-document or inter-document, do not use the cross-reference feature. Use hyperlinks to bookmarks you have set instead. 

The reason for this is that we've realized that while cross-references work fine in the tool, when we save your spec as PDF or HTML, the cross-reference links are not saved. We have encountered this in some documents lately and we haven't found a way to fix it.

Bookmarks work even though they take more effort on your part. Mark any text that you want to act as a link target as a bookmark using your editing tool. (E.g. highlight the text and select Insert / Bookmark.) 

Then, use Insert / Hyperlink, select the document and select the bookmark. 

We have never encountered problems with links done this way even where the editors have constructed complex links to different directories, etc. 

If anyone knows of a method for making cross-references work, please let us know. Meanwhile, to ensure that your links work in all cases, use Bookmarks and Hyperlinks. 




--
This message was sent by Atlassian JIRA
(v6.2.2#6258)