1 rizwank 1.1 %META:TOPICINFO{author="PeterThoeny" date="1092555397" format="1.0" version="1.7"}%
 2             ---+!! Include Topics and Web Pages Using ==%<nop>INCLUDE{...}%== Variable
 3             
 4             Use the ==%<nop>INCLUDE{...}%== variable to embed the content of another topic or web page inside a %WIKITOOLNAME% topic. The whole content or only parts of a page can be included. If needed, set a proxy server in %WIKIPREFSTOPIC%.
 5             
 6             %TOC%
 7             
 8             
 9             ---++ Syntax
10             
11             ==%<nop>INCLUDE{ "page" pattern="reg-exp" rev="1.2" }%==
12             
13             	* =="page"==: %BR%
14             	  The nameless parameter specifies the page to include. It is
15             		* The name of a topic located in the current web, e.g., ==%<nop>INCLUDE{"WebNotify"}%==
16             		* A =Web.Topic= name specifying a topic in another web, e.g., ==%<nop>INCLUDE{"%TWIKIWEB%.SiteMap"}%==
17             		* A full qualified URL with ==http== protocol, domain name and optional port number, e.g., ==%<nop>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.
18             
19             	* ==pattern="reg-exp"==: %BR%
20             	  The *pattern* parameter is optional and allows you to extract some parts of a web page. Specify a %TWIKIWEB%.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.
21             
22 rizwank 1.1 	* ==rev="1.x"==: %BR%
23             	  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.
24             
25             __Note:__ All text of a topic is included unless you specify ==%<nop>STARTINCLUDE%==, ==%<nop>STOPINCLUDE%== and/or a *pattern* parameter. A pattern will only search between ==%<nop>STARTINCLUDE%== and ==%<nop>STOPINCLUDE%==.
26             
27             ---++ Usage Examples
28             
29             ---+++ 1. Display regression test results in a TWiki page
30             <pre>
31               &lt;pre&gt;
32               %<nop>INCLUDE{"http://domain/~qa/v1.1/REDTest.log.txt"}%
33               &lt;/pre&gt;
34             </pre>
35             
36             ---+++ 2. Display Google's robot.txt file
37             
38             	* You type:
39             		* ==%<nop>INCLUDE{"http://www.google.com/robots.txt"}%==
40             
41             ---+++ 3. Display the current time in Tokyo in a TWiki page
42             
43 rizwank 1.1 	* You type:
44             		* ==Tokyo: %<nop>INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}%==
45             	* You get:
46             		* Tokyo: %INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}%
47             
48             See also other TWikiVariables.
49             
50             -- TWiki:Main.PeterThoeny - 15 Aug 2004
51