SPFE Documentation | Collections > Writing in EPPO-simple and Derivatives > Tables of Contents

Tables of Contents

• Think
• Plan
• Do

 

Think

Because SPFE is designed for bottom-up information architectures, a table of contents is considered a secondary navigation tool. However, most bottom-up information architectures should still have some form of table of contents. This is not necessarily a single hierarchical table that encompasses the entire content set. A typical arrangement might be to have one table of contents for the content set, and individual tables of contents for the topic sets. This is the default configuration for EPPO-simple and its derivatives.

In EPPO-simple, and by default in topic types derived from it, a table of content for the content set is built automatically from the topic type groups define in the SPFE content set configuration file. Tables of contents for topic sets are built automatically by the toc build step according to the logic of the specified TOC script. The default TOC script groups the topics in a topic set by topic type and lists them in alphabetical order within the topic type groupings. The order in which topic types appear in a topic set TOC is determined by the order in which the topic types in a topic set are listed in the setting /topic-set/topic-types.

 

Plan

 

Do you need to change the default TOC generation?

If you are writing Every Page is Page One topics, you probably don't need to change the default TOC generation. If you are creating a topic set that is designed as a continuous narrative (like a book) and need to create a TOC with a specified order of topics, you can specify the order in a TOC file.

Note: Pending feature

Specifying an arbitrary TOC is a pending feature. It is not currently implemented.

 

Do

To configure the content set table of contents, use the /content-set/topic-set-groups setting.

To configure the order of topic set types in a topic set TOC, use the setting /topic-set/topic-types.

To specify a different way of auto-generating a content set TOC, write and configure a new content set TOC script for your content set.

To specify a different way of auto-generating a topic set TOC, write and configure a new topic set TOC script for your topic set.