Diff: Help/UnfoldSubpagesPlugin

Differences between version 6 and predecessor to the previous major change of Help/UnfoldSubpagesPlugin.

Other diffs: Previous Revision, Previous Author

Newer page: version 6 Last edited on 17 January 2022 3:00 by harold Revert
Older page: version 5 Last edited on 9 September 2007 0:16 by harold Revert
@@ -1,60 +1,103 @@
-The ~UnfoldSubpages Help:WikiPlugin is used to display all or some subpages  
-of the current or a given page. This gives a overview for a  
-WikiBlogPlugin, CalendarPlugin or similar subpages. 
+The ** ~UnfoldSubpages** [[ Help:WikiPlugin|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 non-existant sections! 
+Warning: Don't use it with subpages with nonexistent sections! 
 The section extractor is currently quite unstable. 
  
-! Usage:  
-<verbatim>  
- <?plugin UnfoldSubpages ?>  
- or <?plugin UnfoldSubpages sortby =-mtime words =50 maxpages=5 ?>  
- or <?plugin UnfoldSubpages quiet=1 smalltitle=1 ?>  
- or <?plugin UnfoldSubpages sections=2 words=100 ?>  
- or <?plugin UnfoldSubpages lines=3 ?>  
- or <?plugin UnfoldSubpages pagename="PhpWikiAdministration"  
- section ="Plugin Arguments" sectionhead =1 ?>  
-</verbatim>  
+== Usage == 
  
-!! Plugin Arguments:  
-<strong>pagename </strong >:  
- Any pagename or if empty the current page. Default: ""  
-<strong >quiet</strong>:  
- Print no header. Default: false  
-<strong>sortby </strong>:  
- Sort by + (ASC) or - (DESC) and one column.  
- Multiple columns like sortby="-hits, -mtime" not yet supported.  
- Supported columns: ~[+|-]pagename, ~[+|-]mtime, ~[+|-]hits.  
- Default: "pagename"  
-<strong> maxpages</strong >:  
- Maximum number of pages to include or all if not defined.  
- Default: false  
-<strong>sections </strong >:  
- Maximum number of sections per page to include or all if not defined.  
- Default: false  
-<strong>section </strong >:  
- Include this named section per page only if defined. Default: ""  
-<strong >sectionhead</strong>:  
- When including a named section show the heading. Default: false  
-<strong>smalltitle </strong >:  
- If set, hide transclusion-title, just have a small link at the start of  
- the page. Default: false  
-<strong >words</strong>:  
- Maximum number of words per page to include. Default: false  
-<strong>lines </strong>:  
- Maximum number of lines per page to include. Default: false  
-<strong >bytes</strong >:  
- Maximum number of bytes per page to include. Default: false  
+{{{  
+<<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 >>  
+}}}  
  
-! Deprecated Arguments:  
-<strong>pages</strong>:  
- deprecated. renamed to maxpages.  
-<strong>sort</strong>:  
- 'asc' or 'desc'. deprecated: use "+" or "-" before the column name with sortby.  
+== Arguments ==  
  
-! Example :  
-<?plugin UnfoldSubpages pagename=PgsrcTranslation limit=20 ?>  
+All [[Help:PageList|PageList]] arguments, plus the following ones : 
  
-------------- 
+{| class="bordered"  
+| -  
+! 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.\\Multiple columns like sortby=" -hits, -mtime" not yet supported.\\Supported columns: ~[+| -]pagename, ~[+| -]mtime, ~[+| -]hits.  
+| 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  
+|}  
  
-PhpWikiDocumentation Help:WikiPlugin  
+=== Deprecated Arguments ===  
+  
+{| class="bordered"  
+|-  
+! 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 >>  
+}}}  
+  
+<<UnfoldSubpages pagename=Help maxpages=5 >>  
+  
+== See Also ==  
+* [[ Help:ListSubpagesPlugin]]  
+  
+<noinclude>  
+----  
+[[PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
+</noinclude>  

version 6

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.
Multiple columns like sortby="-hits,-mtime" not yet supported.
Supported columns: [+|-]pagename, [+|-]mtime, [+|-]hits.

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

Check the spelling of a page and make suggestions.

Usage

<<SpellCheck arguments>>

Arguments

Argument

Description

Default value

pagename

Example

Plugin WikiPluginCached failed. sh: line 1: aspell: command not found Plugin SpellCheck failed. Couldn't start commandline “aspell -a -C --data-dir=/usr/share/aspell --lang=en ”

Author

See Also

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

Boolean. If true, 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

Boolean. If true, when including a named section show the heading

false

Inclusion

<noinclude> .. </noinclude> is stripped.

<includeonly> .. </includeonly> 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

Allows multiple columns: info=mtime,hits,summary,version,author,locked,minor or all

none

userpages

Boolean. If true, display only pages created by users (not the ones created at initialisation of the wiki).

false

Example

<<AllPages limit=20 cols=3>>

All pages in this wiki (865 total):

|<<   << - 1 / 44 - 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

Allows multiple columns: info=mtime,hits,summary,version,author,locked,minor or all

none

userpages

Boolean. If true, display only pages created by users (not the ones created at initialisation of the wiki).

false

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

Allows multiple columns: info=mtime,hits,summary,version,author,locked,minor or all

none

userpages

Boolean. If true, display only pages created by users (not the ones created at initialisation of the wiki).

false

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

PhpWikiAdministration Page Explorer main plugin.

Usage

<<WikiAdminSelect 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

<<WikiAdminSelect s=Temp*>>

Select:

| | | | | | | | |
Page NameClick to reverse sort order Last Modified. Last Author. Hits.
Help/TemplatePlugin 17 January 2022 3:00 harold 1358
Template/Attribute 17 January 2022 3:00 harold 1014
Template/Category 17 January 2022 3:00 harold 1301
Template/Example 17 January 2022 3:00 harold 1209
Template/Linkto 17 January 2022 3:00 harold 1051
Template/NewPlugin 17 January 2022 3:00 harold 1232
Template/Relation 17 January 2022 3:00 harold 1001
Template/Talk 17 January 2022 18:35 harold 1024
Template/UserPage 17 January 2022 18:35 harold 984
TemplateExample 25 September 2005 4:15 harold 636
TemplatePlugin 25 September 2005 4:16 harold 639

Author

See Also

Included from Help/RelatedChangesPlugin

The RelatedChanges plugin gives a list of changes on all pages which are linked to from this page.

Usage

<<RelatedChanges arguments>>

Arguments

The arguments are the same as for RecentChanges plugin.

Example

<<RelatedChanges>>

RecentEdits rssrss2atom

The most recent edits during the past 2 days are listed below. (to pages linked from “Help/UnfoldSubpagesPlugin”)

No changes found

Author

Included from Help/PredefinedIcons

Phpwiki allows you to easily include some predefined icons in your wiki pages.

The following icons are available:

Notation {{:)}} {{:(}} {{:P}} {{:D}} {{;)}} {{(y)}} {{(n)}}
Image :) :( :P :D ;) (y) (n)
Notation {{(i)}} {{(/)}} {{(x)}} {{(!)}} {{(+)}} {{(-)}} {{(?)}}
Image (i) (/) (x) (!) (+) (-) (?)
Notation {{(on)}} {{(off)}} {{(*)}} {{(*r)}} {{(*g)}} {{(*b)}} {{(*y)}}
Image (on) (off) (*) (*r) (*g) (*b) (*y)

Included from Help/RecentReferrersPlugin

The RecentReferrers plugin allows to analyse access log.

Usage

<<RecentReferrers arguments>>

Arguments

All PageList arguments, plus the following ones:

Argument

Description

Default value

noheader

Boolean. If true, header should be omitted.

false

limit

15

Example

<<RecentReferrers>>
Error: no ACCESS_LOG

Author

See Also

See Also