wiki-archive/twiki/data/TWiki/IncludeTopicsAndWebPages.txt

42 lines
1.9 KiB
Plaintext

%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="9"}%
---+!! Include Topics and Web Pages Using =%<nop>INCLUDE{...}%= Variable
Use the =%<nop>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 %WIKIPREFSTOPIC%.
%TOC%
---++ Syntax Example
=%<nop>INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" }%=
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.
VarINCLUDE explains the other parameters.
__Note:__ All text of a topic is included unless it contains a =%<nop>STARTINCLUDE%= and =%<nop>STOPINCLUDE%=, or you specify a =section= parameter and/or a =pattern= parameter. A pattern will only search between =%<nop>STARTINCLUDE%= and =%<nop>STOPINCLUDE%=.
---++ Usage Examples
---+++ 1. Display regression test results in a TWiki page
<pre>
&lt;pre&gt;
%<nop>INCLUDE{"http://domain/~qa/v1.1/REDTest.log.txt"}%
&lt;/pre&gt;
</pre>
---+++ 2. Display Google's robot.txt file
<pre>
%<nop>INCLUDE{"http://www.google.com/robots.txt"}%
</pre>
---+++ 3. Display the current time in Tokyo in a TWiki page
* You type:
* ==Tokyo: %<nop>INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*&lt;\!--tzdate:date--&gt;(.*?)&lt;\!--/tzdate:date--&gt;.*"}%==
* You get:
* Tokyo: %INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}%
__Related Topics:__ VarINCLUDE, UserDocumentationCategory