Stream: ig publishing requirements
Topic: navigation to grouper
John Moehrke (Aug 18 2021 at 19:32):
Is there a method available (that I am unaware of), or an existing issue requesting;;; a navigation feature on an IG that the user can use to navigate "up" to a grouping page? For example, up to all Divinci IGs... or in IHE, up to the domain that this IG is published within?
I could certainly put this in to the narrative, just wondering if there was a way to do this in the header space.
Elliot Silver (Aug 18 2021 at 19:41):
I don't have an answer, but do you mean within an IG to a "parent" IG, or do you mean from within a particular valueset page to a page listing all the valuesets in the IG?
Jose Costa Teixeira (Aug 18 2021 at 19:42):
the latter, I'd think
John Moehrke (Aug 18 2021 at 19:42):
from an IG to a parent 'something'
John Moehrke (Aug 18 2021 at 19:42):
so the MHD IG, I would like to have a way to give the user the ability to go to IHE (already there), but also to just the IT-Infrastructure publication.
Jose Costa Teixeira (Aug 18 2021 at 19:43):
I misunderstood. How do you expect those relationships to be defined?
John Moehrke (Aug 18 2021 at 19:43):
author of the IG
Jose Costa Teixeira (Aug 18 2021 at 19:45):
I think the navigation (next/prev) could be enhanced with "parent page" - there should be value in that for those readers that read linearly (or for content that reads linearly)
Jose Costa Teixeira (Aug 18 2021 at 19:47):
but to a parent, unrelated IG - I don't see why this would be a feature. why not a link in the narrative in the front page?
John Moehrke (Aug 18 2021 at 19:48):
right. the mechanism could yet be designed. I mostly want first to know if I was missing that the feature already existed
John Moehrke (Aug 18 2021 at 19:49):
I can create an issue (in the ig-template-base repo... right?)
John Moehrke (Aug 18 2021 at 19:49):
Jose Costa Teixeira said:
but to a parent, unrelated IG - I don't see why this would be a feature. why not a link in the narrative in the front page?
it is not unrelated. It is grouped by some logic of the publisher.
John Moehrke (Aug 18 2021 at 19:50):
a link in the front narrative disappears as soon as the user navigates to a sub-page, artifact, etc.
Elliot Silver (Aug 18 2021 at 19:50):
I see some value in both capabilities, but challenges with both. It should be easy enough to add a header fragment that has a href to parent IG.
(hmm, though that is in the template, not the IG -- well, if that's all that is in the template, you could put it in the IG source directory.
John Moehrke (Aug 18 2021 at 19:51):
im not trying to design the solution here. just trying to define the need
John Moehrke (Aug 18 2021 at 19:52):
if the need is not universal enough, then it falls to just put it in your index.html narrative. I can live with that, just didn't want to assume that was the best that could be done
Jose Costa Teixeira (Aug 18 2021 at 19:54):
what I would find interesting is, in the profile itself, to be able to see the different constraints that have cascaded down to the current one.
so that I can see if a given extension on Medication is defined in the current profile, or i Volume 4, or in a base profile..
Elliot Silver (Aug 18 2021 at 19:55):
As I said, I can see usefulness of both, and expect different solutions for each. Submit a ticket and we can debate how widespread the need is. In the meantime, if you want to experiment, I think putting it in a fragment so that it can show up on every page is better than putting it only in index.html.
Elliot Silver (Aug 18 2021 at 19:56):
Yes, @Jose Costa Teixeira that's helpful too, but totally unrelated in my mind.
John Moehrke (Aug 18 2021 at 19:56):
I am speaking of IG, not profile within an IG.
Lloyd McKenzie (Aug 18 2021 at 19:57):
Well, there's breadcrumbs within an IG - that lets you move up within the page hierarchy. If you're talking across IGs, there's no notion of IG hierarchy in either the template or the core resources
John Moehrke (Aug 18 2021 at 19:57):
right now IHE ITI has four published IGs, none of them have any way for the user to navigate up to the ITI committee, or even to 'the other IGs'.
John Moehrke (Aug 18 2021 at 19:58):
this is to jump out of the IG, up to some grouper managed by the author. I don't think this is something that should be automatically guessed at by the IG publsiher
John Moehrke (Aug 18 2021 at 19:58):
(although workgroup is a form of this, kind of)
Lloyd McKenzie (Aug 18 2021 at 20:00):
In theory that could be something we could explore - Da Vinci could theoretically have a common page for all the Da Vinci IGs, for example. But no capability now, and not even anything obvious to tie it to
Elliot Silver (Aug 18 2021 at 20:02):
John Moehrke said:
this is to jump out of the IG, up to some grouper managed by the author. I don't think this is something that should be automatically guessed at by the IG publsiher
I think what you are describing/wanting is:
- an almost empty IHE IG that just has index.html with links to the domain IGs
- almost empty domain IGs that just have index.html with links to the individual IGs for that domain, and have a way to get back up to the IHE IG
- individual IGs that have regular IG content along with a way to get back up to the domain IG.
John Moehrke (Aug 18 2021 at 20:39):
I am not looking for a formal rely-on relationship. I am just looking for a way to get OUT OF THE IG.
Jose Costa Teixeira (Aug 18 2021 at 20:42):
a hyperlink?
John Moehrke (Aug 18 2021 at 20:44):
yes
John Moehrke (Aug 18 2021 at 20:44):
not sure where or how or what it looks like.
John Moehrke (Aug 18 2021 at 20:44):
today the top icon points back to the org .. this is good. I just want to be able to point to something smaller within that org
Jose Costa Teixeira (Aug 18 2021 at 20:45):
right. that is what I meant. a hyperlink in the narrative. I don't see what other feature is here, behind the "allow me to add links to stuff outside my IG" which is a hyperlink.
John Moehrke (Aug 18 2021 at 20:45):
If that is your answer.. I can do that today.
John Moehrke (Aug 18 2021 at 20:45):
I was hoping to get something into the header
Jose Costa Teixeira (Aug 18 2021 at 20:46):
(the automated generation of "a table of related IGs" would depend on a relationship to be formalized somehow)
John Moehrke (Aug 18 2021 at 20:47):
I don't want that... (well, I do in a different context)
John Moehrke (Aug 18 2021 at 20:47):
I have four IGs all that I want to give the reader a consistent way to navigate to the ITI domain landing page.... Much like they all do today allow the user to navigate to the IHE organization.
John Moehrke (Aug 18 2021 at 20:48):
these IGs are not dependant on ITI.. ITI is the workgroup that created these IGs
Jose Costa Teixeira (Aug 18 2021 at 20:48):
I don't see the need for any new feature- the requiement seems to be "the author needs to create a set of hypertlinks to external content"
Jose Costa Teixeira (Aug 18 2021 at 20:49):
John Moehrke said:
I have four IGs all that I want to give the reader a consistent way to navigate to the ITI domain landing page.... Much like they all do today allow the user to navigate to the IHE organization.
could be
- a menu item
- something in the landing page
- a small snippet that we can add to the template
John Moehrke (Aug 18 2021 at 20:49):
then why does the top level icon go to the organization? Why does the far right one go to FHIR? Why does the footer have a link to the HL7 workgroup?
Jose Costa Teixeira (Aug 18 2021 at 20:49):
we can choose that and we can tweak that
Jose Costa Teixeira (Aug 18 2021 at 20:50):
perhaps you want something like this?
https://hl7belgium.org/profiles/hl7belgium/be-medication/
John Moehrke (Aug 18 2021 at 20:50):
I can see that I have not convinced @Jose Costa Teixeira , but might have convinced @Elliot Silver ... I am fine to drop it, or fine with adding it as an issue to be further refined/priortized/solved.
Jose Costa Teixeira (Aug 18 2021 at 20:50):
there are 2 icons on the left - never mind where they point to, but they point to different things, e.g. IHE and IHE-ITI
John Moehrke (Aug 18 2021 at 20:50):
really?
Jose Costa Teixeira (Aug 18 2021 at 20:51):
I'm trying to understand what the idea is
John Moehrke (Aug 18 2021 at 20:51):
I have only one icon on the left top
Jose Costa Teixeira (Aug 18 2021 at 20:51):
right, but that we can change
John Moehrke (Aug 18 2021 at 20:51):
if there is a possibility for two.. then I am unaware
Jose Costa Teixeira (Aug 18 2021 at 20:52):
hence me poking at the idea until I see what is needed
Jose Costa Teixeira (Aug 18 2021 at 20:52):
the additional icon can be done in the template
John Moehrke (Aug 18 2021 at 20:52):
I do see that kind of a solution seems to be available in divinci publications
John Moehrke (Aug 18 2021 at 20:52):
which is why I asked
Jose Costa Teixeira (Aug 18 2021 at 20:53):
right. two icons, with different links
John Moehrke (Aug 18 2021 at 20:53):
so we are back to my top question... if this feature exists, then I simply need to learn how to use it.
Jose Costa Teixeira (Aug 18 2021 at 20:53):
ah ok
Jose Costa Teixeira (Aug 18 2021 at 20:54):
that is a local template. Since there is no scripting, it is safe to run it on CI build
John Moehrke (Aug 18 2021 at 20:59):
?
Jose Costa Teixeira (Aug 18 2021 at 21:02):
the second icon is added with a local template - so ITI could have its own local template, Pharmacy also...
Jose Costa Teixeira (Aug 18 2021 at 21:03):
I would prefer this to be automated, and the icon be populated from the author determining the committee
Jose Costa Teixeira (Aug 18 2021 at 21:04):
Otherwise an author could put the IHE-Jazz Band and any logo they want as their workgroup. Appealing, but not appropriate (right...)?
John Moehrke (Aug 18 2021 at 21:10):
I am not worried about that jazz band problem. I would like a more automatic method, closer to something based on the workgroup declared in the IG.
Jose Costa Teixeira (Aug 18 2021 at 21:13):
I think the workgroup is IHE International
Jose Costa Teixeira (Aug 18 2021 at 21:13):
IIRC each IG has one contact only
Elliot Silver (Aug 18 2021 at 21:21):
John Moehrke said:
I can see that I have not convinced Jose Costa Teixeira , but might have convinced Elliot Silver ... I am fine to drop it, or fine with adding it as an issue to be further refined/priortized/solved.
I see the need you have. It seems to be a reasonable need others might have. Apparently, there may or may not be an existing solution that could be leveraged.
Elliot Silver (Aug 18 2021 at 21:22):
Is there a need for a "parent" IG to dynamically/automatically detect child IGs?
Elliot Silver (Aug 18 2021 at 21:23):
(Hmm, actually doing the parents as IGs is wrong -- what would it mean if someone depended on the IHE.ITI IG?)
John Moehrke (Aug 19 2021 at 12:15):
It is not any technical or compliance thing. It is at best custodian of the documentation. Where the custodian is a sub-part of the organization already indicated.
Jose Costa Teixeira (Aug 19 2021 at 13:08):
You can look at the Belgian example to see how to create 2 icons
Lloyd McKenzie (Aug 19 2021 at 14:50):
I'd expect the custodian to be listed as the publisher. You can quality the publisher name as HL7 does - e.g. "HL7 - xyz work group"
John Moehrke (Aug 19 2021 at 14:56):
I noticed that. But it is not a clickable link, it is just text.
Lloyd McKenzie (Aug 19 2021 at 15:02):
It'll be a clickable link if the contact has a URL
John Moehrke (Aug 19 2021 at 15:05):
ah. let me try that. I know i have links in contacts, but I think my first one is an email, not a http
John Moehrke (Aug 19 2021 at 15:08):
well, I learned that is working
John Moehrke (Aug 19 2021 at 15:09):
I think that the IHE color scheme hid this from me. in the footer link text looks identical to non-link text. I can fix that.
John Moehrke (Aug 19 2021 at 15:11):
so that gives me something. but I would rather have something similar in the header. Most people don't think about the footer for this kind of thing (IMHO)
John Moehrke (Aug 19 2021 at 15:12):
it would seem to me that a "feature" similar to the template hack that DiVinci uses would be good to have as a common standard. (that second icon on the top bar)
Lloyd McKenzie (Aug 19 2021 at 15:14):
I don't know... If I'm reading a book or a document, I typically expect the title to be in the header and the author to be in the footer
John Moehrke (Aug 19 2021 at 15:14):
not saying that this does not belong on the footer. I think it does.
John Moehrke (Aug 19 2021 at 15:14):
but my use-case is not someone looking specifically for the author, they are looking for other things published by the author.
John Moehrke (Aug 19 2021 at 15:16):
in the case of the current footer, which is the author... it goes, as it should, to a general page about the workgroup. How to join the workgroup, what their scope is, when they meet, etc... this is proper and good.
John Moehrke (Aug 19 2021 at 15:18):
I am looking more for the equivalent of the publication page for that workgroup. or in web browsing terms "up a level". Much like we have in Confluence. It is true that a back button on a browser likely worked if they started at that workgroup publication page, but if they started from a link somewhere else then they have no idea what else is a peer publication.
John Moehrke (Aug 19 2021 at 15:19):
I don't like the second-icon-hack... but it gets the spirit of what I want.
Lloyd McKenzie (Aug 19 2021 at 15:48):
You can see an example here: https://build.fhir.org/ig/HL7/davinci-crd/
John Moehrke (Aug 19 2021 at 15:54):
yes, that is what I am looking at. the footer goes to FM workgroup (about) page. The second icon goes to Davinci page.
Last updated: Apr 12 2022 at 19:14 UTC
