trunk/NP_CustomURL/customurl/default_help.html

   1 <h3>Outline of plug-in</h3>
   2
   3 <div>
   4
   5 It is a plug-in that replaces dynamic URL generated with NucleusCMS with static URL of a free name.<br />
   6 <em style="color:#cc0000;">Operation only in FancyURL mode and required 'mod-rewrite'.</em><br />
   7 Categories, the Sub-Categories, Archive list, etc. are considered to be a directory respectively.When narrowing it by the category, it becomes an image that refers to the index file that exists in the directory of a category concerned.<br />
   8 <ul style="margin:0 0 25px 12px;"><li>ex.</li>
   9 <li>Image of access to Categories:
  10 <ul><li>http://example.jp/nucleuscms/</li></ul></li>
  11 <li>Image of access to Sub-Categories:
  12 <ul><li>http://example.jp/nucleuscms/plugins/</li></ul></li>
  13 <li>Image of access to Archives:
  14 <ul><li>http://example.jp/archives/</li><li>http://example.jp/archives/nucleuscms/</li></ul></li>
  15 </ul>
  16 Member's detailed page and individual item page become images accessed a file concerned html file.<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>Installation and operation beginning procedure</h3>
  26
  27 <div>
  28
  29 <ol style="margin:0 0 25px 12px;">
  30 <li>After up-loading the "NP_CustomURL.php" file and the "customurl" directory that can be done by developing the downloaded compression file to the "plugins" directory of the server.It installs it from the management area.</li>
  31 <li>First of all, "URL mode" is changed to "Fancy" on "Global setting" page of the management screen.</li>
  32 <li>"fancyurls.config.php" is copied to a top directory according to the procedure of FancyURLs and it edits it.<br />At this time, copying it should not copy the following file with "fancyurls.config.php" file alone.</li>
  33 <li>Next, "index.php" is edited."<code>$CONF['Self']</code>" and the line that is are rewritten as "<code>$CONF['Self'] = '.'</code>" and One line is written "<code>$curl_blogid = 1;</code>" and it adds. ("1" is ID of Brog accessed by "index.php".)
  34 <blockquote><pre style="overflow:auto;">&lt;?php
  35 // This file will generate and return the main page of the site
  36 $CONF = array();
  37 $CONF['Self'] = '.';
  38 $curl_blogid = 1;
  39
  40 include('./config.php');
  41 include('./fancyurls.config.php');
  42
  43 selector();
  44
  45 ?&gt;
  46 </pre></blockquote>
  47 </li>
  48 <li>Next, <code>.htaccess</code> is edited.<ul>
  49     <li>The content is here.<blockquote><pre style="overflow:auto;">RewriteEngine on
  50 RewriteCond %{REQUEST_FILENAME} !-f
  51 RewriteCond %{REQUEST_FILENAME} !-d
  52 RewriteRule ^(.*)$ index.php?curl=$1 [L,QSA]
  53 </pre></blockquote>
  54 Even if nothing is written now by these four lines alone, it is safe.</li></ul></li>
  55 </ol>
  56 It is preparation completion by this.<br />
  57 <br />
  58 Note:Please delete or save operation in another directory the file for FancyURLs with FancyURLs now.It is not necessary because everything has been received by this plug-in.<br />
  59 </div>
  60
  61 <h3>How to use.</h3>
  62
  63 <div>
  64
  65 <ul>
  66 <li style="margin-top:3px;">The option is additional to Brog item category member's edit page respectively, and apply a favorite name, please.</li>
  67 <li style="margin-top:3px;">These edit displays do not go out when new addition of the member and new addition of the category on a "setting of Brog" page, and edit it respectively, please after it adds it.</li>
  68 <li style="margin-top:3px;">The name of the default when newly adding it,Blog as [shortname],Categories as [category_(catid)],Sub-Categories as [subcategory_(scatid)],Item as [item_(itemid)],Member as [login-name].<br />
  69         Path has been generated to all the subBrog item category category members who existed in Brog when the plug-in is installed with the automatic operation.</li>
  70 <li style="margin-top:3px;">The name in the same key in Brog the same cannot overlap and take care, please.<br />
  71         When path that tried to be registered overlaps, each ID is added in the form of '_ id'.<br />
  72         Even if it is same Brog, the category, the subcategory, and the item can apply the same name.<br />
  73         In a word, "http://example.jp/nucleuscms/nucleuscms/nucleuscms.html" becomes effective path.</li>
  74 <li style="margin-top:3px;">".html" is automatically added to path of the member and the item.</li>
  75 <li style="margin-top:3px;">"Member directory", "Archive directory", and "Archive list directory" are revokable in the edit display of the plug-in.An initial value is a value of each "<code>$CONF['***Key']</code>".</li>
  76 <li style="margin-top:3px;">The character that can be used as a directory name and a file name is only a-z,A-Z,0-9,-,_.<br />
  77         "/" and "." included in the specified character string are automatically converted into "_".<br />
  78         When URL is generated, capital letters and small letters of the alphabet are distinguished.However, when accessing it, it doesn't distinguish.</li>
  79 <li style="margin-top:3px;">The directory name for the Sub-Categories can be edited only on the management screen now.<br />
  80         The data base has been updated about the subcategory newly added in the timing of the link generation.</li>
  81 <li style="margin-top:3px;">When the directory name is made a blank by the management screen and the edit display, the name is deleted from the data base, and URL becomes past FancyURLs.</li>
  82 <li style="margin-top:3px;">The same name cannot be applied to path for Brog and path for the category.</li>
  83 <li style="margin-top:3px;">The access with URL is possible even after this plug-in is installed so far.</li>
  84 <li style="margin-top:3px;">It can be selected whether to change URI of each Brog by the option.</li>
  85 </ul>
  86
  87 </div>
  88
  89 <h3>Skin/Template variable</h3>
  90
  91 <div>
  92 It is possible to fill it in skin, the template, and in the article.<br />
  93 Useage:<code>&lt;%CustomURL(link ahead, link text, title text)%&gt;</code><br />
  94 <ul>
  95 <li>link ahead:kind link ahead/id or name/specified type
  96         <ul>
  97                 <li>Paragraph 1:One of i, c, s, b, and m.Each initial of item, category, subcategory, blog, and member.</li>
  98                 <li>Paragraph 2:Id or name link ahead.The name is not a path name but is "Category name" and "Shortname of Brog", etc.When the item is selected the link ahead, specifying it for here becomes only id.</li>
  99                 <li>Paragraph 3:"i" and filling in when id, "n" and filling in when name is specified by paragraph 2.</li>
 100         </ul>
 101 </li>
 102 <li>link text:Character string placed between a tag.Only URL is generated when omitted.</li>
 103 <li>title text:It is set to the "title" attribute of a tag.If the link text exists, it is set to the change when omitted.Even if only the title is specified without specifying the link text, the link tag is not generated.</li>
 104 <li>It can be written &lt;%CustomURL%&gt; by omitting all parameters.In this case, URI of default is written by the filling in place.
 105         <ul>
 106                 <li>skin:URI to the top page of present "Brog" is written.</li>
 107                 <li>template:URI to the written item is written.(Replacement of &lt;%itemlink%&gt;)</li>
 108                 <li>article:URI to oneself is written.</li>
 109         </ul>
 110 </li>
 111 </ul>
 112 Filling in example:
 113 <ul>
 114         <li>When id links with the item of 123:&lt;a href="&lt;%CustomURL(i/123/i)%&gt;"&gt;'Here is freely written.'&lt;/a&gt;<br />
 115         Written character string:&lt;a href="http://blog.example.jp/item_123.html"&gt;'Here is freely written.'&lt;/a&gt;</li>
 116         <li>When the category name writes URI of the category of "Diary":&lt;%CustomURL(c/Diary/n)%&gt;<br />
 117         Written character string(When id of "Diary" category is 12)\81Fhttp://blog.example.jp/category_12/</li>
 118         <li>When you set the link of Brog to shortening name "bibouroku" to the link from the character string "This Brog":&lt;%CustomURL(c/bibouroku/n, This Blog)%&gt;<br />
 119         Written character string:&lt;a href="http://blog.example.jp/"&gt;This Blog&lt;/a&gt;</li>
 120 </ul>
 121 When only id is filled in like skin template article both "&lt;%CustomURL(123)%&gt;", URI to the item with the id is written.<br />
 122 Moreover, passing set to the item with the id like item_123 can be written by writing "&lt;%CustomURL(123/path)%&gt;" only for the item.<br />
 123 </div>
 124
 125 <h3>Operation report and bug report</h3>
 126
 127 <p>...following URL.. I hope the comment or the track back the operation report and bug report.<br />
 128 <a href="http://shizuki.kinezumi.net/NucleusCMS/Plugins/NP_CustomURL/NP_CustomURL.html">
 129 http://shizuki.kinezumi.net/NucleusCMS/Plugins/NP_CustomURL/NP_CustomURL.html</a></p>
 130
 131 <h3>Version history</h3>
 132
 133 <ul>
 134 <li>Version 0.2.1:
 135         <ul>
 136         <li>Making of Sub-Categories multistep URL</li>
 137         <li>Trouble not to be able to delete the data of the subcategory when the category and Brog are deleted is corrected.</li>
 138         <li>Other correction.</li>
 139         </ul>
 140 </li>
 141 <li>Version 0.1.9:
 142         <ul>
 143         <li>It corresponds to the movement between Brog of the category and the item.</li>
 144         </ul>
 145 </li>
 146 <li>Version 0.1.8a:
 147         <ul>
 148         <li>Correction according to timing change in passing registration of new Sub-Categories.</li>
 149         <li>To select whether to use customized URI of each Brog, the option is added.</li>
 150         <li>Correction of Help file.</li>
 151         </ul>
 152 </li>
 153 <li>Version 0.1.8:
 154         <ul>
 155         <li>It corresponds to trouble that URI to 'General' category made by the automatic operation when Brog is newly made doesn't operate normally.</li>
 156         <li>It corresponds to trouble that URI of "Category", "Subcategory", and "Item" that belongs to deleted Brog remained in the table when Brog is deleted.</li>
 157         <li>When the link is generated, the timing of the registration of passing of new Sub-Category is changed.(When URI has been set on the management screen before the link is generated, set URI is used.)</li>
 158         <li>It is corrected that item URI was not normally displayed on the management page.</li>
 159         </ul>
 160 </li>
 161 <li>Version 0.1.7:
 162         <ul>
 163         <li>It rewrites it almost completely.</li>
 164         <li>When the track back is transmitted when a new item is added, trouble not to be able to transmit URL in the track back origin correctly is corrected.</li>
 165         <li>When passing the subcategory is edited from the management screen, trouble to which the list is not displayed is corrected.</li>
 166         </ul>
 167 </li>
 168 <li>Version 0.1.5: Version of opening to the public.</li>
 169 <li>Version 0.01: First version(Remodeling version of NP_Path)</li>
 170 </ul>