NP_CustomURL/trunk/customurl/japanese-utf8_help.html

   1 <h3>プラグインの概要</h3>
   2
   3 <div>
   4
   5 NucleusCMSで作成したwebサイトのアイテム・カテゴリに好きな名前をつけて、静的URLとしてリンクを生成します。<br />
   6 <em style="color:#cc0000;">FancyURLモードでのみの動作、及びmod_Rewrite必須です</em><br />
   7 カテゴリ、サブカテゴリ、アーカイブリスト等を、それぞれディレクトリとみなし、カテゴリで絞り込んだ時は当該カテゴリのディレクトリにあるindexファイルを参照するイメージになります<br />
   8 <ul style="margin:0 0 25px 12px;"><li>ex.</li>
   9 <li>カテゴリへのアクセスのイメージ:
  10 <ul><li>http://example.jp/nucleuscms/</li></ul></li>
  11 <li>サブカテゴリへのアクセスのイメージ:
  12 <ul><li>http://example.jp/nucleuscms/plugins/</li></ul></li>
  13 <li>アーカイブへのアクセスのイメージ:
  14 <ul><li>http://example.jp/archives/</li><li>http://example.jp/archives/nucleuscms/</li></ul></li>
  15 </ul>
  16 メンバーの詳細ページと個別アイテムページは、当該htmlファイルにアクセスするイメージになります<br />
  17 <ul style="margin:0 0 25px 12px;"><li>ex.</li>
  18 <li>http://example.jp/nucleuscms/plugins/NP_CustomURL.html</li>
  19 <li>http://example.jp/new_nucleus_comming_soon.html</li>
  20 <li>http://example.jp/member/Hiroyuki.html</li>
  21 </ul>
  22
  23 </div>
  24
  25 <h3>インストール・動作開始手順</h3>
  26
  27 <div>
  28
  29 <ol style="margin:0 0 25px 12px;">
  30 <li>ダウンロードしたファイルを解凍して出来た「NP_CustomURL.php」ファイルと「customurl」ディレクトリをサーバの plugins ディレクトリにアップロード後、「プラグインの管理」ページで「CustomURL」を選択して「プラグインのインストール」ボタンをクリックします<br />
  31 (この文章を読んでいるということは、ここまでは出来ていると思います)</li>
  32 <li>まず始めに、管理画面の「グローバル設定」ページで「URL モード」を「Fancy」に変更します</li>
  33 <li>通常の「extra」ディレクトリの「fancyurls.config.php」を、FancyURLsの手順通りトップディレクトリへコピーして編集します<br />このときコピーするのは「fancyurls.config.php」ファイルだけで、後のファイルはコピーする必要がありません</li>
  34 <li>次に「index.php」を編集しますの <code>$CONF['Self']</code> の行を <code>$CONF['Self'] = '.'</code> に書き換え、 <code>$curl_blogid = 1;</code>("1"は「index.php」でアクセスするブログのID) と一行書き加えます
  35 <blockquote><pre style="overflow:auto;">&lt;?php
  36 // This file will generate and return the main page of the site
  37 $CONF = array();
  38 $CONF['Self'] = '.';
  39 $curl_blogid = 1;
  40
  41 include('./config.php');
  42 include('./fancyurls.config.php');
  43
  44 selector();
  45
  46 ?&gt;
  47 </pre></blockquote>
  48 </li>
  49 <li>次に<code>.htaccess</code>を編集します<ul>
  50     <li>内容はこちら<blockquote><pre style="overflow:auto;">RewriteEngine on
  51 RewriteCond %{REQUEST_FILENAME} !-f
  52 RewriteCond %{REQUEST_FILENAME} !-d
  53 RewriteRule ^(.*)$ index.php?curl=$1 [L,QSA]
  54 </pre></blockquote>
  55 この4行だけで、後は何も書かなくても大丈夫です</li></ul></li>
  56 </ol>
  57 これで準備完了です<br />
  58 <br />
  59 注1：現在 FancyURLs で運用されている方は、Fancy 用のファイルを削除するか別ディレクトリへ退避してください。すべてこのプラグインで受けているので必要ありません<br />
  60 また、下記プラグイン用のFancyファイルは組み込み済みですので不要です
  61 <ul>
  62 <li>各ページスイッチ用「page」ファイル</li>
  63 <li>タグ用「tag」ファイル(「NP_TagEX」「NP_MultiTags」両方対応。「NP_MultiTags」の「タグクエリー 」の変更にも対応しています)</li>
  64 <li>「NP_Trackback」のトラックバック受信専用「trackback」ファイル</li>
  65 </ul>
  66 </div>
  67
  68 <h3>使い方</h3>
  69
  70 <div>
  71
  72 <ul>
  73 <li style="margin-top:3px;">ブログ・アイテム・カテゴリ・メンバーの編集ページにそれぞれオプションが追加してありますので、好きな名前をつけてください</li>
  74 <li style="margin-top:3px;">メンバーの新規追加、及び「ブログの設定の編集」ページからのカテゴリの新規追加の時にはこれらの編集画面が出ませんので、追加したあとにそれぞれ編集してください</li>
  75 <li style="margin-top:3px;">新規追加時のデフォルトの名前は、ブログは[ショートネーム]カテゴリーは[category_(catid)]、アイテムは[item.html]、メンバーは[ログインネーム.html]がそれぞれ設定されます<br />
  76         なお、プラグインのインストール時にブログに存在した全てのブログ・アイテム・カテゴリ・メンバーには自動でパスを生成済みです</li>
  77 <li style="margin-top:3px;">同一ブログ内、同一キーでの名前は重複できませんので気をつけてください<br />
  78         登録しようとしたパスが重複していた場合は、末尾にそれぞれのIDが'_id'の形で追加されます<br />
  79         同一ブログであっても、カテゴリーとサブカテゴリー、アイテムは同じ名前をつけることが出来ます<br />
  80         つまり、http://example.jp/nucleuscms/nucleuscms/nucleuscms.htmlは有効なパスとなります</li>
  81 <li style="margin-top:3px;">メンバー、及びアイテムのパスには、末尾に自動的に[.html]が付加されるので、編集時に[.html]をつけないように気をつけてください<br />
  82         うっかり付けてしまうと、[item_html.html]というような、なんだかよく解らないファイル名が出来上がってしまいます</li>
  83 <li style="margin-top:3px;">メンバーディレクトリ、アーカイブディレクトリ、アーカイブリストディレクトリはプラグインの編集画面で変更できます。初期値はそれぞれの<code>$CONF['***Key']</code>の値になっています</li>
  84 <li style="margin-top:3px;">ディレクトリ名、及びファイル名として使用できる文字は半角英数字(a-z,A-Z,0-9)と半角ハイフン(-)と半角アンダーバー(_)のみです<br />
  85         なお、指定された文字列の中に含まれている '/'(スラッシュ)や'.'(ピリオド)は、自動的に '_'(半角アンダーバー)に変換されますが、それ以外のときはエラーを返します<br />
  86         URL生成のときはアルファベットの大文字小文字の区別はしますが、アクセスのときはURLの使用上区別できません<br />
  87         通常のHTMLリンク同様、 http://example.jp/NucleusCMS/ と表示してあるリンクに対し、ブラウザのアドレス欄に http://example.jp/nucleuscms/ でアクセス可能です</li>
  88 <li style="margin-top:3px;">サブカテゴリ用のディレクトリ名は、現在管理画面でのみ編集可能です<br />
  89         新しく追加されたサブカテゴリについてはリンク生成のタイミングでデータベースを更新しているので、実用上問題ないと思います<br />
  90         デフォルトのサブカテゴリ用ディレクトリ名は[subcatid_(subid)]です</li>
  91 <li style="margin-top:3px;">管理画面、編集画面でディレクトリ名を空白にした場合は、データベースからその名前が削除され、URLは従来のFancyURLsのものになります<br />
  92         (但しサブカテゴリーについては、追加・削除のタイミングがプラグイン側で判断できないため、「空白文字列 = デフォルト名」になります)</li>
  93 <li style="margin-top:3px;">ブログアクセス用パスとカテゴリーアクセス用パスには同じ名前をつけることが出来ません<br />
  94         これは <code>hostname</code> の次に来るパス名がカテゴリのものであるのかブログのものであるのかを見分ける有効な手段が見つからないための制限です</li>
  95 <li style="margin-top:3px;">トップディレクトリ直下に実在するディレクトリ名やファイル名をパスとして登録することは出来ますが、httpサーバは実在するものの方を返すので、このパスは事実上無効となります</li>
  96 <li style="margin-top:3px;">このプラグインのインストール後でも、従来のクエリ式のURL(ex. http://example.jp/index.php?catid=123)やFancyURLs式のURL(ex. http://example.jp/category/12/item/34)でのアクセスは可能です</li>
  97 <li style="margin-top:3px;">各ブログ毎にオプションで URI を変更する・しないを選択することが出来ます。このオプションを「使用しない」にした場合は、通常のFancyURLs(ex. http://example.jp/category/12/item/34)になります<br />
  98         また「使用しない」にした場合でも、生成される URI が FancyURLs になるだけで、カスタマイズされた URI でリクエストがあった場合のリンクは成立しますので、このプラグインの使用をやめる場合などは外部からのリンクの書き換えが全て終わるまで、このオプションで「使用しない」を選択した状態での運用によってスムーズに移行できると思います</li>
  99 <li style="margin-top:3px;">デフォルトで生成されるURIの接頭語はオプション画面で変更できます</li>
 100 <li style="margin-top:3px;">アイテムの接頭語のみ、&lt;%year%&gt;、&lt;%month%&gt;、&lt;%day%&gt;の各変数が使用できます<br />この値を&lt;%month%&gt;-&lt;%day%&gt;とした場合、アイテムの投稿時に自動で作成されるURIは「08-21_(id)」のようになります</li>
 101 </ul>
 102
 103 </div>
 104
 105 <h3>スキン・テンプレート変数</h3>
 106
 107 <div>
 108 スキン・テンプレート、及び記事中に記入することが出来ます<br />
 109 記入方法：<code>&lt;%CustomURL(リンク先, リンク文字列, リンクタイトル)%&gt;</code><br />
 110 <ul>
 111 <li>リンク先：リンク先の種類/id または名前/指定種別
 112         <ul>
 113                 <li>第一パラグラフ：i、c、s、b、m のいずれか。それぞれ、item、category、subcategory、blog、member の頭文字</li>
 114                 <li>第二パラグラフ：リンク先の id、もしくは名前。名前はパス名ではなく、「カテゴリー名」「ブログの短縮名」等になります。リンク先にアイテムを選択した場合は、ここに指定できるのは id のみになります</li>
 115                 <li>第三パラグラフ：第二パラグラフに id を指定した場合は 'i' 、名前を指定した場合は 'n' と記入してください</li>
 116         </ul>
 117 </li>
 118 <li>リンク文字列：a タグに挟まれる文字列。省略された場合は url のみが生成されます</li>
 119 <li>リンクタイトル：a タグの「title」属性に設定されます。省略された場合は、リンク文字列が存在すれば変わりに設定されます。リンク文字列を指定せずにタイトルのみを指定してもリンクタグは生成されません</li>
 120 <li>全てのパラメータを省略して&lt;%CustomURL%&gt;と書くことも出来ます。この場合は記入場所によってデフォルトの URI が書き出されます
 121         <ul>
 122                 <li>スキン　　　：選択中の「ブログ」のトップページへの URI が書き出されますす</li>
 123                 <li>テンプレート：書き出されるアイテムへの URI が書き出されます(&lt;%itemlink%&gt;の置き換え)</li>
 124                 <li>記事中　　　：自分自身への URI が書き出されます</li>
 125         </ul>
 126 </li>
 127 </ul>
 128 記入例：
 129 <ul>
 130         <li>id が123のアイテムにリンクする場合：&lt;a href="&lt;%CustomURL(i/123/i)%&gt;"&gt;'ここは自由に書き込んでください'&lt;/a&gt;<br />
 131         書き出される文字列：&lt;a href="http://blog.example.jp/item_123.html"&gt;'ここは自由に書き込んでください'&lt;/a&gt;</li>
 132         <li>カテゴリー名が「日記」のカテゴリーの URI を書き出す場合：&lt;%CustomURL(c/日記/n)%&gt;<br />
 133         書き出される文字列(「日記」カテゴリーのidが12の場合)：http://blog.example.jp/category_12/</li>
 134         <li>ブログの短縮名「bibouroku」へのリンクを「このブログ」という文字列からのリンクに設定する場合：&lt;%CustomURL(c/bibouroku/n, このブログ)%&gt;<br />
 135         書き出される文字列：&lt;a href="http://blog.example.jp/"&gt;このブログ&lt;/a&gt;</li>
 136 </ul>
 137 スキン・テンプレート・記事共に、&lt;%CustomURL(123)%&gt;のように id のみを記入した場合は、その id を持つアイテムへの URI が書き出されます<br />
 138 またアイテムの場合のみ、&lt;%CustomURL(123/path)%&gt;と書くことで、item_123 のようにその id を持つアイテムに設定したパスを書き出すことが出来ます<br />
 139 </div>
 140
 141 <h3>動作報告・バグレポート</h3>
 142
 143 <p>動作報告・バグレポートは、以下のURLにコメント・トラックバックをお願いします<br />
 144 <a href="http://shizuki.kinezumi.net/NucleusCMS/Plugins/NP_CustomURL/NP_CustomURL.html">
 145 http://shizuki.kinezumi.net/NucleusCMS/Plugins/NP_CustomURL/NP_CustomURL.html</a></p>
 146
 147 <h3>バージョン履歴</h3>
 148
 149 <ul>
 150 <li>Version 0.2.3: 不具合修正・機能追加
 151         <ul>
 152         <li>リダイレクト周りにバグがあったので修正</li>
 153         <li>「カスタマイズされたURLを使用する」を「はい」にしている時、旧来のFancuURLでアクセスしてきたクライアントに301を返してリダイレクトするように変更</li>
 154         </ul>
 155 </li>
 156 <li>Version 0.2.2a: 不具合修正
 157         <ul>
 158         <li>SQLインジェクションを引き起こす可能性がある脆弱性に対処</li>
 159         </ul>
 160 </li>
 161 <li>Version 0.2.2: 不具合修正・機能追加
 162         <ul>
 163         <li>バグフィックス</li>
 164         <li>アイテム・カテゴリー・サブカテゴリーの新規作成時のデフォルトの接頭語のオプションでの変更に対応<br />
 165         アイテムの接頭語のみテンプレート化</li>
 166         </ul>
 167 </li>
 168 <li>Version 0.2.1a: 不具合修正
 169         <ul>
 170         <li>バグフィックス</li>
 171         </ul>
 172 </li>
 173 <li>Version 0.2.1: 機能追加
 174         <ul>
 175         <li>サブカテゴリの多段URL化</li>
 176         <li>カテゴリ・ブログの削除時にサブカテゴリのデータが消去できていなかった不具合を修正</li>
 177         <li>その他修正</li>
 178         </ul>
 179 </li>
 180 <li>Version 0.1.9: 機能追加
 181         <ul>
 182         <li>カテゴリ及びアイテムのブログ間移動に対応</li>
 183         </ul>
 184 </li>
 185 <li>Version 0.1.8a: 不具合修正・機能追加
 186         <ul>
 187         <li>新規サブカテゴリのパス登録のタイミング変更に伴う修正</li>
 188         <li>ブログ毎にカスタマイズした URI を使用する・しないを選択できるようにオプションを追加</li>
 189         <li>ヘルプファイルの修正</li>
 190         </ul>
 191 </li>
 192 <li>Version 0.1.8: 不具合修正
 193         <ul>
 194         <li>新規ブログ作成時に自動で作成される'General'カテゴリーに対するURIが正常に動作しなかった不具合に対応</li>
 195         <li>ブログを削除した時に、削除したブログに属する「カテゴリー」「サブカテゴリー」「アイテム」のURIがテーブルに残ったままになっていた不具合に対応</li>
 196         <li>新規サブカテゴリーのパスの登録のタイミングをリンクが生成される時に変更(リンク生成前に管理画面でURIを設定していた場合は設定したURIが使用されます)</li>
 197         <li>管理ページでアイテムURIがおかしくなっていたのを修正</li>
 198         </ul>
 199 </li>
 200 <li>Version 0.1.7: 不具合修正
 201         <ul>
 202         <li>ほぼ全面的に書き直し</li>
 203         <li>新規アイテム追加時にトラックバックを送信した時に、トラックバック元のURLが正しく送信できなかった</li>
 204         <li>管理画面からサブカテゴリのパスを編集したときに、リストが表示されなかった</li>
 205         </ul>
 206 </li>
 207 <li>Version 0.1.5: 公開バージョン</li>
 208 <li>Version 0.01: 初期バージョン(NP_Pathの改造バージョン)</li>
 209 </ul>
 210
 211 <h3>謝辞</h3>
 212 <p>
 213 本プラグインの英語版ランゲージファイル、及びヘルプファイル作成に当たりまして、多大なるご協力をいただきましたTucker氏に心より感謝申し上げます
 214 </p>
 215
 216 <h3>プラグイン改造情報</h3>
 217
 218 <div>
 219
 220 「NP_TagEX」と「NP_ContentsList」で 「http://example.jp/nucleuscms/plugins/tag/NP_CustomURL」 形式のリンクを表示させる方法<br />
 221 <br />
 222 「NP_TagEX」の場合<br />
 223 ・一番最後のファンクション<code>creatTagLink()</code>の最後の<code>return addLinkParams($link, $linkparams);</code>の直前に、次のコードを挿入します<br />
 224 <blockquote><pre style="overflow:auto;">global $manager;
 225 if ($manager-&gt;pluginInstalled('NP_CustomURL')) {
 226     $customurls = $manager-&gt;getPlugin('NP_CustomURL');
 227     $link = 'tag/' . $ready.$sep.$this-&gt;_rawencode($tag);
 228     return $CONF['BlogURL'] . '/' . $customurls-&gt;_addLinkParams($link, $linkparams) . '/';
 229 }
 230 </pre></blockquote>
 231 これでタグがURLの一番最後になります<br />
 232 <br />
 233 「NP_ContentsList」の場合<br />
 234 ・<code>doSkinVar()</code>の467行目付近、<code>$catdata['catlink']</code>の生成が終了したところでサブカテゴリのリンクを生成する直前、
 235 <blockquote><pre style="overflow:auto;">// sub category ---
 236 if ($subcat &amp;&amp; (!$subcurrent || $catid == $catdata['catid']) &amp;&amp; !$subnoOpen) {
 237 </pre></blockquote>
 238 の前の行に
 239 <blockquote><pre style="overflow:auto;">if ($CONF['URLMode'] == 'pathinfo' &amp;&amp; $manager-&gt;pluginInstalled('NP_CustomURL')) {
 240     $catdata['catlink'] = createCategoryLink($catdata['catid']);
 241 }
 242 </pre></blockquote>の一行を追加して、カテゴリのリンクを上書きします<br />
 243 さらにそこからもう少し下の
 244 <blockquote><pre style="overflow:auto;">$subdata['sublink'] = addLinkParams($catdata['catlink'], array($subrequest =&gt; $subdata['subcatid']));
 245 </pre></blockquote>
 246 となっている行の下に
 247 <blockquote><pre style="overflow:auto;">global $manager;
 248 if ($CONF['URLMode'] == 'pathinfo' &amp;&amp; $manager-&gt;pluginInstalled('NP_CustomURL')) {
 249     $customurls = $manager-&gt;getPlugin('NP_CustomURL');
 250     $subdata['sublink'] = $customurls-&gt;_addLinkParams($catdata['catlink'], array($subrequest =&gt; $subdata['subcatid']));
 251 }
 252 </pre></blockquote>
 253 と追加、350行目付近の<code>$data['self'] = $data['blogurl'];</code>の前に
 254 <blockquote><pre style="overflow:auto;">if ($CONF['URLMode'] == 'pathinfo' &amp;&amp; $manager-&gt;pluginInstalled('NP_CustomURL')) {
 255     $data['blogurl'] = createBlogidLink($data['blogid']);
 256 }
 257 </pre></blockquote>
 258 を追加して終了です
 259
 260 </div>