View topic | Edit | WYSIWYGAttachPrintable
r5 - 16 Jan 2003 - 07:35:00 - PeterThoeny?You are here: Astrophysics Wiki >  TWiki Web  > IncludeTopicsAndWebPages

Include Topics and Web Pages Using %INCLUDE{...}% Variable

Use the %INCLUDE{...}% variable to embed the content of another topic or web page inside a Astrophysics Wiki topic. The whole content or only parts of a page can be included.

Syntax

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

  • "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.

  • 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.

Usage Examples

1. Display regression test results in a TWiki page

  <pre>
  %INCLUDE{"http://domain/~qa/v1.1/REDTest.log.txt"}%
  </pre>

2. Display Yahoo's robot.txt file

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

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:

Warning
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:

Warning
This site does not allow %INCLUDE% of URLs

See also other TWikiVariables.

-- PeterThoeny? - 15 Jan 2003

View topic | Edit |  | WYSIWYG | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r9 |r7 < r6 < r5 < r4 | More topic actions...

key Log In or Register
Information

Main Web Users Groups Index Search Changes Notifications Statistics Preferences


Webs Main Sandbox TWiki Zen Information

Main Web Users Groups Index Search Changes Notifications Statistics Preferences


Webs Main Sandbox TWiki Zen





 
Astrophysics Wiki


Edit Wysiwyg Attach Printable
This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Astrophysics Wiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.IncludeTopicsAndWebPages