INCLUDE -- include another topic, or subsection of a topic, or a URL, or Foswiki embedded documentation
(Including a topic) Parameters
| Parameter: |
Description: |
Default: |
"SomeTopic" |
The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}% |
|
"Web.Topic" |
A topic in another web, i.e. %INCLUDE{"System.SiteMap"}% |
|
"Web.Topic, SomeOtherTopic, System.OrOtherTopic" |
A list of topics - INCLUDE will include the first topic that exists and the user has permission to VIEW. If a section is also specified, it will use the first topic that has that section defined in it. |
|
pattern |
Include a subset of a topic or a web page. Specify a RegularExpression that contains the text you want to keep in parenthesis, e.g. pattern="(from here.*?to here)". IncludeTopicsAndWebPages has more. |
none |
rev |
Include a previous topic revision; N/A for URLs |
top revision |
warn |
Warn if topic include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) |
%INCLUDEWARNING% preferences setting |
headingoffset |
Adds the given offset to any HTML headings generated in the included text. Works on headings defined by HTML tags as well as headings defined using foswiki markup. |
0 |
section |
Includes only the specified named section, as defined in the included topic by the [VarSTARTSECTION][STARTSECTION{"name" type="section"} ]] and [VarENDSECTION][ENDSECTION{"name" type="section"}]] macros. Nothing is shown if the named section does not exists. section="" is equivalent to not specifying a section |
|
| |
Any other parameter will be defined as a macro within the scope of the included topic. The example parameters on the left will result in %PARONE% and %PARTWO% being defined within the included topic. |
|
(Including a web page) Parameters
| Parameter |
Description |
Default |
"http://..." |
A full qualified URL, i.e. %INCLUDE{"https://foswiki.org:80/index.html"}%. Supported content types are text/html and text/plain.  If the URL resolves to an attachment file on the server this will automatically translate to a server-side include. |
|
pattern |
Include a subset of a topic or a web page. Specify a RegularExpression that contains the text you want to keep in parenthesis, e.g. pattern="(from here.*?to here)". IncludeTopicsAndWebPages has more. |
none |
raw |
When a page is included, normally Wasserstoff-Fahrer Forum will process it, doing the following: 1) Alter relative links to point back to originating host, 2) Remove some basic HTML tags (html, head, body, script) and finally 3) Remove newlines from HTML tags spanning multiple lines. If you prefer to include exactly what is in the source of the originating page set this to on.
raw="on" is short for disableremoveheaders="on", disableremovescript="on", disableremovebody="on", disablecompresstags="on" and disablerewriteurls="on". |
disabled |
literal |
While using the raw option will indeed include the raw content, the included content will still be processed and rendered like regular topic content. To disable parsing of the included content, set the literal option to "on". |
off |
disableremoveheaders |
Bypass stripping headers from included HTML (everything until first </head> tag) |
off |
disableremovescript |
Bypass stripping all <script> tags from included HTML |
off |
disableremovebody |
Bypass stripping the </body> tag and everything around over and below it |
off |
disablecompresstags |
Bypass replacing newlines in HTML tags with spaces. This compression step rewrites unmatched <'s into < entities unless bypassed |
off |
disablerewriteurls |
Bypass rewriting relative URLs into absolute ones |
off |
warn |
Warn if URL include fails: Fail silently (if off); output default warning (if set to on); else, output specific text (use $topic for topic name) appended with the http error information. |
%INCLUDEWARNING% preferences setting |
JavaScript in included webpages is filtered out as a security precaution per default (disable filter with
disableremovescript parameter)
Foswiki by default is configured to deny URL format includes.
(Including Foswiki embedded module documentation) Parameters
| Parameter |
Description |
Default |
"doc:..." |
A full qualified Foswiki module, i.e. %INCLUDE{"doc:Foswiki::Func"}%. The module must be found on the Foswiki lib path |
|
level |
Override the root heading level to the specified number |
|
pattern |
Include a subset of the module. Specify a RegularExpression that contains the text you want to keep in parenthesis, e.g. pattern="(from here.*?to here)". IncludeTopicsAndWebPages has more. |
none |
BASETOPIC,
BASEWEB,
INCLUDINGTOPIC,
INCLUDINGWEB,
STARTINCLUDE,
ENDINCLUDE,
STOPINCLUDE,
STARTSECTION,
ENDSECTION
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.