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.
Syntax
%INCLUDE{ "page" pattern="reg-exp" rev="1.2" }%
-
"page"
:
The nameless parameter specifies the page to include. It is
- The name of a topic located in the current web, e.g.,
%INCLUDE{"WebNotify"}%
- A
Web.Topic
name specifying a topic in another web, e.g., %INCLUDE{"TWiki.SiteMap"}%
- A full qualified URL with
http
protocol, domain name and optional port number, e.g., %INCLUDE{"http://twiki.org:80/index.html"}%
. Supported content types are text/html
and text/plain
. The full page is included by default, but the HTML header and scripts are stripped in case it is a web page.
-
pattern="reg-exp"
:
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.
-
rev="1.x"
:
The rev parameter is optional and allows you to include an earlier revision of a topic. This can be used to include an official version of a topic, e.g. one that has been signed of by management. This parameter does not apply to URLs.
Note: All text of a topic is included unless you specify
%STARTINCLUDE%
,
%STOPINCLUDE%
and/or a
pattern parameter.
Usage Examples
1. Display regression test results in a TWiki page
<pre>
%INCLUDE{"http://domain/~qa/v1.1/REDTest.log.txt"}%
</pre>
2. Display Yahoo's robot.txt file
- You type:
-
%INCLUDE{"http://www.yahoo.com/robots.txt"}%
3. Display the SUNW stock quote in a TWiki page
- You type:
-
SUNW: %INCLUDE{"http://finance.yahoo.com/q?s=SUNW&d=v1&o=t" pattern="^.*?>SUNW</a>[^<]+(.*?)\s+\S+\s+<small.*"}%
- You get:
4. Display the temperature in San Francisco
- You type:
-
San Francisco: %INCLUDE{"http://weather.yahoo.com/forecast/San_Francisco_CA_US_f.html" pattern="^.*?([0-9]+\º\;F).*"}%
- You get:
See also other
TWikiVariables.
--
PeterThoeny - 15 Jan 2003
to top