Manual:LocalSettings.php/ja

From MediaWiki.org

Jump to: navigation, search
MediaWiki File: LocalSettings.php
Location: /
Source code: Not in SVN (created during installation)
Classes: None


このファイルは(DefaultSettings.phpファイルに基づいて)MediaWikiインストレーションのローカルのコンフィギュレーション設定します。このファイルでの設定を点検するために時間をかけなければなりません。 このファイルは通常ウェブベースのMediaWikiのインストーラによって作成されますが、Apacheの設定に合わせて、いくつかのパラメータを微調整するとよいでしょう。

設定の変更は通常PHP変数の値を変更することを意味します。取りかかる前にPHP構文に慣れておくとよいでしょう。大まかには、PHP変数は先頭に"$"の文字がある文字列を準備することでアクセスされます; 多くの変数はtrueもしくはfalseのどちらかに設定されます。

ファイルを保存した後に変更は即座に反映されます: 手動で何か"再起動"させる必要はありません。場合によって変更内容を見るためにブラウザのキャッシュをクリアすることが必要になります。

多くの設定のデフォルト値はincludes/DefaultSettings.phpで設定されるが、編集しないで下さい 変更を望む変数がまだLocalSettings.phpに記述されていない場合、DefaultSettingsから該当の行をコピーして適切に修正します。LocalSettings.phpの範囲内で最終行に新しい行を追加できます。 それらすべての行はrequire_once( "includes/DefaultSettings.php" );'を示す行の下に表示されます。

ファイルの範囲内で'require_once( "extensions/extension.php" );'という行が複数存在することがあります。それらはwiki上で有効になった他のextensionsへのリンクです。これらのエクステンションはLocalSettings.phpで多くの変数の値を設定することが必要になることがあります; さらなる説明についてはエクステンションのドキュメントをチェックする。エクステンションのリストはExtension Matrixが利用できます。

Caution! Caution: require_once( "includes/DefaultSettings.php" );の前にエクステンションを設定しないで下さい; エクステンションのセットアップ関数の配列を空にして、エクステンションがインストールがされていない状態にしておそらくはwikiにアクセスできなくなります。

LocalSettings.phpのバージョンによって?>のPHPの閉じタグで終わっていないものがあります。これはこのタグの後に新しい情報が追加されることを防ぐためです。PHPは閉じタグが存在しなくてもきちんと動作します。

すべての変数が何をするのかを理解するためにコンフィギュレーション設定と設定ファイルに含まれるコメントを参照して下さい。もっとも重要で必要とされる機能の変数の手短いリストは以下の通りです。

もしMediaWiki wikiファーム上でwikiを持つ場合、LocalSettings.phpファイルへの書き込み権限(および読み込み権限でさえ)が無いかもしれません(例えば次を参照:[1])。wikiファーム企業はあなたの望みに合わせて変更してくれないことがあります。おそらくはwikiファームのすべてのwiki群上でほとんど同じ設定をすることが望まれています。

Contents

[edit] 標準設定

[edit] インクルードパス

$IP(インクルードパス)変数はwikiのベースインストールへのローカルファイルのパスを保持します。正しいファイルパスであるか確認して下さい。パスの終わりにスラッシュを含みません。

DefaultSettings.phpファイルはIP変数によって指定されたディレクトリから読み込まれます。

[edit] サイト名

$wgSitename変数はwikiのセットアップの名前を保持します。この名前はシステム全体で多く含まれます。例えばWikipediaのタグラインの"'From Wikipedia, the free encyclopedia."'はこの設定を利用しています。

[edit] サイトの言語

$wgLanguageCode変数はwikiのインターフェイスの言語をコントロールします。ユーザはオプション(プリファレンス)に表示される言語に切り替えでき一方で、それらの変数はすべての匿名ユーザと大半の登録ユーザが見るデフォルトの言語を設定します。

[edit] スクリプトパス

$wgScriptPathはMediaWikiの中心的なコードのアクティングピースであるメインのMediaWikiスクリプトにアクセスするためのURLパスの接頭辞です。この設定はThis setting should correspond to the Apache settings、とりわけApacheのrewriteルールを利用している場合、

[edit] サーバ名

wikiがそれが動作しているローカルホスト、イントラネットもしくはインターネットからアクセスされるとき、Eメール通知と他のコンピュータメッセージは通常異なるURLで配信される。wgServerは検知を上書きしサーバ名は定数になる。

www.example.comがインターネットから見られるwikiのサーバアドレスである場合、 次のような行を追加する。

$wgServer = 'http://www.example.com';

マジックワード {{SERVER}}はwikiページに使用される;

$wgServerの値と等しい。

[edit] スクリプト名

$wgScriptはメインのMediaWikiのPHPスクリプトの名前で、デフォルトではindex.phpである。スクリプト名を変更することはおそらくよいアイディアではない。しかしながら、そうしたいのであれば、変更する場所はここである。やっていることを理解していることを確認する。

[edit] リダイレクトスクリプト名

$wgRedirectScript変数はMediaWikiでリダイレクトを取り扱うリダイレクト スクリプトへのURLパスを指定する。この設定は正確なスクリプト名を設定出来るwgScriptと似ている。上記で説明したように、本当に何をしているのか理解していないのであれば、変更することはおそらくよいアイディアではない。

[edit] 記事へのパス

$wgArticlePathはMediaWikiのページにアクセスするときに使用するパスである。 パスはメインスクリプト(通常は$wgScriptを使用する)へのパスを含み記事の名前に$1プレースホルダを使用する。

プリティURLもしくはショートURLを作成するためにApacheのリライトルールを使用する場合、おそらく正しいパスを指し示す$wgArticlePathを調整する必要がある。wgArticlePathはMediaWikiの範囲内からURLを構築ために使用されることに注意。間違いがあった場合、正しいURLを手作業で指定することでメインページにアクセスできるかもしれない一方で内部リンクは不正に表示される。

典型的な値は以下の通り:

"$wgScript/$1" セパレータ"/"による記事名を渡す
"$wgScript?title=$1" パラメータとして記事名を渡す(古いスタイル)
"mypath/$1" カスタムパス。"mypath"をメインスクリプトにアクセスする適切なパスに変換するためにApacheのリライトルールを使用する。

[edit] スタイルシートの位置

設置されているMediaWikiインストールのためにCSSがある場所へのURLを設定するためには$wgStylePath変数を使用する。$wgStyleDirectory変数は同じ場所を指定するが、ファイルシステムにアクセスする内部スクリプトで使用されるためのローカルファイルシステムであることに注意。

[edit] アップロードの位置

アップロードディレクトリはユーザによってアップロードされたファイルが保存される場所である。 $wgUploadPath変数はURLパスを指定し、$wgUploadDirectoryはローカルファイルシステムパスを指定する。

[edit] ロゴ

$wgLogo変数はデフォルトで左上コーナー上に表示されるグラフィカルなロゴを指し示す相対的なURLを指定します。/wiki/skins/common/images/ ディレクトリにあるデフォルトのロゴを置き換えるために 以下のコードをLocalSettings.phpファイルに追加します ("require"文の下):

$wgStylePath   = "/wiki/skins/";  
$wgLogo        = "{$wgStylePath}/common/images/wiki.png";

代わりに、アップロードしたファイルをアップデートすることでロゴを交換できるようにするために$wgStylePath変数をアップロードディレクトリを指定すると良いでしょう。

$wgStylePathは通常YOUR_WIKI_FOLDER/wiki/skinsです。


[edit] コンタクト情報

$wgEmergencyContact変数は何か起きたときにコンタクトするためのユーザのEメールアドレスです。Eメールアドレスは内部バグレポートを送るために使用されます。アドミニストレータとして、あなたのEメールアドレスをここに掲載しておきます。

$wgPasswordSender変数はパスワードを忘れたユーザにパスワードが送信されるときの使用されるEメールアドレスです。トラブルもしくは混乱の場合利用者が送信できるアドレスを選択します。

[edit] データベースの設定

ページ、ユーザ情報や多くのものを保存するためにMediaWikiはデータベース(現在はMySQLPostgreSQLのどちらか)にアクセスする必要があります。

$wgDBserverはデータベースのホスト名を含みます。多くの場合、同じシステム上で動作しているデータベースとしては"localhost"が当てはまりますが、様々なインストールのために、データベースが動作しているコンピュータの十分に確認されたドメイン名を入力する必要があります。

$wgDBnameはMediaWikiによって使用されるデータベース名です。単独のMySQLもしくはPostgreSQLでは一つ以上のデータベースを保存することができ、一つのサーバで多くのMediaWikiを動作させることができます。正しいデータベース名を記載して同じデータベースサーバ上の異なるwikiインストールのために異なるデータベース名を使用することを確認します。

$wgDBuser$wgDBpassword変数はデータベースにアクセスするためにMediaWikiによって使用されるログイン名とパスワードを含む。データベースサーバ上でwikiのテーブルを操作できる適切なアクセス権を指定されたユーザが所有することで確認できます。

セキュリティに関連するデータに関してはLocalSettings.phpのパーミッションが他のユーザがこのファイルを閲覧できないようにすることを念頭に置いて下さい。

[edit] ユーザの権限

$wgGroupPermissionsは連想配列で、異なるユーザグループのためにページを作成と編集するパーミッションをコントロールする。この配列において、カスタムパーミッションレベルが作成され、異なるユーザグループのためにパーミッションレベルが設定されます。異なるパーミッションと利用可能なユーザグループについてはHelp:User rights/jaでより詳細な情報を見ることができます。

[edit] 大文字リンクの強制

デフォルトでは、小文字(ラテン文字)でページ名は始まらず、最初の文字を大文字に変換されます。リンクターゲット、含まれるページ、画像もしくはカテゴリは小文字で始まる名前で指定され、実際のターゲットなどは大文字で始まるページに対応します

代替的にはページ名は大文字、数字に加えて、小文字で始めることができます。そのためには$wgCapitalLinks変数を調整しなければなりません。falseに設定することで小文字を許可し、trueはデフォルトの振る舞いをします。

[edit] サブページの有効化

$wgNamespacesWithSubpages変数を使用することで名前空間ごとのベースでサブページを有効にします。例えばメインの名前空間でサブページを有効にします:

$wgNamespacesWithSubpages[NS_MAIN] = 1;

[edit] 画像のアップロード

MediaWikiシステムにファイルをアップロードすることをユーザに許可するまえに、この機能を有効にしなければなりません。アップロードディレクトリが適切に設定され、Apacheウェブサーバプロセスによって書き込み可能でなければなりません。$wgEnableUploads変数をtrueに設定することでウェブユーザインターフェイスでアップロードすることが可能になります。

次のコードはLocalSettings.phpの設定例でincludes/DefaultSettings.phpから由来しています:

 $wgUploadPath       = "$wgScriptPath/uploads";      ## Wiki 1.5のデフォルトは/imagesであるがimages以外にも可能
 $wgUploadDirectory  = "$IP/uploads";                ## Wiki 1.5のデフォルトは/imagesであるがimages以外にも可能

 ## 画像のアップロードを有効にするために、Apacheユーザもしくはグループによって上記の'$wgUploadPath'が書き込み可能であることを確認する。
 ## ''(すなわち  chmod og+w uploads images)''、それから次の項目をtrueにする:
 $wgEnableUploads       = true;
 
 $wgUseImageResize      = true;
 $wgUseImageMagick      = true;
 $wgImageMagickConvertCommand = "/usr/bin/convert";
 
 ## セーフモードの元で画像のアップロードを使用したい場合、
 ## images/archive、images/thumb、images/tempのディレクトリを作成し書き込み可能にする。
 ## それから次の項目をアンコメントする:
 $wgHashedUploadDirectory = false;

サムネイルをサポートするために素早く画像をリサイズできるにしたい場合、ImageMagickをシステム上にインストールしてテストしてから$wgUseImageResize$wgUseImageMagick変数をtrueに設定します。$wgImageMagickConvertCommand変数が適切なconvertコマンドの位置を指定し、コマンドがウェブサーバプロセスによって実行可能であることを確認します。

また、利用可能な拡張子の修正を行いたい場合、次のように$wgFileExtensions配列を設定します:

$wgFileExtensions = array('png','jpg','jpeg','ogg','doc','xls','ppt','mp3','sxc','pdf','nse');

ImageMagickでトラブルに遭遇した場合、次のエラーメッセージが表示されます:

Fatal error: mime_magic could not be initialized, magic file is not available in includes/MimeMagic.php on line 506

その場合、次の行を追加して見て下さい;

$wgMimeDetectorCommand = "file -bi";

次の記事も参照: Manual:Configuring file uploads/jaManual:Mime type detection/jaManual:Image Administration/ja#画像のサムネイル

[edit] LaTeXインラインの方程式

LaTeX数式を描画するために、LaTeXインストールをシステム上で動作させる必要があります。この機能を有効にするために$wgUseTeX変数をtrueに設定します。$wgMathPath$wgMathDirectory$wgTmpDirectoryが適切に設定されていることを確認します。変更するためによい理由がない限り、デフォルトの値を使う方がよいでしょう。

[edit] インターウィキのサポート

インターウィキサポートはMediaWikiに組み込まれていますが、内部リンクのために使用される接頭辞を設定する必要があります。この接頭辞は通常$wgSitenameと同じですが、変更する場合、$wgLocalInterwiki変数を望む名前に設定します。

[edit] ユーザインターフェイスの言語

MediaWikiは様々なローカライズされたユーザインターフェイスの言語を利用できます。英語ではない言語でwikiを運営する場合、$wgLanguageCodeを適切な言語コードに設定します(例えば、ドイツ語なら"de"、スペイン語なら"es")

languageディレクトリで見つかる言語を利用できます。例えば、MessagesEs.phpがあれば、スペイン語の"es"を使用できます。注意することは"Es"と大文字で始めないで下さい。動作するかもしれませんが、すべてのテキストが翻訳されてないこともあります。

ノート: 言語コードを変更した後でPHPスクリプトを実行する必要があります。コマンドツールを使用するために"maintenance"ディレクトリに移動をして次のコマンドを入力します。

php rebuildMessages.php --rebuild

Windows上において、PHPコマンドのPATH環境変数が設定されていない場合があることに注意して下さい。

[edit] サイトのための著作権の設定

  • $wgRightsPageはwiki上のページで該当する著作権を表示します。通常はProject:Copyrightsです。
  • $wgRightsTextは"Content is available under"に続くフッターに含まれるテキストです。$wgRightsPageに指定されたページにリンクします。
  • $wgRightsIconはフッタの左に設置される画像のURLです。
  • $wgRightsUrlはライセンスの全内容を記述したページです。(例えばGNU FDLであるならば、http://www.gnu.org/licenses/fdl.htmlになる)
    ノート: $wgRightsPageが空ではない場合、著作権/ライセンス内のリンクはサイト上のそのページにリンクする。$wgRightsPageが空の場合は代わりに$wgRightsUrlにリンクします
  • $wgEnableDublinCoreRdf$wgEnableCreativeCommonsRdfRDFメタデータをwikiページに追加します。RDFメタデータについて詳細な内容はRDF metadataを参照して下さい。

サイトの著作権宣言を修正するために次の行をLocalSettings.phpに追加します:

$wgRightsPage = "YourWiki:Copyright"; 
$wgRightsText = "copyright YourWiki";

後で適切なメッセージを表示するためにMediaWiki:Copyrightを編集します。"$1"を使用して著作権ページへのリンクの位置を示します。

例: クリエイティブ・コモンズライセンスを設定します

クリエイティブコモンズライセンスを設定するために以下のように行います:

 <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/2.5/">
 <img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png" />
 </a>
 This work is licensed under a
 <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/2.5/">
 Creative Commons Attribution-NonCommercial-ShareAlike 2.5 License</a>.
  • $wgRightsURLのために、最初のアンカーからhref情報を入力します:
$wgRightsUrl = "http://creativecommons.org/licenses/by-nc-sa/2.5/";
  • $wgRightsTextのために2番目のアンカーからテキストを入力する(文法的に正しいバージョンであるために"a"をWiki変数に追加します)
$wgRightsText = "a Creative Commons Attribution-NonCommercial-ShareAlike 2.5 License";
  • $wgRightsIconのために最初のアンカーのimgリンクからソースの情報を入力します。Crative Commonsサイトからあなたのサイトにバッジをコピーしたい場合は以下のコードを追加します。
$wgRightsIcon = "http://creativecommons.org/images/public/somerights20.png";
  • 著作権についてのRDFメタデータを使用するためには、LocalSettings.phpに次の行を追加します。
$wgEnableCreativeCommonsRdf = true;
$wgEnableDublinCoreRdf = true;

[edit] カスタムの名前空間

$wgExtraNamespaces配列を宣言して、 $wgNamespacesWithSubpages、と$wgNamespacesToBeSearchedDefault配列を修正することで、追加の名前空間をMediaWikiインストレーションに追加できます。Take heed 既存の名前空間not to have any pages already titled in that namespace, 例えば、"Technical:Support"というページがあり and you created the Technical: 名前空間を作成するとそのページは失われませんが、Special:Allpagesから除去できません。これを修正するためには、名前空間を削除して"Technical:Support"をメインの名前空間の"Support"に移動させ、リダイレクトを削除して、名前空間を再挿入して、先ほどのページを"Technical:Support"に戻します。 詳細な情報に関してはUsing custom namespaces/jaをご覧下さい。

[edit] スキン

サイトのデフォルトスキンは$wgDefaultSkin変数経由で修正できます。