 |
概要 | Wiki 投稿を編集したすべての利用者を、投稿の直下にクレジット表示します |
 |
リポジトリ | GitHub - criptonautas/discourse-wiki-coeditors: Discourse theme component: credits everyone who edited a wiki post, under the post · GitHub |
 |
インストールガイド | テーマまたはテーマコンポーネントのインストール方法 |
 |
Discourse テーマ初心者の方へ | Discourse テーマ利用の初心者ガイド |
このテーマコンポーネントをインストール
Discourse はすべての Wiki 編集履歴を保持していますが、誰が貢献したかを明示していません。このコンポーネントは、投稿の直下に貢献者をリスト表示し、Wiki の最新化に努めた利用者にその功績を認めさせます。
機能内容
- Wiki トピックの最初の投稿の直下に「共同編集者」と編集者のアバターを表示します。
- 最近のリビジョンにおける編集回数の多さに応じて編集者をランク付けします。投稿の作者、
system、およびdiscobotはリストに表示されません。 - クリックすると、各利用者のプロフィールカードが開きます。
- 指定した数のアバターを超えた場合、残りは「+N 件」にまとめられます。
- 未ログインの訪問者にも対応: Wiki の編集履歴は、
edit_history_visible_to_publicがオフであっても公開されています。 - 英語およびスペイン語のローカライズが含まれています。
設定項目
| 設定項目 | デフォルト | |
|---|---|---|
target_categories |
空 | リストを表示する Wiki が属するカテゴリ |
target_tags |
空 | リストを表示する Wiki に付与されるタグ、全カテゴリが対象。カテゴリとタグが未設定の場合、すべての Wiki に表示されます。 |
label |
空 | アバターの前に表示されるテキスト。空の場合、閲覧者の言語が使用されます。 |
label_overrides |
なし | カテゴリごとの文言の個別設定 |
excluded_users |
空 | 表示から除外するユーザー名 |
max_avatars |
5 |
「+N 件」に表示される前に表示されるアバターの数 |
max_revisions |
20 |
読み込む最近のリビジョンの数、最大 40 |
既知の制限事項
- 各閲覧においてリビジョンごとに 1 回のリクエストが発生するため、最近のリビジョンのみが読み込まれます。大量に編集された Wiki の初期の編集者は表示から除外される場合があります。上限を 40 に設定しているのは、Discourse のデフォルト設定により、訪問者からのリクエストが 10 秒間で 50 回を超えるとブロックされるためです。
- AI ボットなどの他のボットは自動的に検出できないため、
excluded_usersに手動で追加する必要があります。 - タイトル、タグ、カテゴリのみを変更したリビジョンもカウントされます。
- クレジット表示は最初の投稿のみに行われます。
excluded_usersは名前を非表示にするだけであり、投稿の履歴に残っている編集自体は削除されません。
投稿ごとのクレジット表示ではなく、ランキング形式で表示したい場合は、README に Data Explorer クエリが含まれています。バグレポートやプルリクエスト（PR）をお待ちしております。