PolyMoNote
Wiki Like SYSTEM 「PolyMoNote」の公式サイト
ガイド/ドキュメント
| 目次 |
|---|
ログインとログアウト
ログインメニューを表示
ログインするには、まずログインメニューを表示させるために以下のURLにアクセスします。
http://example.com/index.php?menu=on
"http://example.com/"の部分は、それぞれのサイトのURLに置き換えてください。
前述のURLにアクセスすると"ログイン"と書かれたリンク文字が表示(デフォルトではページ下部)されるので、そこからログインページへ進んでください。(LOGINコマンドを実行)
"ログイン"リンクの隣にある"閉じる"リンクをクリック、または以下のように"menu"パラメーターに"off"の値を渡すことで、ログインメニューが非表示になります。
http://example.com/index.php?menu=off
ログインページからログインする
"ログイン"リンクからログインページに進み、"ユーザー"の項目に"polymonote.config.php"で設定したユーザー名、"パスワード"の項目に"polymonote.config.php"で設定したログインパスワードを入力して"ログイン"ボタンをクリックします。
ログアウトする
ログイン中は、"ログアウト"のリンク文字が表示(デフォルトではページの下部)されます。
ログアウトしたい場合は、そちらをクリックしてください。
ブックを追加する
PolyMoNoteは、ひとつのツールで複数のコンテンツを作成することができます。
簡単に言うと、PolyMoNoteひとつをインストールするだけで複数のサイトを管理・作成することができるのです。
ブックについての詳しい説明は、"仕様"の該当項目をご覧ください。
新たにブックを追加したい場合は、"pn"ディレクトリ内の"data"・"attach"・"cache"ディレクトリ内に追加したいブックの名前のディレクトリを作成します。
その追加されたディレクトリの名前が、ブックの名前("ブックID")となります。
ブックのディレクトリの名前に使える文字列は"半角のアルファベットと数字"のみです。
作成したディレクトリのパーミッションは、書き込み権限を与える設定"777"(または"707")にしてください。
パーミッションの設定については、インストールガイドもご覧ください。
ちなみに、PolyMoNote公式サイト内の文法マニュアルとDeveloperも、追加したブックによって作成されています。
つまり、ひとつのツールで独立した複数のサイトを構築できるということです。
バックアップ
データのバックアップは、"pn/data"ディレクトリと"pn/attach"ディレクトリ内にある各ファイル・ディレクトリをFTPクライアントなどを利用してダウンロードしてください。
バックアップしたファイルやディレクトリをアップロードする時は、それぞれの対応するディレクトリにFTPクライアントなどを利用してアップロードしてください。
バックアップしたものをサーバにアップする時に、"PN_SAFEMODE"がオフの場合だとページ単位でファイルがディレクトリで仕切られているため、アップロードしたあとのパーミッションの設定を手動で行うのは手間なので、こちらのPERMISSIONコマンドを使ってパーミッションを設定するとよいでしょう。
"PN_SAFEMODE"がオンの場合は、アップロードしたファイルのパーミッションはFTPクライアントなどで手動で設定します。
ページのキャッシュ
"PAGE_CACHE"の設定を有効にすることで、ページ表示のキャッシュを利用できるようになります。
通常は、ページが表示されるたびにPolyMoNote記法で書かれた内容をHTMLに変換して表示しますが、設定を有効にすることで、変換された内容をファイルに記録(キャッシュ)し、ページを表示する時に、そのキャッシュを利用することで表示の処理にかかる負担を軽減し高速化してくれます。
ページのキャッシュは、そのページごとに作成されます。
キャッシュはページが表示された時に作成され、サイト内のどれかのページが編集されると、そのキャッシュは無効となり、改めてページが表示された時にキャッシュが作成されます。
たとえば、ページ名"AAA"が編集されると、"AAA"以外のキャッシュも無効となります。
ページ名"BBB"が未編集であったとしても"BBB"の以前のキャッシュも無効となり、"BBB"が表示された時に改めて新しいキャッシュが作成されます。
これは、どれかのページが編集されたタイミングでないと、CHANGESプラグインやPAGESプラグインのように、他のページが編集されたり新たにページが作成されることで表示される内容が変わるプラグインの表示が反映されないためです。
なお、コマンドでページ内容を表示するものについては、こちらのキャッシュの設定は反映されません。
ログインメニューが表示されている状態およびログイン中は、キャッシュを利用する設定になっていても、キャッシュは利用されず、常に動的にページを生成します。
注意点
キャッシュの更新はサイトが編集されたかどうかで判断するため、環境設定やプラグイン設定の変更、DIARYCATEGORYプラグインへの日記のカテゴリ登録などは、そのままではキャッシュが以前のままとなり変更が反映されません。
前述の設定を変更した場合は、どのページでもよいので、内容を変更しなくてもかまわないので編集ページから保存を行うようにしてください。
そうすることでサイトの内容が更新されたことになるため、新たにキャッシュが作成されて設定の変更も反映されます。
また、ページのキャッシュを利用することで、一部うまく動かないプラグインがあります。
ページのキャッシュを有効にすることで正しく機能しないプラグイン
大きな不具合やセキュリティ上の問題があるわけではありませんが、以下のようなことがあるのでご注意ください。
| プラグイン名 | 確認されている不具合 |
|---|---|
| FILESプラグイン |
添付ファイルのダウンロード数が反映されず、ダウンロードされても数字がかわらない。 添付ファイルが追加・削除されても、その内容が反映されない。(ログイン中の編集ページは除く) |
その他に、一部のプラグインやタグで複数行プラグインによる記述をすると、正しく機能しないものがあります。
高度な設定
インストールガイドで説明されているユーザー設定とは別に、さらに以下の内容についてユーザー側で設定を変更できます。
"index.php"
"pn"ディレクトリ名の変更
PolyMoNoteの各ファイル・ディレクトリが収められている"pn"ディレクトリの名前を変更することができます。
インストールしたい場所に、すでに"pn"ディレクトリが存在するなどの理由で、違うディレクトリ名にしたい場合は、こちらの値を変更します。
PolyMoNoteの実行ファイルである"index.php"の以下の箇所がディレクトリ名の定義をしている部分です。
// PolyMoNoteシステム変数設定 $PN_DIR = "pn";// PolyMoNoteインストールディレクトリ名
"pn"の部分を任意の名前に変更して、FTPクライアントなどを使って対応したディレクトリの名前を変更してください。
"polymonote.config.php"
PolyMoNoteの各ディレクトリの変更
"data"・"attach"・"templates"・"cache"の各ディレクトリの名前を変更することができます。
"pn/lib"の"polymonote.config.php"の以下の箇所が、ディレクトリ名を定義している部分です。
// ディレクトリ設定 $DATA_DIR = "data"; // データ保存ディレクトリ $ATTACH_DIR = "attach"; // 添付ファイル保存ディレクトリ $TEMPLATE_DIR = "templates"; // テンプレート保存ディレクトリ $CACHE_DIR = "cache"; // キャッシュ保存ディレクトリ
"data"・"attach"・"templates"・"cache"の各部分を任意の名前に変更して、FTPクライアントなどを使ってそれぞれに対応したディレクトリの名前を変更してください。
"polymonote.ini.php"
"polymonote.ini.php"の内容は、下記の項目以外は不具合が起きる可能性があるため変更しないようにしてください。
また、セッションや拡張子など説明文の内容がわからない場合は、変更されないようにお願いします。
脚注文の見出しレベル
define("FOOTNOTE_HEADER", 2, true); // 脚注の見出しレベル
記法"脚注"で設定された説明文(テンプレートタグ"FOOTNOTE"が置き換わる内容)の見出しレベルを、上記の"2"の部分を編集して設定します。
設定できる値は以下のとおりです。
0 // "strong"タグ 1 // "h2"タグ 2 // "h3"タグ 3 // "h4"タグ
アップロードできるファイルの種類を追加
アップロードできるファイルの種類は、"pn/lib"ディレクトリ内にある"polymonote.ini.php"の以下の箇所で定義しています。
// アップロードを許可するファイルの拡張子のリスト
$UpFileExtentions = array("jpg", "jpe", "jpeg", "gif", "png", "lzh", "zip", "txt");
そして、添付ファイルとしてアップできるファイルは、標準の設定では以下のものとなります。
-
テキストファイル
- TEXT (拡張子 ".txt")
-
画像ファイル
- JPEG (拡張子 ".jpg"・".jpe"・ ".jpeg")
- GIF (拡張子 ".gif")
- PNG (拡張子 ".png")
-
圧縮ファイル
- LZH (拡張子 ".lzh")
- ZIP (拡張子 ".zip")
さらにアップロードできるファイルを追加したい場合は、前に説明した"polymonote.ini.php"の箇所に追加したいファイルの拡張子を追記します。
たとえば、"bmp"の拡張子を追加したい場合は以下のように書きます。
// アップロードを許可するファイルの拡張子のリスト
$UpFileExtentions = array("bmp", "jpg", "jpe", "jpeg", "gif", "png", "lzh", "zip", "txt");
'"'(ダブルクォーテーション)または"'"(シングルクォーテーション)で拡張子を囲んでください。
拡張子の区切りは","(カンマ)で行います。
"array"はPHPの配列を生成する命令です、詳しく知りたい方はPHPのマニュアルの該当箇所もご覧ください。
入室確認認証の対象から除外するユーザーエージェント
$UA_CheckAgeVerification = array( "Googlebot", "bingbot", "msnbot", "Y!J-(.+)crawler", "Yahoo! Slurp", );
サイトの入室確認認証の機能が有効で、特定のユーザーエージェントを除外する設定になっている場合に、その除外するユーザーエージェントを設定することができます。
追加または削除したいユーザーエージェントがある場合は、こちらを編集してください。
デフォルトでは、主要な検索エンジンのクローラーが設定されていますが、それらのクローラー以外を設定してもかまいません。
ユーザーエージェントの文字列は正規表現で記述します。
また、'"'(ダブルクォーテーション)または"'"(シングルクォーテーション)で囲んでください。
文字列の区切りは","(カンマ)で行います。
"array"はPHPの配列を生成する命令です、詳しく知りたい方はPHPのマニュアルの該当箇所もご覧ください。
セッションIDの再発行
PolyMoNoteは、ログイン時にセッション(SESSION)を利用してログイン状態のチェック用にいくつかのデータを生成・保存します。
そして、セキュリティを保持するために、定義された時間ごとにセッションに関する前述の作業(セッションIDの再発行)を行います。
セッションIDの再発行までの時間は、"pn/lib"ディレクトリ内にある"polymonote.ini.php"の以下の箇所で定義しています。
$SESSION_CHECK_TIME = 1*1*60*60;// ログイン後のセッションID再発行までの期間
単位は"秒"、デフォルトの設定は1時間です。
再発行の間隔を変更したい場合は、"1*1*60*60"の箇所を任意の数字に変更してください。
ログインチェック用のランダムワード
PolyMoNoteは、ログインが成功した時にログイン状態をチェックするためのランダムなキーワードを生成します。
そして、チェック用のキーワードの文字数は、"pn/lib"ディレクトリ内にある"polymonote.ini.php"の以下の箇所で定義しています。
define("RANDAMWORD_COUNT", 50, true);// ログインチェックに使うランダムワードの文字数
文字数を変更したい場合は、"50"の箇所を任意の数字に変更してください。