Stream: IG creation
Topic: ig.ini documentation?
Bob Milius (Apr 21 2020 at 16:40):
I've looked for documenation for the ig.ini file. I see info on the json control file specification in https://confluence.hl7.org/display/FHIR/IG+Publisher+Documentation but can't find anything on ig.ini.
Specifically, I'm looking for how to specify the special-urls in an ig.ini, or does it belong somewhere else?
Jose Costa Teixeira (Apr 21 2020 at 16:42):
https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters
Jose Costa Teixeira (Apr 21 2020 at 16:42):
is that it?
Jose Costa Teixeira (Apr 21 2020 at 16:43):
this is a parameter in the IG itself
Bob Milius (Apr 21 2020 at 17:39):
ah, okay. Thanks! I saw it was in the json control file and figured it would be in the ig.ini as well.
Back to the original question, where can I find documentation on the ig.ini ?
Jose Costa Teixeira (Apr 21 2020 at 17:42):
I don't know if there is any documentation on the ig.ini. @Lloyd McKenzie ?
Jose Costa Teixeira (Apr 21 2020 at 17:43):
if not, we can make something.
Chris Moesel (Apr 21 2020 at 17:54):
ig.ini is documented a bit here: https://build.fhir.org/ig/FHIR/ig-guidance/using-templates.html#root
It used to support a lot more entries, but they were refactored out and into other locations (mainly the ImplementationGuide resource instance). SUSHI lives a little in limbo land in that it supports the old entries in ig.ini too, but will translate them to where they ought to go as best it can (since it doesn't give you direct control over the ImplementationGuide resource instance yet).
Jose Costa Teixeira (Apr 21 2020 at 18:11):
we could put a well-commented ig.ini in the sample-ig.
Jose Costa Teixeira (Apr 21 2020 at 18:13):
something like
[IG] # ini file for the Implementation Guide publisher # lines commented like this are ignored # ig.ini parameters: ################ ##### ig ##### # the name of the implementation guide resource file. ig = input/be.base.ig.xml ##### template: ##### # the IG template that will be used to create the implementation guide (normally be a package name, but can be a local folder). # example: #template = fhir.base.template # it's possible to specify a specific version of the template # template = fhir.base.template#0.1.0 # or the current version: # template = fhir.base.template#current # if no version is specified, the publisher will take the #current version # template = ihe.fhir.template#current template = hl7.be.fhir.template # local templates can be used
Lloyd McKenzie (Apr 21 2020 at 18:29):
'parameters:' isn't a formal part of the ini file, so that probably shouldn't be there.
Jose Costa Teixeira (Apr 21 2020 at 18:29):
sorry
Jose Costa Teixeira (Apr 21 2020 at 18:31):
(this was a first experiment on how to split the content and forgot to comment that. fixed it now)
Jose Costa Teixeira (Apr 21 2020 at 18:37):
so, let's do that. +1 or -1 to confirm or reject the ones I have - or add others
Jose Costa Teixeira (Apr 21 2020 at 18:38):
usage-stats-opt-out - documented as ig parameter
Jose Costa Teixeira (Apr 21 2020 at 18:38):
suppressedWarningFile - ig parameter path-suppressed-warnings
Jose Costa Teixeira (Apr 21 2020 at 18:38):
excludettl /json/xml - not documented as an IG parameter
Jose Costa Teixeira (Apr 21 2020 at 18:39):
ballotstatus - not documented as an IG parameter
Jose Costa Teixeira (Apr 21 2020 at 18:39):
fhirspec - not documented as an IG parameter
Jose Costa Teixeira (Apr 21 2020 at 18:39):
copyrightyear - not documented as an IG parameter
Jose Costa Teixeira (Apr 21 2020 at 18:39):
license - not documented as an IG parameter
Jose Costa Teixeira (Apr 21 2020 at 18:39):
...?
Lloyd McKenzie (Apr 21 2020 at 18:39):
All of those others should now be handled elsewhere I believe
Lloyd McKenzie (Apr 21 2020 at 18:40):
You might want to explain how to point to a local template by either relative or absolute path.
Jose Costa Teixeira (Apr 21 2020 at 18:41):
yes
Jose Costa Teixeira (Apr 21 2020 at 18:45):
ok i updated the list above - many of these are not documented as IG parameters here https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters
Jose Costa Teixeira (Apr 21 2020 at 18:46):
iirc at least copyrightYear and license are indeed in the ig now
Lloyd McKenzie (Apr 21 2020 at 18:48):
ballotstatus got renamed and is documented somewhere. fhirspec is part of the IG as is license. The exclude[x] and copyrightyear are documented somewhere...
Jose Costa Teixeira (Apr 21 2020 at 19:26):
ballotstatus = releaselabel?
Lloyd McKenzie (Apr 21 2020 at 19:31):
y
Lloyd McKenzie (Apr 21 2020 at 21:18):
Applied Jose's PR to address this
Frank Oemig (Apr 23 2020 at 10:54):
Why not making the sample IG a self documentation?
Jose Costa Teixeira (Apr 23 2020 at 11:00):
the IG.ini for the sample IG has the documentation on the parameters and how to use them.
Jose Costa Teixeira (Apr 23 2020 at 11:00):
For more guidance , we have an IG that explains more about IGs: it's the guidance IG.
Jose Costa Teixeira (Apr 23 2020 at 11:00):
The sample IG is just the basic stuff
Frank Oemig (Apr 23 2020 at 11:01):
Ah, ok, thx. Just for completeness, Link?
Jose Costa Teixeira (Apr 23 2020 at 11:09):
http://build.fhir.org/ig/FHIR/ig-guidance/
Frank Oemig (Apr 23 2020 at 12:02):
:+1::+1:
Bob Milius (May 27 2020 at 18:18):
Thanks for updating some of the documentation, but it's still a bit challenging. For example, I see in other chat posts that there's an ig.ini parameter for server that the publisher uses to figure out to create redirects for apache or asp-new or litespeed. But I can't find any other documentation around that. I looked at the ig.ini found in the sample-ig but don't see this parameter in it, nor in the links described in it.
Lloyd McKenzie (May 27 2020 at 18:53):
@Grahame Grieve
Grahame Grieve (May 27 2020 at 20:06):
that's not an ig.ini parameter, and you never need to think about that. Only people hosting webservers do
Bob Milius (May 27 2020 at 20:30):
@Grahame Grieve ok, we're hosting a local webserver for non-HL7 IGs. Is there documentation for using this, or do we still not have to worry about it? and if we can/should use it, then where would I find the documentation for it? I'm interested in using existing tooling for redirection.
Igor Sirkovich (Jun 23 2020 at 05:08):
Jose Costa Teixeira said:
excludettl /json/xml - not documented as an IG parameter
I'm wondering whether there is a place where we can specify "excludettl /json/xml" in either ig.ini or config.yaml (Sushi).
Lloyd McKenzie (Jun 23 2020 at 05:19):
It should be declared as an IG parameter. The sampleIG shows what they should look like.
Grahame Grieve (Jun 23 2020 at 05:20):
feel free to add them here: https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters
Igor Sirkovich (Jun 23 2020 at 05:28):
In the sampleIG I see:
<parameter>
<code value="excludettl"/>
<value value="true"/>
</parameter>
However, R4 ImplementationGuide specifies parameter.code as "generate-turtle" (it seems in R5, the ValueSet binding has been removed).
When I use config.yaml in Sushi for my R4 IG, I'm wondering whether I should specify
parameters:
excludettl: true
or
parameters:
generate-turtle: false
Lloyd McKenzie (Jun 23 2020 at 05:33):
You want excludettl if you're using the HL7 base template. If you just want to control the generation of the turtle artifacts but not affect rendering, generate-turtle will work.
Igor Sirkovich (Jun 23 2020 at 05:36):
Thank you Lloyd! I'm using ig-template-base, will try excludettl.
Jose Costa Teixeira (Jun 23 2020 at 06:06):
Grahame Grieve said:
feel free to add them here: https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters
done
John Moehrke (Feb 22 2022 at 13:22):
I would like some clarity on ig.ini. I see the sample-ig has been trimmed down to just the ig and template, but yet it still points at the confluence page implementation guide parameters - https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters
does the ig.ini have anything to do with the IG parameters?
John Moehrke (Feb 22 2022 at 13:40):
for example, I have in some of my ig.ini
usage-stats-opt-out = false
which I think does nothing in the ig.ini... right?
Lloyd McKenzie (Feb 22 2022 at 14:48):
All of the other parameters are now handled in the ImplementationGuide, not in the ig.ini
Lloyd McKenzie (Feb 22 2022 at 14:48):
Feel free to fix the documentation :)
David Pyke (Feb 22 2022 at 19:47):
deleted
Last updated: Apr 12 2022 at 19:14 UTC
