Difference: IncludeTopicsAndWebPages (1 vs. 14)

Revision 72004-08-15 - PeterThoeny

Revision 62003-02-01 - PeterThoeny

Revision 52003-01-16 - PeterThoeny

Revision 42002-12-11 - PeterThoeny

Revision 32002-11-14 - PeterThoeny

Revision 22002-04-07 - PeterThoeny

Revision 12001-06-26 - PeterThoeny

Line: 1 to 1
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.


%INCLUDE{"page" pattern="reg-exp"}%

  • "page":
    The nameless parameter specifies the page to include. It is
    • The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}%
    • A Web.Topic name specifying a topic in another web, i.e. %INCLUDE{"TWiki.TWikiWebsTable"}%
    • A full qualified URL with http protocol, domain name and optional port number, i.e. %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, i.e. pattern="^.*?(from here.*?to here).*". You need to make sure that the integrity of a web page is not compromised, i.e. if you include a table make sure to include everything including the table end tag.

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


2. Display Yahoo's robot.txt file

  • You type:
    • %INCLUDE{"http://www.yahoo.com/robots.txt"}%
  • You get:

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:
    • SUNW:
This site does not allow %INCLUDE% of URLs

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]+\&ordm\;F).*"}%
  • You get:
    • San Francisco:
This site does not allow %INCLUDE% of URLs

See also other TWikiVariables.

-- PeterThoeny - 25 Jun 2001

This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.IncludeTopicsAndWebPages.