Stream: IG creation
Topic: summary tab is confusing to readers
Eric Haas (Feb 20 2021 at 04:07):
J#30783 is from an implementer complaining about the summary tab in the profile view. I propose we either:
- Remove it all-together
- Allow option for custom summaries that can be injected into the IG to provide useful information
Lloyd McKenzie (Feb 20 2021 at 04:14):
I prefer:
- Replace it with something that's more useful and (perhaps) move it from being the default tab.
We don't want different IGs having different content in the summary and we don't want to push a bunch of manual work on IG authors. I know you've done some 'better' summaries for your IGs in the past. Can we just set up the template to spit that out or do we need some help from the publisher to spit out an appropriate fragment?
Eric Haas (Feb 21 2021 at 04:42):
They are optimized for US Core and they are also using a template that leverage python methods so would be need to be turned into liquid. I think 80% of the definitions summary would turn out to be pretty straightforward, but I am concerned the last 20% (slicing) and maintenance will turned to be a lot of work.
Lloyd McKenzie (Feb 21 2021 at 05:04):
Agree that whatever we come up with needs to be maintainable - but if the alternative is pushing that maintenance work onto every IG publisher, that's much worse. I think we should mock up the algorithm for what we think it should look like that works generically and will be useful for various types and sizes of IGs. If we can do that using Liquid, great. If we need to write some Java code (or more likely, change the existing Java code) to spit out what we want, that's completely viable.
Eric Haas (Feb 22 2021 at 17:05):
I'll take a stab a liquid with what I got.
As far as default tab, I prefer differential - but I am primarily an editor so that is my bias, I have heard some prefer full/snapshot and other MS view.
Need a poll
Jose Costa Teixeira (Feb 22 2021 at 17:17):
Eric Haas said:
Need a poll
And / or a way for template editors to override the default tab?
Lloyd McKenzie (Feb 22 2021 at 17:24):
You can revamp the templates to change order of tabs or remove tabs entirely, but there's no "flag" that can do that (and I can't imagine an easy way to make that happen)
Eric Haas (Feb 22 2021 at 17:40):
actually there is a way to define the default view with an integer value. so it could be defined by authors with a parameter ... i prefer a standard default view however
Jose Costa Teixeira (Feb 22 2021 at 18:27):
Correct. We can have a JS variable that tells which tab to open first.
Changing the order = more work.
Lloyd McKenzie (Feb 22 2021 at 18:44):
Ah, right. I was thinking of re-ordering, not just selecting the default tab. Agree that we want the order (and default) consistent for all HL7 IGs. However, it might be reasonable to make it easy to configure for non-HL7-published IGs
Eric Haas (Feb 22 2021 at 19:13):
it might be reasonable to make it easy to configure for non-HL7-published IGs
I've done this pre templates ... so not hard
Last updated: Apr 12 2022 at 19:14 UTC
