Use bookmarks and a table of contents
Use bookmarks and a table of contents when a document needs internal navigation. These features help users move between sections in reports, contracts, proposals, and long templates.
Before you start, make sure the Document Authoring library is installed and running in your app. If you haven’t set it up yet, refer to the getting started guide.
Work with bookmarks and links to bookmarks
Document Authoring SDK 1.22.0 adds support for preserving bookmarks and bookmark hyperlinks when importing and exporting supported formats.
The SDK preserves supported range bookmarks through DOCX, ODT, and RTF import and export. Links to bookmarks also work in exported PDF and HTML output.
Insert a table of contents
Users can insert a table of contents from the toolbar. The table of contents uses the document headings and page numbers.
Use the default toolbar configuration when possible, because it keeps the table of contents controls available. If your app replaces the default toolbar with a custom toolbar, review the actions and toolbar guide when upgrading.
Imported table of contents entries remain editable. When headings or pagination change, users can regenerate the table of contents from the context menu.
Learn more
Refer to these guides for related authoring and navigation workflows:
- Actions and toolbar — Keep table of contents controls available in custom toolbar configurations.
- Export documents — Export the current document to supported formats.
- Document locations — Navigate to external references and temporary highlights without changing document content.