Stream: IG creation
Topic: Artifact Index tab narrative
John Moehrke (May 12 2021 at 23:56):
Is there a way to add narrative to the Artifact Tab? I would like to explain to my reader how to understand this huge page of stuff.
Lloyd McKenzie (May 13 2021 at 00:01):
My intention is to put a page in the 'guidance' IG that explains how to read all of the different tabs and parts of a standard template IG and then have the template include a link to the relevant section of that page. If you want to take an initial stab, feel free...
John Moehrke (May 13 2021 at 00:09):
Likely a good idea... but much bigger than I was hoping I needed to do. I was mostly looking to just add narrative that says... "Don't start here, the context and use of each artifact is best discovered reading the narrative of the IG.
John Moehrke (May 13 2021 at 00:11):
The Artifact Index good for the advanced user. But I have had too many novice go in there and get confused. Especially regarding finding structure definitions that are in the IG as they are part of pattern creation. meaning they have no intended use, except for modeling.
Lloyd McKenzie (May 13 2021 at 00:28):
If you have a 'Home' page on your menu tab, that's usually what most people would click if they first hit a detail page and are confused. Having text on every page that says "don't start here" would get pretty annoying I'd think...
John Moehrke (May 13 2021 at 00:29):
not disagreeing.. just the artifact index has been a problem
John Moehrke (May 13 2021 at 11:44):
Reviewer used Artifact Index to find an example instance, and could not figure out what it was an example of. This because the examples do not show breadcrumbs back to the structureDefinition, (short-term solution is to add exhaustive replicated instructions in ALL examples.
Jose Costa Teixeira (May 13 2021 at 12:12):
where is this?
Lloyd McKenzie (May 13 2021 at 12:59):
Can you add a Git issue?
Lloyd McKenzie (May 13 2021 at 12:59):
(to the template)
Lloyd McKenzie (May 13 2021 at 12:59):
Note that some examples won't be linked to a particular profile
John Moehrke (May 13 2021 at 13:44):
to which github repo?
Jose Costa Teixeira (May 13 2021 at 13:46):
this would be in the ig base template
John Moehrke (May 13 2021 at 13:48):
ig-template-base?
Jose Costa Teixeira (May 13 2021 at 14:35):
yes
Eric Haas (May 13 2021 at 15:00):
Artifact table is indeed confusing.l and unwieldy We are we that? I strongly prefer independent pages for each type as I did ore templates
Eric Haas (May 13 2021 at 15:01):
“Pre templates “
Lloyd McKenzie (May 13 2021 at 15:58):
What would vary by type?
John Moehrke (May 13 2021 at 21:31):
Artifacts index navigation improvements github issue https://github.com/HL7/ig-template-base/issues/156
Last updated: Apr 12 2022 at 19:14 UTC
