Diff: Help/IncludePagePlugin

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

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

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,6 +1,6 @@
-The **~IncludePage** [[Help:WikiPlugin|plugin]] will “ include” other pages in this wiki. In the language of hypertext  
- this is called //transclusion//. 
+The **~IncludePage** [[Help:WikiPlugin|plugin]] will " include" other pages in this wiki. In the language of hypertext this is called //transclusion//.  
+The pages will render in distinct tables. You can also load external pages in a more limited fashion with the [[Help:FrameIncludePlugin|FrameInclude]] plugin . 
  
 == Usage == 
  
 {{{ 
@@ -16,48 +16,42 @@
 ! Default value 
 |- 
 | **page** 
 | The page to include 
-| //none // (required argument) 
+| //None // (required argument) 
 |- 
 | **rev** 
-| The revision 
+| the revision 
 | most recent revision 
 |- 
 | **quiet** 
-| Boolean. If true , inclusion appears as normal content.  
+| if set , inclusion appears as normal content 
 | false 
 |- 
 | **bytes** 
-| Maximum number of bytes to include  
-| //none // (include whole page) 
+| maximum number of bytes to include  
+| //None // (include all page) 
 |- 
 | **words** 
-| Maximum number of words to include  
-| //none // (include whole page) 
+| maximum number of words to include  
+| //None // (include all page) 
 |- 
 | **lines** 
-| Maximum number of lines to include  
-| //none // (include whole page) 
+| maximum number of lines to include  
+| //None // (include all page) 
 |- 
 | **sections** 
-| Maximum number of sections to include  
-| //none // (include all sections) 
+| maximum number of sections to include  
+| //None // (include all sections) 
 |- 
 | **section** 
-| Include a named section  
-| //none // 
+| include a named section  
+| //None // 
 |- 
 | **sectionhead** 
-| Boolean. If true, when including a named section show the heading 
+| 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 === 
@@ -76,9 +70,9 @@
  
 Does not work in Wikicreole syntax 
 <!-- <<IncludePage page=Help/AllPagesPlugin sections=2>> --> 
  
-== Known Problems === 
+== 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. 
@@ -92,9 +86,10 @@
 == See Also == 
  
 * [[Help:IncludePagesPlugin]] (to include multiple pages) 
 * [[Help:TemplatePlugin]] (to include a page with parameters) 
+* [[Help:FrameIncludePlugin]] (to include an external page)  
  
 <noinclude> 
 ---- 
 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]] 
 </noinclude> 

version 2

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. You can also load external pages in a more limited fashion with the FrameInclude plugin.

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

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 (861 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 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