XOOPS Cube Developer Site::pagehttp://jp.xoopsdev.com/modules/page/index.php2016-10-25T23:05:29+09:00xpWiki RecentChangesxpWikihypweb.netkilicahttp://xoopsdev.comDiezelSunhttp://jp.xoopsdev.com/modules/page/?DiezelSun2016-10-25T08:56:42+09:002016-10-25T08:56:42+09:00ゲストТатарников Александр (diezel sun) - знаменитый 3d моделлер.
Diezel Sun - artist, illustrator, game designer. In his creativity there are paintings executed on game engines, such as unity. The paintings are made in the style of a computer, they have tТатарников Александр (diezel sun) - знаменитый 3d моделлер.

Diezel Sun - artist, illustrator, game designer. In his creativity there are paintings executed on game engines, such as unity. The paintings are made in the style of a computer, they have their esoteric meaning. The game takes place on the engine design unity, the similarity SCP horror games.

Result

You can see the lacked language definitions in target language files compared to base language files.
Xtrans' function is end at this point.
Then you copy the list, paste to target language file, and translate it.

XOOPS Development Guide

]]>abouthttp://jp.xoopsdev.com/modules/page/?about2010-02-11T12:12:44+09:002010-02-11T12:12:44+09:00admin
About
This site is created by HIKAWA Kilica.
HIKAWA's XOOPS Module Laboratory
Cubson is created by minahito.
Tubson is created by mumincacao.
TubsonP is based on the above two C# tools, ported by HIKAWA Kilica.

The visitors are counted throughout the entire wiki, not per page, so it makes more sense to place this plugin in the MenuBar, the skin, etc.

P

paint

Plugin type

(Command type)

Block type

Importance

*

Synopsis

#paint(
[width]
[,height])

Description

Upload and display the image drawn by the Java applet. This plugin requires BBSPainter.jar distributed at this website.
(The site is written in Japanese only. Just look for the link to bbspainter_120.zip and download it. Put the BBSPainter.jar file in the directory where PukiWiki is installed.)

width and height are the default campus size. By default, (80,60) is used.

Constants

PAINT_INSERT_INS - whether to insert the image at the top or bottom

PAINT_DEFAULT_WIDTH - the default width of the campus

PAINT_DEFAULT_HEIGHT - the default height of the campus

PAINT_MAX_WIDTH - the maximum width of the campus

PAINT_MAX_HEIGHT - the maximum height of the campus

PAINT_APPLET_WIDTH - the width of the Applet

PAINT_APPLET_HEIGHT - the height of the Applet

PAINT_NAME_FORMAT - the format of the name form

PAINT_MSG_FORMAT - the format of the comment form

PAINT_NOW_FORMAT - the format of timestamp

PAINT_FORMAT - the format with messages

PAINT_FORMAT_NOMSG - the format without message

Note

Put the BBSPainter.jar file in the directory where PukiWiki is installed. Otherwise this plugin does not work.

pcomment

Record comments on a separate page. It can display only the recent comments on the place the plugin is placed, or it can display a radio button to specify where to display the comment.

Parameters

CommentPage - the page to record comments. If omitted, the page specified by the PLUGIN_PCOMMENT_PAGE constant is used. The default value is [Comment/(current page name)]. If the specified page does not exist, it will be created when the first comment is posted.

num_items - the number of top-level items to be displayed. If omitted, the default value specified by the PLUGIN_PCOMMENT_NUM_COMMENTS constant is used.

This parameter must be placed after the comment page name. If you don't want to specify CommentPage, just put a camma before num_items (e.g., #pcomment(,15))

noname,nodate,above,below,reply - parameters to specify how to enter/display the comments

noname - Do not display the name input form

nodate - Do not display the timestamp

above - Display the comments above the form, in the chronological order (the oldest at the top)

below - Display the comments below the form, in the reverse chronological order (the newest at the top)

reply - Display radio buttons to specify which comment to reply to

Constants

PLUGIN_PCOMMENT_PAGE - the default comment page name (%s is replaced by the value of $vars['page'])

PLUGIN_PCOMMENT_NUM_COMMENTS - the default number of recent comments to be displayed

PLUGIN_PCOMMENT_SIZE_NAME - the width of the name form

PLUGIN_PCOMMENT_SIZE_MSG - the width of the comment form

PLUGIN_PCOMMENT_DIRECTION_DEFAULT - whether to display the posted comments abov or below the form

PLUGIN_PCOMMENT_FORMAT_NAME - the format of the name form

PLUGIN_PCOMMENT_FORMAT_MSG - the format of the comment form

PLUGIN_PCOMMENT_FORMAT_NOW - the format of the timestamp

PLUGIN_PCOMMENT_FORMAT_STRING - the format of the entire comment

PLUGIN_PCOMMENT_AUTO_LOG - the number of comments per page when recording old comments (setting this value to 0 will disable the logging.)

PLUGIN_PCOMMENT_TIMESTAMP - whether to keep the timestamp of the comment page unchanged and instead update the page where the plugin is placed

Note

When there is a conflict (i.e., multiple comments were posted at the same time), the comment is displayed at the top or at the bottom (according to the setting) even if the radio button is checked. This is to prevent the comment from being inserted to a strange place.

When a comment is posted, the plugin displays the message indicating that the page where the plugin is placed has been updated. However, it is the comment page that has been actually updated.

Since the page containing #pcomment is not updated, it doesn't show up on the "recent changes" page.

Avoid using a relative reference (e.g. [ [../] ]) in comments, as it may not be converted as expected. (Keep in mind that the page in which you are writing comment is different from the page that will display it.)

The logging of the old comments is invoked when the number of comments reached to (PLUGIN_PCOMMENT_AUTO_LOG + PLUGIN_PCOMMENT_NUM_COMMENTS).

popular

Plugin type

Block type

Importance

**

Synopsis

#popular(
[[num_pages]
[,[ExcludedPage]
[,true|false]
]])

Description

The list of frequently visited pages

Parameters

num_pages - the number of pages to be displayed. The default value is defined as the PLUGIN_POPULAR_DEFAULT constant.

ExcludedPage - the regular expression that definees the pages which should be excluded from the list. The typical examples are FrontPage, MenuBar, etc.

true, false - whether to use the number of today's visitors only. The default is false.

true - use the number of visitors of today only

false - use the total number of visitors

Constants

PLUGIN_POPULAR_DEFAULT - the default number of pages to be displayed

Note

Since this plugin depends on the information recorded by the counter plugin, the page without the counter plugin is excluded from the list. A simple way to ensure that all pages are counted is to put the plugin in the Menubar or the skin.

R

random

Plugin type

(Command type)

Block type

Importance

*

Synopsis

#random(
[string])

Description

Display the link to a randomly selected page.

The pages to be selected from are those under the page where the plugin is placed.

Parameters

string the message string displayed on the link. The default value is 'press here.'

Note

When the page is reloaded, a different random link is displayed.

read

Plugin type

Command type

Importance

*****

Synopsis

?cmd=read&page=PageName

Description

Display the specified page. If the page doesn't exist, it will be opened in the edit mode. If the page name is an InterWiki, the plugin will resolve it.

This plugin is internally used when plugin= and cmd= are not specified. Users usually don't have to use it explicitly.

Parameters

PageName - the page name to be displayed. This must be URL-encoded.

recent

Plugin type

Block type

Importance

*****

Synopsis

#recent(
[pattern]
[,num_pages])

Description

show an updated page recently of page name that starts by the specified pattern.

Parameters

A common part of displayed PageName is specified for the pattern. When omitting it, it means "All Pages".

And, It is possible also to do list up of another xpWiki on
the same system, with "Dirctory Name:Page Pattern".

num_pages - the number of pages to be displayed. The default value is defined as the PLUGIN_POPULAR_DEFAULT constant.

Constants

PLUGIN_POPULAR_DEFAULT - the default number of pages to be displayed.

PLUGIN_RECENT_CACHE - RecentChanges directory.

PLUGIN_RECENT_USAGE - help that is displayed at the time of Parameters non-parameters.

The file appended to the page by '#attach' is developed with a specified position. The image is displayed when the attached file is an image, and the link for download is displayed besides.

Parameters

The attached file name to the page is specified for the attached file name (When omitting it, become an error). The attached file on another page can be specified by the thing assumed to be another PageName/attached file name.

The page that appends the file is specified for PageName with WikiName or BracketName. Please describe this option first (following of the attached file name). Omitting it is a page set up.

The method of developing the file can be specified for the parameter.

left|center|right - The position of the display is specified. Omitting it is left (It is possible to change).

wrap|nowrap - It is specified not to enclose or the enclosure with the table tag. Omitting it is nowrap (It is possible to change).

around - The turn crowding of the text is enabled. When omitting it, it turns and it doesn't crowd.

noicon - The icon displayed, except when the file is an image is not displayed. When omitting it, it displays it.

noimg - When the file is an image, the image is not progressed. When omitting it, it develops.

nolink - The link to the former file is not put. When omitting it, it links.

zoom - The aspect ratio is maintained. When omitting it, it follows the size specification.

999x999 - The size is specified (height of width x). When omitting it, it follows the size of the expansion rate or the object image.

999% - The size is specified (expansion rate). Omitting it is 100%.

Title - Parameters other than the above-mentioned are used as an alternative character string in the image and a title attribute of the link. When the character string seen PageName and the parameter is used, the comma is extra put ahead of the title like # ref(hoge.png,,zoom).

Constants

PLUGIN_REF_USAGE Help displayed when Parameters is unspecified

PLUGIN_REF_IMAGE Regular expression that considers specified file to be image when matching it

FILE_ICON File of icon image

PLUGIN_REF_DEFAULT_ALIGN Position where it is displayed to omit right left and center

PLUGIN_REF_WRAP_TABLE When nowrap, wrap is omitted do you enclose it with the table tag?

PLUGIN_REF_URL_GET_IMAGE_SIZE When URL is specified, is the image size acquired?

PLUGIN_REF_DIRECT_ACCESS Do you directly access the data of UPLOAD_DIR by the image display of the attached file?

Note

Please use the clear plug-in or the img plug-in to release specification with around ..going.. turning and crowding.

The method of describing two following kinds of when the attached file "fuga.jpg" on another page "hoge" is referred by the in-line plug-in form exists.

(1) &ref(hoge/fuga.jpg);
(2) &ref(fuga.jpg,[[hoge]]);

The description method recommended by the one prepared to maintain the previous version and interchangeability is (1) in the description method of (2) among two above-mentioned kinds of descriptions.

Operation general even if it is which description method is the same. However, it is likely not to function normally when the following specification is done so that the image displayed like a so-called banner image may become a link to another page.

(3) - (5) It peels off and there is no problem. (6) It becomes an error the peel.
Because Synopsis of (6) is a description method of (2) in this The purpose is to expect PageName of the following Parameters of attached file name fuga.jpg.

(7) &ref(fuga.jpg);

(7) It is a description that looks like as peel (6). However, it doesn't become an error. Because the following Parameters of the attached file name is omitted.

referer

Plugin type

Command type

Importance

***

Synopsis

?plugin=referer
[&page=PageName]
[&sort=0d|0a|1d|1a|2d|2a|3
]

Description

Reference former URL(Referer) of the user who inquires the page list is displayed.

Parameters

PageName that displays Referer is specified for PageName. It is necessary to encode PageName. When omitting it, the list of the page where Referer is recorded is displayed.

The order of sorting of the Referer list is specified with sort.

0d - Last updated date and time(newly arrived the order)

0a - Last updated date and time(date the order)

1d - Registration first time date(newly arrived the order)

1a - Registration first time date(date the order)

2d - Counter(large the order)

2a - Counter(small the order)

3 - Referer

Constants

CONFIG_REFERER Page that specifies disregarded URI

Note

It is necessary to do the setting ($referer=1 is specified) that uses Referer with pukiwiki.ini.php.

related

Plugin type

Command type

PseudoBlock type

Importance

***

Synopsis

?plugin=related
[&page=PageName]

#related

Description

The list of the page to refer to the page of the object is displayed.

Parameters

When executing it by the block type, the page set up becomes an object.

When executing it with Command type, the page that becomes an object can be specified for PageName. It is considered that top page is specified when omitting it.

rename

Plugin type

Command type

Importance

***

Synopsis

?plugin=rename
[&refer=PageName]

Description

The name of an existing page is changed. The admin authority is necessary for execution.

The difference, the backup, the attached file, and the counter of specified PageName besides the text on the page are renamed at a dash. :Parameters|

The name of the changed page is specified for PageName. When omitting it, the selection of PageName or the character string input screen for the regular expression substitution is displayed.

The execution result is a page of the conversion result. (It specifies it with PLUGIN_RENAME_LOGPAGE. The standard: RenameLog. )Is added.

Constants

PLUGIN_RENAME_LOGPAGE PageName The conversion result is output PageName.

Note

The link is not rewritten in the page. Please deal with yetlist etc. by making good use of.

Information on TrackBack and Referer is not updated.

It is not checked whether the page to be renamed has been frozen.

When two or more charactors to be renamed are included in a related page, the correspondence is lost.

For instance, when "hoge" page is renamed to "fuga" (A related page is included) when there are two pages "hoge" and "hoge/hoge", the name of "hoge/hoge" page becomes "fuga/fuga".

rss

Plugin type

Command type

Importance

*

Synopsis

?plugin=rss
[&ver=0.91|1.0|2.0]

Description

RecentChanges is converted into RSS and it outputs it.

Parameters

RSS output with ver is specified. When omitting it, 0.91 is output.

Note

RSS is XML format used to deliver the summary of the site. RSS 1.0 is a succession of RSS 0.9 based on RDF(Resource Description Framework) format. In RSS 0.91, it is mounting RSS not to be original, and RSS 2.0 is a succession of RSS 0.91 and 0.92 format to RDF. It is different respectively what abbreviation the acronym named RSS is.

RSS 0.9 and 1.0: RDF Site Summary

RSS 0.91 and 0.92: Rich Site Summary

RSS 2.0: Really Simple Syndication

rss10

Plugin type

Command type

Importance

*

Synopsis

?cmd=rss10

Description

RecentChanges is converted into RSS(RDF Site Summary) 1.0 and it outputs it.

Note

This plug-in exists only for interchangeability with the past because the function of the rss10 plug-in was merged with the rss plug-in. (There is a possibility to be deleted in the future. )

It is redirected to URI of the rss plug-in that specifies the ver=1.0 option that it accesses this plug-in with HTTP status code 301(Moved Permanently).

ruby

Plugin type

Inline type

Importance

*

Synopsis

&ruby(Ruby){Word};

Description

The ruby is put on the word.

Parameters

The displayed ruby is specified for the ruby.

The word to which the ruby is put is specified for the word.

Constants

PLUGIN_RUBY_USAGE Help displayed when Parameters is unspecified.

Note

If it is not a browser corresponding to the ruby of XHTML 1.1, it is not displayed as a ruby. It is possible to display it in IE5.5/6. If XHTML Ruby Support:http://white.sakura.ne.jp/~piro/xul/_rubysupport.html is built in in Netscape 7/Mozilla, it is possible to display it.

The ruby is put in () and displayed just behind the word to which the ruby is put in a browser that doesn't correspond to the ruby.

showrss

By default, this plugin tries to obtain an RSS feed every time the page is accessed. If you place the showrss plugin in a frequently accessed page, use the cache functionality. The value of the cache timeout should be set properly depending on how frequently the target site is updated.

Parameters

RSS_location - the file path or the URL of the RSS feed

The template parameter determines the display format of the RSS. The default value is 'default'.

default - simple list of pages

menubar - display a bullet before the page name (useful in a page like MenuBar, which has a limit in page width)

recent - display the timestamp of the pages name like the recent plugin

cache_timeout - the cache expiration time (in hours). The default is to disable caches.

The last parameter determines whether the plugin displays the timestamp of the RSS feed. The timestamp is displayed if 1 is set. The default is not to display the RSS timestamp.

Note

This plugin requires the xml extension of PHP.

size

Plugin type

Inline type

Importance

***

Synopsis

&size(fontsize){string};

Description

Display a string in a specified font size

Parameters

fontsize - font size (in pixels)

string - the string to be displayed

Constants

PLUGIN_SIZE_MAX - maximum font size allowed

PLUGIN_SIZE_MIN - minimum font size allowed

PLUGIN_SIZE_USAGE - usage texts upon an error (when parameters were not given)

source

Plugin type

Command type

Importance

*

Synopsis

?cmd=source&page=PageName

Description

Display the source texts of the specified page

Parameters

PageName - the page name of which the source texts are displayed. It must be URL-encoded.

stationary

Plugin type

Command type

Block type

Inline type

Importance

*

Synopsis

?plugin=stationary

#stationary

Description

The stationary plugin is a template created for developers of a PukiWiki plugin.

It does not do anything other than displaying a simple text.

Constants

PLUGIN_STATIONARY_MAX - the sample to show how the constant is defined in the plugin

T

tb

Plugin type

Command type

Importance

*

Synopsis

?plugin=tb&tb_id=TrackBackID&__mode=view|rss

Description

Display the list of the trackbacks

It can respond to the trackback from other sites when called by a POST request.

Parameters

&tb_id - the trackback ID of the target page

&__mode - the format of the trackback list

view - display the list in the human-readable format

rss - display the list in the RSS format

Constants

PLUGIN_TB_LANGUAGE - the language of the trackback RSS

PLUGIN_TB_ERROR - the return code for error

PLUGIN_TB_NOERROR - the return code for success

Note

To use this plugin, the $trackback in pukiwiki.ini.php must be set to 1.

template

Plugin type

Command type

Importance

****

Synopsis

?plugin=template&refer=TemplatePage

Description

Create a new page using an existing page as template.

This is similar to the function of 'creating a new page' using a skeleton page, but while 'create new' always reads the entire page, thie plugin can specify which part of the existing page should be used as a template.

Parameters

TemplatePage - The page used as a template. It must be URL-encoded.

Constants

MAX_LEN - The maximum length of the templated (displayed on the form to specify the location of the tamplate page.)

topicpath

Plugin type

Inline type

Block type

Importance

*

Synopsis

&topicpath;

#topicpath

Description

Display the UI which displays the 'topic path'.

The topic path is a hierachical representation of the page structure. For example, If #topicpath is written on the page named PukiWiki/Tour, the plugin displays the following links.

[[Top>FrontPage]]/[[PukiWiki>PukiWiki]]/[[Tour>PukiWiki/Tour]]

The intended uses of this plugin are as follows.

Help page transition between the pages with more than 2-3 levels (e.g., "Foo/Bar/Baz")

Display the topic path instead of the URL shown below the page title (by using this plugin in the skin)

Constants

PLUGIN_TOPICPATH_TOP_DISPLAY - whether to display the link to the default page

PLUGIN_TOPICPATH_TOP_LABEL - the label for $defaultpage

PLUGIN_TOPICPATH_TOP_SEPARATOR - the level separator

PLUGIN_TOPICPATH_THIS_PAGE_DISPLAY - whether to display the link to the current page

PLUGIN_TOPICPATH_THIS_PAGE_LINK whether to link to the current page

Note

If this plugin is used in the skin, set SKIN_DEFAULT_DISABLE_TOPICPATH to 0 in pukiwiki.skin.php.

touchgraph

Plugin type

Command type

Importance

*

Synopsis

?plugin=touchgraph

Description

Create the index for the TouchGraphWikiBrowser

tracker

Plugin type

(Command type)

Block type

Importance

****

Synopsis

#tracker(
[TemplateName]
[,BasePageName])

Description

Display an input form for creating stylized pages.

Unlike the bugtrack plugin, in which the items are fixed, the tracker plugin can create arbitrary input fields on the stylized page. The potential use of this plugin is to create FAQ, BBS, book reviews, TODO list, etc.

The input fields can be defined by creating a template page under :config/plugin/tracker/ according to specific formats. For a reference, the template equivalent to the bugtrack pluging is placed at :config/plugin/tracker/default.

Parameters

TemplateName - the template template name (e.g., #tracker(hoge)). If omitted, :config/plugin/tracker/default is used.

It is possible to specify the form name or the list name after the template name. This is useful when you want to use multiple form/list formats for the same template. For example, #tracker(foo/form_alternative) uses :config/plugin/tracker/foo/form_alternative, and #tracker_list(foo/list_alternative) uses :config/plugin/tracker/foo/list_alternative for layout.

'''BasePageName' - the top-level page created by the plugin. The default is the current page.

Constants

TRACKER_LIST_EXCLUDE_PATTERN - the regular expression that defines the pages excluded from the pages shown by the tracker_list plugin

TRACKER_LIST_SHOW_ERROR_PAGE - whether to display the pages in the list if the items couldn't be extracted from them

Templates syntax

For each tracker, the following 4 pages should be created as a template.

:config/plugin/tracker/foo

the descreiption of the foo template

:config/plugin/tracker/foo/form

definitions of input fields and layouts

:config/plugin/tracker/foo/page

format of the page to be created

:config/plugin/tracker/foo/list

layout of the list displayed by the tracker_list plugin. Special rules apply to the format definition (c), header(h), and footer(f) are a table (|...|)

Keywords

The keywords that can be used in forms

[_name] : display a field to enter the page name to store an entry (optional)

[_submit] : display the [Add] button

The keywords that can be used in pages and lists

[_date] : submission timestamp

[_page] : the page name (with brackets) created

[_refer] : the page in which #tracker was placed

[_base] : the page prefix. If the second parameter of tracker()/tracker_list() is omitted, the value of [_refer] is used.

[_name] : the value of the [_name] in the form. This is used as part of the page name in which the entry is stored.

[_real] : The generated page name exluding [_refer] + '/'. By default, this is the same value as [_name]. If one of the following conditions hold, the tracker plugin creates the page name by adding serial numbers to [_real].

(1) the form does not contain a [_name] field

(2) [_name] is empty, or it contains an invalid character for a page name

TemplateName - the template name used in the tracker plugin. The default is :config/plugin/tracker/default.

BasePageName - the base page name used in the tracker plugin. If the base page name was not specified by the tracker plugin, this should be the page in which the tracker plugin is placed. The default is the current page.

The third parameter specifies the key item for sorting and the sort order. sort_item should be selected from the fields defined in :config/plugin/tracker/TemplateName. The default is PageName. sort_order is either ASC*1, DESC*2, SORT_ASC*3, or SORT_DESC*4, and it should be written after the colon (:). Use semicolons (;) to specify multiple sort keys (and orders). For example, #tracker_list(,,state:SORT_ASC;priority:SORT_ASC;_real:SORT_DESC) display the items sorted by (1) [state] in the ascending order, (2) [priority] in the ascending order, and (3) [_real] in the descending order with the priority of this order.

max_pages - maximum number of pages displayed on the list. The default is to display all pages.

U

unfreeze

Plugin type

Command type

Importance

***

Synopsis

?plugin=unfreeze&page=PageName

Description

Unfreeze the page

Parameters

PageName - the page name to be unfrozen. It must be URL-encoded.

Constants

PLUGIN_UNFREEZE_EDIT - whether to show the edit page when the page unfrozen.

update_entities

Plugin type

Command type

Importance

*

Synopsis

?plugin=update_entities

Description

Create the CACHE_DIR/entities.dat file.

Thie file stores the table which determines the HTML entities. Users and administrators usually don't have to see it.

Constants

W3C_XHTML_DTD_LOCATION - the location of the DTD

Note

This plugin is usually unnecessary, as the PukiWiki releases are distributed with entities.dat.

lookup

The text input column and the button are displayed at the described position. When an arbitrary character string is input and the button is pushed, it moves to URL generated from interwikiname and the input value. As a result, transmitting Ceri to the search engine, and accessing the archive that corresponds only by typing the number become possible.

InterWiki is used for the generation of URL. URL that this plug-in generates is the same as following InterWiki. It is necessary to set InterWikiName used to generate URL beforehand to the page of InterWikiName.

[[interwikiname:Value of input column]]

When the input column is an empty column (null character string), it doesn't operate even if the button is pushed. It is necessary to input some character strings.

Parameters

interwikiname: One of the values set to InterWikiName is specified.

Button name:The caption displayed in the button is specified. Omitting it is 'Lookup'.

Initial value of input column:To specify an initial value, it fills it in. When omitting it, it becomes a null character string.

Constants

PLUGIN_LOOKUP_USAGE Help displayed when Parameters is unspecified

ls

Plugin type

Block type

Importance

**

Synopsis

#ls(
[title])

Description

PageName on the hierarchized page is having a look displayed on the described page.

Parameters

When title is specified, the title in addition to PageName is displayed. The title displays the content of the first line of each page. When omitting it, the title is not displayed.

Note

Actually, it seems that there are a lot of chances to use high performance or more ls2.

ls2

PageName that starts by the specified pattern is having a look displayed.

Parameters

A common part of displayed PageName is specified for the pattern. When omitting it, it becomes "Current PageName/".

And, It is possible also to do list up of another xpWiki on
the same system, with "Dirctory Name:Page Pattern".

The method of the display is specified with title, include, reverse, compact, and link.

title - The list of finding (*,**,***) of the inclusion in the page is described in parallel.

include - When the page in the subordinate position layer uses # include, the list of the page to which include is done is displayed.

reverse - The order of the row on the page is reversed, and it displays it in the descending order of the name. It is displayed in ascending order of the name when omitting it.

compact - The finding level is adjusted.

link - The link is displayed instead of displaying the list at the position in which #ls2 was written. When this link is selected, the list of the page is displayed on another screen.

The character string of taking the place of the character string displayed when parameter link is specified is specified for the display of the alias of link. When omitting it, it becomes List of pages which begin with '...' .

Constants

PLUGIN_LS2_ANCHOR_PREFIX Finding anchor's Synopsis.

PLUGIN_LS2_ANCHOR_ORIGIN Finding anchor's beginning number.

PLUGIN_LS2_LIST_COMPACT When the compact option is omitted, is the finding level adjusted?

Note

About unlike with the ls plugin.

The page that becomes a starting point on the hierarchized page can be specified by the parameter in ls2 in ls though is described page fixation.

"List of finding" is displayed in ls2 though "The first line on the page" is displayed in ls when the title parameter is specified.

The display option named 'include' and 'link' is added.

M

map

Plugin type

Command type

Importance

*

Synopsis

?plugin=map
[&refer=PageName]
[&reverse=true]

Description

The link relations between pages are having a look displayed like the site map.

The specified page is displayed and all pages that can be traced by the link are displayed in the starting point like the tree.

Parameters

The option of the method of displaying the list to Parameters is specified.

&refer=PageName - The page that becomes a starting point is specified. The top page of the site (It is FrontPage usually) becomes a starting point when omitting it.

&reverse=true - Having a look it doesn't link with where, and where it is linked is displayed. Pages that have not been linked are displayed collectively in the latter half of the screen where.

Constants

PLUGIN_MAP_SHOW_HIDDEN Whether a page off the subject for the display is listed or not?

md5

Plugin type

Command type

Importance

*

Synopsis

?plugin=md5&md5=Character string

Description

The character string for the password preserved in pukiwiki.ini.php is output according to the form of the selected password.

The format of the password can be selected from the following eight kinds of inside.
DES or PHP crypt() using MD5 algorithm and LDAP crypt *1.
PHP md5(), LDAP MD5, and LDAP SMD5 (There is a seed) using the MD5 algorithm.
PHP sha(), LDAP SHA, and LDAP SSHA using SHA-1 algorithm(There is a seed. )

Note

The password used in PukiWiki can preserve the character string (security hush)
derived from an actual password instead of the password character string.

This is the one having aimed at the thing that the password doesn't leak easily when
it peeps at contents of pukiwiki.ini.php and it is seen by a malicious person.

It is necessary to use since PHP 4.3.0 to use the SHA-1 algorithm or to introduce the mhash extension.

The password formats other than MD5 can be selected against the plug-in name.
In the past, this is due to details for which the MD5 hush value derived from the
password is used.

Use that includes the password in URL where the plug-in of md5 is called is not recommended though remains for interchangeability.

This plug-in is nullified by setting PKWK_SAFE_MODE or PKWK_READONLY.

memo

Plugin type

(Command type)

Block type

Importance

*

Synopsis

#memo

Description

Two or more-line input column and the button are displayed at the described position.

When the button is pressed, the content of the description of the input column is updated.

Constants

MEMO_COLS Number of display digits of edit columns.

MEMO_ROWS The display number of lines of edit column.

Note

The input content is not output outside the input column, and the point to stay in the input column is different though it looks like the insert plug-in and the article plug-in.

It is convenient to save up information on the unarrangement temporarily when PukiWiki is used instead of a personal memo.

menu

Plugin type

Block type

Importance

****

Synopsis

#menu(PageName)

Description

It is internally used so that the skin of default may display page (MenuBar) for the menu at the left of the page.

The page specified use on an arbitrary page as Block type for Parameters can be specified for the page for the menu.

For instance, to display the page named hogeMenu instead of MenuBar, only the page named hoge can usually be achieved on the site where MenuBar is displayed by the thing described # menu(hogeMenu) on the page named hoge.

It comes to display the MenuBar page that exists in MenuBar of a high-ranking hierarchy on the page under the display or this hierarchy when MENU_ENABLE_SUBMENU in the source is assumed to be TRUE as a menu.

For instance, when the page named FrontPage, MenuBar, hoge, fuga, hoge/MenuBar, and hoge/hoge exists, MenuBar is displayed as a menu in FrontPage, fuga, and MenuBar, and hoge/MenuBar is displayed as a menu in hoge, hoge/MenuBar, and hoge/hoge.

Parameters

PageName displayed as a page for the menu is specified.

Constants

MENU_ENABLE_SUBMENU Is the submenu used?

MENU_SUBMENUBAR PageName called as menu when submenu is used. Default is MenuBar.

Note

Please change $root->menubar of pukiwiki.ini.php when you assume the page for the menu of default to be pages other than MenuBar.

N

navi

Plugin type

Block type

Importance

**

Synopsis

#navi(
[Contents page])

Description

The DocBook style navigation bar is displayed.

It displays on the page that becomes contents and the page of the hierarchy in the under displays the link named Prev, Home, and Next on all those pages (head and ..drinking.. end) when existing by the described thing. As a result, it becomes convenient though the page of the hierarchy in the under is referred sequentially.

Parameters

The page that hits the hierarchy of the page that sees sequentially and turns to the contents page on is specified.

For instance, when # navi(hoge) is described in hoge/2 when the page named hoge, hoge/1, hoge/2, and hoge/3 exists, the link named Next that moves to the link and hoge/3 named Prev that moves to the link and hoge/1 named Home that moves to hoge is displayed.

The link of the header images is output when the first calling it on the page. The link of Fttaimage is output when called on the page after the second. When a present page is a contents page, the list of the page that becomes an object is displayed.

Constants

PLUGIN_NAVI_EXCLUSIVE_REGEX The excluded page is specified by the regular expression.

PLUGIN_NAVI_LINK_TAGS <link> tag is output or not?

new

Plugin type

Inline type

Importance

**

Synopsis

Synopsis1:

&new(
[nodate]){Date strings};

Synopsis2:

&new(
[PageName]
[,nolink]);

Description

The thing updated recently is emphatically displayed when recent the specified date. There are two kinds of specification of method (Synopsis2) of adopting method (Synopsis1) of describing time of the date directly and last updated date and time on the specified page (crowd) at the date.

With standard, New is indicated in when it is within 5 days, and, New! It indicates in when it is within 1 day. Period and pattern in the character string which is indicated is
customization possible with the installer.

Parameters

Synopsis1:

Date string is specified, the date is within the prescribed period, when highlighted. If it is time to check the page is updated description be considered.

nodate - Date string will not be shown. Default is displayed.

Synopsis2:

PageName to specify when the page is updated when the prescribed period, when highlighted. If it is not a plug-in that describes the page specified assumed.

PageName end is / was the case, the page that starts with PageName group in the last modified date within the prescribed time, when highlighted.

nolink - PageName is not displayed. When omitting it, PageName (PageName renewed at the end when specifying it in page group) is displayed.

Constants

PLUGIN_NEW_DATE_FORMAT Display format

Note

The date character string should be Synopsis that can recognize PHP function 'strtotime()'.

newpage

Plugin type

Command type

Block type

Importance

*****

Synopsis

?plugin=newpage&page=PageName&refer=Relation PageName

#newpage(
[PageName initial value])

Description

The page is newly made or the input column of PageName newly made is displayed.

Parameters

Command type:

The option on the page newly made is specified for the parameter.

PageName newly made is specified for PageName. When omitting it, the page of PageName newly made to input it is displayed. It is necessary to encode PageName.

PageName in the link origin is specified for relation PageName. The link to the page specified here is automatically buried under the head of the page newly made. It is necessary to encode PageName.

Block type:

The character string that displays initial in the input column where PageName newly made is input is specified for PageName initial value.

nofollow

Plugin type

Block type

Importance

*

Synopsis

#nofollow

Description

When the described page has been frozen, "NOFOLLOW" "NOINDEX" option is added to the header.

These options are insisted on to the search engine, "It wants you to disregard this page". Actually how do it become it depending on the search engine?

Note

It is ineffectual than the program that disregards man and the above-mentioned option.

norelated

Plugin type

Block type

Importance

***

Synopsis

#norelated

Description

The link of related pages displayed under the page is made non-display.

Note

It is linked on extremely a lot of pages and when the display of the related link is an eyesore etc. , it uses it.

]]>PukiWiki/1.4/Manual/Plugin/A-Dhttp://jp.xoopsdev.com/modules/page/?PukiWiki%2F1.4%2FManual%2FPlugin%2FA-D2009-03-17T08:40:53+09:002009-03-17T08:40:53+09:00You can see the lacked language definitions in target language files compared to base language files.
Xtrans' function is end at this point.
Then you copy the list, paste to target language file, and translate it.&#182;
Root Path
If the module use XO

Changes

You can see the lacked language definitions in target language files compared to base language files.
Xtrans' function is end at this point.
Then you copy the list, paste to target language file, and translate it.

¶

Root Path

If the module use XOOPS_TRUST_PATH so language files are in XOOPS_TRUST_PATH, check this.

It supports Amazon's affiliate program, and it can display the fixed-format reviews.

Parameters

If no options are given, the plugin displays a review input form. For example, if you place this plugin without no options in the page "BookReview", the subpages named "BookReview/ASIN" (where ASIN is the ASIN number).

The options left,right, and clear specify the output format of the product image and title.

left|right - Alignment of the output. The default value is right.

clear - Disables the text wraparound when specified.

Title,image options specify what is displayed.

Title - The title of the product as a string. If the title is not specified, it is automatically obtained from the Amazon website.

image - Displays the image only. By default, both the image and the title are displayed.

PLUGIN_AMAZON_EXPIRE_IMAGECACHE expire Valid period of the image cache in days

PLUGIN_AMAZON_EXPIRE_TITLECACHE expire Valid period of the title cache in days

PLUGIN_AMAZON_NO_IMAGE Default image

PLUGIN_AMAZON_SHOP_URI URL of Amazon

PLUGIN_AMAZON_XML URI for the Amazon product info query

Note

Check the copyright issues at the Amazon affiliate program site.

The default image is used when an image is not available in Amazon. By default, image/noimage.jpg is used.

ASIN is identical to ISBN for books. For other products, check the image name at the Amazon's page. For example, the ASIN is B000002G6J.01. If you use B000002G6J, it becomes "no image" because the default value, 09, is used unless you also display the title.)

http://images-jp.amazon.com/images/P/B000002G6J.01.LZZZZZZZ.jpg

aname

Plugin type

Inline type

Block type

Importance

****

Synopsis

&aname(anchor_name
[,{[super],
[full],
[noid]}]){anchor_string};

#aname(anchor_name
[,{[super],
[full],
[noid]},anchor_string])

Description

Creates an anchor which can be used by a link.

Parameters

The anchor_name is used as a URL fragment idetifier. It can't be omitted. The anchor name must consist of alphabets (uppercase/lowercase).

super,full,noid defines how the anchor is displayed.

super - The anchor string is displayed as superscript. By default, the anchor string is displayed as a normal string.

full - The anchor is displayed with the full URL. By default, only the fragment identifier is displayed.

noid - The fragment identifier is not displayed.

If the anchor_string is specified, the anchor is set for that string, so that the existence of the anchor is visible to users. By default, the anchor is set with an empty string.

PLUGIN_ANAME_ID_MUST_UNIQUE - Produces an error if there is a duplicated anchor name.

Note

Normally, this plugin should be used as the inline type. It can be used as a block-type plugin if you want to set the anchor between two block-type plugins.

Since PukiWiki internally uses the aname plugin, it must always exist.

article

Plugin type

(Command type)

Block type

Importance

***

Synopsis

#article

Description

Displays a simple BBS

Constants

PLUGIN_ARTICLE_COLS - the number of columns in the text area

PLUGIN_ARTICLE_ROWS - the number of lines in the text area

PLUGIN_ARTICLE_NAME_COLS - the number of columns in the name area

PLUGIN_ARTICLE_SUBJECT_COLS - the number of columns in the title area

PLUGIN_ARTICLE_NAME_FORMAT - name format

PLUGIN_ARTICLE_SUBJECT_FORMAT - title format

PLUGIN_ARTICLE_INS - whether the post is displayed before or after the input area

PLUGIN_ARTICLE_COMMENT - whether to allow single-line comments after the post

PLUGIN_ARTICLE_AUTO_BR - whether to automatically convert line breaks

PLUGIN_ARTICLE_MAIL_AUTO_SEND - whether to automatically forward a post by email

PLUGIN_ARTICLE_MAIL_FROM - the sender email address used to forward a post

PLUGIN_ARTICLE_MAIL_SUBJECT_PREFIX - the title of the email used to forward a post

$_plugin_article_mailto - the recipient email address used to forward a post

attach

Plugin type

(Command type)

Block type

Importance

*****

Synopsis

#attach(
[nolist]
[,noform])

Description

Displays the list of the files attached on the page, and the file upload form.

Parameters

nolist, noform - parameters to specify the display format

nolist - Hide the list of the file attachments. The default is to display the list.

noform - Hide the upload form. The default is to display the form.

Constants

PLUGIN_ATTACH_MAX_FILESIZE - The maximum file size that can be uploaded

PLUGIN_ATTACH_UPLOAD_ADMIN_ONLY - Whether to restrict file uploads to the administrator only

PLUGIN_ATTACH_DELETE_ADMIN_ONLY - Whether to restrict file deletion to the administrator only

PLUGIN_ATTACH_DELETE_ADMIN_NOBACKUP - Whether to omit backup when PLUGIN_ATTACH_DELETE_ADMIN_ONLY is enabled

PLUGIN_ATTACH_PASSWORD_REQUIRE Whether to allow a user to set a password for deleting the uploaded file (PLUGIN_ATTACH_*_ADMIN_ONLY has a priority)

PLUGIN_ATTACH_FILE_MODE - the file permission mode for uploaded files

PLUGIN_ATTACH_FILE_ICON - the icon image file

PLUGIN_ATTACH_CONFIG_PAGE_MIME - the page describing the mime-type for downloading files

Note

This plugin is necessary for using the default skin, as it is used in the "upload" menu

If you increase the value of PLUGIN_ATTACH_MAX_FILESIZE, remember also to change the settings related to the upload size outside of PukiWiki, such as upload_max_filesize in php.ini, and LimitRequestBody in Apache.

B

back

Plugin type

Block type

Importance

*

Synopsis

#back(
[[string]
[,[left|center|right]
[,[0|1]
[,[back_link]
]]]])

Description

Displays a link to go back to the previous page or to the specified location

Parameters

string - the link string to be displayed. The default is 'Back'.

left, center, right - the alignment of the link. The default is center.

left - Left-alignment of the link

center - Centering of the link

right - Right-alighment of the link

0, 1 - Whether to display the horizontal rule. The default is 1.

0 - Do not display the horizontal rule

1 - Display the horizontal rule

Back_link - The URL or PageName displayed as alink. The PageName, or an anchor in the form of 'PageName#anchor', can be used only if PLUGIN_BACK_ALLOW_PAGELINK is set to TRUE. If PLUGIN_BACK_ALLOW_JAVASCRIPT is set to TRUE, this parameter can be omitted and the link to go back to the previous page is displayed (the link works only if JavaScript is enabled on a browser).

Constants

PLUGIN_BACK_ALLOW_PAGELINK - Whether to allow the PageName (+ anchor) in the Back_link parameter

PLUGIN_BACK_ALLOW_JAVASCRIPT - Whether to use JavaScript(history.go(-1)) as the back link

PLUGIN_BACK_USAGE - Usage string is displayed upon errors

backup

Plugin type

Command type

Importance

*****

Synopsis

?cmd=backup
[&page=PageName]

Description

Display the list of backup pages for the specified page or for the entire Wiki.

Parameters

If PageName is omitted, the list of the backup pages for the whole PukiWiki. The PageName must be URL-encoded.

Constants

PLUGIN_BACKUP_DISABLE_BACKUP_RENDERING - Whether to disable the functionality of displaying the backup data.

br

Plugin type

Block type

Inline type

Importance

**

Synopsis

#br

&br;

Description

Breaks the current line.

This is used to insert a line break or an empty line, when placing '~' at the end of the line can terminate the block element in certain places like a paragraph, a list, and a table.

bugtrack

Displays an input form for bug reports, as a part of the bug tracking system.

Parameters

PageName is the parent page of the page used as a bug report. The current page is used if this parameter is omitted. By default, the pages for each bug report are created under this page. For example, if PageName is "BugReportPage", the bug reports are created as "BugReportPage/1", "BugReportPage/2", "BugReportPage/3", etc.

Category is the element used as the target of the bug. The default is the input form.

Constants

PLUGIN_BUGTRACK_NUMBER_FORMAT - The format of the page numbers created as bug reports

Note

This plugin is very useful in a website for software development. If you want to create a form which creates pages in a specified format for other purposes, the tracker plugin can be used.

bugtrack_list

Plugin type

Block type

Importance

* (for generic websites)

**** (for websites for software development)

Synopsis

#bugtrack_list(
[PageName])

Description

Displays the list of bug reports, as a part of the bug tracking system.

Parameters

PageName is the parent page of the page used as a bug report. The current page is used if this parameter is omitted.

Note

The bugtrack_list plugin is usually used with the bugtrack plugin.

Since it internally calls the bugtrack plugin, the bugtrack plugin must be installed.

The bugtrack_list plugin has fewer functionalities than the tracker_list plugin, but it is faster and requires less memory. The difference becomes clearer as the number of pages increases. It is important to determine which plugin should be used.

C

calendar, calendar_edit, calendar_read

Plugin type

Block type

Importance

*

Synopsis

#calendar(
[{[PageName],
[year_month]}])

#calendar_edit(
[{[PageName],
[year_month]}])

#calendar_read(
[{[PageName],
[year_month]}])

Description

Display a calander. By selecting the date (yyyy/mm/dd) on the calendar, the page named "PageName/yyyymmdd" can be displayed and edited.

The difference of these three plugins is whether the date page is shown in the edit mode or the display mode; The calendar_edit plugin shows the page in edit mode, while the calendar plugin and the calendar_read plugin shows the page in display mode.

Parameters

PageName - the top page of the calender.
If the page name is omitted, the current page is used.

year_month is the year and month to be displayed. It must be specified in the yyyymm format. The current year and month is used if thie parameter is omitted.

Note

Since we have the calendar2 plugin, which has more functionalities, there is no specific reason to use the calendar plugin anymore.

The calendar is necessary for the calendar_edit plugin and the calendar_read plugin, as it is internally called by them.

calendar_viewer

Display the content of the pages created by the calendar plugin or the calendar2 plugin

Parameters

PageName - the name of the page in which the calendar plugin or the calendar2 is placed.

yyyy-mm - the year and the month to be displayed

n - the number of pages to be displayed

x*y - display y pages starting from the page x (the first page is 0).

this - display the pages for this month

past, future, view - select the pages to be displayed. The default is past.

past - Display the past pages including today

future - Display the future pages including today

view - Display all pages

separator_char is the separator of year, month and day, such as '-' and '/'. The default is '-'.

Constants

PLUGIN_CALENDAR_VIEWER_USAGE - the usage message displayed upon an error

PLUGIN_CALENDAR_VIEWER_DATE_FORMAT - date format

Note

The calendar2 plugin displays the content of the entry for today only. The calendar_viewer plugin was created to extend this feature. For example, while the entry disappears when the date changes in the calendar2 plugin, the calendar_viewer plugin can still displays the latest entry. Therefore, a suggested usage is to use the calendar_viewer plugin together calender2(off).

calendar2

Plugin type

(Command type)

Block type

Importance

***

Synopsis

#calendar2(
[{[PageName|*],
[yyyymm],
[off]}])

Description

Display a calendar. It can show the links (<< and >>) to go to the next/previous months. If the date yyyy/mm/dd is clicked on the calandar, the plugin displays the page named 'PageName/yyyy-mm-dd'. If today's entry exists, the content is displayed next to the calendar.

Parameters

PageName - the parent page of the calendar entries. The default is the page in which the plugin is placed. If the page name is *, the calendar entries do not have the parent page (i.e., the page names are yyyy-mm-dd).

yyyymm - the year and month to be displayed. The default is the current year and month.

off - do not display the content of today's entry. The default is to display the content of today's entry.

Note

The calender2 plugin creates the pages named PageName/yyyy-mm-dd, while the calender_edit plugin creates the pages named PageName/yyyymmdd.

clear

Plugin type

Block type

Importance

*

Synopsis

#clear

Description

Disable text wraparound which was set by the around option of the ref plugin.

nodate - do not display date and time the comment is entered (the default is to display date and time)

noname - do not display the name form (the default is to display the form for entering the name)

Constants

PLUGIN_COMMENT_DIRECTION_DEFAULT - the default location of the comments (above the input form or below the form)

PLUGIN_COMMENT_SIZE_MSG - the width of the comment input form

PLUGIN_COMMENT_SIZE_NAME - the width of the name input form

PLUGIN_COMMENT_FORMAT_MSG - the format of the comment

PLUGIN_COMMENT_FORMAT_NAME - the format of the name

PLUGIN_COMMENT_FORMAT_NOW - the format of the date and time

PLUGIN_COMMENT_FORMAT_STRING - the format of the entire comment

contents

Plugin type

Pseudo-block type

Importance

***

Synopsis

#contents

Description

Display the list of the title of the pages

counter

Plugin type

Block type

Inline type

Importance

***

Synopsis

#counter

&counter(
[total|today|yesterday]);

Description

Display the counter to show the number of visitors to the page

Parameters

The parameter (total, today or yesterday) specified the type of the counter. The default is total. If the plugin is used as the block type, 'total' is used.

total - the total (cumulative) number of visitors

today - the number of visitors of today

yesterday - the number of visitors of yesterday

Constants

PLUGIN_COUNTER_SUFFIX - the suffix of the files storing the number of visitors

Note

To display the number of visitor to all pages, use the counter plugin in the ManuBar or the skin.

D

deleted

Plugin type

Command type

Importance

**

Synopsis

?plugin=deleted
{[&dir=diff|backup]
[&file=on]}

Description

Display the list of the deleted pages

Parameters

If file=on is specified, it displays the file names for backups (or diffs). The default is not to display them.

The dir parameter specified how to find deleted pages. The default is backup.

backup - find the pages that do not exist but have backups.

diff - find the pages that do not exist but have diffs.

Note

This plugin is useful for an administrator to check erroneous or malicious page deletions.

diff

Plugin type

Command type

Importance

*****

Synopsis

?cmd=diff&page=PageName

Description

Display the difference of the current and the previous content of the specified page.

Parameters

PageName - the page name to display the diff. It must be URL-encoded.

Note

Use the backup plugin to display the diffs with other than the last backup.

dump

Plugin type

Command type

Importance

*

Synopsis

?plugin=dump

Description

Backup and restore the files in the specified directory with the tar (tar.gz, tgz) format.

The administrator password is required to execute backup/restore.

The backup can be retrieved by converting the file name used to a page name.
If this conversion is used, the file cannot be used for restore, but
it becomes easier to guess the page name from the file name.

Backup can be performed on any directory.

Since restore just overwrites existing files, it can't delete files.

The directories for backup/restore can be specified are one of the following:

DATA_DIR (wiki/*.txt)

UPLOAD_DIR (attach/*)

BACKUP_DIR (backup/*)

Constants

PLUGIN_DUMP_ALLOW_RESTORE - Whether to allow restore

PLUGIN_DUMP_FILENAME_ENCORDING - Character encoding used to convert the page name to the directory structure