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

Embed topics, or subsections of topics, or other web pages.

The %INCLUDE{...}% macro embeds the content of the specified topic at the place where the INCLUDE is used. The whole content or only parts of of a page can be included.

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 contains the text you want to keep in parenthesis. It may be helpful for the pattern to match more than just the text you wish to keep, e.g. pattern="Some prefix(Start here.*?to here)". If needed, the pattern may even scan from start ('^') to end and match the whole topic, 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.

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:

Frequently Asked Questions

Want to create a new FAQ?

Access

• Does Foswiki have encrypted groups or any other technique to restrict access all the way?

Browser

• How do I enter file paths into a link? (Both local and UNC Names)

Configure

• Basic configuration for Cyrillic support
• Can I hide the System web
• How do I solve email issues
• Search doesn't find words written in my language (Eg. Chinese), help!
• configure tells me that I am "..using a version of $CGI that is know to have issues with Foswiki"
• My Foswiki shows times in UTC/GMT, how do I fix that?

Data forms

• What is a "structured wiki", and what does it mean in Foswiki?
• How can I dynamically list only fields with values on a topic?
• How do I dump my topics' formfields out as XML?
• How do I move data forms to the top of the topic?
• What are the rules on form field names? Eg. Can they have spaces?
• How can I more easily create topics that use DataForms - do I really need to write HTML code each time?

Debugging

• How can I determine which plugin might be causing me an issue
• What does "Max recursive depth reached" in the error log mean?
• How do I debug calls to third-party programs?
• How do I solve email issues
• Why can't I get a stack trace from Foswiki after a failure when using FastCGI?
• A plugin I installed is not working. How can I troubleshoot it?

Development

• Why can't I get a stack trace from Foswiki after a failure when using FastCGI?
• How can I tell what DEFs are generating certain parts of my skin/template output?
• How do I put raw text / Javascript / CSS in my topics?
• How do you handle errors resulting from calls to CGI executables or REST handlers?

Editing

• How do I enter file paths into a link? (Both local and UNC Names)
• How do I prevent Foswiki from automatically linking WikiWords?
• Where is the preview mode when editing
• Can I use the Xxx editor with Foswiki?
• How do I use WYSIWYG with NTLM?
• How do I create a Table of Contents?
• How to make wiki text editing ("raw edit") default
• How can I force WYSIWYG to save content as HTML (prevent conversion to TML?)
• How do I create two tables side by side?
• How can I stop the WYSIWYG editor converting tables to TML?
• How can I stop the WYSIWYG editor leaving tables as HTML?
• How do I put raw text / Javascript / CSS in my topics?
• How can I use LESS for CSS using Less.js
• How do I move data forms to the top of the topic?
• NatSkin and TinyMCE editor
• When creating a topic from a template, can I make it so that %MACROs% are expanded on save?
• Enabling word count in the editor

Email and Notifications

• How do I solve email issues
• Cron webnotify and mailercontrib on Ubuntu server

Errors

• I keep getting mysterious errors from RCS
• How do I solve email issues

Extension

• Can I use the Xxx editor with Foswiki?
• How do I re-write DBQUERY as SEARCH{type="query"}?
• Create a Solr search form on any page
• How do I use WYSIWYG with NTLM?
• How can I force WYSIWYG to save content as HTML (prevent conversion to TML?)
• How can I re-write image tag URLs with FilterPlugin's SUBST macro?
• How do I capture a selection in a jqgrid for use in my wiki application?
• The new PatternSkin broke my Foswiki 1.0 system
• How can I stop the WYSIWYG editor converting tables to TML?
• How can I use JQueryTextboxList on my own HTML input field (without using data forms)?
• How can I stop the WYSIWYG editor leaving tables as HTML?
• How can I process lists in Foswiki, or what is the modern replacement for ForEachPlugin?
• NatSkin and TinyMCE editor
• How can I set a topic variable using a HTML form button/elements?
• A plugin I installed is not working. How can I troubleshoot it?
• Do I really have to hard-code a formatted search to suit a given form and its fields?
• How do I search for all child topics, including their descendants?
• Enabling word count in the editor
• How can I more easily create topics that use DataForms - do I really need to write HTML code each time?

Foswiki

• What is a "structured wiki", and what does it mean in Foswiki?
• Search doesn't find words written in my language (Eg. Chinese), help!

Frontend or Javascript or CSS

• How do I capture a selection in a jqgrid for use in my wiki application?
• The new PatternSkin broke my Foswiki 1.0 system
• How do I create two tables side by side?
• How can I use JQueryTextboxList on my own HTML input field (without using data forms)?
• How do I put raw text / Javascript / CSS in my topics?
• How can I use LESS for CSS using Less.js

Help and Support

• programatically Rename a Topic
• Where can I find professional support?

Installation

• Installation on Redhat
• Can I hide the System web
• Search doesn't find words written in my language (Eg. Chinese), help!
• How to install Foswiki on Mac OS X Leopard
• Where can I find professional support?

Internationalisation or Localisation

• Basic configuration for Cyrillic support
• Limitations in support for Dates
• Search doesn't find words written in my language (Eg. Chinese), help!
• My Foswiki shows times in UTC/GMT, how do I fix that?

Macros or Variables

• How can I broadcast a message to my wiki users, Eg. for maintenance reasons?
• How can I set a topic variable using a HTML form button/elements?

Operating system

• How do I solve email issues
• Cron webnotify and mailercontrib on Ubuntu server
• How to install Foswiki on Mac OS X Leopard

Public websites

• How can I create a simple Google Sitemap for Search Engine Optimisation?

Registration or Authentication or Authorisation

• Login for foswiki-beginners-vm
• Can I hide the System web
• How can I manually approve registrations?
• How do I solve email issues
• Why can't I use BasicAuth to protect configure with FastCGI?
• How can I rebuild my WikiUsers topic?
• How do I use WYSIWYG with NTLM?
• How can I create my own login box in a topic of my choice?
• How can I show the user's e-mail address in the Users topic?

Search

• How can I create a simple Google Sitemap for Search Engine Optimisation?
• How do I re-write DBQUERY as SEARCH{type="query"}?
• How can I report a list of topic children, with a total number of topics under each?
• Create a Solr search form on any page
• How do I find topics not listed on a topic?
• How can I dynamically list only fields with values on a topic?
• How do I stop a FormattedSearch using $formfield() from breaking TML tables?
• Do I really have to hard-code a formatted search to suit a given form and its fields?
• Can a SEARCH take another SEARCH's output as input? How to search all webs and subwebs, while excluding subwebs of a particular web
• How can I SEARCH for topics which have some metadata (Eg. parent.name) that I want to change?
• How do I search for all child topics, including their descendants?
• My SEARCHes are a mess. How can I write them more clearly?

Security

• How do I enter file paths into a link? (Both local and UNC Names)
• How can I secure my Foswiki against hostile attacks?
• Can I hide the System web
• How do I configure Apache to always redirect users to my secure (https) site?

Setup

• Basic configuration for Cyrillic support
• How does Foswiki find Perl libraries? And how do I change that?
• My Foswiki shows times in UTC/GMT, how do I fix that?
• How should I set filesystem access modes?
• Does Foswiki require Javascript?
• Cron webnotify and mailercontrib on Ubuntu server

Templates

• How can I tell what DEFs are generating certain parts of my skin/template output?

Upgrading

• (obsolete) How do I safely upgrade a customized Foswiki installation
• The new PatternSkin broke my Foswiki 1.0 system

Usage

• How do I enter file paths into a link? (Both local and UNC Names)
• How do I prevent Foswiki from automatically linking WikiWords?
• How do I (bulk) import data into Foswiki?
• How do I create a Table of Contents?
• How can I broadcast a message to my wiki users, Eg. for maintenance reasons?
• How can I process lists in Foswiki, or what is the modern replacement for ForEachPlugin?
• How do I put raw text / Javascript / CSS in my topics?
• How do I move data forms to the top of the topic?
• Does Foswiki require Javascript?
• When creating a topic from a template, can I make it so that %MACROs% are expanded on save?
• Where can I find professional support?

User interface

• Can I use the Xxx editor with Foswiki?
• How can I more easily create topics that use DataForms - do I really need to write HTML code each time?

Web server

• How can I secure my Foswiki against hostile attacks?
• How do I configure Apache to always redirect users to my secure (https) site?
• How do I redirect users from old twiki install to new foswiki install urls?

Other...

• How do I (bulk) import data into Foswiki?
• How do I debug calls to third-party programs?
• How can I broadcast a message to my wiki users, Eg. for maintenance reasons?
• How do I remotely update topics (form fields)?
• Is there a nice way to make a (pre-computed) version of a slow page available, so Foswiki doesn't have to expand all its macros on every single view?
• How do I dump my topics' formfields out as XML?
• Does Foswiki require Javascript?

3. Include a topic

• You type:

  %INCLUDE{"%SYSTEMWEB%.TipsOfTheDayInclude"}%

• You get:

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.

---

Related Topics: VarINCLUDE, UserDocumentationCategory