Difference: VarINCLUDE (1 vs. 11)

Revision 112015-06-05 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

INCLUDE{"page"} -- include other topic, attachment, or web page

Line: 17 to 17
 
hidetoc="on" Remove %TOC% in included content. Useful to show table of contents in individual topics, while suppressing them if included in a big master document. TOC_HIDE_IF_
INCLUDED setting
rev="2" Include a previous topic revision; N/A for URLs top revision
raw="on" (for HTTP inclusion) When a page is included via HTTP, normally TWiki 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
Changed:
<
<
raw="on" (for topic or attachment inclusion) When a topic is included, normally TWiki variables in the included topic are expanded in the context of the inlcluded topic. If raw="on" is specified, that variable expansion does not happen. You may wonder what's that for and what are the implications, which are found out on IncludeTopicRaw.
Because of the "in the raw" nature of the parapmeter, if it's specified, parameters such as encode, headingoffset, hidetoc, newline, nofinalnewline, and section are ignored. 		disabled
>
>
raw="on" (for topic or attachment inclusion) When a topic is included, normally TWiki variables in the included topic are expanded in the context of the included topic. If raw="on" is specified, that variable expansion does not happen. You may wonder what's that for and what are the implications, which are found out on IncludeTopicRaw.
Because of the "in the raw" nature of the parameter, if it's specified, parameters such as encode, headingoffset, hidetoc, newline, nofinalnewline, and section are ignored. 		disabled
 
literal="on" 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". disabled
nofinalnewline="on" Delete the new line at the end of the result if exists disabled
newline="$br" Convert newlines in textarea to other delimiters. Variable $br expands to <br /> tag, and $n to a newline. Other text is encoded based on encode parameter. no conversion

Revision 102015-06-05 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"
Changed:
<
<

INCLUDE{"page"} -- include other topic or web page

>
>

INCLUDE{"page"} -- include other topic, attachment, or web page

 
  • Merges the content of a specified page into the current one before rendering.
  • Syntax: %INCLUDE{"page" ...}%
  • Supported parameters:
Line: 9 to 9
 
"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{"TWiki.SiteMap"}%  
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain by default. See allowanytype.
IDEA! if the URL resolves to an attachment file on the server this will automatically translate to a server-side include. 		 
Added:
>
>
attachment="filename.ext" Include the specified attachment instead of topic text. The attachment content is subject to processing just like when topic text is included. For example, text up to %STARTINCLUDE% is excluded. When including an attachment, you can do without topic specification - %INCLUDE{attachment="filename.ext"}% works, which results in including the attachment of the same topic.  
 
allowanytype="on" Suppress the content type checking in including the web page specified by a URL. disabled
Added:
>
>
charset="CHARSET" Specify the charset of the included content so that a proper charset conversion happens when it's different from the site charset. Needless to say, this works for a TWiki topic, a topic attachment, and a content specified with a URL. This parameter overrides otherwise specified or implied charset. none
 
pattern="..." Include a subset of a topic or a web page. Specify a RegularExpression that scans from start ('^') to end and contains the text you want to keep in parenthesis, e.g., pattern="^.*?(from here.*?to here).*". IncludeTopicsAndWebPages has more. none
headingoffset="2" Adjust the level of headings in the included topic. A "2" or "+2" increases the level by two, e.g. a ---+ H1 turns into a ---+++ H3. Positive and negative values are supported. Adjusted min and max levels are H1 and H6, respectively. no adjustment
hidetoc="on" Remove %TOC% in included content. Useful to show table of contents in individual topics, while suppressing them if included in a big master document. TOC_HIDE_IF_
INCLUDED setting
rev="2" Include a previous topic revision; N/A for URLs top revision
raw="on" (for HTTP inclusion) When a page is included via HTTP, normally TWiki 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
Changed:
<
<
raw="on" (for topic inclusion) When a topic is included, normally TWiki variables in the included topic are expanded in the context of the inlcluded topic. If raw="on" is specified, that variable expansion does not happen. You may wonder what's that for and what are the implications, which are found out on IncludeTopicRaw.
Because of the "in the raw" nature of the parapmeter, if it's specified, parameters such as encode, headingoffset, hidetoc, newline, nofinalnewline, and section are ignored. 		disabled
>
>
raw="on" (for topic or attachment inclusion) When a topic is included, normally TWiki variables in the included topic are expanded in the context of the inlcluded topic. If raw="on" is specified, that variable expansion does not happen. You may wonder what's that for and what are the implications, which are found out on IncludeTopicRaw.
Because of the "in the raw" nature of the parapmeter, if it's specified, parameters such as encode, headingoffset, hidetoc, newline, nofinalnewline, and section are ignored. 		disabled
 
literal="on" 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". disabled
nofinalnewline="on" Delete the new line at the end of the result if exists disabled
newline="$br" Convert newlines in textarea to other delimiters. Variable $br expands to <br /> tag, and $n to a newline. Other text is encoded based on encode parameter. no conversion
Line: 32 to 34
 
  • Security Considerations:
    • The ability to INCLUDE arbitrary URLs, such as %INCLUDE{"http://www.google.com/"}% is turned off by default. To turn this on, ask your TWiki administrator to enable the {INCLUDE}{AllowURLs} flag in the Security setup section of configure.
    • JavaScript in included web pages is filtered out as a security precaution per default. Disable filtering with raw or disableremovescript parameter.
Added:
>
>
  • Infinite INCLUDE loop prevention:
    • To prevent obvious infinite INCLUDE loop, %INCLUDE{"http://THIS_SERVER/.../THIS_WEB/THIS_TOPIC}% is detected and blocked.
    • If the server has aliases, $TWiki::cfg{UrlHostRegex} should be set so that it matches all possible server names. e.g. 
      $TWiki::cfg{UrlHostRegex} = qr{http://(www\.)?domain\.com};
  • INCLUDE attachment:
    As described above, there are two ways to include an attachment. They are similar, but behave slightly differently.
    • attachment="filename.ext"
      This works in the same manner as ordinary topic text inclusion. %STARTINCLUDE% and %STOPINCLUDE% in the attachment are observed. The section parameter is observed. The variables are expanded in the context of the topic having the attachment. For example, %TOPIC% is expanded to the name of the topic having the attachment.
    • Specifying the URL of an attachment. (e.g. %INCLUDE{%ATTACHURL%/foo.txt}%)
      The attachment content is processed in the same manner as when data is retrieved from another web server. Unless raw="on" is specified, the content of <body>...</body> is extracted, all occurrences of <script>...</script> are removed. Topic context change doesn't happen because in general inclusion via HTTP doesn't cause topic context change.
 

Revision 92012-12-27 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

INCLUDE{"page"} -- include other topic or web page

Line: 8 to 8
 
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{"TWiki.SiteMap"}%  
Changed:
<
<
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain.
IDEA! if the URL resolves to an attachment file on the server this will automatically translate to a server-side include. 		 
>
>
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain by default. See allowanytype.
IDEA! if the URL resolves to an attachment file on the server this will automatically translate to a server-side include. 		 
allowanytype="on" Suppress the content type checking in including the web page specified by a URL. disabled
 
pattern="..." Include a subset of a topic or a web page. Specify a RegularExpression that scans from start ('^') to end and contains the text you want to keep in parenthesis, e.g., pattern="^.*?(from here.*?to here).*". IncludeTopicsAndWebPages has more. none
headingoffset="2" Adjust the level of headings in the included topic. A "2" or "+2" increases the level by two, e.g. a ---+ H1 turns into a ---+++ H3. Positive and negative values are supported. Adjusted min and max levels are H1 and H6, respectively. no adjustment
hidetoc="on" Remove %TOC% in included content. Useful to show table of contents in individual topics, while suppressing them if included in a big master document. TOC_HIDE_IF_
INCLUDED setting
rev="2" Include a previous topic revision; N/A for URLs top revision
Changed:
<
<
raw="on" When a page is included, normally TWiki 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
>
>
raw="on" (for HTTP inclusion) When a page is included via HTTP, normally TWiki 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
raw="on" (for topic inclusion) When a topic is included, normally TWiki variables in the included topic are expanded in the context of the inlcluded topic. If raw="on" is specified, that variable expansion does not happen. You may wonder what's that for and what are the implications, which are found out on IncludeTopicRaw.
Because of the "in the raw" nature of the parapmeter, if it's specified, parameters such as encode, headingoffset, hidetoc, newline, nofinalnewline, and section are ignored. 		disabled
 
literal="on" 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". disabled
Added:
>
>
nofinalnewline="on" Delete the new line at the end of the result if exists disabled
newline="$br" Convert newlines in textarea to other delimiters. Variable $br expands to <br /> tag, and $n to a newline. Other text is encoded based on encode parameter. no conversion
encode="html" Encode special characters into HTML entities. If a FORMFIELD is passed into an HTML form field it should be encoded as "html". Additional encodings available: encode="quote", encode="moderate", encode="safe", encode="entity" and encode="url". See ENCODE for details. no encoding
 
disableremoveheaders="on" Bypass stripping headers from included HTML (everything until first </head> tag) disabled
disableremovescript="on" Bypass stripping all <script> tags from included HTML disabled
disableremovebody="on" Bypass stripping the </body> tag and everything around over and below it disabled
disablecompresstags="on" Bypass replacing newlines in HTML tags with spaces. This compression step rewrites unmatched <'s into &lt; entities unless bypassed disabled
disablerewriteurls="on" Bypass rewriting relative URLs into absolute ones disabled
Added:
>
>
disablefixlinks="on" Bypass fixing WikiWord links if include is done across webs. Fixing links in included text such as from SomeLink to Otherweb.SomeLink is usually desirable so that links in included text still point to the same target disabled
 
warn="off" 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
section="name" Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists. section="" is equivalent to not specifying a section  
PARAMONE="val 1"
PARAMTWO="val 2" 		Any other parameter will be defined as a variable within the scope of the included topic. The example parameters on the left will result in %PARAMONE% and %PARAMTWO% being defined within the included topic. A default value for a variable can be specified in the included topic in case the corresponding parameter is not specified, such as %PARAMONE{ default="..." }%  
Line: 27 to 33
 
    • The ability to INCLUDE arbitrary URLs, such as %INCLUDE{"http://www.google.com/"}% is turned off by default. To turn this on, ask your TWiki administrator to enable the {INCLUDE}{AllowURLs} flag in the Security setup section of configure.
    • JavaScript in included web pages is filtered out as a security precaution per default. Disable filtering with raw or disableremovescript parameter.
  • Examples: See IncludeTopicsAndWebPages
Added:
>
>
 

Revision 82011-04-14 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

INCLUDE{"page"} -- include other topic or web page

Line: 10 to 10
 
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%  
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain.
IDEA! 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 scans from start ('^') to end and contains the text you want to keep in parenthesis, e.g., pattern="^.*?(from here.*?to here).*". IncludeTopicsAndWebPages has more. none
Added:
>
>
headingoffset="2" Adjust the level of headings in the included topic. A "2" or "+2" increases the level by two, e.g. a ---+ H1 turns into a ---+++ H3. Positive and negative values are supported. Adjusted min and max levels are H1 and H6, respectively. no adjustment
hidetoc="on" Remove %TOC% in included content. Useful to show table of contents in individual topics, while suppressing them if included in a big master document. TOC_HIDE_IF_
INCLUDED setting
 
rev="2" Include a previous topic revision; N/A for URLs top revision
raw="on" When a page is included, normally TWiki 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="on" 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". disabled
Line: 20 to 22
 
disablerewriteurls="on" Bypass rewriting relative URLs into absolute ones disabled
warn="off" 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
section="name" Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists. section="" is equivalent to not specifying a section  
Changed:
<
<
PARONE="val 1"
  PARTWO="val 2" 		Any other parameter will be defined as a variable 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.  
>
>
PARAMONE="val 1"
PARAMTWO="val 2" 		Any other parameter will be defined as a variable within the scope of the included topic. The example parameters on the left will result in %PARAMONE% and %PARAMTWO% being defined within the included topic. A default value for a variable can be specified in the included topic in case the corresponding parameter is not specified, such as %PARAMONE{ default="..." }%  
 
  • Security Considerations:
    • The ability to INCLUDE arbitrary URLs, such as %INCLUDE{"http://www.google.com/"}% is turned off by default. To turn this on, ask your TWiki administrator to enable the {INCLUDE}{AllowURLs} flag in the Security setup section of configure.
    • JavaScript in included web pages is filtered out as a security precaution per default. Disable filtering with raw or disableremovescript parameter.
  • Examples: See IncludeTopicsAndWebPages
Changed:
<
<
>
>

Revision 72010-07-07 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

INCLUDE{"page"} -- include other topic or web page

Line: 25 to 25
 
    • The ability to INCLUDE arbitrary URLs, such as %INCLUDE{"http://www.google.com/"}% is turned off by default. To turn this on, ask your TWiki administrator to enable the {INCLUDE}{AllowURLs} flag in the Security setup section of configure.
    • JavaScript in included web pages is filtered out as a security precaution per default. Disable filtering with raw or disableremovescript parameter.
  • Examples: See IncludeTopicsAndWebPages
Changed:
<
<
>
>

Revision 62009-11-24 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

INCLUDE{"page"} -- include other topic or web page

Line: 21 to 21
 
warn="off" 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
section="name" Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists. section="" is equivalent to not specifying a section  
PARONE="val 1"
  PARTWO="val 2" 		Any other parameter will be defined as a variable 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.  
Changed:
<
<
  • Note: JavaScript in included webpages is filtered out as a security precaution per default (disable filter with disableremovescript parameter)
>
>
  • Security Considerations:
    • The ability to INCLUDE arbitrary URLs, such as %INCLUDE{"http://www.google.com/"}% is turned off by default. To turn this on, ask your TWiki administrator to enable the {INCLUDE}{AllowURLs} flag in the Security setup section of configure.
    • JavaScript in included web pages is filtered out as a security precaution per default. Disable filtering with raw or disableremovescript parameter.
 

Revision 52009-01-17 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

INCLUDE{"page"} -- include other topic or web page

Added:
>
>
  • Merges the content of a specified page into the current one before rendering.
 

Revision 42006-11-18 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"

INCLUDE{"page"} -- include other topic or web page

Line: 18 to 18
 
disablecompresstags="on" Bypass replacing newlines in HTML tags with spaces. This compression step rewrites unmatched <'s into &lt; entities unless bypassed disabled
disablerewriteurls="on" Bypass rewriting relative URLs into absolute ones disabled
warn="off" 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
Changed:
<
<
section="name" Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists.  
>
>
section="name" Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists. section="" is equivalent to not specifying a section  
 
PARONE="val 1"
  PARTWO="val 2" 		Any other parameter will be defined as a variable 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.  
  • Note: JavaScript in included webpages is filtered out as a security precaution per default (disable filter with disableremovescript parameter)
  • Examples: See IncludeTopicsAndWebPages

Revision 32006-11-18 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"
Deleted:
<
<
 

INCLUDE{"page"} -- include other topic or web page

Changed:
<
<
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%  
>
>
"Web.Topic" A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}%  
 
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain.
IDEA! 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 scans from start ('^') to end and contains the text you want to keep in parenthesis, e.g., pattern="^.*?(from here.*?to here).*". IncludeTopicsAndWebPages has more. none
rev="2" Include a previous topic revision; N/A for URLs top revision
Line: 19 to 18
 
disablecompresstags="on" Bypass replacing newlines in HTML tags with spaces. This compression step rewrites unmatched <'s into &lt; entities unless bypassed disabled
disablerewriteurls="on" Bypass rewriting relative URLs into absolute ones disabled
warn="off" 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
Changed:
<
<
section="name" Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists.  
>
>
section="name" Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists.  
 
PARONE="val 1"
  PARTWO="val 2" 		Any other parameter will be defined as a variable 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.  
  • Note: JavaScript in included webpages is filtered out as a security precaution per default (disable filter with disableremovescript parameter)
  • Examples: See IncludeTopicsAndWebPages
Changed:
<
<
>
>

Revision 22006-11-18 - TWikiContributor

Line: 1 to 1
 
META TOPICPARENT name="TWikiVariables"
Line: 9 to 9
 
"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{"TWiki.SiteMap"}%  
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain.
IDEA! if the URL resolves to an attachment file on the server this will automatically translate to a server-side include. 		 
Changed:
<
<
pattern="..." A RegularExpression pattern to include a subset of a topic or page none
>
>
pattern="..." Include a subset of a topic or a web page. Specify a RegularExpression that scans from start ('^') to end and contains the text you want to keep in parenthesis, e.g., pattern="^.*?(from here.*?to here).*". IncludeTopicsAndWebPages has more. none
 
rev="2" Include a previous topic revision; N/A for URLs top revision
Changed:
<
<
raw="on" When a page is included, normally TWiki 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 tags spanning multiple lines. If you prefer to include exactly what is in the source of the originating page set this to on. disabled
>
>
raw="on" When a page is included, normally TWiki 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="on" 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". disabled
disableremoveheaders="on" Bypass stripping headers from included HTML (everything until first </head> tag) disabled
disableremovescript="on" Bypass stripping all <script> tags from included HTML disabled
disableremovebody="on" Bypass stripping the </body> tag and everything around over and below it disabled
disablecompresstags="on" Bypass replacing newlines in HTML tags with spaces. This compression step rewrites unmatched <'s into &lt; entities unless bypassed disabled
disablerewriteurls="on" Bypass rewriting relative URLs into absolute ones disabled
 
warn="off" 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
Changed:
<
<
section="name" Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables  
>
>
section="name" Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists.  
 
PARONE="val 1"
  PARTWO="val 2" 		Any other parameter will be defined as a variable 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.  
Changed:
<
<
  • Note: JavaScript in included webpages is filtered out as a security precaution per default (disable filter with raw parameter)
>
>
  • Note: JavaScript in included webpages is filtered out as a security precaution per default (disable filter with disableremovescript parameter)
 
Deleted:
<
<

Revision 12005-03-27 - TWikiContributor

Line: 1 to 1
Added:
>
>
META TOPICPARENT name="TWikiVariables"

INCLUDE{"page"} -- include other topic or web page

  • Syntax: %INCLUDE{"page" ...}%
  • Supported 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{"TWiki.SiteMap"}%  
    "http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org:80/index.html"}%. Supported content types are text/html and text/plain.
    IDEA! if the URL resolves to an attachment file on the server this will automatically translate to a server-side include.     		 
    pattern="..." A RegularExpression pattern to include a subset of a topic or page none
    rev="2" Include a previous topic revision; N/A for URLs top revision
    raw="on" When a page is included, normally TWiki 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 tags spanning multiple lines. If you prefer to include exactly what is in the source of the originating page set this to on. disabled
    warn="off" 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
    section="name" Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables  
    PARONE="val 1"
      PARTWO="val 2"         		Any other parameter will be defined as a variable 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.  
  • Note: JavaScript in included webpages is filtered out as a security precaution per default (disable filter with raw parameter)
  • Examples: See IncludeTopicsAndWebPages
  • Related: BASETOPIC, BASEWEB, INCLUDINGTOPIC, INCLUDINGWEB, STARTINCLUDE, STOPINCLUDE, STARTSECTION, ENDSECTION
View topic | History: r11 < r10 < r9 < r8 | More topic actions...
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.VarINCLUDE.