OSDN Git Service

ADD:BaseActions::$defined_actionsを管理画面用スキンのスキン変数としてリファレンスマニュアルに追加
authorshizuki <shizuki@kinezumi.net>
Mon, 21 May 2012 09:03:17 +0000 (18:03 +0900)
committershizuki <shizuki@kinezumi.net>
Mon, 21 May 2012 09:03:17 +0000 (18:03 +0900)
nucleus/documentation/help.html

index ff63dc4..f445164 100644 (file)
@@ -2325,6 +2325,20 @@ all
 </div>
 
 
+<div class="page">
+<a id="skinvar-locale" name="skinvar-locale"></a>
+<h1>Skinvar: locale</h1>
+<p>The present locale based on a site's establishing it is output.</p>
+<h2>Arguments</h2>
+<p>None</p>
+<h2>Skintypes</h2>
+<p>All</p>
+<h2>Examples</h2>
+<pre>
+&lt;%locale%&gt;
+</pre>
+</div>
+
 
 
 
@@ -3984,7 +3998,7 @@ These template variables be used in the following template-parts: <tt>item heade
        <td>URL of the weblog</td>
 </tr><tr>
        <td><a href="#templatememberextra" title="authtext()">authtext</a></td>
-       <td>the extra text</a> for members, empty for non members</td>
+       <td>the extra text for members, empty for non members</td>
 </tr><tr>
        <td>short</td>
        <td>a cut off version of the body, which truncates after the first line break. <a href="#templatecommentcontinued">A link is added</a> at the end according to the template</td>
@@ -4034,7 +4048,7 @@ These template variables be used in the following template-parts: <tt>item heade
 <h2>Arguments</h2>
 
 
-<ul>Optional:
+<p>Optional:
        <ul>
                <li><strong><em>what</em></strong>: Choose a type of information to be displayed:
                        <ul>
@@ -4047,7 +4061,7 @@ These template variables be used in the following template-parts: <tt>item heade
                        </ul>
                </li>
        </ul>
-</ul>
+</p>
 
 <h2>Examples</h2>
 <pre><code>&lt;%karma(posp)%&gt; out of &lt;%karma(votes)%&gt; were positive</code></pre>
@@ -4065,12 +4079,12 @@ These template variables be used in the following template-parts: <tt>item heade
 
 <h2>Arguments</h2>
 
-<ul>Optional:
+<p>Optional:
        <ul>
                <li><strong><em>maxlength</em></strong>: When provided, makes the itemtitle behave like the <a href="#templatevar-syndicate_title">syndicate_title templatevar</a>.
                </li>
        </ul>
-</ul>
+</p>
 
 </div>
 
@@ -4086,7 +4100,7 @@ These template variables be used in the following template-parts: <tt>item heade
 <p>Inserts the name of the author</p>
 
 <h2>Arguments</h2>
-<ul>Optional:
+<p>Optional:
        <ul>
                <li><strong><em>what</em></strong>: Choose a type of information to be displayed:
                        <ul>
@@ -4098,7 +4112,7 @@ These template variables be used in the following template-parts: <tt>item heade
                        </ul>
                </li>
        </ul>
-</ul>
+</p>
 
 <h2>Examples</h2>
 
@@ -4163,11 +4177,11 @@ Inserts a date using the <a href="#templatedatetime">date format specified in th
 </p>
 
 <h2>Arguments</h2>
-<ul>Optional
+<p>Optional
        <ul>
                <li><strong><i>format</i></strong>: format to be used to format the date</li>
        </ul>
-</ul>
+</p>
 
 <h2>Specials</h2>
 
@@ -4199,11 +4213,11 @@ Inserts a time using the <a href="#templatedatetime">time format specified in th
 </p>
 
 <h2>Arguments</h2>
-<ul>Optional
+<p>Optional
        <ul>
                <li><strong><i>format</i></strong>: format to be used to format the time</li>
        </ul>
-</ul>
+</p>
 
 <h2>Examples</h2>
 <pre>
@@ -4223,7 +4237,7 @@ Inserts a comments 'block'. <a href="#templatecomments">More information about t
 </p>
 
 <h2>Arguments</h2>
-<ul><p>Optional:</p>
+<p>Optional:
        <table><tr>
                <th>Name</th>
                <th>Contents</th>
@@ -4231,7 +4245,7 @@ Inserts a comments 'block'. <a href="#templatecomments">More information about t
                <td>MaxToShow</td>
                <td>Amount of comments to show (when set, this overrides the <a href="#blogmaxcomments">max. comments blogsetting</a>)</td>
        </tr></table>
-</ul>
+</p>
 
 <h2>Examples</h2>
 
@@ -4879,7 +4893,7 @@ smaller plugins on the forum that never made it to the wiki.
 
 <div class="page">
 <a id="adminskinvar-versioncheckurl" name="adminskinvar-versioncheckurl"></a>
-<h1>AdminSkinvar: version</h1>
+<h1>AdminSkinvar: versioncheckurl</h1>
 <p>URL of which I inquire a newest version of a core file is output.</p>
 <h2>Arguments</h2>
 <p>None</p>
@@ -4891,5 +4905,241 @@ smaller plugins on the forum that never made it to the wiki.
 </pre>
 </div>
 
+<div class="page">
+<a id="adminskinvar-benchmark" name="adminskinvar-benchmark"></a>
+<h1>AdminSkinvar: benchmark</h1>
+<p>Number of issuances of generation time from access starting to the place where this skin variable was written and a query is output.</p>
+<h2>Arguments</h2>
+<p>None</p>
+<h2>Skintypes</h2>
+<p>All</p>
+<h2>Examples</h2>
+<pre>
+&lt;%benchmark%&gt;
+</pre>
+</div>
+
+<div class="page">
+<a id="adminskinvar-charset" name="adminskinvar-charset"></a>
+<h1>AdminSkinvar: charset</h1>
+<p>Character code for page indication.</p>
+<h2>Arguments</h2>
+<p>None</p>
+<h2>Skintypes</h2>
+<p>All</p>
+<h2>Examples</h2>
+<pre>
+&lt;%charset%&gt;
+</pre>
+</div>
+
+<div class="page">
+<a id="adminskinvar-if" name="adminskinvar-if"></a>
+<a id="adminskinvar-else" name="adminskinvar-else"></a>
+<a id="adminskinvar-endif" name="adminskinvar-endif"></a>
+<a id="adminskinvar-ifnot" name="adminskinvar-ifnot"></a>
+<a id="adminskinvar-elseifnot" name="adminskinvar-elseifnot"></a>
+<a id="adminskinvar-elseif" name="adminskinvar-elseif"></a>
+<h1>AdminSkinvars: if/ifnot/else/elseif/elseifnot/endif</h1>
+
+<p>Inserts a content block only when certain conditions are fullfilled. Can be used in the item and comment fields of templates as of 3.60, as well as in Item bodies (same as item template fields).</p>
+
+<h2>Arguments</h2>
+<p>Only the <code>if</code>, <code>ifnot</code>, <code>elseif</code>, and <code>elseifnot</code> skinvars have options</p>
+
+
+<ul>
+       <li><strong>type</strong>: type of condition</li>
+       <li><em>name</em>: name of option (optional)</li>
+       <li><em>value</em>: value to be checked (optional)</li>
+</ul>
+
+<h2>Condition types</h2>
+
+<ul>
+       <li><strong>category</strong>: condition is fullfilled when a category is selected
+               <ul>
+                       <li><strong>category</strong>: checks if any category is selected</li>
+                       <li><strong>category,catname,<em>CategoryName</em></strong>: checks if the current category is <em>CategoryName</em></li>
+                       <li><strong>category,catid,<em>CategoryId</em></strong>: checks if the current category is <em>CategoryId</em></li>
+               </ul>
+       </li>
+       <li><strong>blogsetting</strong>: checks if the value <em>name</em> blogsetting equals <em>value</em> (the name is the column name from the nucleus_blog sql table)</li>
+       <li><strong>loggedin</strong>: condition is fullfilled if visiting member is currently logged in</li>
+       <li><strong>onteam</strong>: condition is fullfilled if visiting member is currently logged in &amp; member of the blog team of the current blog (or the blog given in the <em>name</em> parameter)</li>
+       <li><strong>admin</strong>: condition is fullfilled if visiting member is currently logged in &amp; member with blog admin rights to the current blog (or the blog given in the <em>name</em> parameter)</li>
+       <li><strong>superadmin</strong>: condition is fullfilled if visiting member is currently logged in &amp; member with admin rights to the site</li>
+       <li><strong>nextitem</strong>: true if there is a more recent item available for the current weblog (item skintype)</li>
+       <li><strong>previtem</strong>: true if there is an older item available for the current weblog (item skintype)</li>
+       <li><strong>archivenextexists</strong>: true if there is a more recent archive available for the current weblog (archive skintype)</li>
+       <li><strong>archiveprevexists</strong>: true if there is an older archive available for the current weblog (archive skintype)</li>
+       <li><strong>skintype</strong>: checks if the current skin type is equal to <em>value</em> (index, search, item, archive, archivelist, ...). For special skin parts, the skin type is the name of the special skin part.</li>
+       <li><strong>hasplugin</strong>: checks if the a plugin is installed, or if a plugin option has been set to a specific value
+               <ul>
+                       <li><strong>hasplugin,<em>PluginName</em></strong>: checks if plugin is available</li>
+                       <li><strong>hasplugin,<em>PluginName</em>,<em>OptionName</em></strong>: checks if a plugin option is not set to 'no'</li>
+                       <li><strong>hasplugin,<em>PluginName</em>,<em>OptionName=value</em></strong>: checks if a plugin option is set to a specific value</li>
+               </ul>
+       </li>
+       <li><strong>adminaction</strong>: checks if the action query of URL is equal to <em>value</em>.</li>
+       <li><strong>adminoldaction</strong>: checks if the original action query of URL is equal to <em>value</em>.</li>
+       <li><strong>addresschange</strong>: checks if there change in the address of the member.</li>
+       <li><strong>bechangepass</strong>: checks if have to change the password.</li>
+       <li><strong>skincandidates</strong>: checks if skin overlap.</li>
+       <li><strong>nameclashes</strong>: checks if member name overlap.</li>
+       <li><strong>existsnewplugin</strong>: checks if plugin of non-installation in a plugin directory.</li>
+       <li><strong>autosave</strong>: checks if autosave of the article which is being edited.</li>
+       <li><strong>itemproperty</strong>: checks whether the contents of a property of an item "$name" are equal to $value.</li>
+</ul>
+<h2>Skintypes</h2>
+<p>All</p>
+<h2>Examples</h2>
+<pre>
+&lt;%if(superadmin)%&gt;
+non-installed plugin list overview &amp; installed plugin list overview
+&lt;else&gt;
+installed plugin list overview only
+&lt;%endif%&gt;
+</pre>
+</div>
+
+<div class="page">
+<a id="adminskinvar-include" name="adminskinvar-include"></a>
+<h1>AdminSkinvar: include</h1>
+<p>
+Includes a textfile into the output. The contents of the file is not parsed in any way, so you cannot use skin/templatevars or use PHP code (see <a href="#adminskinvar-parsedinclude">parsedinclude</a> and <a href="#adminskinvar-phpinclude">phpinclude</a> if you want parsed includes)
+</p>
+<h2>Arguments</h2>
+<ul>
+       <li><strong>filename</strong>: the name of the file to be included (either relative to the position of index.php, or absolute). Note that an URL can also be used here.</li>
+</ul>
+<h2>Notes</h2>
+<ul>
+       <li>This tag is affected by the <a href="#parser-properties">parser settings <code>IncludeMode</code> and <code>IncludePrefix</code></a></li>
+</ul>
+<h2>Skintypes</h2>
+<p>All</p>
+<h2>Examples</h2>
+<pre>
+&lt;%include(filename.txt)%&gt;
+&lt;%include(/home/user/myself/filename.txt)%&gt;
+&lt;%include(http://mydomain.com/filename.html)%&gt;
+</pre>
+</div>
+
+<div class="page">
+<a id="adminskinvar-locale" name="adminskinvar-locale"></a>
+<h1>AdminSkinvar: locale</h1>
+<p>The present locale based on a site's establishing it is output.</p>
+<h2>Arguments</h2>
+<p>None</p>
+<h2>Skintypes</h2>
+<p>All</p>
+<h2>Examples</h2>
+<pre>
+&lt;%locale%&gt;
+</pre>
+</div>
+
+<div class="page">
+<a id="adminskinvar-parsedinclude" name="adminskinvar-parsedinclude"></a>
+<h1>AdminSkinvar: parsedinclude</h1>
+<p>Includes a file into the output. The contents of the file is parsed by the Nucleus skin/template parser, so you can use skin/templatevars. (see <a href="#skinvar-phpinclude">phpinclude</a> and <a href="#skinvar-include">include</a> for other include options)</p>
+<h2>Arguments</h2>
+<ul>
+       <li><strong>filename</strong>: the name of the file to be included (either relative to the position of index.php, or absolute)</li>
+</ul>
+<h2>Notes</h2>
+<ul>
+       <li>This tag is affected by the <a href="#parser-properties">parser settings <code>IncludeMode</code> and <code>IncludePrefix</code></a></li>
+       <li>From inside the included file, you can call <code>&lt;%parsedinclude(filename)%&gt;</code> again. To avoid endless loops, the maximum depth level you can go is 3.</li>
+</ul>
+<h2>Skintypes</h2>
+<p>
+all
+</p>
+<h2>Examples</h2>
+<pre>
+&lt;%parsedinclude(filename.txt)%&gt;
+&lt;%parsedinclude(/home/user/myself/filename.txt)%&gt;
+</pre>
+</div>
+
+<div class="page">
+<a id="adminskinvar-phpinclude" name="adminskinvar-phpinclude"></a>
+<h1>AdminSkinvar: phpinclude</h1>
+<p>Includes a php-file into the output. The contents of the file is parsed by the PHP parser, so be careful. Nucleus skin/templatevars are <b>not</b> parsed! (see <a href="#skinvar-parsedinclude">parsedinclude</a> and <a href="#skinvar-include">include</a> for other include options).</p>
+<h2>Arguments</h2>
+<ul>
+       <li><strong>filename</strong>: the name of the file to be included (either relative to the position of index.php, or absolute)</li>
+</ul>
+<h2>Notes</h2>
+<ul>
+       <li>This tag is affected by the <a href="#parser-properties">parser settings <code>IncludeMode</code> and <code>IncludePrefix</code></a></li>
+       <li>Your file will be included using the standard php <code>include()</code> command. This command will be called from <em>inside</em> a class method, so <strong>you'll need to declare which global variables you want to access</strong> yourself. Most of the <a href="#skinvar-phpinclude-vars">standard variables</a> are automatically declared global by Nucleus itself.</li>
+</ul>
+<h2>Skintypes</h2>
+<p>all</p>
+<h2>Examples</h2>
+<pre>
+<code>&lt;%phpinclude(filename.php)%&gt;
+&lt;%phpinclude(/home/user/myself/filename.php)%&gt;</code>
+</pre>
+</div>
+
+<div class="page">
+<a id="adminskinvar-set" name="adminskinvar-set"></a>
+<h1>AdminSkinvar: set</h1>
+<p>
+Sets a <a href="#parser-properties" title="A list of available parser properties">parser property</a>.
+</p>
+<h2>Arguments</h2>
+<p>
+       <ul>
+               <li><strong>property</strong>: name of the property</li>
+               <li><strong>value</strong>: value of the property</li>
+       </ul>
+</p>
+<h2>Skintypes</h2>
+<p>all</p>
+<h2>Examples</h2>
+<pre>
+&lt;%set(IncludeMode,skindir)%&gt;
+&lt;%set(IncludePrefix,somedir/)%&gt;
+</pre>
+</div>
+
+<div class="page">
+<a name="adminskinvar-skinfile"></a>
+<h1>AdminSkinvar: skinfile</h1>
+<p>Used by imported skins to put a link relative to the skins-URL. Use it in conjunction with the <tt>IncludePrefix</tt> <a href="#parser-properties">parser property</a> to get the best results</p>
+<h2>Arguments</h2>
+<p>
+       <ul>
+               <li><strong>filename</strong>: filename of which you want the correct URL</li>
+       </ul>
+</p>
+<h2>Skintypes</h2>
+<p>all</p>
+<h2>Examples</h2>
+<pre>
+&lt;%skinfile(mystyle.css)%&gt;
+</pre>
+</div>
+
+<div class="page">
+<a id="adminskinvar-text" name="adminskinvar-text"></a>
+<h1>AdminSkinvar: text</h1>
+<p>Constant which is already defined is output.</p>
+<h2>Arguments</h2>
+<p>Constant</p>
+<h2>Skintypes</h2>
+<p>All</p>
+<h2>Examples</h2>
+<pre>
+&lt;%text(_ADMINPAGEFOOT_DONATE)%&gt;
+</pre>
+</div>
+
 </body>
 </html>