Skip to main content

How to create a table of contents for a document

Prerequisites​

  • The editor or admin role, or permission to edit this entity
  • An entity that has at least one document

A table of contents belongs to a single document. If an entity has several documents, each one has its own table of contents.

Steps​

Open the entity in the document viewer. The document opens with the side panel on the right.

Open the table of contents​

  1. In the side panel, select the Table of Contents tab.
  2. The panel lists the document's headings. If there are none yet, it shows a "No table of contents" message.
  3. If you can edit this document, an Edit button shows at the bottom of the panel.

People without edit access still see the headings, but as plain text rather than buttons.

Add a heading​

  1. In the document, select (highlight) the text you want as a heading.
  2. In the small menu that appears, select Add to table of contents.
  3. The text becomes a new heading, and the panel opens in edit mode.

Uwazi lists headings in the order they appear in the document. You can't drag them to re-order.

Rename a heading​

  1. If you aren't in edit mode, open the Table of Contents tab and select Edit.
  2. Find the heading in the list.
  3. Type a new label in its text box.

Change a heading's level​

Levels show structure, such as a main heading with subheadings under it.

  1. In edit mode, find the heading.
  2. Select the right arrow to move it one level deeper.
  3. Select the left arrow to move it one level back.

Delete a heading​

warning

Deleting a heading happens at once, with no confirmation prompt.

  1. In edit mode, find the heading.
  2. Select the trash button on its row.

To bring a deleted heading back before you save, select Cancel. This also discards your other unsaved changes.

Save or discard your changes​

Your changes stay as a draft until you save them.

  1. To keep your changes, select Save. Uwazi shows a "Document updated" message.
  2. To discard every change, select Cancel.

Leaving the document before you save also discards your unsaved changes.

Jump to a heading​

  1. Open the Table of Contents tab, and don't select Edit.
  2. Select any heading. Each heading shows its page number.
  3. Uwazi scrolls the document to that point.

Result​

The document has a table of contents that readers can use to jump to each section.

tip

After you save, select each heading to confirm it jumps to the right place.

See also​