Stream: IG creation
Topic: Canonical Index
Grahame Grieve (Jun 24 2020 at 02:27):
The next version of the IG publisher will generate a new fragment and a new file.
- Fragment "canonical-index.html" - a list of canonical URLs and OIDs with references, ready to drop into a page. @Lloyd McKenzie please add this one to the template somewhere
- file: "canonicals.json" - will be added directly to the output directory so that software can quickly process the list of canonical URLs, Oids and other URLs defined in the IG. This will will also be generated in the _data directory in case anyone wants to build something from it in a template
Lloyd McKenzie (Jun 24 2020 at 02:34):
Will the URLs be hyperlinks that resolve to the relevant artifact page? How ordered? Thoughts on where this should show up?
Grahame Grieve (Jun 24 2020 at 02:37):
it contains a table of id | canonical | oids | other urls sorted by type. The id is a link to the resource. It should show up somewhere as part of a special purpose ToC
Lloyd McKenzie (Jun 24 2020 at 02:41):
Linked from the artifacts page? Does it need to appear on the menu?
Grahame Grieve (Jun 24 2020 at 02:42):
yes and no, I think. Certainly to start with - we can see what feedback we get
Lloyd McKenzie (Jun 24 2020 at 02:43):
@Jose Costa Teixeira are you up to adding this?
Jose Costa Teixeira (Jun 24 2020 at 04:03):
Yes.
Jose Costa Teixeira (Jun 24 2020 at 04:04):
What is the purpose for having the list of canonical/OIDs? (For me to see where this fits)
Jose Costa Teixeira (Jun 24 2020 at 04:09):
If the artifact index is the master index of all artifacts, then this fragment can be added there, at the bottom?
Grahame Grieve (Jun 24 2020 at 04:26):
the purpose is so that you can find by oid. UTG in particular needs it, but it would be useful anywhere else. but not enough useful to be on the artifact page itself
Jose Costa Teixeira (Jun 24 2020 at 04:33):
What about a dedicated "references" page? Could be a submenu of Artifacts, sibling of artifact index
Grahame Grieve (Jun 24 2020 at 04:50):
could be
Jose Costa Teixeira (Jun 24 2020 at 04:57):
Jose Costa Teixeira (Jun 24 2020 at 04:58):
this would be easiest for now.
Jose Costa Teixeira (Jun 24 2020 at 04:58):
If this meets the purpose, I suggest we start like this, and depending on feedback we can always change.
Grahame Grieve (Jun 24 2020 at 05:01):
sure that works
Grahame Grieve (Jun 24 2020 at 05:01):
thx
Eric Haas (Jun 24 2020 at 18:11):
nobody outside this stream is going to know what "Canonical Index" means ( a list of Hoewitzers?) how about List of URL's ?
Eric Haas (Jun 24 2020 at 18:14):
and put at end where all indexes naturally belong
Last updated: Apr 12 2022 at 19:14 UTC