:CategoryDev/Document/Plugins/S-U
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
検索
|
最終更新
|
ヘルプ
|
ログイン
]
開始行:
//1.4.6
#nofollow
#norelated
#navi(../)
#contents
------------------------------
* S [#mee1bd43]
**search [#ba94ddfd]
:Plugin type|
~Command type
~Block type
:Importance|
~*****
:Synopsis|
''?cmd=search''{
[&color(blue){&word='''search_string'''};]
[&color(blue){&type=OR};]
}
~''#search''
:Description|
~Display a query form for searching the pages containing ...
:Parameters|
~The parameters control the search conditions
--word - the search string is specified by '''search_stri...
--type － If 'OR' is specified, OR search (querying the p...
:Constants|~
--PLUGIN_SEARCH_DISABLE_GET_ACCESS - deny the query with ...
--PLUGIN_SEARCH_MAX_LENGTH - the maximum length of the se...
**server [#d69aa1d0]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
''#server''
:Description|
~Display the server information (server name, server soft...
**setlinebreak [#va79297e]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
''#setlinebreak(''
[&color(blue){on};|&color(blue){off};|&color(blue){defaul...
'')''
:Description|
~Determine whether the line breaks in input texts are dis...
~The default behavior of PukiWiki with line breaks in inp...
|Texts|$line_break=0;|$line_break=1;|h
|Text_1&br;Text_2|Text_1 Text_2|Text_1&br;Text_2|
~The setlinebreak plugin changes this $line_break setting...
:Parameters|
~The parameter sets the the treatment of line breaks.
If the parameters is omitted, the plugin toggles the curr...
--on - Display the line breaks in the subsquent texts as ...
--off － Ignore the line breaks in the subsquent texts ($...
To explicitly make line breaks, write a tilde at the end ...
--default - Set the line break setting to the default (i....
**showrss [#v7316017]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
''#showrss(''
&color(blue){'''RSS_location'''};
[,[&color(blue){default};|&color(blue){menubar};|&color(b...
[,[&color(blue){'''cache_timeout'''};]
[,&color(blue){1};
]]]
'')''
:Description|
~Obtain an RSS feed and display it on the page
~By default, this plugin tries to obtain an RSS feed ever...
:Parameters|
~'''RSS_location''' - the file path or the URL of the RSS...
~The template parameter determines the display format of ...
--default - simple list of pages
--menubar － display a bullet before the page name (usefu...
--recent － display the timestamp of the pages name like ...
:|
~'''cache_timeout''' - the cache expiration time (in hour...
~The last parameter determines whether the plugin display...
:Note|
~This plugin requires the xml extension of PHP.
**size [#e5db48c0]
:Plugin type|
~Inline type
:Importance|
~***
:Synopsis|
''&size(''
&color(blue){'''fontsize'''};
''){''
&color(blue){'''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 par...
**source [#k23d3e24]
:Plugin type|
~Command type
:Importance|
~*
:Synopsis|
''?cmd=source''
&color(blue){&page='''PageName'''};
:Description|
~Display the source texts of the specified page
:Parameters|
~'''PageName''' - the page name of which the source texts...
**stationary [#ifad4486]
:Plugin type|
~Command type
~Block type
~Inline type
:Importance|
~*
:Synopsis|
~''?plugin=stationary''
~''#stationary''
~''&stationary;''
:Description|
~The stationary plugin is a template created for develope...
It does not do anything other than displaying a simple te...
:Constants|~
--PLUGIN_STATIONARY_MAX - the sample to show how the cons...
------------------------------
* T [#u58dc027]
**tb [#s5056787]
:Plugin type|
~Command type
:Importance|
~*
:Synopsis|
''?plugin=tb''
&color(blue){&tb_id=TrackBackID};
&color(blue){&__mode=};
&color(blue){view};|
&color(blue){rss};
:Description|
~Display the list of the trackbacks
~It can respond to the trackback from other sites when ca...
: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 m...
**template [#j2adfc3d]
:Plugin type|
~Command type
:Importance|
~****
:Synopsis|
''?plugin=template''
&color(blue){&refer='''TemplatePage'''};
:Description|
~Create a new page using an existing page as template.
~This is similar to the function of 'creating a new page'...
:Parameters|
~'''TemplatePage''' - The page used as a template. It mus...
:Constants|~
--MAX_LEN - The maximum length of the templated (displaye...
**topicpath [#vd55c067]
: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 pa...
[[Top>FrontPage]]/[[PukiWiki>PukiWiki]]/[[Tour>PukiWiki/...
~The intended uses of this plugin are as follows.
++ Help page transition between the pages with more than ...
++ Display the topic path instead of the URL shown below ...
:Constants|~
--PLUGIN_TOPICPATH_TOP_DISPLAY - whether to display the l...
--PLUGIN_TOPICPATH_TOP_LABEL - the label for $defaultpage
--PLUGIN_TOPICPATH_TOP_SEPARATOR - the level separator
--PLUGIN_TOPICPATH_THIS_PAGE_DISPLAY - whether to display...
--PLUGIN_TOPICPATH_THIS_PAGE_LINK whether to link to the ...
:Note|
~If this plugin is used in the skin, set SKIN_DEFAULT_DIS...
**touchgraph [#p93402bd]
:Plugin type|
~Command type
:Importance|
~*
:Synopsis|
''?plugin=touchgraph''
:Description|
~Create the index for the TouchGraphWikiBrowser
**tracker [#rf5296e2]
:Plugin type|
~(Command type)
~Block type
:Importance|
~****
:Synopsis|
~''#tracker(''
[&color(blue){'''TemplateName'''};]
[,&color(blue){BasePageName};]
'')''
:Description|
~Display an input form for creating stylized pages.
~Unlike the [[bugtrack>../A-D#a83293e8]] plugin, in which...
~The input fields can be defined by creating a template p...
:Parameters|
~'''TemplateName''' - the template template name (e.g., #...
~It is possible to specify the form name or the list name...
~'''BasePageName' - the top-level page created by the plu...
:Constants|~
--TRACKER_LIST_EXCLUDE_PATTERN - the regular expression t...
--TRACKER_LIST_SHOW_ERROR_PAGE - whether to display the p...
:Templates syntax|~
~For each tracker, the following 4 pages should be create...
--: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....
:Keywords|~
--The keywords that can be used in forms
---[_name] : display a field to enter the page name to st...
---[_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 ...
---[_name] : the value of the [_name] in the form. This i...
---[_real] : The generated page name exluding [_refer] + ...
(1) the form does not contain a [_name] field~
(2) [_name] is empty, or it contains an invalid character...
(2) the page named [_refer] / [_name] already exists~
--The keywords that can be used in lists
---[_update] : last update date of the page
---[_past] : time since the last update date
**tracker_list [#t78d6d0a]
:Plugin type|
~(Command type)
~Block type
:Importance|
~****
:Synopsis|
''#tracker_list(''
[&color(blue){'''TemplateName'''};]
[,[&color(blue){'''BasePageName'''};]
[,[[&color(blue){'''sort_item'''};]
:[&color(blue){'''sort_order'''};]]
[,&color(blue){'''max_pages'''};]
]]]
'')''
:Description|
~Display the list of pages created by the [[tracker>./#rf...
:Parameters|
~'''TemplateName''' - the template name used in the [[tra...
~'''BasePageName''' - the base page name used in the [[tr...
~The third parameter specifies the key item for sorting a...
~'''max_pages''' - maximum number of pages displayed on t...
------------------------------
* U [#q0183edd]
**unfreeze [#v039be15]
:Plugin type|
~Command type
:Importance|
~***
:Synopsis|
''?plugin=unfreeze''
&color(blue){&page='''PageName'''};
:Description|
~Unfreeze the page
:Parameters|
~'''PageName''' - the page name to be unfrozen. It must b...
:Constants|~
--PLUGIN_UNFREEZE_EDIT - whether to show the edit page wh...
**update_entities [#r62603ec]
: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 ent...
:Constants|~
--W3C_XHTML_DTD_LOCATION - the location of the DTD
:Note|
~This plugin is usually unnecessary, as the PukiWiki rele...
#navi(../)
終了行:
//1.4.6
#nofollow
#norelated
#navi(../)
#contents
------------------------------
* S [#mee1bd43]
**search [#ba94ddfd]
:Plugin type|
~Command type
~Block type
:Importance|
~*****
:Synopsis|
''?cmd=search''{
[&color(blue){&word='''search_string'''};]
[&color(blue){&type=OR};]
}
~''#search''
:Description|
~Display a query form for searching the pages containing ...
:Parameters|
~The parameters control the search conditions
--word - the search string is specified by '''search_stri...
--type － If 'OR' is specified, OR search (querying the p...
:Constants|~
--PLUGIN_SEARCH_DISABLE_GET_ACCESS - deny the query with ...
--PLUGIN_SEARCH_MAX_LENGTH - the maximum length of the se...
**server [#d69aa1d0]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
''#server''
:Description|
~Display the server information (server name, server soft...
**setlinebreak [#va79297e]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
''#setlinebreak(''
[&color(blue){on};|&color(blue){off};|&color(blue){defaul...
'')''
:Description|
~Determine whether the line breaks in input texts are dis...
~The default behavior of PukiWiki with line breaks in inp...
|Texts|$line_break=0;|$line_break=1;|h
|Text_1&br;Text_2|Text_1 Text_2|Text_1&br;Text_2|
~The setlinebreak plugin changes this $line_break setting...
:Parameters|
~The parameter sets the the treatment of line breaks.
If the parameters is omitted, the plugin toggles the curr...
--on - Display the line breaks in the subsquent texts as ...
--off － Ignore the line breaks in the subsquent texts ($...
To explicitly make line breaks, write a tilde at the end ...
--default - Set the line break setting to the default (i....
**showrss [#v7316017]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
''#showrss(''
&color(blue){'''RSS_location'''};
[,[&color(blue){default};|&color(blue){menubar};|&color(b...
[,[&color(blue){'''cache_timeout'''};]
[,&color(blue){1};
]]]
'')''
:Description|
~Obtain an RSS feed and display it on the page
~By default, this plugin tries to obtain an RSS feed ever...
:Parameters|
~'''RSS_location''' - the file path or the URL of the RSS...
~The template parameter determines the display format of ...
--default - simple list of pages
--menubar － display a bullet before the page name (usefu...
--recent － display the timestamp of the pages name like ...
:|
~'''cache_timeout''' - the cache expiration time (in hour...
~The last parameter determines whether the plugin display...
:Note|
~This plugin requires the xml extension of PHP.
**size [#e5db48c0]
:Plugin type|
~Inline type
:Importance|
~***
:Synopsis|
''&size(''
&color(blue){'''fontsize'''};
''){''
&color(blue){'''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 par...
**source [#k23d3e24]
:Plugin type|
~Command type
:Importance|
~*
:Synopsis|
''?cmd=source''
&color(blue){&page='''PageName'''};
:Description|
~Display the source texts of the specified page
:Parameters|
~'''PageName''' - the page name of which the source texts...
**stationary [#ifad4486]
:Plugin type|
~Command type
~Block type
~Inline type
:Importance|
~*
:Synopsis|
~''?plugin=stationary''
~''#stationary''
~''&stationary;''
:Description|
~The stationary plugin is a template created for develope...
It does not do anything other than displaying a simple te...
:Constants|~
--PLUGIN_STATIONARY_MAX - the sample to show how the cons...
------------------------------
* T [#u58dc027]
**tb [#s5056787]
:Plugin type|
~Command type
:Importance|
~*
:Synopsis|
''?plugin=tb''
&color(blue){&tb_id=TrackBackID};
&color(blue){&__mode=};
&color(blue){view};|
&color(blue){rss};
:Description|
~Display the list of the trackbacks
~It can respond to the trackback from other sites when ca...
: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 m...
**template [#j2adfc3d]
:Plugin type|
~Command type
:Importance|
~****
:Synopsis|
''?plugin=template''
&color(blue){&refer='''TemplatePage'''};
:Description|
~Create a new page using an existing page as template.
~This is similar to the function of 'creating a new page'...
:Parameters|
~'''TemplatePage''' - The page used as a template. It mus...
:Constants|~
--MAX_LEN - The maximum length of the templated (displaye...
**topicpath [#vd55c067]
: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 pa...
[[Top>FrontPage]]/[[PukiWiki>PukiWiki]]/[[Tour>PukiWiki/...
~The intended uses of this plugin are as follows.
++ Help page transition between the pages with more than ...
++ Display the topic path instead of the URL shown below ...
:Constants|~
--PLUGIN_TOPICPATH_TOP_DISPLAY - whether to display the l...
--PLUGIN_TOPICPATH_TOP_LABEL - the label for $defaultpage
--PLUGIN_TOPICPATH_TOP_SEPARATOR - the level separator
--PLUGIN_TOPICPATH_THIS_PAGE_DISPLAY - whether to display...
--PLUGIN_TOPICPATH_THIS_PAGE_LINK whether to link to the ...
:Note|
~If this plugin is used in the skin, set SKIN_DEFAULT_DIS...
**touchgraph [#p93402bd]
:Plugin type|
~Command type
:Importance|
~*
:Synopsis|
''?plugin=touchgraph''
:Description|
~Create the index for the TouchGraphWikiBrowser
**tracker [#rf5296e2]
:Plugin type|
~(Command type)
~Block type
:Importance|
~****
:Synopsis|
~''#tracker(''
[&color(blue){'''TemplateName'''};]
[,&color(blue){BasePageName};]
'')''
:Description|
~Display an input form for creating stylized pages.
~Unlike the [[bugtrack>../A-D#a83293e8]] plugin, in which...
~The input fields can be defined by creating a template p...
:Parameters|
~'''TemplateName''' - the template template name (e.g., #...
~It is possible to specify the form name or the list name...
~'''BasePageName' - the top-level page created by the plu...
:Constants|~
--TRACKER_LIST_EXCLUDE_PATTERN - the regular expression t...
--TRACKER_LIST_SHOW_ERROR_PAGE - whether to display the p...
:Templates syntax|~
~For each tracker, the following 4 pages should be create...
--: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....
:Keywords|~
--The keywords that can be used in forms
---[_name] : display a field to enter the page name to st...
---[_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 ...
---[_name] : the value of the [_name] in the form. This i...
---[_real] : The generated page name exluding [_refer] + ...
(1) the form does not contain a [_name] field~
(2) [_name] is empty, or it contains an invalid character...
(2) the page named [_refer] / [_name] already exists~
--The keywords that can be used in lists
---[_update] : last update date of the page
---[_past] : time since the last update date
**tracker_list [#t78d6d0a]
:Plugin type|
~(Command type)
~Block type
:Importance|
~****
:Synopsis|
''#tracker_list(''
[&color(blue){'''TemplateName'''};]
[,[&color(blue){'''BasePageName'''};]
[,[[&color(blue){'''sort_item'''};]
:[&color(blue){'''sort_order'''};]]
[,&color(blue){'''max_pages'''};]
]]]
'')''
:Description|
~Display the list of pages created by the [[tracker>./#rf...
:Parameters|
~'''TemplateName''' - the template name used in the [[tra...
~'''BasePageName''' - the base page name used in the [[tr...
~The third parameter specifies the key item for sorting a...
~'''max_pages''' - maximum number of pages displayed on t...
------------------------------
* U [#q0183edd]
**unfreeze [#v039be15]
:Plugin type|
~Command type
:Importance|
~***
:Synopsis|
''?plugin=unfreeze''
&color(blue){&page='''PageName'''};
:Description|
~Unfreeze the page
:Parameters|
~'''PageName''' - the page name to be unfrozen. It must b...
:Constants|~
--PLUGIN_UNFREEZE_EDIT - whether to show the edit page wh...
**update_entities [#r62603ec]
: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 ent...
:Constants|~
--W3C_XHTML_DTD_LOCATION - the location of the DTD
:Note|
~This plugin is usually unnecessary, as the PukiWiki rele...
#navi(../)
ページ名:
![[PukiWiki]](image/pukiwiki-dev.png "[PukiWiki]")
