# 脚注と文末脚注

- Human documentation: [https://docs.univer.ai/ja-JP/guides/docs/features/footnotes](https://docs.univer.ai/ja-JP/guides/docs/features/footnotes)

- Agent Markdown: [https://docs.univer.ai/ja-JP/guides/docs/features/footnotes.md](https://docs.univer.ai/ja-JP/guides/docs/features/footnotes.md)

- Requested language: `ja-JP`

- Content language: `ja-JP`

- Documentation version: `1.1.0`

- Source: [docs/features/footnotes.ja-JP.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/footnotes.ja-JP.mdx)

---

#### Package metadata

```json
{
  "preset": [
    {
      "client": "@univerjs/preset-docs-advanced",
      "locale": "@univerjs/preset-docs-advanced/locales/ja-JP",
      "style": "@univerjs/preset-docs-advanced/lib/index.css"
    }
  ],
  "plugins": [
    {
      "client": "@univerjs-pro/docs-reference",
      "facade": "@univerjs-pro/docs-reference/facade"
    },
    {
      "client": "@univerjs-pro/docs-reference-ui",
      "locale": "@univerjs-pro/docs-reference-ui/locale/ja-JP",
      "style": "@univerjs-pro/docs-reference-ui/lib/index.css"
    }
  ],
  "license": true,
  "server": false
}
```

従来型のページ分割ドキュメントに脚注と文末脚注を追加します。脚注は参照元のページに配置され、文末脚注はドキュメント設定に従って配置されます。この API はモダンドキュメントには対応していません。

## インストール

ライセンスを設定済みの Docs エディターに次のプラグインを追加し、UI スタイルとエディターの言語リソースを読み込みます。

`UniverDocsAdvancedPreset` には両方のプラグインが含まれています。この preset を使う場合、再登録は不要です。

#### npm

```bash
npm install @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui
```

#### pnpm

```bash
pnpm add @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui
```

#### yarn

```bash
yarn add @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui
```

#### bun

```bash
bun add @univerjs-pro/docs-reference @univerjs-pro/docs-reference-ui
```

```ts
import { UniverDocsReferencePlugin } from '@univerjs-pro/docs-reference'
import { UniverDocsReferenceUIPlugin } from '@univerjs-pro/docs-reference-ui'
import ReferenceLocale from '@univerjs-pro/docs-reference-ui/locale/ja-JP'
import { LocaleType } from '@univerjs/core'

import '@univerjs-pro/docs-reference/facade'
import '@univerjs-pro/docs-reference-ui/lib/index.css'

univerAPI.loadLocales(LocaleType.JA_JP, ReferenceLocale)
univer.registerPlugin(UniverDocsReferencePlugin)
univer.registerPlugin(UniverDocsReferenceUIPlugin)
```

## 脚注の挿入と管理

```ts
const document = univerAPI.getActiveDocument()
if (document) {
  const noteId = document.insertFootnote(0)
  if (noteId) console.log(document.getParagraphs(noteId))
  console.log(document.getFootnotes(), document.getEndnotes())
}
```

オフセットは構造トークンを含む本文の UTF-16 位置です。位置や内容が無効な場合、編集権限がない場合、モダンドキュメントの場合は `null` を返します。成功時は安定した脚注 ID を返します。参照と本文は同じ取り消し・共同編集 mutation に含まれます。

`getFootnotes()` / `getEndnotes()` で取得し、`deleteFootnote(noteId)` / `deleteEndnote(noteId)` で削除します。`setFootnoteSettings()` と `setEndnoteSettings()` で番号や配置を設定し、`null` で明示的な設定をリセットします。内容の指定には返された ID を使ってください。表示番号は再ページ分割によって変わることがあります。