FHIR Chat · IG Publisher documentation layout clarification

Stream: IG creation

Topic: IG Publisher documentation layout clarification

Bob Milius (Jun 09 2020 at 15:18):

I've been reading and rereading the the IG Publisher documentation and have something I have a couple of things I'd like to clarify.

Layout Requirements:

for each resource in the implementation guide, whether a conformance resource or an example, the IG Publisher will produce

[Type]-[id].html - the home page for the resource (note: you can rename this page using the control file)

[Type]-[id].[fmt] - the resource for the specified format (pretty printed)

!! [Type]-[id].canonical.[fmt] - the resource for the specified format in canonical format (not produced for ttl) (not currently produced)

redirects from /[Type]/[id] to one of the pages above (depending on request format)

[Type]-[id].[fmt].html - An HTML wrapper around the specified format, with a link to the native form

I have a question from our devops guys.
Is there a way to configure the publisher to create the subdirectories so that redirection isn't necessary?
e.g., we see that note: you can rename this page using the control file.
Is it permissible to rename [Type]-[id].html to [Type]/[id].html?
Or to define subdirectories where the different types are found? I think I know the answer to this, but just want to confirm.

Also, re redirection, should the redirection point to the current release at the top level, or point to the most recent milestone release explicitly. For example, let's say we have an IG whose most recent milestone is STU1, and can be found at
myig/
and at
myig/STU1

should
myig/StructureDefinition/thing
redirect to
myig/StructureDefinition-thing.html ?
or should it redirect to
myig/STU1/StructureDefinition-thing.html ?

Lloyd McKenzie (Jun 09 2020 at 15:41):

I don't think so. Subdirectories makes hyperlinking that much harder. @Grahame Grieve?

Grahame Grieve (Jun 09 2020 at 19:58):

Is there a way to configure the publisher to create the subdirectories so that redirection isn't necessary?

no. there isn't. And it wouldn't make redirection unnecessary, since redirection is based on the Accept header

Grahame Grieve (Jun 09 2020 at 19:59):

should the redirection point to the current release at the top level, or point to the most recent milestone release explicitly

the generator redirects to myig/StructureDefinition-thing.html not myig/STU1/StructureDefinition-thing.html

Grahame Grieve (Jun 09 2020 at 20:00):

not that the publication manager does a whole lot more than just manage redirects

Bob Milius (Jun 09 2020 at 20:07):

Thanks, @Grahame Grieve !
I notice that us-core redirects to the milestone.
e.g.,
http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
redirects to
http://hl7.org/fhir/us/core/STU3.1/StructureDefinition-us-core-patient.html

Bob Milius (Jun 10 2020 at 15:03):

Grahame Grieve said: