Noasabaのコマンド早見表は、掲載項目が増えても運営者がGitを使わずに追加・修正できるよう、WordPressのコンテンツとして管理しています。今回は、早見表を固定の表からCMSで扱えるカタログにした考え方を紹介します。
項目とマニュアルを分ける
早見表の1行には、用途、実行する文字列、分類、詳しい説明へのリンクが必要です。これらを1枚のHTML表に書き込むと、行を追加するたびにページ本文を直接編集し、検索や分類の情報も別々に保つことになります。
そこで、一覧の各行を独立した「コマンド早見表」の項目として登録します。項目名、コマンドの文字列、表示形式、関連するマニュアルを管理画面で設定し、分類はカテゴリーで整理します。Minecraftの説明ページは従来どおり階層型の固定ページとして残し、早見表の項目から該当ページへリンクします。
一覧は項目データから組み立てる
- 項目名は用途を表すタイトルにする
- コマンド欄には実行例や補足を保存する
- 分類を付けて、関連する項目をまとめる
- 詳しい操作説明がある場合は、既存のマニュアルをリンクする
早見表ページには専用ブロックを置き、選択した分類に属する項目を表として表示します。そのため、項目を追加すると表示内容も更新されます。分類や項目を増やすときも、テーマのPHPやページ内の固定表を編集する必要はありません。
検索と更新時の注意
サイト内検索では、項目名だけでなくコマンド文字列や分類も検索対象にします。検索結果からは個別の項目編集画面ではなく、利用者が一覧を見つけやすい早見表の該当行へ移動します。
次の例は入力欄の形式を示す架空の文字列です。実際のサーバーで使えるコマンドではありません。
/example <対象> [任意の値]新しい項目を登録するときは、対象エディションや必要な権限を確認し、引数の意味も説明に記載します。実在するコマンドの仕様は、導入しているサーバーソフトウェアやプラグインのバージョンに合わせて確認してください。
追加・修正の基本手順
- 管理画面の「コマンド早見表」から項目を追加する
- 用途を表すタイトル、コマンド欄、分類を入力する
- 必要に応じて関連マニュアルと表示形式を選ぶ
- 保存後、早見表ページと検索結果で表示を確認する
この構成なら、コマンドの項目と長いマニュアルをそれぞれの用途に合った形で更新できます。今後項目が増えたときも、分類を追加して一覧を整理しながら運用できます。