Skip to main content

How to create a table of contents for a document

Add, rename, indent, and delete table of contents entries for a document in the Uwazi viewer.

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. The panel always shows the document you're reading, in the language you're reading it in.

Steps​

Open the entity. The viewer opens on the Document tab, with the right pane beside it.

Open the table of contents​

  1. In the right pane, select the ToC tab.
  2. The panel lists the document's entries. 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 entries, but no buttons to change them.

note

Some instances build the table of contents for you when you upload a document. The footer then shows Mark as reviewed, which you select once you've checked the entries.

Add an entry​

  1. In the document, select (highlight) the text you want as an entry.
  2. In the small menu that appears, select Add to ToC.
  3. Uwazi adds the entry, opens the ToC tab, and turns on edit mode.

Uwazi sorts entries by page, then by their place on the page. You can't drag them into a different order.

Rename an entry​

  1. If you aren't in edit mode, open the ToC tab and select Edit.
  2. Select the entry's label. It turns into a text box.
  3. Type the new label.
  4. Press Enter, or select the check button. To drop the change, press Escape.

Change an entry's level​

Levels show structure, such as a main entry with sub-entries under it. A table of contents can hold three levels.

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

The first entry in the list always stays at the top level.

Delete an entry​

  1. In edit mode, select the trash button on the entry's row.
  2. In the Delete? prompt, select Yes. To keep the entry, select No.

To bring a deleted entry back before you save, select Cancel. This also drops 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 flashes a "Table of contents saved successfully" message in the header, and keeps it in the Notifications panel.
  2. To drop every change, select Cancel.

Leaving the entity before you save also drops your unsaved changes.

Jump to an entry​

  1. Open the ToC tab, and don't select Edit.
  2. Select any entry, or the page tag on its right. Uwazi scrolls the document to that page.
  3. If an entry has sub-entries, selecting it also opens them. Select Expand All or Collapse All to open or close every entry at once.

Uwazi marks the entry that matches the page on screen.

Result​

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

tip

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

See also​