Diff: Help/IncludePagePlugin
Differences between version 4 and predecessor to the previous major change of Help/IncludePagePlugin.
Other diffs: Previous Revision, Previous Author
| Newer page: | version 4 | Last edited on October 14, 2015 11:47 am | by PhilHollenback | Revert | 
| Older page: | version 3 | Last edited on February 23, 2012 2:51 pm | by PhilHollenback | Revert | 
version 4
The IncludePage plugin will “include” other pages in this wiki. In the language of hypertext this is called transclusion. The pages will render in distinct tables.
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 all page)  | 
words  | 
maximum number of words to include  | 
None (include all page)  | 
lines  | 
maximum number of lines to include  | 
None (include all 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
<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  | 
none  | 
Example
<<AllPages limit=20 cols=3>>
All pages in this wiki (1445 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  | 
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 bugs
- 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)
 

