# 機能設計書 26-要約編集

## 概要

本ドキュメントは、Wikipedia iOSアプリケーションにおける要約編集機能の設計を記載する。この機能により、ユーザーは編集内容を説明する要約文を入力できる。

### 本機能の処理概要

要約編集機能は、編集保存画面に埋め込まれる子ViewControllerとして実装され、定型要約ボタンまたは自由入力テキストフィールドを通じて編集要約を入力する。

**業務上の目的・背景**：編集要約はWikipediaの編集ワークフローにおいて重要な要素であり、他の編集者や閲覧者に対して何を変更したかを簡潔に伝える。適切な要約は編集履歴の可読性を高め、パトロール活動を支援する。

**機能の利用シーン**：編集保存画面において、ユーザーが編集内容を保存する前に使用する。定型ボタン（「誤字修正」「文法修正」「リンク追加」等）を選択するか、自由入力フィールドに直接入力する。

**主要な処理内容**：
1. 定型要約ボタンの表示（typo, grammar, link, addedImage, addedImageAndCaption）
2. 自由入力テキストフィールドの提供
3. 最大文字数制限（255文字）
4. デリゲートを通じた親ViewControllerへの変更通知
5. 多言語対応（言語コードに基づくローカライズ）
6. RTL言語対応（セマンティックコンテンツ属性）

**関連システム・外部連携**：EditSaveViewController（親VC）、WMFLocalizedString（多言語対応）

**権限による制御**：編集保存画面に到達したユーザーのみが使用可能

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 編集保存画面 | 親画面 | 要約入力UIを埋め込み |
| - | 要約編集ビュー | 埋め込み | 定型ボタンとテキスト入力 |

## 機能種別

テキスト入力、UI制御

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| languageCode | String | Yes | 言語コード | デフォルト"en" |
| cannedSummaryTypes | [EditSummaryViewCannedButtonType] | Yes | 表示する定型ボタン種別 | デフォルト[.typo, .grammar, .link] |
| delegate | EditSummaryViewDelegate? | No | 変更通知デリゲート | weak参照 |
| pageURL | URL? | No | 編集対象ページURL | 言語コード抽出用 |

### 入力データソース

- EditSaveViewController（親VC）からの設定
- ユーザー入力（テキストフィールド/定型ボタン）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| summaryText | String | 入力された要約テキスト |

### 出力先

- EditSummaryViewDelegate.summaryChanged（親VCへの通知）
- EditSummaryViewDelegate.learnMoreButtonTapped（ヘルプ画面遷移）

## 処理フロー

### 処理シーケンス

```
1. 初期化
   └─ viewDidLoadでUI設定

2. UI設定
   ├─ プレースホルダーテキスト設定
   ├─ ラベルテキスト設定
   ├─ 定型ボタンの更新
   └─ セマンティックコンテンツ属性設定

3. ユーザー入力
   ├─ 定型ボタンタップ → テキストフィールドに反映
   └─ テキストフィールド入力 → 文字数制限チェック

4. 変更通知
   └─ delegate?.summaryChanged(newSummary:)
```

### フローチャート

```mermaid
flowchart TD
    A[要約編集開始] --> B[UI初期化]
    B --> C{ユーザー操作}
    C -->|定型ボタンタップ| D[ボタンテキストをフィールドに設定]
    C -->|テキスト入力| E{255文字以内?}
    E -->|Yes| F[入力許可]
    E -->|No| G[入力拒否]
    D --> H[delegate.summaryChanged]
    F --> H
    C -->|Learn More| I[delegate.learnMoreButtonTapped]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 最大文字数 | 要約は255文字以内 | 常時 |
| BR-002 | 定型ボタン数制限 | cannedSummaryTypesの数がボタン数以下 | 常時 |
| BR-003 | RTL言語対応 | 言語に応じてセマンティックコンテンツ属性を設定 | RTL言語コード時 |
| BR-004 | 定型ボタン非表示 | cannedSummaryTypesに含まれないボタンは非表示 | 常時 |

### 計算ロジック

| 計算項目 | 計算式・ロジック |
|---------|----------------|
| 新テキスト長判定 | (textField.text?.count ?? 0) + string.count - range.length <= 255 |

## データベース操作仕様

### 操作別データベース影響一覧

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

本機能に固有のエラー処理はない。入力検証（文字数制限）はUIレベルで処理。

## トランザクション仕様

該当なし

## パフォーマンス要件

特になし（UIレスポンス要件のみ）

## セキュリティ考慮事項

特になし

## 備考

- EditSummaryViewControllerはEditSaveViewControllerに子ViewControllerとして埋め込まれる
- SummaryButtonScrollViewはボタンの高さを自動計算するカスタムScrollView

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | EditSummaryViewController.swift | `Wikipedia/Code/EditSummaryViewController.swift` | EditSummaryViewDelegate（L4-7） |
| 1-2 | EditSummaryViewController.swift | `Wikipedia/Code/EditSummaryViewController.swift` | EditSummaryViewCannedButtonType（L9-26） |

**読解のコツ**: EditSummaryViewCannedButtonTypeの各ケースがどのローカライズ文字列に対応するかを確認する。

#### Step 2: 初期化とUI設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | EditSummaryViewController.swift | `Wikipedia/Code/EditSummaryViewController.swift` | viewDidLoad（L49-68） |

**主要処理フロー**:
- **L52**: プレースホルダーテキスト設定
- **L59**: ラベルテキスト設定
- **L60**: Learn Moreボタンタイトル設定
- **L65**: updateCannedSummaryButtons()呼び出し
- **L66**: setupSemanticContentAttibute()呼び出し

#### Step 3: 定型ボタン処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | EditSummaryViewController.swift | `Wikipedia/Code/EditSummaryViewController.swift` | updateCannedSummaryButtons（L128-146） |
| 3-2 | EditSummaryViewController.swift | `Wikipedia/Code/EditSummaryViewController.swift` | cannedSummaryButtonTapped（L92-98） |

**主要処理フロー**:
- **L128-146**: cannedSummaryTypesに基づくボタンタイトル設定と表示/非表示制御
- **L92-98**: ボタンタップ時のupdateInputText呼び出し

#### Step 4: テキスト入力とデリゲート通知を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | EditSummaryViewController.swift | `Wikipedia/Code/EditSummaryViewController.swift` | UITextFieldDelegate（L149-158） |

**主要処理フロー**:
- **L154-157**: shouldChangeCharactersInでの255文字制限
- **L84-86**: textFieldDidChangeでのデリゲート通知
- **L88-90**: notifyDelegateOfSummaryChange()

### プログラム呼び出し階層図

```
EditSaveViewController
    │
    └─ wmf_add(childController: EditSummaryViewController)
           │
           ├─ viewDidLoad()
           │      ├─ updateCannedSummaryButtons()
           │      └─ setupSemanticContentAttibute()
           │
           ├─ cannedSummaryButtonTapped()
           │      └─ updateInputText(to:)
           │             └─ notifyDelegateOfSummaryChange()
           │                    └─ delegate?.summaryChanged(newSummary:)
           │
           └─ textFieldDidChange()
                  └─ notifyDelegateOfSummaryChange()
                         └─ delegate?.summaryChanged(newSummary:)
```

### データフロー図

```
[入力]                      [処理]                         [出力]

定型ボタンタップ   ───▶ updateInputText()          ───▶ summaryTextField.text
                           │
テキスト入力       ───▶ textField(_:shouldChangeCharactersIn:)
                           │
                           ▼
                   notifyDelegateOfSummaryChange()
                           │
                           ▼
                   delegate?.summaryChanged(newSummary:) ───▶ EditSaveViewController
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| EditSummaryViewController.swift | `Wikipedia/Code/EditSummaryViewController.swift` | ソース | 要約編集メインコントローラー |
| EditSaveViewController.swift | `Wikipedia/Code/EditSaveViewController.swift` | ソース | 親VC、デリゲート実装 |
| SummaryButtonScrollView | `Wikipedia/Code/EditSummaryViewController.swift` | ソース | ボタンスクロールビュー（L160-169） |
