Stream: shorthand
Topic: Implementation guide instances
Thomas Tveit Rosenlund (Nov 27 2019 at 09:30):
Thanks for a great presentation at the Dev Days!
Browsed through the documentation on GitHub and thought, would'nt it be Nice to be able to define the actual ImplementationGuide Instance in Shorthand to? The way I read the documentation I still have to provide a Handwritten IG instance for the IG-Publisher to actually make an Implementation Guide. Maybe I'am just interpreting the documentation wrong.
Grahame Grieve (Nov 27 2019 at 12:27):
that's certainly where we are, but it probably makes sense to do shorthand for the IG as well. But I suspect it's lower priority than everything else
Chris Moesel (Dec 02 2019 at 14:54):
Right -- we want to support a simpler approach to generating a whole IG, but we were also waiting for the IG Publisher templating approach to settle down a bit so that we're not chasing a moving target. But... given a FSH Tank and the package.json file, I think we can generate much of the content of the ImplementationGuide instance. We just need to design how it should work in a way to also allow flexibility for authors. As Grahame said, it's just a matter of priorities at this point -- and we're still defining core functionality right now.
Ward Weistra (Dec 12 2019 at 16:34):
It seems @Nick Freiter has started work on this? Sorry, I've missed a few Shorthand calls, though not due to a lack of interest :slight_smile:
I don't see any documentation on it on https://github.com/HL7/fhir-shorthand/wiki yet, can you give a brief overview of the thinking right now? Shorthand to describe a IG FHIR resource and then markdown files to create the pages, with some special codes for rendering and such? Thanks!
Chris Moesel (Dec 12 2019 at 16:41):
Hi @Ward Weistra -- Nick is working on downloading the FHIR core packages (and eventually HL7 IGs). I'm working on the start of exporting something that can be used as source for the IG Publisher. There isn't much documentation on it yet, as I'm kind of working out how it might work as I go along. It's a bit complicated by the fact that the template-based IG publishing is not yet fully documented.
Chris Moesel (Dec 12 2019 at 16:44):
The initial version will be very simple. It will require minimal user input to get something that is buildable, and the result will be admittedly plain. I think it will probably have a way, however, for a user to provide ancillary files that get fed directly to the publisher -- so there should be a lot of flexibility; but only for people who really know and understand how the template-based publisher works.
Chris Moesel (Dec 12 2019 at 16:45):
A future version will provide more user-friendly mechanisms for controlling the IG output, but we may wait for the template-based IG Publisher work to stabilize a bit (and be more fully documented) before implementing anything too fancy around IG generation.
David Hay (Dec 12 2019 at 18:00):
@Chris Moesel happy to be a tester if / when you want one...
Ward Weistra (Dec 16 2019 at 16:07):
Sounds perfect @Chris Moesel, thanks. I'd like to get that working with our Markdown IG editor at some point, so also happy to test.
Last updated: Apr 12 2022 at 19:14 UTC
