Micro-content
リビジョンと翻訳をサポートする、フィールド対応の小さなコンテンツスニペットを作成するための、バンドルサポート付きの軽量で再利用可能なコンテンツエンティティタイプを提供します。
microcontent
インストール
composer require 'drupal/microcontent:^2.0'
composer require 'drupal/microcontent:8.x-1.8'
概要
Micro-contentは、小さな構造化コンテンツを作成するために設計された、軽量で再利用可能なコンテンツエンティティタイプを提供するDrupalモジュールです。完全なノードとは異なり、Micro-contentエンティティは、お客様の声、人物カード、評価、キャリア成果などの小さな再利用可能なコンテンツスニペット向けに設計されています。
このモジュールは、サイトビルダーが独自のフィールド構成を持つ異なるタイプのMicro-contentを定義できるバンドルシステム(Micro-contentタイプ)を提供します。各Micro-contentタイプには、管理インターフェースでコンテンツ編集者がタイプを視覚的に区別できるよう、説明とCSSクラスを設定できます。
主な機能には、リビジョンログ付きの完全なリビジョンサポート、多言語サイト向けの翻訳サポート、エンティティ所有者の追跡、公開/非公開ワークフロー、有効時のDrupalのContent Moderationシステムとの統合が含まれます。また、カスタムリストを作成するためのViews統合や、エンティティ参照フィールドでMicro-contentを選択するためのEntity Browser統合も提供します。
Features
- 設定可能なバンドルタイプ(microcontent_type)を持つカスタムコンテンツエンティティタイプ(microcontent)
- リビジョンユーザー、タイムスタンプ、ログメッセージの追跡を含む完全なリビジョンサポート
- 多言語コンテンツ管理のための翻訳サポート
- 作成者情報を含むエンティティ所有者の追跡
- ステータスフィールドによる公開/非公開ワークフロー
- Content Moderation統合 - モデレーション有効時にリビジョン作成を強制
- 管理リストやフロントエンド構築用のカスタムViewsデータを含むViews統合
- 既存のMicro-contentの選択や新規作成のためのモーダル表示を備えたEntity Browser統合
- 公開/非公開コンテンツのフィルターアクセス付きJSON APIサポート
- レンダリング出力からの素早い編集のためのコンテキストリンクサポート
- Micro-contentタイプにカスタムフィールドを追加するためのField UI統合
- きめ細かなアクセス制御のためのバンドルベースの権限粒度
- コンテンツタイプを視覚的に区別するための管理テーマカスタマイズ用CSSタイプクラスサポート
- 管理コンテキストでMicro-contentを表示するためのプレビュー表示モード
Use Cases
お客様の声と引用
引用テキスト、著者名、著者の肩書き、会社名、写真のフィールドを持つ「お客様の声」Micro-contentタイプを作成します。コンテンツを重複させることなく、複数のページから参照できるクライアントの声を管理するために使用します。
人物カード
写真、名前、肩書き、経歴、連絡先情報のフィールドを持つスタッフやチームメンバーのプロフィール用の「人物カード」Micro-contentタイプを作成します。これらのカードをチームページ、記事の著者紹介、イベントのスピーカー一覧で参照します。
評価とレビュー
評価値、レビューテキスト、レビュアー名、日付のフィールドを持つ「評価」Micro-contentタイプを作成します。複数のコンテキストで表示できる製品レビュー、コース評価、サービスフィードバックに使用します。
コールトゥアクションブロック
見出し、説明、ボタンテキスト、リンクのフィールドを持つ「CTA」Micro-contentタイプを作成します。コンテンツ編集者が様々なページレイアウトに配置できる再利用可能なコールトゥアクションコンポーネントを作成できます。
機能ハイライト
製品やサービスの機能を強調するためのアイコン、タイトル、説明のフィールドを持つ「機能」Micro-contentタイプを作成します。ランディングページ、比較表、機能マトリックスで参照します。
FAQアイテム
質問と回答のフィールドを持つ「FAQ」Micro-contentタイプを作成します。FAQコンテンツを一元管理し、複数のFAQページやコンテキストに関連するコンテンツエリアで参照します。
Tips
- Micro-contentタイプを作成する際にタイプクラスフィールドを使用して、管理インターフェースで異なるタイプを視覚的に区別するのに役立つCSSクラスを追加してください
- コンテンツ履歴を追跡したいタイプでは、デフォルトで「新しいリビジョンを作成」を有効にすることを検討してください
- 管理一覧やエンティティブラウザでMicro-contentがどのように表示されるかをカスタマイズするには、プレビュー表示モードを使用してください
- Entity Browserを使用する場合、モジュールは選択とインライン作成の両方の機能を備えたすぐに使えるブラウザ設定を提供します
- Micro-contentタイプはすべての標準的なDrupalフィールドタイプをサポートしているため、画像、フォーマット済みテキスト、エンティティ参照などを含む複雑な構造化コンテンツを作成できます
- このモジュールはヘッドレス/デカップルドアーキテクチャ用にJSON APIと統合されており、Micro-contentはAPIリソースとして公開できます
Technical Details
Admin Pages 8
/admin/structure/microcontent-types
すべてのMicro-contentタイプを一覧表示します。このページから新しいタイプの追加、既存タイプの編集、フィールドの管理、フォームと表示の設定、タイプの削除ができます。
/admin/structure/microcontent-types/add
ラベル、マシン名、説明、スタイリング用のタイプクラス、リビジョン設定を含む新しいMicro-contentタイプを作成するためのフォームです。
/admin/structure/microcontent-types/manage/{microcontent_type}
既存のMicro-contentタイプのラベル、説明、タイプクラス、リビジョン動作などの設定を編集するためのフォームです。
/admin/content/microcontent
すべてのMicro-contentエンティティの管理一覧です。プレビュー、タイプ、作成者、ステータス、更新日、操作を表示します。ラベル、タイプ、作成者、公開ステータスによるフィルタリングをサポートします。
/admin/content/microcontent/add
利用可能なMicro-contentタイプを表示する選択ページです。タイプをクリックしてそのタイプの新しいMicro-contentを作成します。
/admin/content/microcontent/add/{microcontent_type}
指定されたタイプの新しいMicro-contentエンティティを作成するためのフォームです。フォームフィールドはMicro-contentタイプに設定されたフィールドによって異なります。
/admin/content/microcontent/{microcontent}/edit
既存のMicro-contentエンティティを編集するためのフォームです。Micro-contentは管理専用コンテンツのため、正規URLは編集フォームにリダイレクトされます。
/admin/content/microcontent/{microcontent}/delete
Micro-contentエンティティを削除するための確認フォームです。この操作は元に戻せません。
権限 9
Hooks 2
hook_preprocess_microcontent
microcontentテンプレート用の変数を準備します。テーマ用にmicrocontentエンティティ、view_mode、name(ラベル)、content変数を設定します。
hook_jsonapi_microcontent_filter_access
microcontentエンティティのJSON APIフィルターアクセスを制御します。ユーザーが「view unpublished microcontent」権限を持っている場合はすべてのエンティティ間でのフィルタリングを許可し、「access content」権限を持っている場合は公開済みエンティティ間でのフィルタリングを許可します。
Troubleshooting 5
コンテンツを作成する前に、少なくとも1つのMicro-contentタイプを作成する必要があります。管理 > 構造 > Micro-contentタイプに移動し、「Micro-contentタイプを追加」をクリックしてください。
「access microcontent overview」権限があることを確認してください。この権限はコンテンツの作成/編集権限とは別です。
Entity Browserモジュールがインストールされ、有効になっていることを確認してください。Entity Browser設定はモジュールが利用可能な場合にのみインストールされます。
Micro-contentタイプの設定で「新しいリビジョンを作成」が有効になっていることを確認してください。Content Moderationを使用している場合、リビジョンは自動的に強制されます。
「view unpublished microcontent」権限(すべてのコンテンツ用)または「access content」権限(公開済みコンテンツのみ用)があることを確認してください。
Security Notes 4
- 「administer microcontent types」と「administer microcontent」権限は制限付きとしてマークされています - 信頼できる管理者にのみ付与してください
- バンドルベースの権限により、特定のタイプのMicro-contentを作成、編集、削除できるユーザーをきめ細かく制御できます
- 非公開のMicro-contentを表示するには、明示的な「view unpublished microcontent」権限が必要です
- 公開前に編集レビューが必要なMicro-contentには、Content Moderationワークフローの使用を検討してください