X-Git-Url: https://git.openafs.org/?p=openafs-wiki.git;a=blobdiff_plain;f=TWiki%2FIncludeTopicsAndWebPages.mdwn;h=7a4eba4164c881ddefc55a3ef9317dd6ba16f9cc;hp=2c09b832509a390f2f073ab1bd66d14ce01eee67;hb=1c001fddc712dd7e4420a502a320709597e8cb02;hpb=ef766f700da90c49cbc33afd535cb70d78d4cc67
diff --git a/TWiki/IncludeTopicsAndWebPages.mdwn b/TWiki/IncludeTopicsAndWebPages.mdwn
index 2c09b83..7a4eba4 100644
--- a/TWiki/IncludeTopicsAndWebPages.mdwn
+++ b/TWiki/IncludeTopicsAndWebPages.mdwn
@@ -17,14 +17,16 @@ Use the **%INCLUDE\{...\}%**
variable to embed the content of anoth
## Syntax
-**%INCLUDE\{"page" pattern="reg-exp"\}%**
+**%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, i.e. **%INCLUDE\{"WebNotify"\}%**
- - A `Web.Topic` name specifying a topic in another web, i.e. **%INCLUDE\{"TWiki.SiteMap"\}%**
- - 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.
+- **"page"**
: %BR% 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, 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.
+- **pattern="reg-exp"**
: %BR% 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"**
: %BR% 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.