Skip to content

ヘルプ

Jump to bottom
Heiko Lübbe edited this page Nov 24, 2023 · 27 revisions

Joomlaモジュール zitat-service.de 🇯🇵

Joomlaのモジュールは、ユーザーコミュニティwww.zitat-service.de/ja/のコレクションからランダムな引用を表示します。引用の選択は、5つの言語、500以上の著者の一つ、500以上のカテゴリの一つ、またはユーザー自身が設定した引用のいずれかに限定することができます。2007年以来、広告なしで無料でご利用いただけます。

Note

モジュールのJoomla 5デモサイトがあります： joomla.zitat-service.de/ja/

インストール

Joomlaのモジュール zitat-service.de はJoomlaのバージョン3、4、5をサポートしています。管理者としてJoomlaバックエンドにインストールする場合：

構成

基本設定

新しくインストールされたJoomlaモジュールと同様に、モジュールを表示するには初期設定が必要です。Joomlaの管理者として、システム | サイトモジュール | zitat-service.deに移動します：

  1. 位置: 例: 右サイドバー
  2. 状態: 公開日
  3. メニューの割り当て: すべてのページに

Tip

入力フィールドの短いメモは インラインヘルプを折りたたむ で表示されます。

モジュールパラメーター

モジュールの基本オプションで、表示される引用を限定することができます：

  • 著者を選択（例：聖徳太子）、
  • 特定のカテゴリー (例: 運)、または
  • ユーザーを選択。

ここで、ユーザーとは、引用を作成したメンバーのログイン名です。これにより、例えば自分で作成した名言を選択することができます。

選択*は、すべての著者、すべてのカテゴリー、すべてのユーザーを表しています。

引用文の言語には3つの基本的な選択肢があります：

  • ja – 具体的な言語の例として、日本語。
  • frontend - Joomlaが使用する言語での引用。言語がサポートされていない場合、英語が使用されます。
  • all - すべての言語で引用を表示します。

高度なモジュールパラメータ

高度な設定タブでは、さらなるカスタマイズオプションを提供します。

引用文はリンクされ、利用可能であれば作者と出典もリンクされます。これらのリンクは同じブラウザウィンドウ/タブで開きます。リンクを別のブラウザウィンドウ/タブで開くようにするには、quote_linksのような名前をHTMLリンクのターゲットに入力する必要があります。

クエリ方法は引用の取得方法を設定します。推奨されるクエリメソッドは ウェブブラウザ内のJavaScriptで非同期 である。この方法はページの読み込みと並行して引用を取得するため、ページの読み込みが速くなります。逆に、Joomlaから クエリメソッドでは、ページの読み込みと一緒に引用がフェッチされます。ここでの利点は、モジュールをページ上に複数回埋め込むことができることです。

ページがロードされた後、非同期クエリーメソッドが引用符を取得するので、後続のモジュールは_ジャンプ_するかもしれません。そのため、モジュールはシリーズの最後に置くか（下のスペースを確保するため）、水平方向のスペースを確保する必要があります。モジュールの高さの最小値は 高さ (CSS) パラメータで指定できます。例えば、最小の高さを 20ex や 200px に設定することができます。カテゴリ WebDesignTest の言語選択 all は最も短い引用符と最も長い引用符を含んでいるので、高さのテストに適しています。

Tip

または、モジュールはページの一番下に配置されます。

スタイリング

表示される引用文はCascading Style Sheets（CSS）を使ってスタイルを設定することができます。quoteクラスのDIV要素は引用全体を囲み、例えばボーダーを設定することができます。quoteクラスのDIV要素には、引用を表すquotationと作者と引用元を表すsource`の2つのDIV要素が含まれます。以下の例では、標準的なリンクの装飾（下線）を取り除き、引用文を黒文字で通常よりも大きく設定しています。ソースは（リンクの有無にかかわらず）グレーで表示されます：

styling_ja

これを行うには、使用するテンプレートの CSS ディレクトリに 新規ファイル を作成します：

div.quote * a {
  text-decoration: none;
  color: black;
  font-size: larger;
}
div.quote div.source, div.quote div.source a {
  color: gray;
}

インターネット上の例

digitalflem.comのウェブサイトのテーマに合わせてスタイリングされた英語の引用文：

styled

現在 2023年11月17日

エラーの状況

404 No quote found for given parameters

パラメータが不利に組み合わされた場合、選択可能な引用は残りません。次の例では、言語 Spanish と作者 Douglas Adams が設定されています。しかし、スペイン語で保存されているダグラス・アダムスの引用はありません：

404 No quote found for given parameters: language=es (Spanish), authorId=345 (Douglas Adams). "https://api.zitat-service.de/v1/quote_html?contentOnly=true&V_2.0.1_5.0.0_S&language=es&authorId=345"

👉 引用が見つかるようにパラメータを選択してください。

Error: Failed to fetch (refused to connect)

もしCSP (Content Security Policy)が有効になっていて、次のようなエラーメッセージが表示された場合。

Error: Failed to fetch "https://api.zitat-service.de/v1/quote_html?contentOnly=true&language=ja"

ブラウザのJavaScriptコンソールでエラーを確認してください。そこで以下のようなエラーが見つかった場合は

zitatservice.js:32 Refused to connect to 'https://api.zitat-service.de/v1/quote_html?contentOnly=true&language=ja' because it violates the document's Content Security Policy.

👉 それから、ウェブサイトのCSP (Content Security Policy)コンフィギュレーションに、API用のconnect-srcを追加して、そこから引用を取得できるようにする必要があります。例えば、Apacheのコンフィギュレーションでは

# CSP
Header set Content-Security-Policy "connect-src 'self' api.zitat-service.de;"

👉 あるいは、モジュールの 'Query method' を 'From Joomla' に変更することもできます。

RuntimeException Connection timed out

見積もりを取得できる時間は最大3秒です。この時間を超えると、次のようなエラーメッセージが表示されます

RuntimeException Connection timed out after 3000 milliseconds "https://api.zitat-service.de/v1/quote_html?contentOnly=true"

👉 これは、ネットワーク接続が非常に悪い場合に発生する可能性があります。本当にサービスが利用できない場合は、チケットを作成してください。

Error: Invalid data "Goethe" for parameter "authorId"

プラグインの古いバージョン(2.0.0以前)では、設定されたパラメータに名前が使用されていましたが、プラグインのアップデート後は使用できなくなりました。以下の例では、Goetheが作者として保存されています：

Error: Invalid data "Goethe" for parameter "authorId". "https://api.zitat-service.de/v1/quote_html?contentOnly=true&authorId=Goethe"

👉 プラグインを2.0.0から2.0.0にアップデートした後、著者、カテゴリ、ユーザーなどの保存されたパラメータをユニークIDに切り替えるには、一度選択し直す必要があります。

チケット

バグや改善が必要ですか？GitHub Ticketを作成してください。 👍

Clone this wiki locally