Diff: Help/UnfoldSubpagesPlugin

Note: You are viewing an old revision of this page. View the current version.

Differences between version 5 and previous revision of Help/UnfoldSubpagesPlugin.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 5 Last edited on 9 September 2007 0:16 by harold Revert
Older page: version 4 Last edited on 22 May 2014 3:01 by harold Revert
@@ -1,100 +1,60 @@
-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. 
+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. 
  
 Warning: Don't use it with subpages with non-existant sections! 
 The section extractor is currently quite unstable. 
  
-== Usage == 
+! 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>  
  
-{{{  
-<<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 >>  
-}}}  
+!! 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  
  
-== Arguments ==  
+! Deprecated Arguments:  
+<strong>pages</strong>:  
+ deprecated. renamed to maxpages.  
+<strong>sort</strong>:  
+ 'asc' or 'desc'. deprecated: use "+" or "-" before the column name with sortby.  
  
-All [[Help:PageList|PageList]] arguments, plus the following ones : 
+! Example :  
+<?plugin UnfoldSubpages pagename=PgsrcTranslation limit=20 ?>  
  
-{| 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  
-|}  
+------------- 
  
-=== 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 lines=10>>  
-}}}  
-  
-<<UnfoldSubpages pagename=Help maxpages=5 lines=10>>  
-  
-<noinclude>  
-----  
-[[PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
-</noinclude>  
+PhpWikiDocumentation Help :WikiPlugin  

version 5

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.

Warning: Don't use it with subpages with non-existant sections! The section extractor is currently quite unstable.

Usage:

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

Plugin Arguments:

pagename
Any pagename or if empty the current page. Default: ""
quiet
Print no header. Default: false
sortby
Sort by + (ASC) or - (DESC) and one column. Multiple columns like sortby="-hits,-mtime" not yet supported. Supported columns: [+|-]pagename, [+|-]mtime, [+|-]hits. Default: "pagename"
maxpages
Maximum number of pages to include or all if not defined. Default: false
sections
Maximum number of sections per page to include or all if not defined. Default: false
section
Include this named section per page only if defined. Default: ""
sectionhead
When including a named section show the heading. Default: false
smalltitle
If set, hide transclusion-title, just have a small link at the start of the page. Default: false
words
Maximum number of words per page to include. Default: false
lines
Maximum number of lines per page to include. Default: false
bytes
Maximum number of bytes per page to include. Default: false

Deprecated Arguments:

pages
deprecated. renamed to maxpages.
sort
'asc' or 'desc'. deprecated: use "+" or "-" before the column name with sortby.

Example:

Included from PgsrcTranslation/ja

Note: This page is much more impressive on the demo server, where the page names actually link.

What you are looking at: This table shows all the default pages that ship with PhpWiki translated into this special language. If you click on a "T" you can contribute a missing translation.

Translated Page Name Matrix (dynamic)

Plugin “_WikiTranslation” does not exist.

See also: PhpWiki:MultiLingualWiki, PhpWiki:LanguageSelection, PhpWikiDocumentation

Included from PgsrcTranslation/es

Note: This page is much more impressive on the demo server where the page names actually link.

What you are looking at: This table shows all the default pages that ship with PhpWiki translated into this special language. If you click on a "T" you can contribute a missing translation.

Translated Page Name Matrix (dynamic)

Plugin “_WikiTranslation” does not exist.

See also: PhpWiki:MultiLingualWiki, PhpWiki:LanguageSelection, PhpWikiDocumentation

Included from PgsrcTranslation/zh

Note: This page is much more impressive on the demo server, where the page names actually link.

What you are looking at: This table shows all the default pages that ship with PhpWiki translated into this special language. If you click on a "T" you can contribute a missing translation.

Translated Page Name Matrix (dynamic)

Plugin “_WikiTranslation” does not exist.

See also: PhpWiki:MultiLingualWiki, PhpWiki:LanguageSelection, PhpWikiDocumentation

Included from PgsrcTranslation/de

Note: This page is much more impressive on the demo server where the page names actually link.

What you are looking at: This table shows all the default pages that ship with PhpWiki translated into this special language. If you click on a "T" you can contribute a missing translation.

Translated Page Name Matrix (dynamic)

Plugin “_WikiTranslation” does not exist.

See also: PhpWiki:MultiLingualWiki, PhpWiki:LanguageSelection, PhpWikiDocumentation, PhpWikiDemo:de/PhpWikiDokumentation

Included from PgsrcTranslation/it

Note: This page is much more impressive on the demo server where the page names actually link.

What you are looking at: This table shows all the default pages that ship with PhpWiki translated into this special language. If you click on a "T" you can contribute a missing translation.

Translated Page Name Matrix (dynamic)

Plugin “_WikiTranslation” does not exist.

See also: PhpWiki:MultiLingualWiki, PhpWiki:LanguageSelection, PhpWikiDocumentation

Included from PgsrcTranslation/fr

Note: This page is much more impressive on the demo server where the page names actually link.

What you are looking at: This table shows all the default pages that ship with PhpWiki translated into this special language. If you click on a "T" you can contribute a missing translation.

Translated Page Name Matrix (dynamic)

Plugin “_WikiTranslation” does not exist.

See also: PhpWiki:MultiLingualWiki, PhpWiki:LanguageSelection, PhpWikiDocumentation

Included from PgsrcTranslation/nl

Note: This page is much more impressive on the demo server where the page names actually link.

What you are looking at: This table shows all the default pages that ship with PhpWiki translated into this special language. If you click on a "T" you can contribute a missing translation.

Translated Page Name Matrix (dynamic)

Plugin “_WikiTranslation” does not exist.

See also: PhpWiki:MultiLingualWiki, PhpWiki:LanguageSelection, PhpWikiDocumentation

Included from PgsrcTranslation/sv

Note: This page is much more impressive on the demo server where the page names actually link.

What you are looking at: This table shows all the default pages that ship with PhpWiki translated into this special language. If you click on a "T" you can contribute a missing translation.

Translated Page Name Matrix (dynamic)

Plugin “_WikiTranslation” does not exist.

See also: PhpWiki:MultiLingualWiki, PhpWiki:LanguageSelection, PhpWikiDocumentation

PhpWikiDocumentation Help:WikiPlugin