• Included from Help/PhpWiki

    You are using PhpWiki at this very moment. Incredible, ain't it?

    Visit our home page at http://phpwiki.fr and see PhpWiki in action at http://phpwiki.fr (and of course here too :-)).

    Plugin IncludePage failed. Page “Help/WikiWikiWeb” does not exist.

    Included from Help/WikiForumPlugin

    Describe Help/WikiForumPlugin? here.

    Included from Help/WabiSabi

    Since wabi-sabi represents a comprehensive Japanese world view or aesthetic system, it is difficult to explain precisely in western terms. According to Leonard Koren, wabi-sabi is the most conspicuous and characteristic feature of what we think of as traditional Japanese beauty and it “occupies roughly the same position in the Japanese pantheon of aesthetic values as do the Greek ideals of beauty and perfection in the West.”

    “Wabi-sabi is a beauty of things imperfect, impermanent, and incomplete.”

    “It is the beauty of things modest and humble.”

    “It is the beauty of things unconventional.”

    (quoted from “WABI-SABI: FOR ARTISTS,DESIGNERS, POETS & PHILOSOPHERS,” 1994, Leonard Koren)

    The concepts of wabi-sabi correlate with the concepts of Zen Buddhism, as the first Japanese involved with wabi-sabi were tea masters, priests, and monks who practiced Zen. Zen Buddhism originated in India, traveled to China in the 6th century, and was first introduced in Japan around the 12th century. Zen emphasizes “direct, intuitive insight into transcendental truth beyond all intellectual conception.” At the core of wabi-sabi is the importance of transcending ways of looking and thinking about things/existence.

    • All things are impermanent
    • All things are imperfect
    • All things are incomplete

    (also taken from WABI-SABI: FOR ARTISTS,DESIGNERS, POETS & PHILOSOPHERS, 1994, Leonard Koren):

    Material characteristics of wabi-sabi:

    • suggestion of natural process
    • irregular
    • intimate
    • unpretentious
    • earthy
    • simple

    For more about wabi-sabi, see http://c2.com/cgi/wiki?WabiSabi.

    Included from Help/WikiForumPlugin

    Describe Help/WikiForumPlugin? here.

    Plugin IncludePage failed. Page “Help/AddingPages” does not exist.

    Included from Help/WikiForumPlugin

    Describe Help/WikiForumPlugin? here.

    Plugin IncludePage failed. Page “Help/GoodStyle” does not exist.

    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

    See MeatBall:GooglePrompt

    Included from Help/WikiForumPlugin

    Describe Help/WikiForumPlugin? here.

    Included from FindPage

    Here are some good starting points for browsing.

    Here's a title search. Try something like wiki or sandwich.

        case_exact regex 

    Use the following for a full text search. This takes a few seconds. The results will show all lines on a given page which contain a match.

        case_exact regex 

    In a fuzzy pages search the titles of all pages are examined to find those which are similarly spelled or similar sounding (english).


    Tips

    Separate words with a space. All words have to match as substrings.
    'OR', grouping with parenthesis, string-quoting and some glob-style wildcard characters are also supported.
    To exclude words from a title search or full text search, prepend a '-'.
    Use '^xx' or 'xx*' to match words starting with 'xx'.
    Use '*xx' or 'xx$' to match words ending with 'xx'.
    Use '^word$' to match exact words.
    Use regex=auto and 're:' like 're:word.*xx' or regex=posix to use posix regular expressions. (not yet)
    Use regex=auto and '//' like '/^word$/' or regex=pcre to match using perl-style regular expressions.
    Use regex=sql to match using SQL-style wildcards '%' and '_'.
    Use regex=none to match any wildcards verbatim.

    Example: 'wiki text -php' looks for all pages containing the words 'wiki' and 'text',

    but not containing the word 'php'.

    Plugin IncludePage failed. Page “Help/Images” does not exist.

    Included from Help/WikiForumPlugin

    Describe Help/WikiForumPlugin? here.

    Plugin IncludePage failed. Page “Help/Categories” does not exist.

    Included from Help/WikiForumPlugin

    Describe Help/WikiForumPlugin? here.

    Plugin IncludePage failed. Page “Help/LinkIcons” does not exist.

    Included from Help/WikiForumPlugin

    Describe Help/WikiForumPlugin? here.

    Included from Help/WikiPlugin

    A plugin is some PHP code that:

    • lives in phpwiki/lib/plugin/<pluginname>.php
    • implements the WikiPlugin interface by extending that class.

    There are many plugins already distributed with PhpWiki. Simply look in the lib/plugin directory or see the PluginManager list or see all the Help/*Plugin pages.

    To write your own, look at the Help:HelloWorldPlugin (HelloWorld.php in that directory), which is a minimal example of a plugin.

    A WikiPlugin allows one to easily add new types of dynamic content (as well as other functionality) to wiki pages within PhpWiki. In this very wiki all actions which are not entirely lowercased are implemented using plugins, and some lowercased convenience actions also. (rename, revert, setacl, diff, ...)

    Note that you can NOT extend the markup syntax with a plugin, as in other wiki engines.

    (The old-style MagicPhpWikiURLs have been replaced by plugins entirely.)

    Example

    Currently, one invokes a plugin by putting something like:

    <<AllPages limit=20 cols=3>>

    into a regular wiki-page. That particular example produces a list of the first 20 existing pages in 3 columns, via the PageList library.

    All pages in this wiki (824 total):

    |<<   << - 1 / 42 - Next >>   >>|

    Details

    Plugins can take certain named arguments, most do. The values of these arguments can be determined four different ways. In order of precedence:

    1. The plugin invocation can specify the value for an argument, like so:

      <?plugin BackLinks page=OtherPage ?>
    2. The argument can be specified via an HTTP query argument. This doesn't happen (is not allowed) unless the argument is mentioned in the plugin invocation:

      <?plugin BackLinks page ?>
    3. Default values specified in the plugin invocation:

      <?plugin BackLinks page||=OtherPage ?>
    4. The plugin must supply default values for each argument it uses. Such default args may be overriden by URL arguments like so:

        BackLinks?page=ThisPage&sortby=-mtime

      (The BackLinks plugin uses the current page as the default value for the page argument.)

      Most plugins using the PageList library inherit their default arguments from the PageList.

    Standard Arguments

    Most plugins display a list of pages, via the PageList library. PageList provides automatic support for those arguments.

    info, exclude, author, owner, creator, sortby, limit, paging, cols, azhead, comma, commasep, ordered

    For details see the PageList library documentation.

    exclude and pages accept a list of pages. Either as comma-separated list, supporting glob-style wildcards, or via the <!plugin-list pluginname [args] !> invocation syntax, where pluginname might be any plugin returning a PageList.

    Since most plugins return a PageList, this PageList is also a common input parameter for other plugins, actions or formats.

    Basic Plugin Types

    All these plugins derive from the WikiPlugin class extending the run method, which returns a object tree of HTML objects, and may react on any provided arguments from the WikiPage (see the args below) or optionally overridden by arguments from the url (GET or POST args), if defined via '||='.

    A basic plugin just needs the run() method, and optionally getName, getDescription, getDefaultArguments. See the Help:HelloWorldPlugin for a short introduction.

    plugin reacts on its arguments and the request and displays arbitrary HTML.

    plugin-form is used to display a input type=text box for the default argument s.

    plugin-list is used as argument to provide a dynamic list of pagenames.

      <?plugin PluginName [args...] ?>
      <?plugin-form PluginName [args...] ?>
      <?plugin PluginName args=<!plugin-list pluginname [args...] !> ?>

    The box Method

    Themes based on the "sidebar" theme may use the box method of any plugin, which displays a title and a condensed content in a box.

    WikiPluginCached

    Plugins deriving from the class WikiPluginCached must also define the methods getPluginType(), optionally getExpire(), managesValidators(), and dependent of the getPluginType the methods to display the possibly cached result.

    getImage(), getMap() or getHtml(),

    optionally also

    getAlt(), getImageType(), embedMap(), embedImg(), embedObject()

    See the config.ini PLUGIN_CACHED_* settings and WikiPluginCached

    Action Pages

    The term ActionPage refers to a page containing a plugin invocation with the same or translated pluginname as the pagename. An action is together with the pagename argument the basic PhpWiki argument. It can both be GET or POST actions. Actions are untranslated, always English, pagenames can be localized. Basic (and old) actions are all lowercase, like edit, browse, remove, ... Newer actions in CamelCase are invoked via plugins on their specific action page.

    We decoupled actions from plugins via action pages for the following reasons:

    1. Support translated action buttons and customizable action descriptions.
    2. Customize standard actions by tuning the plugin invocation arguments. Override or add plugin defaults.
    3. Split simple plugins into multiple actions, like RecentChanges/RecentEdits, MostPopular/LeastPopular, AllPages/AllPagesCreatedByMe/AllPagesLastEditedByMe/ AllPagesOwnedByMe which differ only in one argument.
    4. Simplify the syntax for actions on another actions using a PageList as result of an actionpage as input parameter for another action or format.
    • Those actions which have buttons or links in the theme or are referenced in the standard pgsrc pageset require their (possibly localized) actionpages, otherwise the actions will not work.
    • If the localized actionpage is not found the english version is used.
    • If no actionpage is found, it is recommended to do action=upgrade, which imports all missing and required action pages into the database.

    So for a hypothetical new MyActionPage plugin MyActionPage will invoke the plugin and Help:MyActionPagePlugin should be the description page.

    Existing Plugins

    See PluginManager for a detailed list. Most plugins should have their own description page as subpage of Help/ with the name Plugin appended.


    PhpWikiDocumentation

    Plugin IncludePage failed. Page “Help/MagicPhpWikiURLs” does not exist.Plugin IncludePage failed. Page “Help/MoreAboutMechanics” does not exist.

    Included from Help/WikiForumPlugin

    Describe Help/WikiForumPlugin? here.

    Plugin IncludePage failed. Page “Help/TextFormattingRules” does not exist.

    Included from Help/WikiForumPlugin

    Describe Help/WikiForumPlugin? here.

    Plugin IncludePage failed. Page “Help/SemanticRelations” does not exist.

    Included from Help/WikiForumPlugin

    Describe Help/WikiForumPlugin? here.

    Plugin IncludePage failed. Page “Help/PageList” does not exist.Plugin IncludePage failed. Page “Help/Advice for Mediawiki users” does not exist.

    Included from Help/ActionPage

    The term ActionPage refers to a page containing a plugin invocation with the same or translated pluginname as the pagename. An action is together with the pagename argument the basic PhpWiki argument. It can both be GET or POST actions. Actions are untranslated, always English, pagenames can be localized. Basic (and old) actions are all lowercase, like edit, browse, remove, ... Newer actions in CamelCase are invoked via plugins on their specific action page.

    We decoupled actions from plugins via action pages for the following reasons:

    1. Support translated action buttons and customizable action descriptions.
    2. Customize standard actions by tuning the plugin invocation arguments. Override or add plugin defaults.
    3. Split simple plugins into multiple actions, like RecentChanges/RecentEdits, MostPopular/LeastPopular, AllPages/AllPagesCreatedByMe/AllPagesLastEditedByMe/ AllPagesOwnedByMe which differ only in one argument.
    4. Simplify the syntax for actions on another actions using a PageList as result of an actionpage as input parameter for another action or format.
    • Those actions which have buttons or links in the theme or are referenced in the standard pgsrc pageset require their (possibly localized) actionpages, otherwise the actions will not work.
    • If the localized actionpage is not found the english version is used.
    • If no actionpage is found, it is recommended to do action=upgrade, which imports all missing and required action pages into the database.

    So for a hypothetical new MyActionPage plugin MyActionPage will invoke the plugin and Help:MyActionPagePlugin should be the description page.

    Existing Plugins

    See PluginManager for a detailed list. Most plugins should have their own description page as subpage of Help/ with the name Plugin appended. PhpWikiDocumentation

    Included from Help/AllPagesPlugin

    The AllPages plugin lists all pages in this wiki.

    Usage

    <<AllPages arguments>>

    Arguments

    All PageList arguments, plus the following ones:

    Argument

    Description

    Default value

    noheader

    Boolean. If true, header should be omitted.

    false

    include_empty

    Boolean. If true, pages that are referenced but not yet created are included in the list.

    false

    info

    none

    Example

    <<AllPages limit=20 cols=3>>

    All pages in this wiki (824 total):

    |<<   << - 1 / 42 - Next >>   >>|

    Author

    See Also

    Included from Help/AuthorHistoryPlugin

    The AuthorHistory plugin allows you to list the history of edits by a particular author; you can specify the page name as well (default is the current page).

    Usage

    <<AuthorHistory arguments>>

    Arguments

    Argument

    Description

    Default value

    exclude

    Pages to exclude

    none

    noheader

    Do not display page header

    false

    includeminor

    Include minor modifications

    false

    includedeleted

    Include deleted pages

    false

    author

    Display modification by this author

    Current user

    page

    Give a page name or "all"

    Current page

    info

    Info to display in the table

    version, minor, author, summary, mtime

    Examples

    <<AuthorHistory page=HomePage includeminor=1>>
    <<AuthorHistory page=all>>

    Included from Help/CalendarPlugin

    The Calendar plugin can be used to generate a monthly calendar in a wiki page. It's handy for personal wikis.

    Individual dates in the calendar link to specially named wiki pages. The names for the “day pages” are by default formed by appending the date to the pagename on which the calendar appears.

    Usage

    <<Calendar>>

    will get you:

    < June 2022 >
    Mon Tue Wed Thu Fri Sat Sun
     1   2   3   4   5 
     6   7   8   9   10   11   12 
     13   14   15   16   17   18   19 
     20   21   22   23   24   25   26 
     27   28   29   30 

    Arguments

    Argument

    Description

    Default value

    Selection of Month

    year

    Specify the year for the calendar.

    Current year

    month

    Specify the month for the calendar.

    Current month

    month_offset

    Added to month. Can be used to include several months worth of calendars on a single wiki page.

    0

    “Day Page” Names

    date_format

    strftime style format string used to generate page names for the “day pages.”

    The default value is %Y-%m-%d.

    prefix

    Prepended to the date (formatted per date_format) to generate the “day page” names.

    The default value is [pagename]/.

    Appearance

    month_format

    strftime style format string used to generate the title of the calendar.

    (Default: %B %Y.)

    wday_format

    strftime style format string used to generate the day-of-week names at the top of the calendar.

    start_wday

    What day of the week does the calendar start on. This should be specified as an integer in the range zero (Sunday) through six (Saturday), inclusive.

    Examples

    <<Calendar month_offset=+1>>

    will get you:

    < July 2022 >
    Mon Tue Wed Thu Fri Sat Sun
     1   2   3 
     4   5   6   7   8   9   10 
     11   12   13   14   15   16   17 
     18   19   20   21   22   23   24 
     25   26   27   28   29   30   31 
    <<Calendar start_wday=0>>

    will get you:

    < June 2022 >
    Sun Mon Tue Wed Thu Fri Sat
     1   2   3   4 
     5   6   7   8   9   10   11 
     12   13   14   15   16   17   18 
     19   20   21   22   23   24   25 
     26   27   28   29   30 

    See Also

    Often used together like this:

    <<Calendar>>
    <<CalendarList>>

    Authors

    This feature was inspired by Calendar, and first implemented by Gary Benson. It was later implemented as a plugin by Jeff Dairiki.

    Included from Help/CommentPlugin

    The Comment plugin lets you hide parts of a Wiki page without actually deleting the text. Comments will only be visible in the Wiki markup when editing or viewing the source.

    Usage

    Simply place the text to be commented out between <<Comment and >>:

    <<Comment
    
    == A Hidden Section ==
    
    This text will not show up in the generated HTML page, but it is still
    visible when editing the WikiMarkup.
    
    >>

    Author

    Included from Help/CreateBibPlugin

    The CreateBib plugin creates a BibTex file from linked pages.

    The page used in argument should contain a list of links to pages containing references in BibTex format.

    Usage

    <<CreateBib arguments>>

    Arguments

    Argument

    Description

    Default value

    pagename

    The page from which the BibTex file is generated

    None (required argument)

    Example

    <<CreateBib pagename="MyBib">>

    Author

    • Lea Viljanen

    See Also

    Included from Help/CreateTocPlugin

    The CreateToc plugin allows to create a dynamical Table of Contents of all headers. It also allows to number the headers in the page.

    The headers might be in classic Phpwiki syntax or in Wikicreole/Mediawiki syntax (see below).

    The Table of Contents can easily be inserted by clicking on the TOC button in the Edit toolbar.

    Usage

    <<CreateToc arguments>>

    Arguments

    Argument

    Description

    Default value

    extracollapse

    Provide a button to hide/display the Table of Contents

    true

    firstlevelstyle

    Style of first level numbering: number, letter or roman.

    number

    headers

    Which headers to include. See below.

    1,2,3,4,5

    indentstr

    Indent string.

    &nbsp;&nbsp;

    jshide

    Boolean if the Table of Contents should be initially hidden and on click expanded.

    false

    liststyle

    List style: dl or ol or ul. Using ol is equivalent to with_counter=1.

    dl

    noheader

    Boolean if the Table of Contents header should be omitted.

    false

    notoc

    Boolean if the Table of Contents should no be displayed (headers are numbered).

    false

    pagename

    Table of Contents of which page?

    current pagename

    position

    Where to display the Table of Contents: full, left or right.

    full

    version

    Page version

    most recent version

    width

    Width of Table of Contents (if position is left or right)

    200px

    with_counter

    Boolean if hierarchical prefixes should be added.

    false

    with_toclink

    Boolean if headers should link back to the Table of Contents.

    false

    Headers

    Syntax: a comma-separated list of levels. !!!,!!,! also allowed

    Level

    Phpwiki syntax

    Wikicreole/Mediawiki syntax

    HTML rendering

    1

    !!!

    ==

    h2

    2

    !!

    ===

    h3

    3

    !

    ====

    h4

    4

    None

    =====

    h5

    5

    None

    ======

    h6

    Examples

    Default values

    <<CreateToc>>

    Only two levels of headers

    <<CreateToc headers=1,2>>

    Table of Contents with hierarchical numbering

    <<CreateToc with_counter=1>>

    No Table of Contents, but headers are numbered

    <<CreateToc notoc=1>>

    Table of Contents with hierarchical numbering, first level in roman

    <<CreateToc with_counter=1 firstlevelstyle=roman>>

    See Also

    Known Problems

    • If you include pages via Template or IncludePage plugins, the Table of Contents will not contain the headers of the included pages.
    • The Table of Contents will be incorrect if a header contains:

      • a Template plugin call via {{ }},
      • an image,
      • or a ~.
    • If you preview the page, the Table of Contents will not be correct if you modified headers. The Table of Contents will be taken from the last saved revision.

    Included from Help/DeadEndPagesPlugin

    The DeadEndPages plugin returns a list of pages which are not linked to by any other page.

    It is simply an alias for OrphanedPages plugin.

    Included from Help/DebugAuthInfoPlugin

    Administrative plugin, used to debug auth problems and settings. This plugin is only for testing purposes. If DEBUG has no _DEBUG_LOGIN bit set, only the admin user can call it, which is of no real use.

    Warning! This may display DB and user passwords in cleartext. We think we cleared everything out though.

    Usage

    <<DebugAuthInfo userid||=AdminUser>>

    Arguments

    Argument

    Description

    Default value

    userid

    Id of user to debug

    Current user

    Example

    See DebugAuthInfo

    Authors

    See Also

    Included from Help/EditMetaDataPlugin

    The EditMetaData plugin allows you to add/edit/delete metadata key/value pairs for a given page. You must be logged in as the administrator to do this. The page's metadata contains things like the page hit count, last edit time and so on.

    <<AppendText argument>>

    Argument

    Argument

    Description

    Default value

    page

    Which page to edit

    Current page.

    Examples

    Editing the metadata for the HomePage would look like this:

    <<EditMetaData page="HomePage">>

    With no arguments the plugin defaults to the current page:

    <<EditMetaData>>

    Included from Help/ExternalSearchPlugin

    The ExternalSearch plugin creates a form to query InterWikis or other internet sites.

    Usage

    <<ExternalSearch
             url="InterWiki or URL"
             name="button text"
    >>

    Arguments

    Argument

    Description

    Default value

    url

    Specify a wiki from the InterWikiMap or a url. Any text entered by the user will be appended to the search url. The string placeholder '%s' can be used to insert a search query into the url rather than appending it.

    name

    Text to display in the submit button.

    For InterWiki sites the default is the wiki name, for other urls the default is the text “External Search”.

    formsize

    Specify the input area size.

    30 characters

    debug

    Don't really redirect to the external site, just print out the url that would be redirected to.

    Examples

      url="http://sunir.org/apps/meta.pl?"       name="Metawiki Search"
      url="http://www.usemod.com/cgi-bin/mb.pl?" name="MeatBall Search"
      url=php-lookup
      url=php-function
      url=PhpWiki

    Perform a full-text search on multiple wiki's:

    Perform a full-text search on MeatBall wiki:

    Search the PHP web site for a function name:

    Enter the name of a PHP function to view the documentation page:

    Enter any existing page name on PhpWiki to jump to that page:

    See Also

    Included from Help/FileInfoPlugin

    The FileInfo plugin displays the version, date, size, perms of an uploaded file. Only files relative and below to the uploads path can be handled.

    For exe files the version argument might work to display the VERSIONINFO ressource string. (highly experimental).

    Typical Usage

    <<FileInfo file=uploads/setup.exe display=version,date>>
    <<FileInfo file=uploads/setup.exe display=name,version,date
                                      format="%s (version: %s, date: %s)">>

    Arguments

    Argument

    Description

    Default value

    file

    Relative path from PHPWIKI_DIR.

    None (required argument)

    display

    Comma-separated string of version, size, phonysize, date, mtime, owner, name, path, dirname, link, mime-typ, magic.

    None (required argument)

    format

    printf format string with %s only, all display modes from above vars return strings

    (optional)

    quiet

    print no error if file not found

    false

    Examples

    This wiki was installed at 12/16/18 20:35:17.

    Included from Help/FullTextSearchPlugin

    The FullTextSearch plugin searches the content of all pages in this wiki.

    Usage

    <<FullTextSearch arguments>>

    Arguments

    All PageList arguments (except paganame), plus the following ones:

    Argument

    Description

    Default value

    s

    The search term

    none

    hilight

    Highlight results (boolean)

    true

    case_exact

    Search with case exact (boolean)

    false

    regex

    Type of regular expression used for searching

    auto

    sortby

    Sorting order for results

    -hi_content

    noheader

    Do not display header (boolean)

    false

    exclude

    Comma-separated list of glob to exclude

    false

    quiet

    Be less verbose (boolean)

    true

    Example

    <<FullTextSearch s=boolean>>

    Full text search results for “boolean”

    Help/SearchHighlightPlugin

    | boolean

    | boolean

    Help/AllPagesPlugin

    | Boolean. If true, header should be omitted.

    | Boolean. If true, pages that are referenced but not yet created are included in the list.

    Help/VideoPlugin

    | Auto play the video when page is displayed (boolean).

    Help/FullTextSearchPlugin

    | Highlight results (boolean)

    | Search with case exact (boolean)

    | Do not display header (boolean)

    | Be less verbose (boolean)

    <<FullTextSearch s=boolean>>

    Help/CreateTocPlugin

    | Boolean if the Table of Contents should be initially hidden and on click expanded.

    | Boolean if the Table of Contents header should be omitted.

    | Boolean if the Table of Contents should no be displayed (headers are numbered).

    | Boolean if hierarchical prefixes should be added.

    | Boolean if headers should link back to the Table of Contents.

    Hilfe/AutorenProtokollPlugin

    boolean. Vorgabe: false

    boolean. Vorgabe: false

    boolean. Vorgabe: false

    ReleaseNotes

    * added boolean UPLOAD_USERDIR to upload into user-specific directory.

    Author

    See Also

    Included from Help/GoToPlugin

    The GoTo plugin displays a form with text entry box and 'Go' button. The user enters a page name... if it exists, browse that page; if not, edit (create) that page.

    Note: pagenames are absolute, not relative to the actual subpage.

    Usage

    <<GoTo>>

    Arguments

    None.

    Example

    <<GoTo>>

    Authors

    See Also

    Included from Help/GooglePluginPlugin

    The GooglePlugin plugin is a wrapper for the Google Web APIs. It allows you to do Google searches, retrieve pages from the Google cache, and ask Google for spelling suggestions.

    Note: You must first obtain a license key at http://www.google.com/apis/

    Max 1000 queries per day.

    Usage

    <<GooglePlugin arguments>>

    Arguments

    Argument

    Description

    Default value

    q

    mode

    search, cache or spell

    search

    startIndex

    1

    maxResults

    10

    formsize

    30

    Example

    <<GooglePlugin>>

    Author

    See Also

    Included from Help/GraphVizPlugin

    The GraphViz plugin passes all its arguments to the graphviz dot binary and displays the result as cached image (PNG, GIF, SVG) or imagemap. See http://www.graphviz.org/Documentation.php, esp. http://www.graphviz.org/doc/info/lang.html for the dot language specs.

    Notes

    • We support all image types supported by GD so far, PNG most likely.
    • On imgtype = imap, cpamx, ismap, cmap an additional mapfile will be produced.

    Usage

    <<GraphViz [options...]
       multiline dot script ...
    >>

    Arguments

    Argument

    Description

    Default value

    imgtype

    Image type

    png

    alt

    Image alternate text

    pages

    <! plugin-list support !> encoded as pagename = [ URL = url ]

    exclude

    Exclude pages

    help

    Display argument help

    Example

    <<GraphViz
    digraph automata_0 {
            size ="8.5, 11";
            node  [ shape  = circle];
            0 [ style = filled, color=lightgrey ];
            2 [ shape = doublecircle ];
            0 -> 2 [ label = "a " ];
            0 -> 1 [ label = "other " ];
            1 -> 2 [ label = "a " ];
            1 -> 1 [ label = "other " ];
            2 -> 2 [ label = "a " ];
            2 -> 1 [ label = "other " ];
            "Machine: a" [ shape = plaintext ];
    }
    >>

    Author

    See Also

    • VisualWiki plugin, which depends on GraphViz and WikiPluginCached.

    Included from Help/HelloWorldPlugin

    A simple example plugin.

    Hello,, Wiki User?!

    From the source of this page:

    <<HelloWorld salutation="Hello," name="Wiki User" >>

    PhpWiki's plugin architecture allows you to add custom page elements to your wiki. All you have to do is extend (subclass) the WikiPlugin class and create your output via the run() method, dependent on the Wiki- or Request arguments,

    • either with the predefined HTML classes to create valid XHTML,
    • or by using templates, which are easier customizable, but generally more a mess to use and easier to create invalid XHTML.
    /**
     * A simple demonstration WikiPlugin.
     *
     * Usage:
     * <<HelloWorld> >
     * <<HelloWorld
     *          salutation="Greetings, "
     *          name=Wikimeister
     * > >
     * <<HelloWorld salutation=Hi > >
     * <<HelloWorld name=WabiSabi > >
     */

    // Constants are defined before the class.
    if (!defined('THE_END'))
        
    define('THE_END'"!");

    class 
    WikiPlugin_HelloWorld
    extends WikiPlugin
    {
        
    // Five required functions in a WikiPlugin.

        
    function getName () {
            return 
    _("HelloWorld");
        }

        function 
    getDescription () {
            return 
    _("Simple Sample Plugin");

        }

        
    // Establish default values for each of this plugin's arguments.
        
    function getDefaultArguments() {
            return array(
    'salutation' => "Hello,",
                         
    'name'       => "World");
        }

        function 
    run($dbi$argstr$request) {
            
    extract($this->getArgs($argstr$request));

            
    // Any text that is returned will not be further transformed,
            // so use html where necessary.
            
    $html HTML::samp(fmt('%s: %s'$salutationWikiLink($name'auto')),
                             
    THE_END);
            return 
    $html;
        }
    };

    Included from Help/IncludePagePlugin

    The IncludePage plugin will “include” other pages in this wiki. In the language of hypertext this is called transclusion.

    Usage

    <<IncludePage page=OtherPage rev=6 quiet=1 words=50 lines=6>>

    Arguments

    Argument

    Description

    Default value

    page

    The page to include

    None (required argument)

    rev

    the revision

    most recent revision

    quiet

    if set, inclusion appears as normal content

    false

    bytes

    maximum number of bytes to include

    None (include whole page)

    words

    maximum number of words to include

    None (include whole page)

    lines

    maximum number of lines to include

    None (include whole page)

    sections

    maximum number of sections to include

    None (include all sections)

    section

    include a named section

    None

    sectionhead

    when including a named section show the heading

    false

    Inclusion

    is stripped.

    .. is only expanded in included pages.

    Examples

    IncludePage page=Help/AllPagesPlugin

    Included from Help/AllPagesPlugin

    The AllPages plugin lists all pages in this wiki.

    Usage

    <<AllPages arguments>>

    Arguments

    All PageList arguments, plus the following ones:

    Argument

    Description

    Default value

    noheader

    Boolean. If true, header should be omitted.

    false

    include_empty

    Boolean. If true, pages that are referenced but not yet created are included in the list.

    false

    info

    none

    Example

    <<AllPages limit=20 cols=3>>

    All pages in this wiki (824 total):

    |<<   << - 1 / 42 - Next >>   >>|

    Author

    See Also

    IncludePage page=Help/AllPagesPlugin lines=6

    Included from Help/AllPagesPlugin

    The AllPages plugin lists all pages in this wiki.

    Usage

    <<AllPages arguments>>

    ... first 6 lines

    IncludePage page=Help/AllPagesPlugin section="Arguments"

    Included from Help/AllPagesPlugin

    All PageList arguments, plus the following ones:

    Argument

    Description

    Default value

    noheader

    Boolean. If true, header should be omitted.

    false

    include_empty

    Boolean. If true, pages that are referenced but not yet created are included in the list.

    false

    info

    none

    IncludePage page=Help/AllPagesPlugin section="Arguments" sectionhead=true

    Included from Help/AllPagesPlugin

    Arguments

    All PageList arguments, plus the following ones:

    Argument

    Description

    Default value

    noheader

    Boolean. If true, header should be omitted.

    false

    include_empty

    Boolean. If true, pages that are referenced but not yet created are included in the list.

    false

    info

    none

    IncludePage page=Help/AllPagesPlugin sections=2

    Does not work in Wikicreole syntax

    Known Problems

    • Line and word limit doesn't work if the included page itself includes a plugin.
    • "sections" parameter does not work if sections to include are in Wikicreole syntax.
    • "section" parameter does not always work if sections to include use both Wikicreole/Mediawiki and classic Phpwiki syntax.

    Authors

    • Joe Edelman
    • bug fixes by Reini Urban
    • "sections" parameter implemented by Marc-Etienne Vargenau, Alcatel-Lucent

    See Also

    Included from Help/IncludePagesPlugin

    The IncludePages plugin will "include" a list of multiple pages, based on IncludePage plugin.

    Usage

    <<IncludePages arguments >>

    Arguments

    All arguments from IncludePage plugin, plus the following ones:

    Argument

    Description

    Default value

    pages

    The pages to include

    none

    exclude

    The pages to exclude

    false

    Example

    <<IncludePages pages=<!plugin-list BackLinks !> >>

    Author

    See Also

    Included from Help/IncludeTreePlugin

    Display Dynamic Category Tree.

    Usage

    <<IncludeTree arguments>>

    Arguments

    Argument

    Description

    Default value

    exclude

    include_self

    0

    noheader

    0

    page

    The current page

    description

    Override default Description. Printed as header.

    reclimit

    2

    info

    false

    direction

    Get BackLinks or forward links (links listed on the page)

    back

    firstreversed

    If true, get BackLinks for the first page and forward links for the rest. Only applicable when direction = 'forward'.

    false

    excludeunknown

    If true (default) then exclude any mentioned pages which don't exist yet. Only applicable when direction = 'forward'.

    true

    dtree

    true

    Example

    <<IncludeTree>>

    Author

    See Also

    Included from Help/JabberPresencePlugin

    The JabberPresence plugin shows Jabber presence status.

    Usage

    <<JabberPresence arguments>>

    Arguments

    Argument

    Description

    Default value

    scripturl

    http://edgar.netflint.net/status.php

    jid

    type

    image

    iconset

    gabber

    Example

    <<JabberPresence scripturl=http://edgar.netflint.net/status.php
                     jid=yourid@jabberserver type=html iconset=phpbb >>

    Author

    • Arnaud Fontaine

    See Also

    Included from Help/LikePagesPlugin

    The LikePages plugin lists page names which share an initial or final title word with a given page.

    Usage

    <<LikePages arguments>>

    Arguments

    All PageList arguments, plus the following ones:

    Argument

    Description

    Default value

    page

    The page to execute upon

    current pagename

    prefix

    List only pages that share the same prefix

    false

    suffix

    List only pages that share the same suffix

    false

    Examples

    <<LikePages page=HomePage>>

    These pages share an initial or final title word with “HomePage

    <<LikePages suffix=Page>>

    Page names with suffix “Page”

    Author

    See Also

    Included from Help/ListPagesPlugin

    The ListPages plugin is the simplest plugin to explicitly list a set of pages with all available PageList options, mainly used for a wikilens theme to display ratings info and recommendations.

    It can also be used with the PluginList method to list a set of pages generated by another plugin, and/or to exclude a set of pages generated by another plugin.

    See the PageList options.

    Usage

    <<ListPages arguments>>

    Arguments

    All PageList arguments, plus the following ones:

    Argument

    Description

    Default value

    pages

    Pages to list

    false

    dimension

    0

    Additional info arguments

    top3recs recommendations (wikilens theme only)
    numbacklinks number of backlinks (links to the given page)
    numpagelinks number of forward links (links at the given page)

    Examples

    <<ListPages pages=HomePage,FindPage>>
    <<ListPages info=hits
                sortby=hits
                pages=<!plugin-list BackLink page=[] !>
                exclude=ListPagesPlugin,WikiPlugin
    >>

    Included from Help/MostPopularPlugin

    The MostPopular plugin will display the pages of wiki that have the most (or least) number of hits.

    Usage

    <<MostPopular arguments>>

    Arguments

    All PageList arguments, plus the following ones:

    Argument

    Description

    Default value

    limit

    The number of pages to display. If the limit is negative, the least popular pages will be displayed. If the limit is 0, all visited pages will be displayed.

    20

    sortby

    Page sorting order

    -hits

    noheader

    Do not display header

    false

    info

    List of columns to display

    hits

    Example

    <<MostPopular limit=10>>
    The 10 most popular pages of this wiki:
    |<<   << - 1 / 58 - Next >>   >>|
    |<<   << - 1 / 58 - Next >>   >>|
    Page Name. HitsClick to reverse sort order
    HomePage 1708814
    VerlinkteÄnderungen 980159
    RecentChanges 831684
    NeuesteÄnderungen 818459
    GeringfügigeÄnderungen 486089
    SenasteÄndringar 374936
    DetteErUtenMelk 285479
    RecentEdits 244036
    KokeBok 233069
    Bakst og kaker 213413

    Author

    See Also

    Included from Help/OldStyleTablePlugin

    The OldStyleTable plugin can be used to include tables within a wiki page using the old-style markup syntax for tables.

    This plugin is included for legacy only. We recommend to use Wikicreole tables or Mediawiki tables instead.

    Usage

    <<OldStyleTable caption="OldStyleTable" border||=2
    ||^  *Name*                |v *Cost*   |v *Notes*
    | *First*     | *Last*
    |> Jeff       |< Dairiki   |^  Cheap   |< Not worth it
    |> Marco      |< Polo      | Cheaper   |< Not available
    >>

    will get you

    OldStyleTable
     Name   Cost   Notes 
     First   Last 
     Jeff   Dairiki   Cheap   Not worth it 
     Marco   Polo   Cheaper   Not available 

    Note that multiple |s lead to spanned columns, and vs can be used to span rows. A > generates a right justified column, < a left justified column and ^ a centered column (which is the default.)

    Arguments

    Argument

    Description

    Default value

    caption

    Any string

    Empty string

    border

    Any number

    1

    cellspacing

    Any number

    1

    cellpadding

    Any number

    1

    Syntax

    Note that within each table cell, new-style markup is used. You can only use inline markup --- no block level markup is allowed within table cells.

    (Using old-style markup wouldn't make much sense, since one can't include multi-line plugin invocations using the old-style markup rules.)

    See Also

    Included from Help/PageInfoPlugin

    The PageInfo plugin returns extra information about a page.

    This plugin just passes a page revision handle to the Template 'info.tmpl', which does all the real work.

    Usage

    <<PageInfo arguments>>

    Arguments

    Argument

    Description

    Default value

    page

    pagename

    version

    Example

    <<PageInfo>>
    Last Modified: December 16, 2018 9:27 pm
    Last Author: hege
    Page Version: 2
    Size: 134 words, 1.3 KiB (1298 bytes)
    Hits: 159475
    Last Summary:
    ACL type: page permission inherited from default
    ACL: view:_EVERY; edit:_AUTHENTICATED,-_BOGOUSER; create:_AUTHENTICATED,-_BOGOUSER; list:_EVERY; remove:_ADMIN,_OWNER; purge:_ADMIN,_OWNER; dump:_ADMIN; change:_ADMIN,_OWNER

    Author

    See Also

    Included from Help/PluginManagerPlugin

    The PluginManager plugin provides a dynamic list of plugins on this wiki.

    Usage

    <<PluginManager info=args>>

    Arguments

    Argument

    Description

    Default value

    info

    Display the arguments also. To disable use info=0.

    enabled

    Configuration

    define('REQUIRE_ADMIN', true) in the sourcecode to disable general usage.

    Example

    <<PluginManager>>

    PhpWiki lets you extend it with new functionality via a plugin mechanism. In short, you extend a PHP class we provide and customize it to print out the content you want. For more information see Help:WikiPlugin, Help:HelloWorldPlugin, and view the source of the files in lib/plugin.

    If there is no example page for the plugin, or you need more information, the best place to go is the source of the plugin. Under your wiki's root directory, the folder lib/plugin contains all the PHP files for the plugins.

    External Requirements

    Some plugins require correctly configured PLUGIN_CACHED and external libraries not provided with PhpWiki or PHP, such as

    Author

    Included from Help/PopularTagsPlugin

    The PopularTags plugin lists the most popular tags.

    Usage

    <<PopularTags arguments>>

    Arguments

    Argument

    Description

    Default value

    pagename

    limit

    10

    mincount

    5

    noheader

    0

    Example

    <<PopularTags>>

    Author

    See Also

    Included from Help/RawHtmlPlugin

    With this plugin you can embed raw unfiltered HTML in the page source; say, for example, you want to put in a complicated set of nested tables to display data. By default, raw HTML is not allowed in most Wikis due to security problems (because malicious users can insert redirects, Javascript, etc.)

    For this plugin to work, the page must be locked by the administrator. If you are seeing the raw HTML being displayed below, instead of rendered, try locking the page (log in as the administrator first).

    Sample HTML from www.gnu.org

    Included from Help/RecentChangesCachedPlugin

    Cache output of RecentChanges called with default arguments.

    Usage

    <<RecentChangesCached>>

    Arguments

    Same as Help:RecentChangesPlugin

    Example

    <<RecentChangesCached limit=10>>

    RecentChanges rssrss2atomgrazr

    The 10 most recent major edits during the past 2 days are listed below.

    No changes found

    Author

    See Also

    Included from HomePage

    Velkommen til utenmelk !!

    Utenmelk er en side for alle oss som lever med melkefritt kosthold.

    I forumet kan man diskutere kosthold, utveksle tips, oppskrifter, få råd og dra nytte av andres erfaringer. Mailinglista har vært i aktivitet en stund. Her kan man meddele tips og motta nyhetsbrev. Dere er selvfølgelig velkommen til å skrive direkte til meg også.

    Utgangspunktet for siden er melkefritt kosthold, men det er litt å finne også for andre allergier og intoleranser. Dessverre er det slik at man ofte har flere enn èn allergi. Det være seg f.eks egg, nøtter, sitrus, soya, fisk, pollen, miljøfaktorer eller glutenintoleranse (cøliaki).

    Mitt navn er Hege J. Fledsberg, jeg er laktoseintolerant og har ulcerøs colitt, i tillegg til allergi for en del miljøfaktorer. Min datter er multiallergiker, med blant annet både melk, egg, nøtter, skalldyr, sitrus og miljøfaktorer på sin liste. Vi har også begge ulik grad av atopisk eksem. Jeg har etterhvert mye erfaring og god oversikt over temaet allergi. Jeg har drevet Utenmelk siden 2006, da tok jeg over etter Kristin Øien som startet siden i 1999. Kristin er fortsatt med på laget og har ansvaret for mailinglista.

    Håper siden kan være til hjelp og at vi alle her kan dra nytte av hverandres erfaringer.

    Velkommen!!

    Undersider:

    *MelkeAllergi *LaktoseIntoleranse *AndreAllergier *AtopiskEksem *HøytKolesterol *UlcerøsColitt *TipsOgGodeRåd *DetteErUtenMelk *TrygdeRettigheter *NyttigeLenker *KokeBok *HandleISverige *KontaktInfo

    Included from Help/SearchHighlightPlugin

    The SearchHighLight plugin is an action page plugin, which is only used internally.

    When someone is referred from a search engine like Google, Yahoo or our own fulltextsearch, the terms the user searched for are highlighted. See also .

    Arguments

    Argument

    Description

    Default value

    s

    The search term

    none

    case_exact

    boolean

    false

    regex

    boolean

    false

    Included from Help/SemanticRelationsPlugin

    Display the list of relations and attributes on this page.

    Usage

    <<SemanticRelations>>

    Arguments

    Argument

    Description

    Default value

    page

    Which pages (glob allowed)

    Current page

    relations

    Which relations

    All

    attributes

    Which attributes

    All

    units

    noheader

    false

    nohelp

    false

    Example

    <<SemanticRelations>>

    Help/SemanticRelations - Find out how to add relations and attributes to pages.

    Author

    See Also

    Included from Help/TemplatePlugin

    The Template plugin allows to include text from a wiki page and replace certain placeholders by parameters.

    A template can be seen as a parametrized block. It is similiar to CreatePage with the template argument, but at run-time.

    There are two syntaxes to call a template, the usual Phpwiki syntax for plugins, and a more concise syntax similar to Mediawiki templates.

    Usage

    Without parameters

    Plugin syntax:

    <<Template page=Footer>>

    Short syntax:

    {{Footer}}

    With parameters

    Plugin syntax:

    <<Template page=Film vars="title=SomeFilm&year=1999">>

    Short syntax:

    {{Film|title=SomeFilm|year=1999}}

    With a specific revision of the page

    Plugin syntax:

    <<Template page=somepage rev=5>>

    Short syntax:

    {{somepage?version=5}}

    Arguments

    Argument

    Description

    Default value

    page

    pagename to be included as template

    None (required argument)

    vars

    optional parameters to be expanded inside the template

    (empty)

    rev

    page revision

    most recent revision

    section

    just include a named section

    (empty)

    sectionhead

    when including a named section show the heading

    (empty)

    Page to include

    If "Template:$page" exists, it is used.

    Else, if "Template/$page" exists, it is used.

    Else "$page" is used.

    This allows compatibility with Mediawiki that puts templates in the "Template:" namespace.

    Parameter expansion

    We only support named parameters, not numbered ones as in Mediawiki, and the placeholder is %%var%% and not {{{var}}} as in Mediawiki.

    vars="var1=value1&var2=value2"

    The following predefined variables are automatically expanded if existing:

    Variable

    Description

    pagename

    mtime

    last modified date + time

    ctime

    creation date + time

    author

    last author

    owner

    creator

    first author

    SERVER_URL

    DATA_PATH

    SCRIPT_NAME

    PHPWIKI_BASE_URL

    BASE_URL

    Inclusion

    is stripped.

    .. is only expanded in pages using the template, not in the template itself.

    Included from Help/TexToPngPlugin

    Converts TeX to an image. May be used to embed formulas in PhpWiki.

    Usage

    <<TexToPng arguments>>

    Arguments

    Argument

    Description

    Default value

    tex

    TeX Commands (default: text mode), use $...$ for inline math formula style and $$...$$ for large formula style

    magstep

    magnify image by (1.2 to the magstep)

    img

    Image type (png, jpeg or gif), if chosen image type is not available use the first possible from png, gif, jpeg (in that order)

    png

    subslash

    on or off: substitute slashes by backslashes (to avoid the backslash bug of the database pear interface)

    off

    antialias

    on or off: render ps to img with antialias option. This produces higher quality output but is slower and needs more disk space.

    transparent

    on or off: produce transparent background instead of white background. Seems to be buggy (in pstoimg - not my fault)

    center

    on or off

    off

    Examples

    This produces a little help screen:

    <<TexToPng>>

    A simple formula:

    <<TexToPng tex="$x^2$" >>
    $x^2$

    A more complex formula:

    <<TexToPng tex="$$/int^/infty_{-/infty} dx {1 /over /sqrt {x^2+1}}$$" subslash="on" >>
    $$/int^/infty_{-/infty} dx {1 /over /sqrt {x^2+1}}$$

    Author

    • Johannes Große

    See Also

    Included from Help/TranscludePlugin

    The Transclude plugin can be used to embed include whole (external) web pages within a wiki page.

    Pages are transcluded using <iframe> tags.

    Arguments

    Argument

    Description

    Default value

    src

    The URL of the page to transclude

    none

    title

    The title of the page to transclude

    Transcluded page

    height

    The (initial) height of the transclusion frame. If, possible, after the transcluded page is loaded, the frame is resized via Javascript so that it fits the entire transcluded page. (See below for more.)

    450

    quiet

    If set, frame appears as normal content

    false

    Bugs / Caveats

    • When possible, Javascript code is used to adjust the height of the iframe so that it fits the entire transcluded page. Unfortunately, this seems possible only when the transcluded page comes from the same server as the wiki page. (This restriction is due to security checks built in to the Javascript language.)
    • The recursion detection code does not currently work. Be careful to avoid recursive transclusions, or you'll be sorry (or at least amused.)

    Example

    <<Transclude src="http://phpwiki.svn.sourceforge.net/viewvc/phpwiki/trunk/pgsrc/ReleaseNotes?view=markup">>

    will get you

    Transcluded from http://phpwiki.svn.sourceforge.net/viewvc/phpwiki/trunk/pgsrc/ReleaseNotes?view=markup

    Included from Help/UpLoadPlugin

    The UpLoad plugin displays an editbox and two buttons.

    • The first button lets you choose the file to be uploaded at your local filesystem. The text value of this button is localised from your browser.
    • The second “Upload” button actually uploads the given filename to the upload directory.

    This directory is not browsable, any file there may be accessed by using the “Upload:” InterWikiMap prefix to the given filename. This way you can easily inline uploaded images.

    Usage

    <<UpLoad arguments>>

    Arguments

    Argument

    Description

    Default value

    logfile

    Local path. The format is currently HTML - a new <tr> row per entry - and not log file syntax.

    phpwiki-upload.log

    autolink

    Add the uploaded filename to the list of uploaded files at the page.

    true

    page

    The page where the uploaded files are publicly listed, if autolink is true.

    Current page

    mode

    'actionpage' or 'edit'

    actionpage

    Notes

    1. The user must be authenticated to be able to upload.
    2. The filename may not end with certain disallowed extensions, to prevent from abuse.
    3. MAX_FILE_SIZE is configured by the config.ini option MAX_UPLOAD_SIZE, which defaults to 16MB. Your webserver and PHP may add another limit.
    4. Already existing uploaded files are NOT overwritten.

    Example

    <<UpLoad>>

    See Also

    Included from Help/VideoPlugin

    The Video plugin allows to include video in a wiki page. Video file must be encoded in FLV format (Flash Video) or in an HTML 5 format:

    • Ogg (.ogg suffix),
    • MP4 (.mp4 suffix),
    • WebM (.webm suffix).

    The Video plugin can also be called with the {{video.flv}} syntax.

    Arguments

    Use only one of url or file arguments at a time.

    Argument

    Description

    Default value

    url

    The url of a video file.

    none

    file

    The name of a video file that has been uploaded.

    none

    width

    The width of the video (in pixels).

    460

    height

    The height of the video (in pixels).

    320

    autoplay

    Auto play the video when page is displayed (boolean).

    false

    Examples

    A video:

    <<Video url=http://a.video.server/a_video.flv>>

    Another video:

    <<Video file=another_video.flv>>

    This is equivalent to:

    {{another_video.flv}}

    Big Buck Bunny

    {{http://video.webmfiles.org/big-buck-bunny_trailer.webm}}

    Authors

    • Roger Guignard, Alcatel-Lucent
    • Marc-Etienne Vargenau, Alcatel-Lucent

    See Also

    Included from Help/WikiAdminDeleteAclPlugin

    The WikiAdminDeleteAcl plugin allows to delete page permissions.

    Usage

    <<~WikiAdminDeleteAcl arguments>>

    Arguments

    Argument

    Description

    Default value

    s

    Pages to select

    None

    info

    Columns to include in listing

    pagename, perm, mtime, owner, author

    Example

    <<WikiAdminDeleteAcl s=Temp*>>
    Plugin WikiAdminDeleteAcl disabled. Plugin not run: not in browse mode
    <?plugin WikiAdminDeleteAcl s=Temp*?>

    Author

    • Marc-Etienne Vargenau, Alcatel-Lucent

    See Also

    Included from Help/WikiAdminPurgePlugin

    The WikiAdminPurge plugin allows to purge pages.

    Usage

    <<WikiAdminPurge arguments>>

    Arguments

    Argument

    Description

    Default value

    s

    Pages to select

    None

    Example

    <<WikiAdminPurge s=Temp*>>
    Plugin WikiAdminPurge disabled. Plugin not run: not in browse mode
    <?plugin WikiAdminPurge s=Temp*?>

    Author

    • Marc-Etienne Vargenau, Alcatel-Lucent

    See Also

    Included from Help/WikiBlogPlugin

    This simple plugin allows blog-style entries on a page. Try making a few entries, and then look at RecentChanges to get an idea of how things work.

    This plugin shows 'blogs' (comments/news) associated with a particular page and provides an input form for adding a new blog.

    Arguments

    Argument

    Description

    Default value

    page

    page which is blogged to

    Current page

    order

    • 'normal' - place in chronological order
    • 'reverse' - place in reverse chronological order

    normal

    mode

    • 'show' - only show old blogs
    • 'add' - only show entry box for new blog
    • 'show,add' - show old blogs then entry box
    • 'add,show' - show entry box followed by old blogs

    show,add

    Usage

    Add <<WikiBlog>> at your PersonalPage and BlogArchives and BlogJournal? will find the Blog entries automatically.

    Now it is also the base class for all attachable pagetypes: "wikiblog", "comment" and "wikiforum"

    Hints/comments

    To have the blog show up on a separate page:

    On TopPage, use <<WikiBlog mode=add>> Create TopPage/Blog with this page as actionpage: <<WikiBlog pagename=TopPage mode=show>>

    To have the main ADMIN_USER Blog appear under Blog and not under WikiBlog?/Blog or UserName/Blog as for other users blogs, define BLOG_DEFAULT_EMPTY_PREFIX=true use the page Blog as basepage and user="" (as default for ADMIN or current user) and pagename="Blog" in the various blog plugins (BlogArchives, BlogJournal?)

    Example

    You must be logged in to add blog entries.

    Author

    • Michael Van Dam, major refactor by Jeff Dairiki (as AddComment)
    • Changed as baseclass to AddComment and WikiForum and EditToolbar integration by Reini Urban.

    See Also

    Included from Help/WikiFormPlugin

    The WikiForm plugin provides generic input buttons.

    Usage

    <<WikiForm arguments>>

    Arguments

    Argument

    Description

    Default value

    action

    upload, loadfile, dumphtml or dumpserial

    upload

    default

    Default value in the input box

    empty

    buttontext

    Text displayed on the button

    if action=upload, Upload
    if action=loadfile, Load File
    if action=dumphtml, Dump Pages as XHTML
    if action=dumpserial, Dump Pages

    overwrite

    When loading pages, force overwrite or not

    false

    size

    Size of the input box

    50

    Example

    <<WikiForm action="loadfile" buttontext="Load File">>

    Author

    See Also

    Included from Help/WikiFormRichPlugin

    Create generic and enhanced forms, with various options:

    • editbox[] name=.. value=.. text=.. autocomplete=0|1
    • checkbox[] name=.. value=0|1 checked text=..
    • radio[] name=.. value=.. text=..
    • pulldown[] name=.. value=.. selected=.. text=.. autocomplete=0|1
    • combobox[] name=.. value=.. text=.. method=.. args=..
    • hidden[] name=.. value=..
    • submit[]
    • action, submit buttontext, optional cancel button (bool)
    • method=get or post, Default: post.

    Valid arguments for pulldown and editbox: autocomplete=1, Default: 0

    If autocomplete=1, additional arguments method and args may be used. autocomplete together with dyn-methods (see below) should be used to handle larger lists (> 500).

    If no method is given, value will be used to fill in the valid values.

    method="xmlrpc:name [optional args]"
    method="dynxmlrpc:url [optional args]"
    method="url:http://server/wiki/method"
    method="dynurl:http://server/wiki/method"
    method="array:jsvariable"
    method="plugin:pluginname [optional args]"
    • The plugin must return a pagelist.
    • args are optional arguments, space separated, for the method.
    • A combobox is a pulldown with autocomplete=1.
    • Values which are constants are evaluated.
    • The cancel button must be supported by the action (just some wikiadmin actions so far)
    • improve layout by: nobr=1
    • some allow values as list from <!plugin-list pluginname args !>

    Samples

    <<WikiFormRich action=dumpserial method=get
                   checkbox[] name=include value="all"
                   editbox[] name=directory value=DEFAULT_DUMP_DIR
                   editbox[] name=pages value=*
                   editbox[] name=exclude value=""
    >>
     include
    directory 
    pages 
    exclude 

    <<WikiFormRich action=dumphtml method=get
                   editbox[] name=directory value=HTML_DUMP_DIR
                   editbox[] name=pages value="*"
                   editbox[] name=exclude value=""
    >>
    directory 
    pages 
    exclude 

    <<WikiFormRich action=loadfile method=get
                   editbox[]  name=source value=DEFAULT_WIKI_PGSRC
                   checkbox[] name=overwrite value=1
                   editbox[]  name=exclude value=""
    >>
    source 
     overwrite
    exclude 

    <<WikiFormRich action=TitleSearch method=get class=wikiadmin nobr=1
                   editbox[] name=s text=""
                   submit[]
                   checkbox[] name=case_exact
                   checkbox[] name=regex
    >>
        case_exact  regex 

    <<WikiFormRich action=FullTextSearch method=get class=wikiadmin nobr=1
                   editbox[] name=s text=""
                   submit[]
                   checkbox[] name=case_exact
                   checkbox[] name=regex
    >>
        case_exact  regex 

    <<WikiFormRich action=FuzzyPages method=get class=wikiadmin nobr=1
                   editbox[] name=s text=""
                   submit[]
                   checkbox[] name=case_exact
    >>
        case_exact 

    <<WikiFormRich action=AppendText buttontext="AddPlugin"
                   radio[] name=s value=<!plugin-list BackLinks page=WikiPlugin limit=5 !>
    >>
     InterWikiSearch 
     ModeratedPage 
     ReleaseNotes 
     Einstellungen 
     Hilfe/AutorenProtokollPlugin 
     Hilfe/NeueSeitePlugin 

    <<WikiFormRich action=AppendText buttontext="AddPlugin"
                   combobox[] name=s text="" style="width:60px" value=<!plugin-list BackLinks page=WikiPlugin !>
                   submit[]
    >>
     

    <<WikiFormRich action=AppendText buttontext="AddCategory"
                   pulldown[] name=s text="Categories: " value=<!plugin-list TitleSearch s=Category !>
    >>
    Categories:  

    <<WikiFormRich action=SemanticSearch buttontext="AddRelation"
                   combobox[] name=relation method="xmlrpc:listRelations"
                   submit[]
                   checkbox[] name=case_exact text="Case-exact?"
    >>

    <<WikiFormRich action=AppendText buttontext="InsertTemplate"
                   combobox[] name=s text="Template: " method="plugin:titleSearch s=Template*"
                   submit[]
    >>
    Template:  

    <<WikiFormRich action=GoTo
                   editbox[] name=page text="GoTo: " method="dynxmlrpc:titleSearch s=H" style="width:100px" autocomplete=1
                   submit[]
    >>

    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/<LANG> 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

    Plugin IncludePage failed. Recursive inclusion of page PhpWikiManual ignored

    END OF DOCUMENT


Warning: "count(): Parameter must be an array or an object that implements Countable"