Table of Contents
Generate a clickable outline of record sections and attached files so users can navigate long records faster
Specs
Version
v1.0.0 (updated on 2021-11-24)
Developer
Labii Inc.
Type
Section
Support Configuration
No
Overview
The Table of Contents widget creates a compact navigation menu for a Labii record by listing the sections already present in that record. It is designed for long experiment records, protocols, reports, and regulated documentation where readers need to jump quickly to a specific part of the page instead of scrolling through every section manually.
In addition to section titles, the widget can also surface files stored in the Files section, making it useful for records that combine narrative documentation with supporting attachments. The result is a lightweight record index that improves readability without duplicating any underlying content.
Use Cases
Long experiment records: Help researchers jump directly to sections such as Overview, Procedure, Results, and Signatures.
Protocol navigation: Provide a quick index for multi-step SOPs or assay procedures with many documentation blocks.
Review and approval workflows: Let reviewers move quickly between data sections, attached evidence, and approval sections in regulated records.
Project documentation: Make mixed-content records easier to scan when they contain text, tables, charts, and file attachments.
Training records: Give new users a simple way to understand the structure of a complex record before reading each section in detail.
Configuration
The Table of Contents widget requires no configuration. After you add it to a record, it automatically builds a navigation list from the sections already present in that record.
Initial Setup
Open the target record and click Add Section.
Select Table of Contents from the section widget library.
Click Save. The widget immediately generates a navigation outline from the current record sections.
Required Settings
The Table of Contents widget has no required settings.
Optional Settings
The Table of Contents widget has no optional settings.
Because the widget depends on existing section titles, it works best when each section in the record has a clear, descriptive name.
Interface
Read-only View
In read-only mode, the widget displays a numbered list of section titles. Each entry acts as a navigation link, allowing users to move directly to the corresponding section in the record. When the record includes a Files section, attached files can also appear in the table of contents so readers can locate supporting documents more quickly.
The list reflects the current structure of the record. If sections are renamed or reordered, the table of contents updates to match.
Edit View
The widget does not provide a separate content-editing interface. In edit mode, users typically manage the surrounding record structure by renaming, adding, removing, or reordering sections. The Table of Contents widget then reflects those structural changes automatically.
Additional Functions
Automatic Section Indexing
The widget automatically rebuilds its outline when record sections are renamed or reordered, so the navigation list stays aligned with the current document structure.
File Visibility Support
When the record contains a Files section, the widget can help surface attached files as part of the record navigation experience.
Best Practices
Structure Records Clearly
Use concise, descriptive section titles so the generated table of contents is meaningful to readers.
Keep a consistent section order across similar records or templates to make navigation predictable.
Place the Table of Contents near the top of long records so users see the record structure immediately.
Improve Review Efficiency
Use this widget in records with many sections, especially when multiple users review or approve the same document.
Combine it with signature, audit, or file-heavy sections so reviewers can move directly to evidence and approval content.
Common Pitfalls to Avoid
Avoid using vague section names such as "Notes" repeatedly, because the table of contents becomes less useful when entries are hard to distinguish.
Avoid adding the widget to very short records with only one or two sections, where it may add clutter without improving navigation.
Avoid expecting the widget to create content on its own. It only indexes sections and relevant attached files that already exist in the record.
Last updated