|
<
< | Include Topics and Web Pages Using %INCLUDE{...}% Variable |
>
> | 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. |
>
> | 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 |
| | |
|
<
< | Syntax |
>
> | %INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" }% |
| | |
|
<
< | %INCLUDE{ "page" pattern="reg-exp" rev="1.2" }% |
>
> | 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. |
| | |
|
<
< |
-
"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.
|
>
> | TWikiVariables#VarINCLUDE explains the other parameters. |
| | |
|
<
< |
-
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. A pattern will only search between %STARTINCLUDE% and %STOPINCLUDE%. |
>
> | 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 |
| | 2. Display Google's robot.txt file |
|
<
< |
- You type:
-
%INCLUDE{"http://www.google.com/robots.txt"}%
|
>
> |
%INCLUDE{"http://www.google.com/robots.txt"}%
|
| | 3. Display the current time in Tokyo in a TWiki page
|
|
<
< |
-
-
Tokyo: %INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}%
|
>
> |
-
-
Tokyo: %INCLUDE{"http://TWiki.org/cgi-bin/xtra/tzdate?tz=Asia/Tokyo" pattern="^.*<\!--tzdate:date-->(.*?)<\!--/tzdate:date-->.*"}%
|
| |
<-- template: messages.nat.tmpl -->
- Warning
- This site does not allow %INCLUDE% of URLs
|
|
<
< | See also other TWikiVariables.
-- TWiki:Main.PeterThoeny - 15 Aug 2004 |
>
> | Related Topics: TWikiVariables#VarINCLUDE, UserDocumentationCategory |
| | |