logo

パレット - カラフルに🎨

Palette — ビジュアルページビルダー、デザインの専門知識は不要です。

ライブデモ パレットをダウンロード

Scroll

ドキュメントとヘルプモジュール

15/04/2025, by Ivan

モジュールの中には、実際にあなたが何かをする必要がなく、裏側で黙々と仕事をこなすだけのものもあります。ただし、そうしたモジュールは設定項目を持たないか、他のモジュールの依存関係としてのみ機能することが多いでしょう。

多くの場合、あなたが関心を持つモジュールは、権限や設定を構成できる類いのものです。プロジェクトによっては使いやすく「直感的」で、何を設定できるのか、意図したとおりに動作させるには何をすればよいのかが比較的わかりやすいものもあります。

新しくインストールしたモジュールを賢く使いこなすために必要な詳細をすべて学びたい場合、必要になりそうなものや、確認すべき場所をいくつか挙げてみます。

次に挙げる提案は、使いやすい順に並べています。

私たちのような初心者のエンドユーザーにとって残念なことに、Drupal は常に進化を続けています。開発者たちの素晴らしい成果を無償で享受できるのは幸運ですが、彼らの時間は限られています。優れた開発者ほど、少なくとも初心者を念頭に置いたドキュメントを丁寧に書く人ではない、と言っても差し支えないでしょう。そうでなければ、あなたも私も今ここにいなかったはずです。

ぜひ、Drupal の使い方を学ぶ中で経験した試行錯誤や課題を、あなた自身で記録し公開してください。これからの日々、数か月、数年のうちに、あなたと同じ立場に立つ何千人もの人々のためになります。

これこそが、このドキュメントを作成する究極の目的だと私は考えています。Drupal を使う上での――そして新しいドキュメントセクションの――終わりのないように思える煩わしさ、いら立ち、複雑さにもかかわらず(あるいはそれゆえに)、そして、あなたや私のような他の初心者が以前にきちんとした初心者向けの手引きを書いてくれていれば解決していたかもしれない、Drupal を学び使う上での問題を少しでも減らすために。しかし何より、友よ、あなたがこれによって役立てられることを私はうれしく思います。

あなたも私と同じで、自分が「知っている」ことや学んだことを共有するのに、「開発」やプログラミングについて何かを知っている必要はありません。

試行錯誤

とにかく飛び込んで、モジュールを使い始めたり、その設定をいじってみたりすればよいのです。

あるオプションが何をするのか、どんな結果になるのかがどうしてもわからない場合は、あなたの冒険心が最善だと感じたものを試してみてください。

モジュールの使用が当て推量になるような場面に出くわしたときは、恐れずに実験してください。ただし、必要なら元に戻せるよう、サイトのバックアップを取ってあることだけは確認してください。サイトのバックアップは取っていますよね?

どの機能がそのモジュールや特定のオプションの影響を受けるのかはすぐにはわからないことがあるため、一度に有効化するモジュールは一つだけにし、別のコントリビュートモジュールを追加する前に、新しいページを作成したりさまざまな設定を試したりしながらサイトをじっくり調べることをお勧めします。

そうしないと、新しいモジュールを一度に複数有効化して奇妙な問題に遭遇した場合、どのモジュールが原因なのかがわからなくなってしまいます。

モジュールのプロジェクトページ

すべてのモジュールのプロジェクトページは、drupal.org 上のそのモジュールのホームページです。私は通常、モジュールを試すかどうかを判断するときや、最近有効化したモジュールについて問題や疑問があるときは、まずそこから始めます。

プロジェクトページ全体を注意深く読めば、最も重要な情報は押さえられていると、ある程度自信を持てます。たとえば、あるモジュールが動作するために他のモジュールを必要とする場合、通常はそこに一覧が記載されています。

プロジェクトページには、そのモジュールに関連する他の役立つリンクやリソースが含まれていることもあります。

プロジェクトページの内容は、Drupal の新規ユーザー向けの場合もあれば、より上級のユーザーや開発者向けの場合もあります。

「Read Documentation(ドキュメントを読む)」リンク(ある場合)

右側のカラム(モバイルや幅の狭いブラウザーウィンドウでは下部に表示されます)には、必ず「Resources(リソース)」セクションがあり、そこに「Read documentation(ドキュメントを読む)」リンクがある場合があります。

ただし、すべてのプロジェクトページにこのリンクがあるわけではありません。その場合は、メインのコンテンツ領域に他の役立つリンクがあることを願うばかりです。

「Read documentation」リンクが存在する場合、それは開発者がさらに詳しく調べ始めるのに最適だと考えているリソースです。

各プロジェクトページの内容は、そのプロジェクトの最初の作成者と、その人が権限を与えた可能性のある他の人々によって管理されています。

プロジェクトページを編集できない他の drupal.org ユーザーも、そのモジュールに関する有用な情報を含む優れたページを作成していることがよくあります。しかし残念ながら、それらがメインのプロジェクトページからリンクされていることはめったにありません。

リンクされていないそれらのページを見つける方法については、以下の drupal.org に限定した Google 検索 ⤵ のセクションで扱います。

モジュールの「README.txt」ファイル

「README.txt」ファイルは、従来、モジュール(またはテーマ)に関するすべての重要かつ必須の情報を、新しいバージョンへの更新に関することを含めて記載する公式の場所とされてきました。

README.txt ファイルは、存在する場合、モジュールを展開した後のトップレベルディレクトリにあります。

何もダウンロードせずに README.txt を表示するには、次の形式のリンクを使用します:

http://cgit.drupalcode.org/project/PROJECT_MACHINE_NAME.git/blob/HEAD:/README.txt

URL 内の PROJECT_MACHINE_NAME を、モジュールの実際のマシン名に置き換えてください。

マシン名は、drupal.org でプロジェクトページを訪れたときの URL で確認できます。次のように表示されます:

https://www.drupal.org/project/PROJECT_MACHINE_NAME

README.txt がない場合、そのモジュールにはおそらく設定がなく、他のコントリビュートモジュールの依存関係として黙って動作します。

README.txt がない場合や、すべてのドキュメントを調べたい場合は、次の URL を使用してください(PROJECT_MACHINE_NAME を置き換えます):

http://cgit.drupalcode.org/PROJECT_MACHINE_NAME/tree/?id=HEAD

その drupalcode.org ページの右上で、作業している Drupal のコアバージョンに切り替える必要がある場合があります。

drupal.org に限定した Google 検索

検索を drupal.org に限定するために、私が行っている方法を紹介します。この方法は、drupal.org や他の任意のドメインを検索するのによく使います。

google.com ⎘ にアクセスして、次のように入力します:

site:drupal.org

注意:コロンの後にスペースを入れず、ドメイン名に「www.」を使わないでください。

スペースを追加してから、キーワード――この場合はモジュール名――を入力します。

ときには、関連するバージョンに結果を絞り込むために「Drupal 8」(引用符付き)を追加することもあります。

drupal.org だけでなくウェブ全体でモジュールに関する情報を探すには、サイトの限定を外します。

Google の検索結果を 1 ページあたり 10 件ではなく 100 件表示するには、結果ページ右上の歯車アイコンをクリックし、「検索設定」を選び、「Google インスタント予測」を「インスタント結果を表示しない」に設定して、「ページあたりの表示件数」のスライダーを右端までスライドします。

一つ注意点があります。drupal.org 自体が提供している検索を使いたくなるかもしれませんが、私はそれがあまり役に立たないと感じています。いら立つのが好きなら試してみてください。

サイトの「Extend(拡張)」ページにある「Help(ヘルプ)」ボタン/リンク(ある場合)

サイトの「Extend(拡張)」ページでは、各モジュール名の右側に、ブラウザーウィンドウが十分に広ければその説明の最初の行が表示されることがあります。

この行をクリックすると、完全な説明が展開され、利用可能な場合は「Help(ヘルプ)」「Permissions(権限)」「Configure(設定)」のボタン/リンクが表示されます。

説明がすぐに表示されない場合は、モジュール設定ページのガイドに従ってください。

残念ながら、モジュールのヘルプページにアクセスするには、モジュールをインポートするだけでなく、有効化されている必要があります。しかも、すべてのモジュールにヘルプリンクがあるわけではありません。ですから、まずモジュールを有効化してみないと、それが存在するかどうかもわかりません。

こうした理由から、私は「Help(ヘルプ)」リンクを頼りにすることはありませんでした。もっとも、今あらためて見てみると、それらが役立つページにつながっていることも多いと気づきます。