# ドキュメント設定

ドキュメントの表紙・色・フォントなどは「ドキュメント設定」画面で編集します。適用すると、ドキュメント先頭の設定ブロック（YAML の `ohyna:`）に書き戻されます。ディスクへの保存はファイルメニューの「保存」で行います。

色テーマは表紙だけでなく、見出しの帯、表のヘッダ、図（Mermaid）のアクセント色など、ドキュメント全体に効きます。

---

## 1. 必須項目

次の 4 つが揃うと、プレビュー更新と PDF 作成が使えます。

| 項目 | YAML 名 | 説明 |
|------|---------|------|
| タイトル | `title` | 表紙中央の主見出し。ページタイトルにも使います |
| 色テーマ | `style` | ドキュメント全体の色（後述の一覧） |
| フォント | `font`（または `fontFamily`） | 本文のフォントプリセット |
| 言語 | `lang` | 例: `ja`、`en` |

---

## 2. 色・言語

### 2.1 色テーマ（`style`）

次のいずれかを選びます。表紙の背景色、見出し帯、表ヘッダ、Mermaid ダイアグラムの色に使われます。

| 表示名 | 値 |
|--------|-----|
| 縹（はなだ／青） | `blue` |
| 空色（そらいろ／水色） | `sky` |
| 藍（あい／紺） | `indigo` |
| 青磁（せいじ／青緑） | `celadon` |
| 常磐（ときわ／緑） | `forest` |
| 山吹（やまぶき／黄） | `yellow` |
| 琥珀（こはく／黄茶） | `default` |
| 金色（こんじき／金） | `gold` |
| 柑子（こうじ／オレンジ） | `orange` |
| 桜（さくら／ピンク） | `sakura` |
| 朱（あけ／赤） | `red` |
| 蘇芳（すおう／赤紫） | `wine` |
| 藤（ふじ／紫） | `purple` |
| 焦茶（こげちゃ／茶） | `brown` |
| 銀鼠（ぎんねず／灰色） | `neutral` |
| 墨色（すみいろ／黒） | `dark` |

### 2.2 言語（`lang`）

例: `ja`、`en`、`ja-JP`。

本文フォントは「フォント・体裁」で指定します。

---

## 3. 表紙

### 3.1 表紙の配置

表紙を付ける場合、用紙上の配置は次のとおりです（上から下へ）。

| 要素 | 設定項目 | 位置 |
|------|----------|------|
| ラベル | `label` | 上部の小さな枠（番号・区分など） |
| タイトル | `title` | 中央の大きな見出し |
| サブタイトル | `subtitle` | タイトル直下の副題 |
| 表紙フッタ | `meta`（複数行可） | ページ下端（発行元・日付など） |
| 著者／版／日付 | `author` / `version` / `date` | メタ。`meta` が空のときは表紙フッタへ自動流し込み。ヘッダ／フッタの定型にも使える |

「表紙を付ける」をオンにすると、PDF の先頭に表紙ページが付きます。

### 3.2 表紙デザイン（`coverPattern`）

色テーマごとに用意された背景デザインを選びます。

| 表示名 | 値 | 表示名 | 値 |
|--------|-----|--------|-----|
| 霞 | `noise` | 砂子 | `grainy` |
| 極光 | `aurora` | 彩雲 | `mesh` |
| 無地 | `solid` | 斜影 | `diagonal` |
| 横霞 | `horizontal` | 縦霞 | `vertical` |
| 円暈 | `radial` | 二面 | `split` |
| 帯 | `band` | 隅取り | `corner` |
| 側帯 | `ribbon` | 脇板 | `panel` |
| 額縁 | `frame` | 中暈 | `glow` |
| 黄昏 | `dusk` | 薄霧 | `mist` |
| 地平 | `horizon` | 縦縞 | `stripe` |
| 点描 | `dots` | 方眼 | `grid` |
| 矢筈 | `chevron` | 菱 | `diamond` |
| 亀甲 | `hex` | 鱗 | `triangle` |
| 市松 | `checker` | 杉綾 | `herringbone` |
| 升目 | `isometric` | 組子 | `lattice` |
| 寄木 | `mosaic` | 切子 | `blades` |
| 日輪 | `sunburst` | 渦 | `spiral` |
| 周回 | `orbit` | 同心円 | `circles` |
| 波 | `wave` | 連波 | `waves` |
| 細波 | `ripples` | 波縁 | `scallop` |
| 連山 | `mountains` | 円弧 | `arcs` |
| 稲妻 | `zigzag` | | |

一覧はドキュメント設定画面の「表紙デザイン」でも同じ名称で選べます。

---

## 4. フォント・体裁

### 4.1 本文フォント（`font`）

組み合わせ（和文／欧文の優先ファミリー）を選びます。画面にはファミリー名と見本だけ出ます。

| 値 | 和文（優先） | 欧文（優先） |
|----|--------------|--------------|
| `noto` | Noto Sans JP | Segoe UI |
| `gothic` | 游ゴシック／ヒラギノ角ゴ／Noto Sans JP | Segoe UI |
| `mincho` | Noto Serif JP／游明朝／ヒラギノ明朝 | 同左 |
| `sans` | Noto Sans JP | Segoe UI／system-ui |
| `serif` | Noto Serif JP | Georgia／Times New Roman |
| `inter` | Noto Sans JP | Inter |
| `mono` | IBM Plex Mono | IBM Plex Mono |

「カスタム」に値を入れると、上の選択より優先されます。

### 4.2 コードフォント（`fontMono`）

インラインコード、コードブロック、図のソース表示に使います。本文フォントとは独立です。

| 画面上の選択 | 実際のフォント（要約） |
|--------------|------------------------|
| Cascadia / Consolas（既定） | Cascadia Mono → Consolas → Courier New |
| IBM Plex Mono | IBM Plex Mono を優先 |
| Consolas | Consolas → Courier New |
| カスタム | 入力した CSS の `font-family` |

### 4.3 その他の体裁

| 項目 | 説明 | 既定の目安 |
|------|------|------------|
| 用途プリセット | 標準／報告書／スライド資料寄り（サイズ・行間・字間を一括） | （任意） |
| 文字サイズ | 本文の基本サイズ（例: `10.5pt`） | `10.5pt` |
| 行間 | 倍率（例: `1.7`） | `1.7` |
| 字間 | CSS `letter-spacing`（例: `0` / `0.02em`） | `0` |
| 角丸 | コードブロックや表などの角 | オン、サイズ「中」 |
| 見出し帯背景 | 第 2 水準見出しに色テーマの帯を付ける | オン |
| 表ヘッダ塗りつぶし | 表のヘッダ行を色テーマの濃色で塗る | オン |
| リンク下線 | `linkUnderline` | オフ |
| リンク色をテーマに | `linkThemeColor`（オフなら本文色） | オン |

---

## 5. 用紙・余白

| 項目 | キー | 値の例 |
|------|------|--------|
| 用紙サイズ | `pageSize` | `a4`（既定）/ `a5` / `b5` / `letter` |
| 向き | `pageOrientation` | `portrait`（既定）/ `landscape` |
| 余白 | `marginPreset` | `narrow` / `normal`（既定）/ `wide` / `custom` |
| 余白 mm | `marginTop` など | `custom` のときのみ（単位なし数値＝mm） |

プレビューの用紙サイズと PDF の紙面は連動します。

---

## 6. ページ・コード

### 6.1 本文ヘッダ／フッタ

表紙フッタ（`meta`）とは別枠です。本文ページの上下に出す文言を選びます。

| 項目 | キー | 定型 |
|------|------|------|
| ヘッダ | `pageHeader` | なし／文書名／著者／日付／版／社外秘／カスタム |
| フッタ | `pageFooter` | なし／ページ番号／文書名／文書名＋ページ番号／日付／著者／社外秘／カスタム |

既定はどちらも「なし」。PDF では全ページ（表紙含む）に出ます。プレビューでは本文ページに出ます。

### 6.2 目次

| 項目 | キー | 説明 |
|------|------|------|
| 自動目次 | `toc` | オンで本文に `[TOC]` が無いとき先頭へ挿入 |
| 深さ | `tocDepth` | `2`（H2 まで）または `3`（H3 まで、既定） |

手書きの `[TOC]` もそのまま使えます（深さ設定は効きます）。目次は**前後とも改ページ**され、プレビュー／PDF とも専用ページ（長いときは複数頁）になります。

### 6.3 コードブロック

| 項目 | キー | 既定 |
|------|------|------|
| 行番号 | `codeLineNumbers` | オフ |
| 折り返し | `codeWrap` | オフ（横スクロール） |
| 文字サイズ | `codeFontSize` | 空＝本文連動（約 0.92em） |

### 6.4 透かし

| 項目 | キー | 値 |
|------|------|-----|
| 種類 | `watermark` | `none` / `draft` / `confidential` / `custom` |
| 文言 | `watermarkText` | `custom` のとき |

---

## 7. ドキュメント先頭に書き込まれる形

「適用」後、ドキュメントの先頭は次のような形になります（例）。

```yaml
---
ohyna:
  title: ドキュメントタイトル
  style: blue
  font: noto
  lang: ja
  cover: true
  subtitle: 副題
  label: DOC
  meta:
    - 発行元
    - 2026-07
---
```

規則の要点:

- 設定は必ず `ohyna:` の下に置きます。  
- キー名は camelCase です（例: `coverPattern`、`fontSize`）。  
- このブロックのあとに、通常の Markdown 本文が続きます。  

通常はドキュメント設定画面から編集すれば足り、手編集は不要です。