編集者が使えるページ部品を作る

本文のひな形、組み替えるページ部品、ページ全体のレイアウトを区別します。編集者の操作と開発者の準備をつなげます。

目次

「部品を置ける」は、3つの意味に分ける

EmDashでは、繰り返し使う文章にはSections、並べ替える部品にはblocks型の欄、ページ全体の見た目にはページレイアウトを使います。編集者が何を変えたいかに合わせて、制作担当者が仕組みを用意します。

やりたいこと使う仕組み編集者が変えるもの
本文の定型文を入れて、記事ごとに直すSectionsコピーして入れた文章
見出し・写真などのまとまりを並べ替えるblocks型の欄用意された種類と各項目の値
ページ全体の見た目を選ぶページレイアウトテーマで許可したレイアウト名

編集者が管理画面で追加・変更できる部品は、テーマや入力欄で用意された範囲に限られます。選択肢にないデザインを使いたい場合は、制作担当者による準備が必要です。

定型文なら、まずSectionsを使う

Sectionsは、見出しや段落をまとめた本文を再利用するためのひな形です。この本文はPortable Textという形式で保存されます。「週末ノート」なら、記事の末尾に入れる「道具選びの注意」を作れます。

  1. 管理画面のSectionsを開き、New sectionを選びます。
  2. タイトル、スラッグ、必要に応じて説明を入力します。
  3. 注意書きの本文を入力し、探しやすいキーワードを付けて保存します。
  4. 記事の本文で/sectionと入力し、作ったひな形を探して挿入します。
  5. 記事に合わせて文章を直し、保存・公開します。

挿入時に文章がコピーされます。元のSectionを後から直しても、すでに記事へ入れた文章は変わりません。全部の記事の注意書きを一括で更新したい場合は、共通部品を直接読み込む方式や、共通の表示枠であるWidget areaを検討します。

並べ替えるページ部品はblocksを使う

ここからは、入力欄と表示用コードを用意する制作側の話です。一覧と詳細ページを作る練習のあとで読み進めると、保存した値を画面に出す流れを追いやすくなります。

blocks型の欄には、部品の種類、版、識別用のキー、入力内容が順番に保存されます。たとえば「大きな見出し」「特徴の一覧」を並べるページを作れます。

開発者が準備するものは、次の3つです。

  1. 部品の定義:見出しや画像など、部品に必要な入力欄。
  2. 使用できる部品の指定:そのページで何を追加できるか。
  3. 表示するAstro部品:保存した値をどんなHTMLで出すか。

入力欄があっても表示用コードがなければ、読者向けの見た目は完成しません。逆にAstro部品だけ作っても、管理画面の部品一覧には自動登録されません。

最小の部品定義を読む

次は、新しいサイトの初期設定に加える部品定義の例です。既存のseedファイル全体と置き換えるものではありません。

{
  "slug": "notice",
  "label": "お知らせ",
  "currentVersion": 1,
  "versions": [
    {
      "version": 1,
      "fields": [
        { "slug": "heading", "label": "見出し", "type": "string", "required": true },
        { "slug": "body", "label": "本文", "type": "portableText" }
      ]
    }
  ]
}

これはseedのblockTypes配列に入る1件です。ページ側にはtype: "blocks"の欄を定義し、そのvalidation.allowedTypesにnoticeを含めます。新規サイトではseedで準備できますが、初期設定済みサイトでは定義の変更を別に適用します。手順は運用中の項目変更を参照してください。

表示する側では、どの種類のデータをどの部品で表示するかという対応表をdefineBlockComponentsで作ります。このとき、EmDashが生成した型の情報を使います。続いて、表示用のBlocks部品にデータと対応表を渡します。フィールド名によって生成される型名が変わるため、公式例のPageLayoutBlockをどのサイトでもそのまま使えるとは限りません。

具体的なseed、Astro部品、ページを一組で確認したい場合は、公式のblocksガイド(別タブで開く)が参照先です。

版を変える理由

公開後にheadingをtitleへ変えると、古い記事や変更履歴にはheadingで保存された値が残っています。そこで、保存した部品には_versionという版の番号を持たせます。

互換性のない変更では新しい版を作り、表示側も残っている古い版を扱えるようにします。最新版の定義だけ残して古い版を消すと、履歴や以前の内容を正しく表示できなくなる可能性があります。

また、追加できる種類の一覧から部品を外しても、保存済みの部品は一括で削除されません。EmDashは、廃止した種類の部品を新しく追加することと、すでにある内容を編集することを区別して扱います。

ページ全体のレイアウトを選ばせる

テーマ側で「標準」「幅広」などのレイアウトを用意したら、保存された選択値とAstro部品の対応を明示的に決めます。管理画面の文字列を、そのまま自由なファイル読み込み先として使う実装は避けます。

選択欄を作る、選択値を保存する、テーマがその値を使う。この3点が揃って初めて、編集者が見た目を選べます。

確認では、部品0個、同じ部品が複数、長い見出し、画像未設定、並べ替え、過去の版の表示を見ます。入力画面の使いやすさと、読者向けの表示の両方を確認してください。

表示するプラグインを外す前に

記事に部品のデータが残っていても、それを描くコードがなくなれば、以前と同じ表示にはなりません。どの記事がその部品を使っているかを一覧にし、検証環境でプラグインを無効化して確認します。

代わりの表示部品を残す、一般の文章や画像へ変換する、該当記事を修正するなどの方法を選びます。編集画面で開いて保存したときにデータが欠けないかも試します。コードを削除する前に、対象件数と変換後の内容を照合してください。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。