Class: VivlioStarter::CLI::SamovarCommands::IndexCommand

Inherits:
VsCommand
  • Object
show all
Defined in:
lib/vivlio_starter/cli/samovar/index_command.rb

Overview

index コマンドの Samovar 実装

Constant Summary

Constants included from OptionTokenNormalizer

OptionTokenNormalizer::BARE_VALUE_DEFAULTS

Instance Method Summary collapse

Methods included from OptionTokenNormalizer

#initialize, prepended

Instance Method Details

#call ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/vivlio_starter/cli/samovar/index_command.rb', line 42

def call
  puts <<~HELP
    索引機能のコマンド:

      vs index:plan [章]  - 索引語数の目安と現況を表示（辞書は変更しない）
      vs index:auto [章]  - 候補抽出・分類・確認用ファイル生成（章を指定可）
      vs index:apply      - レビュー結果を index_glossary_terms.yml に適用
      vs index:export     - 用語集[g]・棄却語 を index_library.yml に書き出す
      vs index:import     - index_library.yml から用語集[g]・棄却語 を取り込む

    ワークフロー:
      0. vs index:plan   → 目安語数と現況を確認する（任意）
      1. vs index:auto   → _index_glossary_review.md を生成
      2. _index_glossary_review.md を編集（[x]で承認、[r]で棄却）
      3. vs index:apply  → index_glossary_terms.yml を更新
      4. vs build        → 索引ページを含む PDF を生成

    章の指定（長い本で一部だけ見たいとき）:
      vs index:auto 21          # 21 章だけを対象に候補抽出
      vs index:auto 21-23,25    # 範囲・複数指定も可

    書籍間での持ち運び（用語集[g]・棄却語 を別の本へ引き継ぐ）:
      vs index:export           # index_library.yml へ書き出す
      vs index:import           # index_library.yml から取り込む
      vs index:export mylib.yml # パスを指定して書き出す（取り込みも同様）

    詳細は各コマンドに --help を付けて確認してください。
  HELP
  0
end