Help/UnfoldSubpagesPlugin
The UnfoldSubpages
plugin is used to display all or some subpages
of the current or a given page. This gives an overview for a
Help:WikiBlogPlugin,
Help:CalendarPlugin or similar subpages.
Warning: Don't use it with subpages with nonexistent sections! The section extractor is currently quite unstable.
Usage
<<UnfoldSubpages>>
<<UnfoldSubpages sortby=-mtime words=50 maxpages=5>>
<<UnfoldSubpages quiet=1 smalltitle=1>>
<<UnfoldSubpages sections=2 words=100>>
<<UnfoldSubpages lines=3>>
<<UnfoldSubpages pagename="PhpWikiAdministration"
section="Plugin Arguments" sectionhead=1>>
Arguments
All
PageList arguments, plus the following ones:
Argument |
Description |
Default value |
|---|---|---|
pagename |
Any pagename or if empty the current page. |
empty |
quiet |
Print no header. |
false |
sortby |
Sort by + (ASC) or - (DESC) and one column. |
pagename |
maxpages |
Maximum number of pages to include or all if not defined. |
false |
sections |
Maximum number of sections per page to include or all if not defined. |
false |
section |
Include this named section per page only if defined. |
empty |
sectionhead |
When including a named section show the heading. |
false |
smalltitle |
If set, hide transclusion-title, just have a small link at the start of the page. |
false |
words |
Maximum number of words per page to include. |
false |
lines |
Maximum number of lines per page to include. |
false |
bytes |
Maximum number of bytes per page to include. |
false |
Deprecated Arguments
Argument |
Description |
|---|---|
pages |
Deprecated. Renamed to maxpages. |
sort |
'asc' or 'desc'. Deprecated: use "+" or "-" before the column name with sortby. |
Example
<<UnfoldSubpages pagename=Help maxpages=5 >>
Included from Help/WikiAdminRenamePlugin
The WikiAdminRename
plugin allows to rename pages.
Usage
<<WikiAdminRename arguments>>
Arguments
Argument |
Description |
Default value |
|---|---|---|
s |
Pages to select |
None |
updatelinks |
Change pagename in all linked pages also? |
false |
Example
<<WikiAdminRename s=Temp*>>
Author
See Also
Included from Help/text2pngPlugin
Convert text into a png image using GD without using
WikiPluginCached.
The images are stored in a private <PHPWIKI_DIR>/images/ subdirectory instead,
which are not timestamp checked at all. Delete the .png file(s) if you change anything.
This is a really simple and stupid plugin, which might need some work.
Usage
<<text2png text="some text">>
Arguments
Argument |
Description |
Default value |
|---|---|---|
text |
some text to display |
|
lang |
language subdirectory |
|
force |
set to 1 to recreate the image |
|
fontsize |
18. with GD1 it's the pixelsize, with GD2 the pointsize |
|
with_shadow |
1 |
|
fontcolor |
#000000 |
|
shadowcolor |
#AFAFAF |
|
backcolor |
#ffffff |
Configurable Options
See the sourcecode. You'd probably need to adjust $ttfont and text2png_debug.
Example
<<text2png text='Hello WikiWorld!'>>
See Also
Included from Help/IncludeTreePlugin
Display Dynamic Category Tree.
Usage
<<IncludeTree arguments>>
Arguments
Argument |
Description |
Default value |
|---|---|---|
exclude |
Comma-separated list of pages to exclude |
empty |
include_self |
Boolean. If true, include yourself in the results. |
false |
noheader |
Boolean. If true, header should be omitted. |
false |
page |
The page to start the include tree |
The current page |
description |
Override default description. Printed as header. |
Default description |
reclimit |
Max recursion depth. |
2 |
info |
Info to display in the table |
false |
direction |
Get BackLinks or forward links (links listed on the page) |
back |
firstreversed |
Boolean. If true, get BackLinks for the first page and forward links for the rest. Only applicable when direction = 'forward'. |
false |
excludeunknown |
Boolean. If true, then exclude any mentioned pages which don't exist yet. Only applicable when direction = 'forward'. |
true |
includepages |
words=100 |
|
category |
empty |
|
dtree |
true |
Example
<<IncludeTree>>
Author
See Also
Included from Help/UserRatingsPlugin
The UserRatings
plugin lists the user's ratings.
Usage
<<UserRatings arguments>>
Arguments
Argument |
Description |
Default value |
|---|---|---|
dimension |
0 |
|
userids |
Array of userids to display ratings for; null/empty for active user only |
null |
pageids |
Array of pageids to display ratings for; null for all of current active user's ratings |
null |
category |
a category to display ratings for; null for no category; has higher precedence than pageids |
null |
pagename |
||
exclude |
Pages to exclude (allows multiple pagenames exclude=HomePage,RecentChanges) |
none |
limit |
limit of <=0 is show-all |
0 |
noheader |
Boolean. If true, header should be omitted. |
false |
userPage |
Boolean. If true, we're on a user's homepage, get their ratings |
false |
nobuds |
Boolean. |
false |
info |
columns to display (hits, pagename, author, ratingwidget...) |
pagename |
Example
<<UserRatings>>
Author
- Dan Frankowski
See Also
Included from Help/GoogleLink
A new UserPreferences setting to optionally add a [G] link to unknown pages, with a link to Google:[pagename]. Default: Off
Included from Help/MagicPhpWikiURLs
About phpwiki: URLs
A special type of URL is available for making links to perform administrative and other special functions in PhpWiki. Here is a brief description of how they work.
The basic syntax of a phpwiki: URL is
phpwiki:pagename?query-args
If pagename is omitted it defaults to the current page.
Query-args should be a set of parameters in standard HTTP GET format.
The "action=x" parameter should almost always be given. It can be one of browse, diff, edit, viewsource, zip, dumpserial, loadserial, remove, lock, unlock, login, logout, setprefs or save. The default action is browse.
Some of the actions accept other parameters.
| FullTextSearch, TitleSearch | Accepts s=search term, and size=input size. |
| edit | Accepts version. |
| remove | Accepts verify. |
| save | Accepts editversion, minor_edit and content. |
| setprefs | Accepts edit_area_width and edit_area_height. |
Writing Magic Links in Wiki Pages
A magic link looks like:
[[ text | phpwiki-url ]]
The "text |" is optional but usually recommended. If given it will provide the label for the link.
The phpwiki-url is a phpwiki: URL as described above.
Some examples
[[phpwiki:SandBox?action=edit|Edit the SandBox]]
will generate a link which will take you directly to editing the SandBox, like so: Lock page to enable link.
Other possibilities:
- Diff the SandBox,
- Lock page to enable link,
- Lock page to enable link,
- Search for Page titles containing 'wiki'
Writing Magic Forms in Wiki Pages
Note: The old syntax for Magic forms is no longer supported. They are superseded by <?plugin-form>.
If the plugin is called using <?plugin-form instead of <?plugin and the plugin supports searching, then it will be rendered as a form.
| size | If given, specifies the size of the input area. |
| s | Specifies the default value for the input. |
Examples
A search plugin invoked with <?plugin instead of <?plugin-form simply inserts the search results of the plugin:
<<TitleSearch s=wiki noheader=true limit=10>>
Search results for Page titles containing 'wiki':
No matches
<?plugin-form FullTextSearch ?>
gives
While
<?plugin-form TitleSearch formsize=12 ?>
yields