Describing Hierarchical Table of Contents with Omeka S IIIF Server Module

Overview

This article introduces how to describe a hierarchical table of contents using the Omeka S IIIF Server module.

Documentation

The documentation is somewhat complex, but explanations are available at:

https://github.com/Daniel-KM/Omeka-S-module-IiifServer?tab=readme-ov-file#input-format-of-the-property-for-structures-table-of-contents

Simple Table of Contents

The following example from “Toyo Bunko Media Repository” is used:

https://app.toyobunko-lab.jp/s/main/document/9f9d95c2-d33d-7402-742b-47db12748688

Specify {Range ID},{Range name},{Canvas index} as follows:

This results in the following table of contents display:

Hierarchical Table of Contents

The following example is used:

https://app.toyobunko-lab.jp/s/main/document/4797b8ca-530f-8aae-f252-7911ad64039b

To describe a hierarchical table of contents, prepare data with four columns as follows:

The fourth column specifies the Range IDs of child elements. With indentation, it looks like this:

This results in the following hierarchical table of contents display:

The table of contents data created in the IIIF manifest file is as follows. Note that the first Range “All” with viewingHint set to top is not displayed in the viewer:

Notes

As mentioned above, the table of contents specified on the first line is assigned viewingHint of top and is not displayed in the viewer.

Therefore, you need to add a line representing the overall structure on the first line, as in the following example:

In the previous version of the IIIF Server module, writing data as shown below worked without issues, but at some point an update changed how the first line is processed:

Similarly, the example above uses three columns, but due to the update, four-column data is now required:

As a result, with the old format (three columns), r1, r3, and r5 (which specify Canvas indices in the third column) display correctly, while r2 and r4 (which specify child Range IDs in the third column) do not display correctly.

Summary

When describing a hierarchical table of contents using the latest IIIF Server module as of June 2025, you need to be aware of how the first line is handled and that data must be written in four columns.

I hope this serves as a useful reference for using the Omeka S IIIF Server module.