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

Use the %INCLUDE{...}% macro to embed the content of another topic or web page inside a topic. The whole content or only parts of a page can be included. If needed, set a proxy server with the {PROXY}{HOST} and {PROXY}{PORT} settings in configure.

Syntax Example

%INCLUDE{ "page" pattern="reg-exp" rev="2" warn="off" section="clients" PARAMETER1="value" PARAMETER2="Some value"}%

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.

The example parameters PARAMETER1 and PARAMETER2 will be defined as macros within the scope of the included topic. The example parameters shown will result in %PARAMETER1% and %PARAMETER2% being defined within the included topic.

VarINCLUDE explains the other parameters.

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

1. Display regression test results

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

2. Display foswiki.org's frequently asked questions

• You type:

  %INCLUDE{"http://foswiki.org/Support/FrequentlyAskedQuestion?skin=text"}%

• You get:

Warning

This site does not allow %INCLUDE% of URLs

Note: Including URLs is disabled by default as it presents a security risk. It may be enabled via configure. Only enable this if you understand the risk.

3. Include a topic

• You type:

  %INCLUDE{%SYSTEMWEB%.TipsOfTheDayInclude}%

• You get:

Tip of the Day

Server side include
To include the contents of a web page or Foswiki topic, use % nop INCLUDE{"page"}% . Examples: ... Read on 

4. Include a topic MyTopic with two parameters

You include the topic with this line

  %INCLUDE{ "MyTopic" BETTER="apples" WORSE="Oranges"}%

An example of a very simple MyTopic could contain

   * I like %BETTER% better than %WORSE%.

The result would be

• I like apples better than oranges.