View Issue Details

IDProjectCategoryView StatusLast Update
000972311020: Companion Spec TemplateImplementation Bugpublic2024-11-09 08:02
ReporterKarl Deiretsbacher Assigned ToKarl Deiretsbacher  
PrioritynormalSeverityminorReproducibilityhave not tried
Status resolvedResolutionfixed 
Summary0009723: Can Specs use hyperlinks to the online reference
Description

From Randy:
Permanent links have the form:
https://reference.opcfoundation.org/Machinery/Jobs/v100/docs/7.2

Where v100 is the document version (1.0.X) and 7.2 is the section number.

Search links shall not be used at all. They are not guaranteed to return the same results in the future.

While the links are a huge convenience for the reader, they should not be in normative text. The published document is the bible (the standard).
We could allow for non-normative text/examples.

From Jim:
Even the "permanent" links are not really permanent. For example:

  1. We make no claim to keep all versions of a spec online, so links to older versions may go dead.
  2. With the core specs, only the latest version is online and the section numbering can change between versions, so the permalink may resolve, but it could bring you to the wrong section.
    I suggest we discourage any deep hyperlinks between OPC UA Specs including companion specs.
TagsNo tags attached.

Activities

Jim Luth

2024-08-05 13:43

administrator   ~0021530

Last edited: 2024-08-05 13:45

Even the "permanent" links are not really permanent. For example:

  1. We make no claim to keep all versions of a spec online, so links to older versions may go dead.
  2. With the core specs, only the latest version is online and the section numbering can change between versions, so the permalink may resolve, but it could bring you to the wrong section.

I suggest we discourage any deep hyperlinks between OPC UA Specs including companion specs.

Karl Deiretsbacher

2024-11-09 08:02

manager   ~0022043

A guideline "not to use such hyperlinks" has been added to v1.01.18 of the CS Template.

Issue History

Date Modified Username Field Change
2024-08-05 12:02 Karl Deiretsbacher New Issue
2024-08-05 13:43 Jim Luth Note Added: 0021530
2024-08-05 13:45 Jim Luth Note Edited: 0021530
2024-08-05 15:27 Karl Deiretsbacher Description Updated
2024-11-09 08:02 Karl Deiretsbacher Assigned To => Karl Deiretsbacher
2024-11-09 08:02 Karl Deiretsbacher Status new => resolved
2024-11-09 08:02 Karl Deiretsbacher Resolution open => fixed
2024-11-09 08:02 Karl Deiretsbacher Note Added: 0022043