Glossary output

[mrchristian]

First off is to look at how to create a Table of Contents or navigation of the glossary in a multi-format book form.

Note: Initially we want a simple solution that will work with Vivliostyle JS and Vivliostyle CLI.

The output is rendered here in this TEST repo https://github.com/semanticClimate/glossary-demo

There are different types of ToC that could be made, and different ways to make the ToC.

ToC Type option 1 is a multi-column ToC at the start listing all 930 terms.

How to make option 1: A. Processing HTML; or B. Vivliostyle generates a ToC.

A. Processing HTML (is this possible)

1. Currently glossary terms have an H4, name tag, and an empty class e.g.
2. Can the HTMl be processed to make an an unordered list at the start of the HTML document, with a list class of its own, and inside a section, with a class. List items would need to link to glossary terms.
3. The section class can be used to open and close the ToC view on mobile as it will be very long. On other views it can have multiple columns.

B. Vivliostyle generates a ToC

1. I can ask Vivliostyle support if their ToC function could generate a ToC from the H4s - https://docs.vivliostyle.org/#/vivliostyle-cli#creating-a-table-of-contents

[mrchristian]

FYI I am asking Vivliostyle about how to create a publication from multiple HTML files, how to manage ToC features when using multiple HTML files. And how to design a publication to work with Vivliostyle JS and Vivliostyle CLI as CLI has other features like PDF bookmarks, print trims, etc., see: vivliostyle/vivliostyle.js#1236 and notes on our own Project semanticClimate/glossary-sandbox#1

[mrchristian]

I have made some good progress with decisions on ToC tech. Vivliostyle point to the use of publication manifests using JSON and JSON-LD.

You can see my thread here over on Vivliostyles support.

vivliostyle/vivliostyle.js#1236

A Publication Manifest give a structured method for describing a publiation - and for our purposes it means we can combine different HTML sources, but down the line also means we can glue other sources like Wikidata, Metadata sources.

Publication Manifest
W3C Editor's Draft 02 October 2023

And Vivliostyles documentation https://docs.vivliostyle.org/#/vivliostyle-viewer#web-publications-multi-html-documents

This is a very very basic start - but looks good:

https://semanticclimate.github.io/glossary-sandbox/ipccglossary.jsonld

Render

https://vivliostyle.vercel.app/#src=https://semanticclimate.github.io/glossary-sandbox/ipccglossary.jsonld