> For the complete documentation index, see [llms.txt](https://help.brieftech.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.brieftech.ai/how-to-guides/index/add-edit-sub-index-entries.md).

# Add or edit sub-index entries

Add, edit, or remove the sub-index entries that appear beneath a document in the Document Index.

Sub-index entries are the individual lines that appear beneath a document row in the <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-320692e120077fab01f6944df1edd4eec4881a4c%2Ftab-index.svg?alt=media" alt="Index tab" data-size="line"> tab — typically the exhibits or chapters from an affidavit or bundle tab. Each entry has a title, a level, and a page range.

## Open the Edit Subindex dialog

1. In the <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-320692e120077fab01f6944df1edd4eec4881a4c%2Ftab-index.svg?alt=media" alt="Index tab" data-size="line"> tab, hover over the document row you want to edit — action icons appear at the bottom-right of its **Description** cell.
2. Click the <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-6e7d4ebfce7a47a504d3408172583f987a93bd78%2Ficon-description.svg?alt=media" alt="Edit subindex" data-size="line"> icon.

The **Edit Subindex** dialog opens, showing the current sub-index entries for that document. If there are none yet, it opens with a single placeholder row ("Enter document description") for you to fill in. The dialog is persistent — pressing Esc or clicking outside won't close it; use <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-bbff6c32497cde9d3297b45db292f7a2bddd04d6%2Fbtn-cancel.svg?alt=media" alt="Cancel" data-size="line"> to close without saving.

## Check entries against the document

Click any row in the table to jump the document to that entry's page start, so you can confirm each title and page number against the document as you go. The **Edit Subindex** dialog is split in two — the entry table on the left, the source document alongside it on the right — and the document opens straight away, even for a large file.

If the document has no PDF attached, the right-hand side shows "No PDF available to preview for this document." instead.

## Generate sub-index entries from the PDF

1. In the **Edit Subindex** dialog, click <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-b974559cc190c53aaca4028a46a6ea116b0f57a3%2Ficon-auto-mode.svg?alt=media" alt="Generate from PDF" data-size="line"> Generate from PDF.
2. Review the entries that appear in the table.
3. Click <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-c3296596b39af79f895f41420e38edb70da91196%2Fbtn-save.svg?alt=media" alt="Save" data-size="line"> to apply them.

BriefTech builds the sub-index from the PDF for you, and it works even when the PDF has no bookmarks of its own. Generate from PDF needs a PDF — if the document has no PDF attached, BriefTech asks you to upload one first.

{% hint style="warning" %}
**Generate from PDF replaces the whole table.** When it finds entries, it overwrites every row currently shown in the dialog — including any you added or edited by hand — with the generated set. It does not merge, and there's no confirmation first. The replacement isn't stored until you click **Save**. Only when generation finds nothing is the table left unchanged.
{% endhint %}

## Review the generated entries

Auto-generated entries are a starting point, not a finished index — always check them before you save.

* If BriefTech runs into anything it isn't sure about while reading a bundle index — for example page numbers it can't line up with the pages in this PDF — an amber banner appears at the top of the dialog listing the issues (for example "2 issues found while reading the index — review before saving"), with a <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-ed5f06cffae1ebbec9ade72a20661e6ea0fcb3d9%2Fbtn-dismiss-warnings.svg?alt=media" alt="Dismiss" data-size="line"> button. Read each issue and fix the affected rows before saving.
* If the bundle's index table lists documents from a **later volume**, those entries may be pulled in as well, and their page numbers can be wrong — a later volume's page numbers can't be worked out from this PDF. Delete any entries that don't belong to this volume before you save.

## Add entries manually

1. In the **Edit Subindex** dialog, click <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-9f87cce26b778055f8740d8dda501193a2da071f%2Ficon-add.svg?alt=media" alt="add" data-size="line"> **Add subindex item**.
2. A new row appears. Double-click each field to edit it:
   * **Level** — the entry's depth, as a whole number from `0` upwards. Leave it at `0` in most cases: sub-index entries always sit one level beneath their parent document in the exported bundle, so a higher number here won't nest an entry any deeper.
   * **Title** — the text that appears in the index. Required.
   * **Page start** — the page number where this entry begins (1-based). Required.
   * **Page end** — the page number where this entry ends. Optional; if you set it, it must be the same as or after the **Page start**, or BriefTech won't let you save.
   * **Date** — the date of the entry. Optional; BriefTech accepts several formats and standardises them when you save:

     * A full date, for example `2018-01-31`, `31/01/2018`, or `31.01.2018`
     * A month and year, for example `01/2018`
     * A range, for example `2018-01-01 to 2018-12-31`

     Dates are read **day-first**, so `31/01/2018` means 31 January (US month-first order isn't supported). Type `undated` for a document with no date, or leave the field blank to clear it — an undated sub-index entry shows a **blank** date in the index and bundle (not the word "Undated"). If the value can't be read as a date, BriefTech shows **Invalid date format**.
3. Click <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-c3296596b39af79f895f41420e38edb70da91196%2Fbtn-save.svg?alt=media" alt="Save" data-size="line"> to apply.

{% hint style="info" %}
**How the sub-index stays ordered:**

* The list is always kept in **page order** — entries sort by their page start as you add or edit them, so the sub-index reads top to bottom in the same order as the document.
* A new entry is added at the **bottom**, with its **Page start** pre-filled to one page after the furthest page any existing entry covers (page 1 for the very first entry). Change it to the entry's real page — the list re-sorts into page order when you do.
* If two entries' page ranges **overlap**, or leave a **gap** between them, an amber warning icon appears next to the page number on the affected rows — hover it to see what's wrong.
* These warnings are **guidance only** — they never stop you saving.
  {% endhint %}

## Edit an existing entry

Any field in the table can be edited the same way — make your change, then click <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-c3296596b39af79f895f41420e38edb70da91196%2Fbtn-save.svg?alt=media" alt="Save" data-size="line">.

After the bundle has been paginated (switch to **Preview**), sub-index entries appear as their own rows in the Document Index. There you can edit a sub-index title or date directly without opening the dialog — double-click the cell in the sub-index row, or hover the row and click the <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-67750f413ca1f83135a9a763cdb9d9fb5547e4e1%2Ficon-drive-file-rename-outline.svg?alt=media" alt="edit" data-size="line"> icon that appears on the cell. Before pagination, edit entries from the **Edit Subindex** dialog (above).

## Preview an entry at its page

Once the bundle has been paginated (switch to **Preview**) so sub-index rows appear in the Document Index, hover over a sub-index row in the <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-320692e120077fab01f6944df1edd4eec4881a4c%2Ftab-index.svg?alt=media" alt="Index tab" data-size="line"> tab and click the <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-dee4ef964fbc709933b45f6f52bf9c0798d49df8%2Ficon-search.svg?alt=media" alt="Preview at page" data-size="line"> icon that appears next to its number to open the source document in the preview pane at that entry's page — a quick way to confirm an entry points at the right page. The icon appears only when the entry has a page to jump to.

## Remove an entry

Click the <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-f93c09f5622622f7856b21733816e0ef2f1808f9%2Ficon-delete.svg?alt=media" alt="delete" data-size="line"> icon on the right of the row you want to delete, then click <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-c3296596b39af79f895f41420e38edb70da91196%2Fbtn-save.svg?alt=media" alt="Save" data-size="line">.

## What you've built

You now have a sub-index that sits beneath its document's heading in the <img src="https://2262431129-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlnHu06wl3NH457iwjBmr%2Fuploads%2Fgit-blob-320692e120077fab01f6944df1edd4eec4881a4c%2Ftab-index.svg?alt=media" alt="Index tab" data-size="line"> tab and mirrors the tabs and pagination of the original bundle, so the main index reads as one complete guide to the record — the way to show what's inside a document that is itself a bundle, such as a Bundle of Documents or an affidavit with exhibits. When you generate a paginated court bundle, each entry is written into the bundle PDF as a nested bookmark (outline entry) beneath its document's own bookmark, so it appears in the PDF reader's bookmark panel indented one level under the parent document, each jumping to the page where it begins.

## Related

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>From Document Index to court bundle</strong></td><td>How the Document Index and the bundle share one source of truth.</td><td><a href="/concepts/index-and-court-bundle.md">From Document Index to court bundle</a></td></tr><tr><td><strong>Manage headings in the Document Index</strong></td><td>Add, rename, move, and generate the headings that organise the index.</td><td><a href="/how-to-guides/index/manage-index-headings.md">Manage headings in the Document Index</a></td></tr><tr><td><strong>Reorder documents and add structure</strong></td><td>Drag documents to reorder them and move them between sections.</td><td><a href="/how-to-guides/index/reorder-documents-add-structure.md">Reorder documents and add structure</a></td></tr><tr><td><strong>Generate a paginated court bundle</strong></td><td>Produce the bundle where sub-index entries appear as nested PDF bookmarks.</td><td><a href="/how-to-guides/bundle/generate-paginated-bundle.md">Generate a paginated court bundle</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.brieftech.ai/how-to-guides/index/add-edit-sub-index-entries.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
