:CategoryDev/Document/Plugins/A-D
をテンプレートにして作成
[
トップ
] [
新規
|
一覧
|
検索
|
最終更新
|
ヘルプ
|
ログイン
]
開始行:
#nofollow
#norelated
#navi(../)
#contents
------------------------------
* A [#w8de4799]
**add [#vef8f18f]
:Plugin type|
~Command type
:Importance|
~*
:Synopsis|
''?cmd=add''
&color(blue){&page=PageName};
:Description|
~Display an empty edit screen, and when the Update button...
:Parameters|
~PageName must not be omitted. It must be URL encoded.
~While [[edit>../E-G#i1e8d3e8]] displays the current cont...
:Note|
~In the old versions, this plugin used to be called the d...
**amazon [#v7173e39]
:Plugin type|
~(Command type)
~Inline type
~Block type
:Importance|
~*
:Synopsis|
~''&amazon(''
&color(blue){ASIN};
'');''
~''#amazon''
~''#amazon('',
&color(blue){clear};
'')''
~''#amazon(''
&color(blue){ASIN};,
[&color(blue){left};|&color(blue){right};],
[&color(blue){Title};|&color(blue){image};|&color(blue){d...
'')''
:Description|
~Displays the producet name and image in Amazon (http://w...
~It supports Amazon's affiliate program, and it can displ...
:Parameters|
~If no options are given, the plugin displays a review in...
~The options left,right, and clear specify the output for...
--left|right － Alignment of the output. The default valu...
--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 t...
--image － Displays the image only. By default, both the ...
:|delimage,deltitle, and delete options controls the cache.
--delimage － Delete the corresponding image cache.
--deltitle － Delete the corresponding title cache.
--delete － Delete both the image cache and the title cac...
:Constants|
--PLUGIN_AMAZON_AID Amazon affiliate ID (anonymous user ...
--PLUGIN_AMAZON_EXPIRE_IMAGECACHE expire Valid period of ...
--PLUGIN_AMAZON_EXPIRE_TITLECACHE expire Valid period of ...
--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 progr...
~The default image is used when an image is not available...
~ASIN is identical to ISBN for books. For other products,...
http://images-jp.amazon.com/images/P/B000002G6J.01.LZZZZ...
**aname [#n9f7bab5]
:Plugin type|
~Inline type
~Block type
:Importance|
~****
:Synopsis|
~''&aname(''
&color(blue){'''anchor_name'''};
[,{[&color(blue){super};],
[&color(blue){full};],
[&color(blue){noid};]}]
''){''
&color(blue){'''anchor_string'''};
''};''
~''#aname(''
&color(blue){'''anchor_name'''};
[,{[&color(blue){super};],
[&color(blue){full};],
[&color(blue){noid};]},
&color(blue){'''anchor_string'''};]
'')''
:Description|
~Creates an anchor which can be used by a link.
:Parameters|
~The '''anchor_name''' is used as a URL fragment idetifie...
~super,full,noid defines how the anchor is displayed.
--super － The anchor string is displayed as superscript....
--full － The anchor is displayed with the full URL. By d...
--noid － The fragment identifier is not displayed.
:|~If the '''anchor_string''' is specified, the anchor is...
:Constants|~
--PLUGIN_ANAME_ID_MAX - The maximum length of the anchor ...
--PLUGIN_ANAME_ID_REGEX - The regular expression that def...
--PLUGIN_ANAME_ID_MUST_UNIQUE - Produces an error if ther...
:Note|
~Normally, this plugin should be used as the inline type....
~Since PukiWiki internally uses the aname plugin, it must...
**article [#a06a7f60]
: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...
--PLUGIN_ARTICLE_ROWS - the number of lines in the text a...
--PLUGIN_ARTICLE_NAME_COLS - the number of columns in the...
--PLUGIN_ARTICLE_SUBJECT_COLS - the number of columns in ...
--PLUGIN_ARTICLE_NAME_FORMAT - name format
--PLUGIN_ARTICLE_SUBJECT_FORMAT - title format
--PLUGIN_ARTICLE_INS - whether the post is displayed befo...
--PLUGIN_ARTICLE_COMMENT - whether to allow single-line c...
--PLUGIN_ARTICLE_AUTO_BR - whether to automatically conve...
--PLUGIN_ARTICLE_MAIL_AUTO_SEND - whether to automaticall...
--PLUGIN_ARTICLE_MAIL_FROM - the sender email address use...
--PLUGIN_ARTICLE_MAIL_SUBJECT_PREFIX - the title of the e...
--$_plugin_article_mailto - the recipient email address u...
**attach [#qe43bebc]
:Plugin type|
~ (Command type)
~Block type
:Importance|
~*****
:Synopsis|
''#attach(''
[&color(blue){nolist};]
[,&color(blue){noform};]
'')''
:Description|
~Displays the list of the files attached on the page, and...
:Parameters|
~nolist, noform - parameters to specify the display format
--nolist － Hide the list of the file attachments. The de...
--noform － Hide the upload form. The default is to displ...
:Constants|~
--PLUGIN_ATTACH_MAX_FILESIZE - The maximum file size that...
--PLUGIN_ATTACH_UPLOAD_ADMIN_ONLY - Whether to restrict f...
--PLUGIN_ATTACH_DELETE_ADMIN_ONLY - Whether to restrict f...
--PLUGIN_ATTACH_DELETE_ADMIN_NOBACKUP - Whether to omit b...
--PLUGIN_ATTACH_PASSWORD_REQUIRE Whether to allow a user ...
--PLUGIN_ATTACH_FILE_MODE - the file permission mode for ...
--PLUGIN_ATTACH_FILE_ICON - the icon image file
--PLUGIN_ATTACH_CONFIG_PAGE_MIME - the page describing th...
:Note|
~This plugin is necessary for using the default skin, as ...
~If you increase the value of PLUGIN_ATTACH_MAX_FILESIZE,...
------------------------------
* B [#v07e2c1a]
**back [#vd9cd7ec]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
''#back(''
[[&color(blue){'''string'''};]
[,[&color(blue){left};|
&color(blue){center};|
&color(blue){right};]
[,[&color(blue){0};|
&color(blue){1};]
[,[&color(blue){'''back_link'''};]
]]]]
'')''
:Description|
~Displays a link to go back to the previous page or to th...
:Parameters|
~'''string''' - the link string to be displayed. The defa...
~left, center, right - the alignment of the link. The def...
--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 def...
--0 － Do not display the horizontal rule
--1 － Display the horizontal rule
:|~'''Back_link''' - The URL or PageName displayed as ali...
:Constants|~
--PLUGIN_BACK_ALLOW_PAGELINK - Whether to allow the PageN...
--PLUGIN_BACK_ALLOW_JAVASCRIPT - Whether to use JavaScrip...
--PLUGIN_BACK_USAGE - Usage string is displayed upon errors
**backup [#n727318e]
:Plugin type|
~Command type
:Importance|
~*****
:Synopsis|
''?cmd=backup''
[&color(blue){&page='''PageName'''};]
:Description|
~Display the list of backup pages for the specified page ...
:Parameters|
~If '''PageName''' is omitted, the list of the backup pag...
:Constants|~
--PLUGIN_BACKUP_DISABLE_BACKUP_RENDERING - Whether to dis...
**br [#g693034c]
: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, wh...
:Constants|~
--PLUGIN_BR_ESCAPE_BLOCKQUOTE - avoid creating unmatched ...
--PLUGIN_BR_TAG - the tag that is displayed by the br plu...
**bugtrack [#a83293e8]
:Plugin type|
~ (Command type)
~Block type
:Importance|
~* (for generic websites)
~**** (for websites for software development)
:Synopsis|
''#bugtrack(''
[[&color(blue){'''PageName'''};]
[&color(blue){,'''Category_1...Category_n'''};]]
'')''
:Description|
~Displays an input form for bug reports, as a part of the...
:Parameters|
~'''PageName''' is the parent page of the page used as a ...
~'''Category''' is the element used as the target of the ...
:Constants|~
--PLUGIN_BUGTRACK_NUMBER_FORMAT - The format of the page ...
:Note|
~This plugin is very useful in a website for software dev...
**bugtrack_list [#q557ea11]
:Plugin type|
~Block type
:Importance|
~* (for generic websites)
~**** (for websites for software development)
:Synopsis|
''#bugtrack_list(''
[&color(blue){'''PageName'''};]
'')''
:Description|
~Displays the list of bug reports, as a part of the bug t...
:Parameters|
~'''PageName''' is the parent page of the page used as a ...
:Note|
~The bugtrack_list plugin is usually used with the bugtra...
~Since it internally calls the bugtrack plugin, the bugtr...
~The bugtrack_list plugin has fewer functionalities than ...
------------------------------
* C [#y43dfe74]
**calendar、calendar_edit、calendar_read [#v5a54211]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
~''#calendar(''
[{[&color(blue){'''PageName'''};],
[&color(blue){'''year_month'''};]}]
'')''
~''#calendar_edit(''
[{[&color(blue){'''PageName'''};],
[&color(blue){'''year_month'''};]}]
'')''
~''#calendar_read(''
[{[&color(blue){'''PageName'''};],
[&color(blue){'''year_month'''};]}]
'')''
:Description|
~Display a calander. By selecting the date (yyyy/mm/dd) o...
~The difference of these three plugins is whether the dat...
: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. ...
:Note|
~Since we have the calendar2 plugin, which has more funct...
~The calendar is necessary for the calendar_edit plugin a...
**calendar_viewer [#nd7dc5b8]
:Plugin type|
~ (Command type)
~Block type
:Importance|
~***
:Synopsis|
''#calendar_viewer(''
&color(blue){'''PageName'''};,
&color(blue){yyyy-mm};|
&color(blue){n};|
&color(blue){x*y};|
&color(blue){this};
[,[&color(blue){past};|&color(blue){future};|&color(blue)...
[,&color(blue){'''separator_char'''};]]
'')''
:Description|
~Display the content of the pages created by the calendar...
:Parameters|
~'''PageName''' - the name of the page in which the calen...
~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 firs...
~this - display the pages for this month
~past、future、view - select the pages to be displayed. T...
--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 a...
:Constants|~
--PLUGIN_CALENDAR_VIEWER_USAGE - the usage message displa...
--PLUGIN_CALENDAR_VIEWER_DATE_FORMAT - date format
:Note|
~The calendar2 plugin displays the content of the entry f...
**calendar2 [#afda2820]
:Plugin type|
~ (Command type)
~Block type
:Importance|
~***
:Synopsis|
''#calendar2(''
[{[&color(blue){'''PageName'''};|&color(blue){*};],
[&color(blue){yyyymm};],
[&color(blue){off};]}]
'')''
:Description|
~Display a calendar. It can show the links (<< and >>) to...
:Parameters|
~'''PageName''' - the parent page of the calendar entries...
~yyyymm - the year and month to be displayed. The default...
~off - do not display the content of today's entry. The d...
:Note|
~The calender2 plugin creates the pages named PageName/yy...
**clear [#v515085f]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
''#clear''
:Description|
~Disable text wraparound which was set by the around opti...
:Note|
~It does the same thing as the clear option of the img pl...
**color [#q9790b97]
:Plugin type|
~Inline type
:Importance|
~****
:Synopsis|
~''&color(''
[&color(blue){'''text_color'''};]
[,&color(blue){'''background_color'''};]
''){''
&color(blue){'''text'''};
''};''
:Description|
~Display given texts (or inline elements) with the specif...
:Parameters|
~'''text_color''' and '''background_color''' are either c...
~At least one of '''text_color''' and '''background_color...
:Constants|~
--PLUGIN_COLOR_ALLOW_CSS - use CSS instead of the font ta...
--PLUGIN_COLOR_USAGE - display usage message upon error
--PLUGIN_COLOR_REGEX - the regular expression defining th...
:Note|
~Below are selected color names defined in [[W3C Recommen...
Aqua = "#00FFFF",
Black = "#000000",
Blue = "#0000FF",
Fuchsia = "#FF00FF",
Gray = "#808080",
Green = "#008000",
Lime = "#00FF00",
Maroon = "#800000",
Navy = "#000080",
Olive = "#808000",
Purple = "#800080",
Red = "#FF0000",
Silver = "#C0C0C0",
Teal = "#008080",
White = "#FFFFFF",
Yellow = "#FFFF00"
**comment [#kc065cd8]
:Plugin type|
~ (Command type)
~Block type
:Importance|
~*****
:Synopsis|
''#comment(''
{[&color(blue){above};],
[&color(blue){below};],
[&color(blue){nodate};],
[&color(blue){noname};]}
'')''
:Description|
~Display a form for entering comments
:Parameters|
~The parameters specify how the comments are displayed
--above － comments are displayed above the input form (t...
--below － comments are displayed below the input form
--nodate － do not display date and time the comment is e...
--noname － do not display the name form (the default is ...
:Constants|~
--PLUGIN_COMMENT_DIRECTION_DEFAULT - the default location...
--PLUGIN_COMMENT_SIZE_MSG - the width of the comment inpu...
--PLUGIN_COMMENT_SIZE_NAME - the width of the name input ...
--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 ...
--PLUGIN_COMMENT_FORMAT_STRING - the format of the entire...
**contents [#vd4dabcd]
:Plugin type|
~Pseudo-block type
:Importance|
~***
:Synopsis|
~''#contents''
:Description|
~Display the list of the title of the pages
**counter [#zedb02cf]
:Plugin type|
~Block type
~Inline type
:Importance|
~***
:Synopsis|
~''#counter''
~''&counter(''
[&color(blue){total};|
&color(blue){today};|
&color(blue){yesterday};]
'');''
:Description|
~Display the counter to show the number of visitors to th...
:Parameters|
~The parameter (total, today or yesterday) specified the ...
--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...
:Note|
~To display the number of visitor to all pages, use the c...
------------------------------
* D [#bfe38652]
**deleted [#kf08f93d]
:Plugin type|
~Command type
:Importance|
~**
:Synopsis|
''?plugin=deleted''
{[&color(blue){&dir=diff};|
&color(blue){backup};]
[&color(blue){&file=on};]}
:Description|
~Display the list of the deleted pages
:Parameters|
~If file=on is specified, it displays the file names for ...
~The dir parameter specified how to find deleted pages. T...
--backup － find the pages that do not exist but have bac...
--diff － find the pages that do not exist but have diffs.
:Note|
~This plugin is useful for an administrator to check erro...
**diff [#zabff312]
:Plugin type|
~Command type
:Importance|
~*****
:Synopsis|
''?cmd=diff''
&color(blue){&page='''PageName'''};
:Description|
~Display the difference of the current and the previous c...
:Parameters|
~'''PageName''' - the page name to display the diff. It m...
:Note|
~Use the backup plugin to display the diffs with other th...
**dump [#k344e979]
:Plugin type|
~Command type
:Importance|
~*
:Synopsis|
~''?plugin=dump''
:Description|
~Backup and restore the files in the specified directory ...
The administrator password is required to execute backup/...
The backup can be retrieved by converting the file name u...
If this conversion is used, the file cannot be used for r...
it becomes easier to guess the page name from the file na...
Backup can be performed on any directory.~
Since restore just overwrites existing files, it can't de...
The directories for backup/restore can be specified are o...
--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 use...
--PLUGIN_DUMP_MAX_FILESIZE - the maximum file size (in Kb...
--PLUGIN_DUMP_DUMP - the plugin parameters used for backup
--PLUGIN_DUMP_RESTORE - the plugin parameters used for re...
:Note|
~Since this plugin directly accesses the files which Puki...
it must be used carefully to avoid security problems.
~If the DATA_DIR is restored, call the [[links>../L-N#m5b...
#navi(../)
終了行:
#nofollow
#norelated
#navi(../)
#contents
------------------------------
* A [#w8de4799]
**add [#vef8f18f]
:Plugin type|
~Command type
:Importance|
~*
:Synopsis|
''?cmd=add''
&color(blue){&page=PageName};
:Description|
~Display an empty edit screen, and when the Update button...
:Parameters|
~PageName must not be omitted. It must be URL encoded.
~While [[edit>../E-G#i1e8d3e8]] displays the current cont...
:Note|
~In the old versions, this plugin used to be called the d...
**amazon [#v7173e39]
:Plugin type|
~(Command type)
~Inline type
~Block type
:Importance|
~*
:Synopsis|
~''&amazon(''
&color(blue){ASIN};
'');''
~''#amazon''
~''#amazon('',
&color(blue){clear};
'')''
~''#amazon(''
&color(blue){ASIN};,
[&color(blue){left};|&color(blue){right};],
[&color(blue){Title};|&color(blue){image};|&color(blue){d...
'')''
:Description|
~Displays the producet name and image in Amazon (http://w...
~It supports Amazon's affiliate program, and it can displ...
:Parameters|
~If no options are given, the plugin displays a review in...
~The options left,right, and clear specify the output for...
--left|right － Alignment of the output. The default valu...
--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 t...
--image － Displays the image only. By default, both the ...
:|delimage,deltitle, and delete options controls the cache.
--delimage － Delete the corresponding image cache.
--deltitle － Delete the corresponding title cache.
--delete － Delete both the image cache and the title cac...
:Constants|
--PLUGIN_AMAZON_AID Amazon affiliate ID (anonymous user ...
--PLUGIN_AMAZON_EXPIRE_IMAGECACHE expire Valid period of ...
--PLUGIN_AMAZON_EXPIRE_TITLECACHE expire Valid period of ...
--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 progr...
~The default image is used when an image is not available...
~ASIN is identical to ISBN for books. For other products,...
http://images-jp.amazon.com/images/P/B000002G6J.01.LZZZZ...
**aname [#n9f7bab5]
:Plugin type|
~Inline type
~Block type
:Importance|
~****
:Synopsis|
~''&aname(''
&color(blue){'''anchor_name'''};
[,{[&color(blue){super};],
[&color(blue){full};],
[&color(blue){noid};]}]
''){''
&color(blue){'''anchor_string'''};
''};''
~''#aname(''
&color(blue){'''anchor_name'''};
[,{[&color(blue){super};],
[&color(blue){full};],
[&color(blue){noid};]},
&color(blue){'''anchor_string'''};]
'')''
:Description|
~Creates an anchor which can be used by a link.
:Parameters|
~The '''anchor_name''' is used as a URL fragment idetifie...
~super,full,noid defines how the anchor is displayed.
--super － The anchor string is displayed as superscript....
--full － The anchor is displayed with the full URL. By d...
--noid － The fragment identifier is not displayed.
:|~If the '''anchor_string''' is specified, the anchor is...
:Constants|~
--PLUGIN_ANAME_ID_MAX - The maximum length of the anchor ...
--PLUGIN_ANAME_ID_REGEX - The regular expression that def...
--PLUGIN_ANAME_ID_MUST_UNIQUE - Produces an error if ther...
:Note|
~Normally, this plugin should be used as the inline type....
~Since PukiWiki internally uses the aname plugin, it must...
**article [#a06a7f60]
: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...
--PLUGIN_ARTICLE_ROWS - the number of lines in the text a...
--PLUGIN_ARTICLE_NAME_COLS - the number of columns in the...
--PLUGIN_ARTICLE_SUBJECT_COLS - the number of columns in ...
--PLUGIN_ARTICLE_NAME_FORMAT - name format
--PLUGIN_ARTICLE_SUBJECT_FORMAT - title format
--PLUGIN_ARTICLE_INS - whether the post is displayed befo...
--PLUGIN_ARTICLE_COMMENT - whether to allow single-line c...
--PLUGIN_ARTICLE_AUTO_BR - whether to automatically conve...
--PLUGIN_ARTICLE_MAIL_AUTO_SEND - whether to automaticall...
--PLUGIN_ARTICLE_MAIL_FROM - the sender email address use...
--PLUGIN_ARTICLE_MAIL_SUBJECT_PREFIX - the title of the e...
--$_plugin_article_mailto - the recipient email address u...
**attach [#qe43bebc]
:Plugin type|
~ (Command type)
~Block type
:Importance|
~*****
:Synopsis|
''#attach(''
[&color(blue){nolist};]
[,&color(blue){noform};]
'')''
:Description|
~Displays the list of the files attached on the page, and...
:Parameters|
~nolist, noform - parameters to specify the display format
--nolist － Hide the list of the file attachments. The de...
--noform － Hide the upload form. The default is to displ...
:Constants|~
--PLUGIN_ATTACH_MAX_FILESIZE - The maximum file size that...
--PLUGIN_ATTACH_UPLOAD_ADMIN_ONLY - Whether to restrict f...
--PLUGIN_ATTACH_DELETE_ADMIN_ONLY - Whether to restrict f...
--PLUGIN_ATTACH_DELETE_ADMIN_NOBACKUP - Whether to omit b...
--PLUGIN_ATTACH_PASSWORD_REQUIRE Whether to allow a user ...
--PLUGIN_ATTACH_FILE_MODE - the file permission mode for ...
--PLUGIN_ATTACH_FILE_ICON - the icon image file
--PLUGIN_ATTACH_CONFIG_PAGE_MIME - the page describing th...
:Note|
~This plugin is necessary for using the default skin, as ...
~If you increase the value of PLUGIN_ATTACH_MAX_FILESIZE,...
------------------------------
* B [#v07e2c1a]
**back [#vd9cd7ec]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
''#back(''
[[&color(blue){'''string'''};]
[,[&color(blue){left};|
&color(blue){center};|
&color(blue){right};]
[,[&color(blue){0};|
&color(blue){1};]
[,[&color(blue){'''back_link'''};]
]]]]
'')''
:Description|
~Displays a link to go back to the previous page or to th...
:Parameters|
~'''string''' - the link string to be displayed. The defa...
~left, center, right - the alignment of the link. The def...
--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 def...
--0 － Do not display the horizontal rule
--1 － Display the horizontal rule
:|~'''Back_link''' - The URL or PageName displayed as ali...
:Constants|~
--PLUGIN_BACK_ALLOW_PAGELINK - Whether to allow the PageN...
--PLUGIN_BACK_ALLOW_JAVASCRIPT - Whether to use JavaScrip...
--PLUGIN_BACK_USAGE - Usage string is displayed upon errors
**backup [#n727318e]
:Plugin type|
~Command type
:Importance|
~*****
:Synopsis|
''?cmd=backup''
[&color(blue){&page='''PageName'''};]
:Description|
~Display the list of backup pages for the specified page ...
:Parameters|
~If '''PageName''' is omitted, the list of the backup pag...
:Constants|~
--PLUGIN_BACKUP_DISABLE_BACKUP_RENDERING - Whether to dis...
**br [#g693034c]
: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, wh...
:Constants|~
--PLUGIN_BR_ESCAPE_BLOCKQUOTE - avoid creating unmatched ...
--PLUGIN_BR_TAG - the tag that is displayed by the br plu...
**bugtrack [#a83293e8]
:Plugin type|
~ (Command type)
~Block type
:Importance|
~* (for generic websites)
~**** (for websites for software development)
:Synopsis|
''#bugtrack(''
[[&color(blue){'''PageName'''};]
[&color(blue){,'''Category_1...Category_n'''};]]
'')''
:Description|
~Displays an input form for bug reports, as a part of the...
:Parameters|
~'''PageName''' is the parent page of the page used as a ...
~'''Category''' is the element used as the target of the ...
:Constants|~
--PLUGIN_BUGTRACK_NUMBER_FORMAT - The format of the page ...
:Note|
~This plugin is very useful in a website for software dev...
**bugtrack_list [#q557ea11]
:Plugin type|
~Block type
:Importance|
~* (for generic websites)
~**** (for websites for software development)
:Synopsis|
''#bugtrack_list(''
[&color(blue){'''PageName'''};]
'')''
:Description|
~Displays the list of bug reports, as a part of the bug t...
:Parameters|
~'''PageName''' is the parent page of the page used as a ...
:Note|
~The bugtrack_list plugin is usually used with the bugtra...
~Since it internally calls the bugtrack plugin, the bugtr...
~The bugtrack_list plugin has fewer functionalities than ...
------------------------------
* C [#y43dfe74]
**calendar、calendar_edit、calendar_read [#v5a54211]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
~''#calendar(''
[{[&color(blue){'''PageName'''};],
[&color(blue){'''year_month'''};]}]
'')''
~''#calendar_edit(''
[{[&color(blue){'''PageName'''};],
[&color(blue){'''year_month'''};]}]
'')''
~''#calendar_read(''
[{[&color(blue){'''PageName'''};],
[&color(blue){'''year_month'''};]}]
'')''
:Description|
~Display a calander. By selecting the date (yyyy/mm/dd) o...
~The difference of these three plugins is whether the dat...
: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. ...
:Note|
~Since we have the calendar2 plugin, which has more funct...
~The calendar is necessary for the calendar_edit plugin a...
**calendar_viewer [#nd7dc5b8]
:Plugin type|
~ (Command type)
~Block type
:Importance|
~***
:Synopsis|
''#calendar_viewer(''
&color(blue){'''PageName'''};,
&color(blue){yyyy-mm};|
&color(blue){n};|
&color(blue){x*y};|
&color(blue){this};
[,[&color(blue){past};|&color(blue){future};|&color(blue)...
[,&color(blue){'''separator_char'''};]]
'')''
:Description|
~Display the content of the pages created by the calendar...
:Parameters|
~'''PageName''' - the name of the page in which the calen...
~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 firs...
~this - display the pages for this month
~past、future、view - select the pages to be displayed. T...
--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 a...
:Constants|~
--PLUGIN_CALENDAR_VIEWER_USAGE - the usage message displa...
--PLUGIN_CALENDAR_VIEWER_DATE_FORMAT - date format
:Note|
~The calendar2 plugin displays the content of the entry f...
**calendar2 [#afda2820]
:Plugin type|
~ (Command type)
~Block type
:Importance|
~***
:Synopsis|
''#calendar2(''
[{[&color(blue){'''PageName'''};|&color(blue){*};],
[&color(blue){yyyymm};],
[&color(blue){off};]}]
'')''
:Description|
~Display a calendar. It can show the links (<< and >>) to...
:Parameters|
~'''PageName''' - the parent page of the calendar entries...
~yyyymm - the year and month to be displayed. The default...
~off - do not display the content of today's entry. The d...
:Note|
~The calender2 plugin creates the pages named PageName/yy...
**clear [#v515085f]
:Plugin type|
~Block type
:Importance|
~*
:Synopsis|
''#clear''
:Description|
~Disable text wraparound which was set by the around opti...
:Note|
~It does the same thing as the clear option of the img pl...
**color [#q9790b97]
:Plugin type|
~Inline type
:Importance|
~****
:Synopsis|
~''&color(''
[&color(blue){'''text_color'''};]
[,&color(blue){'''background_color'''};]
''){''
&color(blue){'''text'''};
''};''
:Description|
~Display given texts (or inline elements) with the specif...
:Parameters|
~'''text_color''' and '''background_color''' are either c...
~At least one of '''text_color''' and '''background_color...
:Constants|~
--PLUGIN_COLOR_ALLOW_CSS - use CSS instead of the font ta...
--PLUGIN_COLOR_USAGE - display usage message upon error
--PLUGIN_COLOR_REGEX - the regular expression defining th...
:Note|
~Below are selected color names defined in [[W3C Recommen...
Aqua = "#00FFFF",
Black = "#000000",
Blue = "#0000FF",
Fuchsia = "#FF00FF",
Gray = "#808080",
Green = "#008000",
Lime = "#00FF00",
Maroon = "#800000",
Navy = "#000080",
Olive = "#808000",
Purple = "#800080",
Red = "#FF0000",
Silver = "#C0C0C0",
Teal = "#008080",
White = "#FFFFFF",
Yellow = "#FFFF00"
**comment [#kc065cd8]
:Plugin type|
~ (Command type)
~Block type
:Importance|
~*****
:Synopsis|
''#comment(''
{[&color(blue){above};],
[&color(blue){below};],
[&color(blue){nodate};],
[&color(blue){noname};]}
'')''
:Description|
~Display a form for entering comments
:Parameters|
~The parameters specify how the comments are displayed
--above － comments are displayed above the input form (t...
--below － comments are displayed below the input form
--nodate － do not display date and time the comment is e...
--noname － do not display the name form (the default is ...
:Constants|~
--PLUGIN_COMMENT_DIRECTION_DEFAULT - the default location...
--PLUGIN_COMMENT_SIZE_MSG - the width of the comment inpu...
--PLUGIN_COMMENT_SIZE_NAME - the width of the name input ...
--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 ...
--PLUGIN_COMMENT_FORMAT_STRING - the format of the entire...
**contents [#vd4dabcd]
:Plugin type|
~Pseudo-block type
:Importance|
~***
:Synopsis|
~''#contents''
:Description|
~Display the list of the title of the pages
**counter [#zedb02cf]
:Plugin type|
~Block type
~Inline type
:Importance|
~***
:Synopsis|
~''#counter''
~''&counter(''
[&color(blue){total};|
&color(blue){today};|
&color(blue){yesterday};]
'');''
:Description|
~Display the counter to show the number of visitors to th...
:Parameters|
~The parameter (total, today or yesterday) specified the ...
--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...
:Note|
~To display the number of visitor to all pages, use the c...
------------------------------
* D [#bfe38652]
**deleted [#kf08f93d]
:Plugin type|
~Command type
:Importance|
~**
:Synopsis|
''?plugin=deleted''
{[&color(blue){&dir=diff};|
&color(blue){backup};]
[&color(blue){&file=on};]}
:Description|
~Display the list of the deleted pages
:Parameters|
~If file=on is specified, it displays the file names for ...
~The dir parameter specified how to find deleted pages. T...
--backup － find the pages that do not exist but have bac...
--diff － find the pages that do not exist but have diffs.
:Note|
~This plugin is useful for an administrator to check erro...
**diff [#zabff312]
:Plugin type|
~Command type
:Importance|
~*****
:Synopsis|
''?cmd=diff''
&color(blue){&page='''PageName'''};
:Description|
~Display the difference of the current and the previous c...
:Parameters|
~'''PageName''' - the page name to display the diff. It m...
:Note|
~Use the backup plugin to display the diffs with other th...
**dump [#k344e979]
:Plugin type|
~Command type
:Importance|
~*
:Synopsis|
~''?plugin=dump''
:Description|
~Backup and restore the files in the specified directory ...
The administrator password is required to execute backup/...
The backup can be retrieved by converting the file name u...
If this conversion is used, the file cannot be used for r...
it becomes easier to guess the page name from the file na...
Backup can be performed on any directory.~
Since restore just overwrites existing files, it can't de...
The directories for backup/restore can be specified are o...
--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 use...
--PLUGIN_DUMP_MAX_FILESIZE - the maximum file size (in Kb...
--PLUGIN_DUMP_DUMP - the plugin parameters used for backup
--PLUGIN_DUMP_RESTORE - the plugin parameters used for re...
:Note|
~Since this plugin directly accesses the files which Puki...
it must be used carefully to avoid security problems.
~If the DATA_DIR is restored, call the [[links>../L-N#m5b...
#navi(../)
ページ名:
![[PukiWiki]](image/pukiwiki-dev.png "[PukiWiki]")
