Moderation Note
モデレート対象のコンテンツエンティティにインラインテキスト注釈を追加し、編集チームの共同作業とフィードバックを可能にします。
moderation_note
概要
Moderation Noteモジュールは、DrupalのContent Moderationワークフロー向けの強力な注釈システムを提供します。エディターやレビュアーがエンティティフィールド内の特定のテキストを選択し、その選択箇所に直接ノートを添付することで、コンテキストを意識したフィードバックシステムを構築できます。
モデレート対象エンティティの最新リビジョンを表示している際、適切な権限を持つユーザーはサポートされているフィールドタイプのテキストをハイライトし、必要に応じて担当者を指定してノートを追加できます。ノートはコンテンツ上に黄色のハイライトとして表示され、ツールチップで簡単に内容を確認できます。返信機能によるスレッド形式の会話をサポートしており、コンテンツ上で直接協力的なディスカッションが可能です。
フィードバックが対応済みになったノートは解決済みとしてマークでき、必要に応じて再度開くこともできます。Drupalのツールバーと統合されており、割り当てられたノート数がユーザーに表示されます。また、モデレート対象エンティティには「ノートを表示」タブが追加され、アクティブなノートの総数が表示されます。
メール通知機能により、ノートの作成、割り当て、解決、再オープン、返信時に関係者へ通知されます。また、Views統合によりカスタムノート管理インターフェースの構築も可能です。
Features
- インラインテキスト選択注釈 - エンティティフィールド内のテキストを選択し、ハイライトされたコンテンツに直接ノートを添付
- ノート割り当てシステム - モデレーションノートへのアクセス権限を持つ特定のユーザーにノートを割り当て
- スレッド形式の会話 - 既存のノートに返信して協力的なディスカッションを促進
- ノートライフサイクル管理 - フィードバック対応後にノートを解決済みにし、必要に応じて再オープン、または完全に削除
- メール通知 - ノートの作成、割り当て、解決、再オープン、返信時に自動でメールを送信
- ツールバー統合 - 管理ツールバーに割り当てられたノート数を表示してすばやくアクセス
- ローカルタスク統合 - モデレート対象エンティティに「ノートを表示」タブを追加し、アクティブなノートの総数を表示
- 多言語サポート - ノートは特定の言語翻訳に紐付けられ、複数言語の同時レビューが可能
- Views統合 - モデレーションノートのデータをカスタムViewsで利用可能にし、注釈付きコンテンツとのリレーションシップを提供
- サポートされているフィールドタイプ: text、text_long、text_with_summary、string、string_long、entity_reference、entity_reference_revisions、boolean、datetime、list_string
- AJAXベースのインターフェース - ページリロードなしでオフキャンバスダイアログを使用してノートの作成、編集、返信、解決、削除が可能
- Quick Edit互換性 - Quick Editセッション中はモデレーションノートが非表示になり、保存後に復元
Use Cases
編集レビューワークフロー
コンテンツレビュアーは下書きコンテンツ内の特定の箇所を選択し、変更要求や質問のノートを追加できます。コンテンツ作成者はメール通知を受け取り、対応が必要なハイライト箇所を確認できます。変更が完了したら、レビュアーはノートを解決済みにできます。これによりレビュープロセスの明確な監査証跡が作成されます。
複数レビュアーによる共同作業
複数のエディターが同じコンテンツに同時にノートを追加できます。各ノートはそのフィードバックに対応する責任を持つ特定のチームメンバーに割り当てることができます。ツールバーには各ユーザーに割り当てられたノート数が表示され、未対応のタスクを簡単に追跡できます。
翻訳レビュー
コンテンツが翻訳されると、レビュアーは特定の言語バージョンに独立してノートを追加できます。ノートはコンテンツの言語コードに紐付けられているため、干渉なく翻訳の同時レビューが可能です。
クライアントフィードバック収集
代理店の場合、クライアントユーザーに編集アクセスなしでノート作成権限を付与できます。クライアントはテキストをハイライトしてフィードバックノートを追加でき、コンテンツチームがそれに対応できます。解決/再オープンワークフローにより、どのフィードバック項目が処理されたかを追跡できます。
コンテンツQAプロセス
品質保証チームはコンテンツ監査中に問題をフラグするためにノートを使用できます。Views統合により、担当者、コンテンツタイプ、作成日でフィルタリング可能な、サイト全体のすべてのオープンノートを表示するダッシュボードを構築できます。
Tips
- ノートユーザーがレビュー中の下書きコンテンツにアクセスできるよう'view latest version'権限を付与してください
- コンテンツオーナーが自分のコンテンツのノートを管理できるよう'resolve moderation notes on editable entities'権限を使用してください
- テーマでtemplates/mail-moderation-note.html.twigをオーバーライドしてメール通知をカスタマイズできます
- 提供されているViews統合を使用してカスタムノート管理ビューを構築し、サイト全体のノートを追跡してください
- ノートは改行をサポートしています - ノートテキストでEnterキーを押すと複数行のフィードバックを作成できます
Technical Details
Admin Pages 1
/admin/config/moderation-note
メール通知設定を含む、Moderation Noteモジュールのグローバル設定を構成します。
権限 7
Hooks 2
hook_moderation_note_insert
新しいモデレーションノートが作成されたときにトリガーされます。内部的にはメール通知の送信とキャッシュタグの無効化に使用されます。
hook_moderation_note_update
モデレーションノートが更新されたときにトリガーされます。内部的には担当者の変更と公開ステータスの変更による通知処理に使用されます。
Troubleshooting 5
エンティティタイプでContent Moderationが有効になっていること、最新リビジョンを表示していること、ユーザーが'access moderation notes'権限を持っていること、フィールドタイプがサポートされているタイプ（text、string、entity_referenceなど）のいずれかであることを確認してください。
ユーザーが'create moderation notes'権限を持っていることを確認してください。コンテンツを編集できない場合は、'create moderation notes on uneditable entities'権限も必要です。
/admin/config/moderation-noteでメール送信が有効になっているか確認してください。また、サイトのメールシステムが正しく設定されていること、受信者ユーザーが有効なメールアドレスを持っていることも確認してください。
これはノート作成後にコンテンツが大幅に変更された場合に発生することがあります。モジュールはファジーマッチングを使用してテキストを検索しますが、大きな変更により位置がずれる場合があります。そのような場合、元々選択されていた内容を明確にするため、引用コンテキストがノートに表示されます。
ユーザーがツールバーにアクセスでき、'access moderation notes'権限を持っていることを確認してください。ツールバーリンクはこの権限を持つユーザーにのみ表示されます。
Security Notes 4
- 'administer moderation notes'権限はすべてのノートへの完全なアクセスを付与するため、信頼できる管理者に限定してください
- ノートテキストはプレーンテキストとして保存され、基本的なサニタイズで表示されます - XSSが懸念される場合は信頼できないユーザーにノート作成を許可しないでください
- メール通知にはノート内容が含まれます - 機密性の高いフィードバックがメールで送信される可能性があることに注意してください
- 担当者のオートコンプリートは'access moderation notes'権限を持つユーザーのみを表示し、情報漏洩を防止します