Diff: Help/UnfoldSubpagesPlugin

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

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

Other diffs: Previous Major Revision, Previous Author

Newer page:	version 2	Last edited on 22 May 2014 3:01	by harold	Revert
Older page:	version 1	Last edited on 17 January 2022 18:35	by harold	Revert

@@ -1,9 +1,9 @@

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 ~~nonexistent~~ sections!

+Warning: Don't use it with subpages with non-existant sections!

The section extractor is currently quite unstable.

== Usage ==

@@ -27,13 +27,13 @@

! Description

! Default value

| **pagename**

-| Any pagename or if empty the current page.

-| // empty//

+| Any pagename or if empty the current page

+| empty

| **quiet**

-| ~~Boolean. If true,~~ header ~~should be omitted.~~

+| 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.

@@ -48,16 +48,16 @@

| false

| **section**

| Include this named section per page only if defined.

-| // empty//

+| 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.

+| 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.

@@ -88,16 +88,13 @@

== Example ==

{{{

-<<UnfoldSubpages pagename=Help maxpages=5 >>

+<<UnfoldSubpages pagename=Help maxpages=5 lines=10 >>

}}}

-<<UnfoldSubpages pagename=Help maxpages=5 >>

-

-~~== See Also ==~~

-* [[Help:ListSubpagesPlugin]]

+<<UnfoldSubpages pagename=Help maxpages=5 lines=10 >>

----

[[PhpWikiDocumentation]] [[CategoryWikiPlugin]]

</noinclude>

version 2

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 non-existant 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 lines=10>>

Included from Help /SpellCheckPlugin

Check the spelling of a page and make suggestions.

Usage

<<SpellCheck arguments>>

Arguments

... first 10 lines

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

... first 10 lines

Included from Help /WikiAdminSelectPlugin

PhpWikiAdministration Page Explorer main plugin.

Usage

<<WikiAdminSelect arguments>>

Arguments

All PageList arguments, plus the following ones: ... first 10 lines

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.

... first 10 lines

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
Notation	{{(i)}}	{{(/)}}	{{(x)}}	{{(!)}}	{{(+)}}	{{(-)}}	{{(?)}}
Image
Notation	{{(on)}}	{{(off)}}	{{(*)}}	{{(*r)}}	{{(*g)}}	{{(*b)}}	{{(*y)}}
Image