Footnotes
CKEditor 5向けに自動番号付き脚注参照機能を提供します。引用、バックリンク、カスタマイズ可能なグループ化オプションに対応しています。
footnotes
概要
Footnotesモジュールは、コンテンツ編集者がURLへの参照や学術的な引用など、記事や投稿に自動番号付きの脚注参照を簡単に作成できるようにします。CKEditor 5のツールバーボタンを提供し、モーダルウィンドウを開いて脚注ソース内に書式付きコンテンツ（太字、斜体、リンク）を追加できます。
このモジュールはテキスト内に引用（例：[1]、[2]）を自動的に作成し、コンテンツの下部に脚注参照セクションを生成します。各引用は対応する参照にリンクし、バックリンクによりユーザーはテキスト内の引用箇所に戻ることができます。複数の引用が同じ脚注を参照でき、同一の脚注は単一の参照番号に統合できます。
複数のテキストフィールドを持つ複雑なレイアウト用に、ページ内のすべての脚注を収集して単一の統合参照セクションに表示するFootnotes Groupブロックを提供します。また、Search APIと統合して引用マーカーを検索インデックスから除外します。
Features
- モーダルダイアログインターフェースで脚注を挿入するためのCKEditor 5ツールバーボタン
- カスタマイズ可能な手動値を持つ自動脚注番号付け
- 参照セクションにジャンプする引用リンクと引用箇所に戻るバックリンク
- アルファベットサフィックス（1a、1b、1c）を持つ同一脚注への複数引用のサポート
- 同一の脚注コンテンツを単一の参照番号に統合するオプション
- 複数のテキストフィールドからの脚注を1つの参照セクションに統合するFootnotes Groupブロック
- 遅延読み込みコンテンツシナリオ用のJavaScriptベースのグループ化
- 参照セクションにジャンプする代わりにポップアップで脚注コンテンツを表示するダイアログモードオプション
- 検索インデックスから脚注引用を除外するSearch APIプロセッサ
- Footnotes 3.xから4.x形式へのコンテンツアップグレード用Drushコマンド
- 引用、引用グループ、参照リスト用のテーマ可能なテンプレート
- ツールバー設定のCKEditor 4からCKEditor 5への自動アップグレードパス
- Microsoft WordおよびLibreOfficeドキュメントからの脚注貼り付けのサポート
Use Cases
引用付きの学術・研究記事
脚注を使用して学術コンテンツにソース引用を追加します。各引用は記事下部の完全な参照にリンクする自動番号を取得します。読者は引用をクリックして参照を確認し、バックリンクを使用して読んでいた位置に戻ることができます。
参照付きの法的文書
法的コンテンツでは、法律、判例、その他の文書への番号付き参照が必要になることが多いです。脚注モジュールは自動番号付けを提供し、同じソースが複数回引用される場合に同一の参照を同じ番号に統合できます。
説明付きノートを含む長文記事
ジャーナリストやコンテンツライターは、メインの物語を中断することなく補足情報を追加するために脚注を使用できます。ダイアログオプションを有効にすると、ページ下部にジャンプする代わりにポップアップで脚注コンテンツを表示します。
複数のコンテンツセクションを持つページ
複数のフィールド（本文テキストとサイドバーコンテンツなど）からコンテンツを組み合わせるページでは、Footnotes Groupブロックを使用してすべての脚注を単一の統合参照セクションに収集します。ブロックをメインコンテンツエリアの後に配置します。
遅延読み込みコンポーネントを持つコンテンツ
脚注が遅延読み込みコンテンツ（AJAX読み込みセクションなど）に表示される場合、Footnotes Groupブロックで「JavaScriptを使用して脚注をグループ化」オプションを有効にして、すべての脚注が収集され適切に番号付けされるようにします。
他のシステムからのコンテンツの移行
脚注を含むMicrosoft WordやLibreOfficeからペーストされたコンテンツはこのモジュールで処理できます。ペーストの問題をトラブルシューティングするにはデバッグモード（URLに?debug=1を追加）を使用します。DrushアップグレードコマンドはFootnotes 3.x形式からの移行を処理します。
Tips
- テンプレートをテーマディレクトリにコピーし、テーマレジストリキャッシュ（drush cc theme-registry）をクリアして脚注の外観をカスタマイズできます
- 「同一コンテンツの脚注を統合」オプションを使用して、重複引用を自動的に同じ参照番号に統合できます
- Footnotes Groupブロックを使用する場合、適切なCache無効化のためにEntityコンテキストを'node'に設定します
- 学術コンテンツでは、ダイアログオプションを有効にしてポップアップで参照を表示することでユーザー体験を向上させることを検討してください
- 本番コンテンツで実行する前に、開発/ステージング環境でアップグレードDrushコマンドを十分にテストしてください
Technical Details
Admin Pages 2
/admin/config/content/formats/manage/{format}
特定のテキストフォーマットのFootnotesフィルター設定を構成します。Footnotesフィルターが有効な任意のテキストフォーマットを編集してアクセスします。
/admin/config/content/formats/manage/{format}
Footnotesモーダルダイアログ内で使用されるCKEditorツールバーを構成します。特別な'Footnote'テキストフォーマットを使用します。
Hooks 1
hook_footnotes_upgrade_3x4x_build_alter
3.xから4.x形式へのコンテンツアップグレード時に、アップグレードされた脚注タグを生成するために使用されるrender arrayを変更します。
Drush Commands 1
drush footnotes:upgrade-3-to-4 <entity_type>
脚注コンテンツを3.x形式（<fn>および[fn]タグ）から4.x形式（data属性を持つ<footnotes>タグ）にアップグレードします。脚注を含む書式付きテキストフィールドを持つ、指定されたタイプのすべてのEntityを処理します。
Troubleshooting 6
テキストフォーマットでFootnotesフィルターが有効になっており、HTML修正フィルターの前に表示されていることを確認してください。設定変更後はCacheをクリアしてください。
Footnotesフィルターはフィルター順序で「改行を変換」フィルターの前に表示される必要があります。このモジュールは空白を最小化するためにカスタムのspaceless Twigフィルターを使用しています。
Footnotes Groupブロック設定で「JavaScriptを使用して脚注をグループ化」オプションを有効にします。このオプションを使用する場合は、脚注フッター出力を無効にしないでください。
ペーストする前にページURLに?debug=1を追加してコンソール出力を確認します。ペーストされたコンテンツに認識可能な脚注マーカーが含まれているか確認してください。
「脚注フッターの出力を無効化」設定を変更した後、すべてのCacheをクリアしてください。この設定はコンテンツのレンダリングとキャッシュ方法に影響します。
これはDrupal Coreの制限です - モーダルウィンドウ内のモーダルウィンドウはサポートされていません。脚注内では埋め込みメディアの代わりにリンクを使用してください。
Security Notes 3
- このモジュールは公式のDrupalセキュリティカバレッジを受けています
- 脚注コンテンツは、許可されるHTMLタグをbr、p、strong、em、およびリンクに制限する'footnote'テキストフォーマットを通じてフィルタリングされます
- 脚注ダイアログへのアクセスには'use text format footnote'権限が必要です