![[PukiWiki]](image/pukiwiki-dev.png "[PukiWiki]")
Command type
*
Display an empty edit screen, and when the Update button is clicked, append the new content at the end of the current content.
PageName must not be omitted. It must be URL encoded.
While edit displays the current content in the edit screen, add always displays an empty screen. This is useful for an append-only page, as the existing content is not changed unexpectedly.
In the old versions, this plugin used to be called the default skin from the "append" menu of the MenuBar. It is no longer in the MenuBar, as the edit command is more convenient.
(Command type)
Inline type
Block type
*
&amazon( ASIN );
#amazon
#amazon(, clear )
#amazon( ASIN, [left|right], [Title|image|delimage|deltitle|delete] )
Displays the producet name and image in Amazon (http://www.amazon.co.jp ).
It supports Amazon's affiliate program, and it can display the fixed-format reviews.
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.
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
Inline type
Block type
****
&aname( anchor_name [,{[super], [full], [noid]}] ){ anchor_string };
#aname( anchor_name [,{[super], [full], [noid]}, anchor_string] )
Creates an anchor which can be used by a link.
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.
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.
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.
(Command type)
Block type
***
Displays a simple BBS
(Command type)
Block type
*****
Displays the list of the files attached on the page, and the file upload form.
nolist, noform - parameters to specify the display format
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.
Block type
*
Displays a link to go back to the previous page or to the specified location
string - the link string to be displayed. The default is 'Back'.
left, center, right - the alignment of the link. The default is center.
0, 1 - Whether to display the horizontal rule. The default is 1.
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).
Command type
*****
Display the list of backup pages for the specified page or for the entire Wiki.
If PageName is omitted, the list of the backup pages for the whole PukiWiki. The PageName must be URL-encoded.
Block type
Inline type
**
#br
&br;
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.
(Command type)
Block type
* (for generic websites)
**** (for websites for software development)
Displays an input form for bug reports, as a part of the bug tracking system.
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.
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.
Block type
* (for generic websites)
**** (for websites for software development)
Displays the list of bug reports, as a part of the bug tracking system.
PageName is the parent page of the page used as a bug report. The current page is used if this parameter is omitted.
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.
Block type
*
#calendar( [{[PageName], [year_month]}] )
#calendar_edit( [{[PageName], [year_month]}] )
#calendar_read( [{[PageName], [year_month]}] )
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.
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.
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.
(Command type)
Block type
***
Display the content of the pages created by the calendar plugin or the calendar2 plugin
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.
separator_char is the separator of year, month and day, such as '-' and '/'. The default is '-'.
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).
(Command type)
Block type
***
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.
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.
The calender2 plugin creates the pages named PageName/yyyy-mm-dd, while the calender_edit plugin creates the pages named PageName/yyyymmdd.
Block type
*
Disable text wraparound which was set by the around option of the ref plugin.
It does the same thing as the clear option of the img plugin.
Inline type
****
&color( [text_color] [,background_color] ){ text };
Display given texts (or inline elements) with the specified text color and background color.
text_color and background_color are either color names (e.g., red, blue), 3-letter hex color code (#000-#FFF), or 6-letter hex color code (#000000-#FFFFFF). The color names and color codes are case-insensitive.
At least one of text_color and background_color must be specified. The text/background colors are not changed if the corresponding parameter is omitted.
Below are selected color names defined in W3C Recommendation: 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"
(Command type)
Block type
*****
Display a form for entering comments
The parameters specify how the comments are displayed
Pseudo-block type
***
#contents
Display the list of the title of the pages
Block type
Inline type
***
#counter
&counter( [total| today| yesterday] );
Display the counter to show the number of visitors to the page
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.
To display the number of visitor to all pages, use the counter plugin in the ManuBar or the skin.
Command type
**
Display the list of the deleted pages
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.
This plugin is useful for an administrator to check erroneous or malicious page deletions.
Command type
*****
Display the difference of the current and the previous content of the specified page.
PageName - the page name to display the diff. It must be URL-encoded.
Use the backup plugin to display the diffs with other than the last backup.
Command type
*
?plugin=dump
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:
Since this plugin directly accesses the files which PukiWiki internally uses, it must be used carefully to avoid security problems.
If the DATA_DIR is restored, call the links plugin to update the cache for page links.
| Site admin: PukiWiki Development Team PukiWiki 1.5.4+ © 2001-2022 PukiWiki Development Team. Powered by PHP 8.2.12. HTML convert time: 0.723 sec. |
|