none
[openafs-wiki.git] / TWiki / IncludeTopicsAndWebPages.mdwn
index 2c09b83..7a4eba4 100644 (file)
@@ -17,14 +17,16 @@ Use the <code>**%INCLUDE\{...\}%**</code> variable to embed the content of anoth
 
 ## <a name="Syntax"></a> Syntax
 
-<code>**%INCLUDE\{"page" pattern="reg-exp"\}%**</code>
+<code>**%INCLUDE\{ "page" pattern="reg-exp" rev="1.2" \}%**</code>
 
-- <code>**"page"**</code>: <br /> The nameless parameter specifies the page to include. It is
-  - The name of a topic located in the current web, i.e. <code>**%INCLUDE\{"WebNotify"\}%**</code>
-  - A `Web.Topic` name specifying a topic in another web, i.e. <code>**%INCLUDE\{"TWiki.SiteMap"\}%**</code>
-  - A full qualified URL with <code>**http**</code> protocol, domain name and optional port number, i.e. <code>**%INCLUDE\{"http://twiki.org:80/index.html"\}%**</code>. Supported content types are <code>**text/html**</code> and <code>**text/plain**</code>. The full page is included by default, but the HTML header and scripts are stripped in case it is a web page.
+- <code>**"page"**</code>: %BR% The nameless parameter specifies the page to include. It is
+  - The name of a topic located in the current web, e.g., <code>**%INCLUDE\{"WebNotify"\}%**</code>
+  - A `Web.Topic` name specifying a topic in another web, e.g., <code>**%INCLUDE\{"TWiki.SiteMap"\}%**</code>
+  - A full qualified URL with <code>**http**</code> protocol, domain name and optional port number, e.g., <code>**%INCLUDE\{"http://twiki.org:80/index.html"\}%**</code>. Supported content types are <code>**text/html**</code> and <code>**text/plain**</code>. The full page is included by default, but the HTML header and scripts are stripped in case it is a web page.
 
-- <code>**pattern="reg-exp"**</code>: <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, i.e. <code>**pattern="^.\*?(from here.\*?to here).\*"**</code>. 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.
+- <code>**pattern="reg-exp"**</code>: %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., <code>**pattern="^.\*?(from here.\*?to here).\*"**</code>. 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.
+
+- <code>**rev="1.x"**</code>: %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 <code>**%STARTINCLUDE%**</code>, <code>**%STOPINCLUDE%**</code> and/or a **pattern** parameter.