# Оглавление

- Human documentation: [https://docs.univer.ai/ru-RU/guides/docs/features/table-of-contents](https://docs.univer.ai/ru-RU/guides/docs/features/table-of-contents)

- Agent Markdown: [https://docs.univer.ai/ru-RU/guides/docs/features/table-of-contents.md](https://docs.univer.ai/ru-RU/guides/docs/features/table-of-contents.md)

- Requested language: `ru-RU`

- Content language: `ru-RU`

- Documentation version: `1.2.0`

- Source: [docs/features/table-of-contents.ru-RU.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/table-of-contents.ru-RU.mdx)

---

Оглавление вставляет заголовки в тело документа и отличается от панели навигации. Добавьте плагины к Docs Core до создания документа, объедините локаль UI с `locales` и подключите CSS. Пресеты Core и Advanced их не включают.

#### npm

```bash
npm install @univerjs/docs-toc @univerjs/docs-toc-ui
```

#### pnpm

```bash
pnpm add @univerjs/docs-toc @univerjs/docs-toc-ui
```

#### yarn

```bash
yarn add @univerjs/docs-toc @univerjs/docs-toc-ui
```

#### bun

```bash
bun add @univerjs/docs-toc @univerjs/docs-toc-ui
```

```ts
import { UniverDocsTocPlugin } from '@univerjs/docs-toc'
import { UniverDocsTocUIPlugin } from '@univerjs/docs-toc-ui'
import FeatureLocale from '@univerjs/docs-toc-ui/locale/ru-RU'
import { LocaleType } from '@univerjs/core'

import '@univerjs/docs-toc-ui/lib/index.css'

univerAPI.loadLocales(LocaleType.RU_RU, FeatureLocale)

univer.registerPlugin(UniverDocsTocPlugin)
univer.registerPlugin(UniverDocsTocUIPlugin)
```

## Вставка и обновление

Перед вставкой поместите курсор в документ. UI поддерживает вставку, полное обновление, обновление только номеров страниц и удаление. Без `rangeId` обновляется оглавление в текущем выделении.

```ts
import { InsertTableOfContentsCommand, UpdateTableOfContentsCommand } from '@univerjs/docs-toc'

await univerAPI.executeCommand(InsertTableOfContentsCommand.id, {
  levels: 3,
  showPageNumbers: true,
  rightAlignPageNumbers: true,
})
await univerAPI.executeCommand(UpdateTableOfContentsCommand.id, { mode: 'entireTable' })
```

Обновление вычисляет инструкции по уровням структуры (`\o`). Другие переключатели Word сохраняются в метаданных FIELD, но не все вычисляются. См. [параметры команд](https://docs.univer.ai/ru-RU/reference/packages/plugins/univerjs/docs-toc.md).