Table of Contents Data

[hcayless]

How should a client build or retrieve a table of contents? Which endpoint should provide the info for that ToC, and what should the info look like? Do we want to offer an expanded ToC with a single request? Related to #110 and #101.

[PonteIneptique]

If we think about our system, ie hydra, and the things we discussed in the TEI Proposal, I feel like we'd need some kind of tree structure. This could be a document provided, on a "fourth" but rather limited endpoint that we'd discuss after draft 1 ?

[PonteIneptique]

This one is gonna get tricky. I feel like it should be in the Navigation endpoint, but how is the question.

Do we want a mode=curated or mode=ToC which would allow people to provide a one page filtered Navigation object (where things are expanded by default) ? This might be seen as adding clutter though... But I see the point of this kind of functionality.

This might be tied to #167 to some extent: if we add an endpoint for Annotations or the like, then we could have an AnnotationType: ToC made of Reference trees.

[monotasker]

During the 2024 Durham RC Workshop we finalized the release candidate design of the Navigation endpoint. It does not include a dedicated TOC request, but a request can retrieve the entire citation tree of a document to a specified depth. This can easily be used to construct a TOC.

We published the resolution of this issue during the tech committee meeting on 2024-03-08

commit a0db8ca
release https://github.com/distributed-text-services/specifications/releases/tag/1-alpha1

This is an alpha release and we are looking for feedback!