TWiki/IncludeTopicsAndWebPages.mdwn

   1 # <a name="Include Topics and Web Pages Usi"></a><a name=" Include Topics and Web Pages Us"></a> Include Topics and Web Pages Using `%INCLUDE{...}%` Variable
   2
   3 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]].
   4
   5 <div>
   6   <ul>
   7     <li><a href="#Syntax Example"> Syntax Example</a></li>
   8     <li><a href="#Usage Examples"> Usage Examples</a><ul>
   9         <li><a href="#1. Display regression test resul"> 1. Display regression test results in a TWiki page</a></li>
  10         <li><a href="#2. Display Google's robot.txt fi"> 2. Display Google's robot.txt file</a></li>
  11         <li><a href="#3. Display the current time in T"> 3. Display the current time in Tokyo in a TWiki page</a></li>
  12       </ul>
  13     </li>
  14   </ul>
  15 </div>
  16
  17 ## <a name="Syntax Example"></a> Syntax Example
  18
  19 `%INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" }%`
  20
  21 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.
  22
  23 [[VarINCLUDE]] explains the other parameters.
  24
  25 **_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%`.
  26
  27 ## <a name="Usage Examples"></a> Usage Examples
  28
  29 ### <a name="1. Display regression test resul"></a> 1. Display regression test results in a TWiki page
  30
  31       <pre>
  32       %INCLUDE{"http://domain/~qa/v1.1/REDTest.log.txt"}%
  33       </pre>
  34
  35 ### <a name="2. Display Google&#39;s robot.txt fi"></a> 2. Display Google's robot.txt file
  36
  37       %INCLUDE{"http://www.google.com/robots.txt"}%
  38
  39 ### <a name="3. Display the current time in T"></a> 3. Display the current time in Tokyo in a TWiki page
  40
  41 - You type:
  42   - <code>**Tokyo: %INCLUDE\{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.\*&lt;\\!--tzdate:date--&gt;(.\*?)&lt;\\!--/tzdate:date--&gt;.\*"\}%**</code>
  43 - You get:
  44   - Tokyo:
  45
  46 **_Related Topics:_** [[VarINCLUDE]], [[UserDocumentationCategory]]