Stream: committers
Topic: Constructing stable links
Grahame Grieve (Jul 14 2016 at 23:16):
One feature of FHIR that users like a lot is the little globe icon to the left of a heading. You can right click on it, copy the location of the header, and email someone the link
Grahame Grieve (Jul 14 2016 at 23:16):
consider this link:
Grahame Grieve (Jul 14 2016 at 23:16):
http://hl7-fhir.github.io/location.html#example
Grahame Grieve (Jul 14 2016 at 23:17):
however, consider this link:
Grahame Grieve (Jul 14 2016 at 23:17):
http://hl7-fhir.github.io/location.html#8.12.5.1
Grahame Grieve (Jul 14 2016 at 23:18):
see how that link uses the generated index value in the link - even though it's not persistent. As the content is reorganised, or content is added above it in the page, the location numbers will change. And that won't point at the same thing
Grahame Grieve (Jul 14 2016 at 23:18):
this is a constant problem for me- people put those links in their tasks, but the task now doesn't point anywhere near the same content as it used to.
Grahame Grieve (Jul 14 2016 at 23:18):
what's the difference between those two in the source?
Grahame Grieve (Jul 14 2016 at 23:19):
<a name="example"> </a>
<h2>Example Location Hierarchy</h2>
Grahame Grieve (Jul 14 2016 at 23:19):
and
Grahame Grieve (Jul 14 2016 at 23:19):
<h3>Positional Searching</h3>
Grahame Grieve (Jul 14 2016 at 23:20):
note the missing anchor. You, the editor, add the anchor, and if it's there, the generator will use that anchor in preference to the generated section number. But if it's not there, there's no stable link to go by
Grahame Grieve (Jul 14 2016 at 23:20):
please remember to add the anchors everywhere.
Grahame Grieve (Jul 14 2016 at 23:21):
this is in reference to the content in [type]-introduction and [type]-notes, and more generally, in any of your edited HTML pages. It does not apply to the new IG publisher, where you're on your own for that stuff anyway
Grahame Grieve (Jul 14 2016 at 23:23):
and, btw, it must be
<a name="whatever"> </a>
Grahame Grieve (Jul 14 2016 at 23:23):
not
<a name="whatever"/>
Grahame Grieve (Jul 14 2016 at 23:24):
I'm sure it's a bug, but all the versions of webkit I've ever tested completely freak out with the second option, and miss the end of the hyperlink.
Brian Postlethwaite (Jul 14 2016 at 23:51):
Can this be made into a build warning?
Grahame Grieve (Jul 14 2016 at 23:51):
well, I certainly could. How woudl you feel about another 10k warnings?
Brian Postlethwaite (Jul 14 2016 at 23:59):
Its that bad?
Then maybe not.
Brian Postlethwaite (Jul 14 2016 at 23:59):
Will update the ones I know of.
Brian Postlethwaite (Jul 15 2016 at 00:00):
Its any entry in the notes/intro.xml that has a <h?> tag right?
Grahame Grieve (Jul 15 2016 at 00:02):
y
Grahame Grieve (Jul 15 2016 at 00:03):
I don't know how many it is. It used to be a number like that, but I've been chipping away at it. e.g. while on a call I'll do a search for <h and plough through them
John Moehrke (Jul 15 2016 at 14:17):
I think it should be a warning, as it is likely a bad-quality indication.
Lloyd McKenzie (Jul 15 2016 at 22:45):
I think it should be an information message. Warnings mean you can't be FMM level 1. Information messages mean you can't be FMM level 3
Last updated: Apr 12 2022 at 19:14 UTC
