Diff: Help/IncludePagePlugin
Differences between version 6 and previous revision of Help/IncludePagePlugin.
Other diffs: Previous Major 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 | 
version 6
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):
  | 
Author
See Also
IncludePage page=Help/AllPagesPlugin lines=6
Included from Help/AllPagesPlugin
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
Help:IncludePagesPlugin (to include multiple pages)
Help:TemplatePlugin (to include a page with parameters)