Include Topics and Web Pages Using %INCLUDE{...}%
Variable
Use the
%INCLUDE{...}%
variable to embed the content of another topic or web page inside a TWiki topic. The whole content or only parts of a page can be included. If needed, set a proxy server in
TWikiPreferences.
Syntax Example
%INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" PARAMETER1="value" PARAMETER2="Some value"}%
The
pattern
parameter is optional and allows you to extract some parts of 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).*"
. You need to make sure that the integrity of a web page is not compromised; for example, if you include a table, make sure to include everything including the table end tag.
The example parameters PARAMETER1 and PARAMETER2 will be defined as a variable within the scope of the included topic. The example parameters shown will result in %PARAMETER1% and %PARAMETER2% being defined within the included topic.
VarINCLUDE explains the other parameters.
Note: All text of a topic is included unless it contains a
%STARTINCLUDE%
and
%STOPINCLUDE%
, or you specify a
section
parameter and/or a
pattern
parameter. A pattern will only search between
%STARTINCLUDE%
and
%STOPINCLUDE%
.
Usage Examples
1. Display regression test results in a TWiki page
<pre>
%INCLUDE{"http://domain/~qa/v1.1/REDTest.log.txt"}%
</pre>
2. Display Google's robot.txt file
%INCLUDE{"http://www.google.com/robots.txt"}%
3. Display the current time in Tokyo in a TWiki page
- You type:
-
Tokyo: %INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}%
- You get:
- Warning
- This site does not allow %INCLUDE% of URLs
4. Include a topic MyTopic with two parameters
You include the topic with this line
%INCLUDE{ "MyTopic" BETTER="apples" WORSE="Oranges"}%
An example of a very simple MyTopic could contain
* I like %BETTER% better than %WORSE%.
The result would be
- I like apples better than oranges.
Related Topics: VarINCLUDE,
UserDocumentationCategory