none
[openafs-wiki.git] / TWiki / IncludeTopicsAndWebPages.mdwn
index d84f5fe..8b96732 100644 (file)
@@ -1,4 +1,4 @@
-**Include Topics and Web Pages Using <code>**%INCLUDE\{...\}%**</code> Variable**
+# <a name="Include Topics and Web Pages Usi"></a><a name=" Include Topics and Web Pages Us"></a> Include Topics and Web Pages Using <code>**%INCLUDE\{...\}%**</code> Variable
 
 Use the <code>**%INCLUDE\{...\}%**</code> variable to embed the content of another topic or web page inside a %WIKITOOLNAME% topic. The whole content or only parts of a page can be included.
 
@@ -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.TWikiWebsTable"\}%**</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.
 
@@ -33,31 +35,28 @@ Use the <code>**%INCLUDE\{...\}%**</code> variable to embed the content of anoth
 ### <a name="1. Display regression test resul"></a> 1. Display regression test results in a TWiki page
 
       <pre>
-      %INCLUDEURL{"http://domain/~qa/v1.1/REDTest.log.txt"}%
+      %INCLUDE{"http://domain/~qa/v1.1/REDTest.log.txt"}%
       </pre>
 
 ### <a name="2. Display Yahoo&#39;s robot.txt fil"></a> 2. Display Yahoo's robot.txt file
 
 - You type:
-  - <code>**%INCLUDE\{"http://www.yahoo.com/robots.txt"\}%**</code><br />
-- You get:
-
-    %INCLUDE{"http://www.yahoo.com/robots.txt"}%
+  - <code>**%INCLUDE\{"http://www.yahoo.com/robots.txt"\}%**</code>
 
 ### <a name="3. Display the SUNW stock quote"></a><a name="3. Display the SUNW stock quote "></a> 3. Display the SUNW stock quote in a TWiki page
 
 - You type:
-  - <code>**SUNW: %INCLUDE\{"http://finance.yahoo.com/q?s=SUNW&amp;d=v1&amp;o=t" pattern="^.\*?&gt;SUNW&lt;/a&gt;[^&lt;]+(.\*?)\\s+\\S+\\s+&lt;small.\*"\}%**</code><br />
+  - <code>**SUNW: %INCLUDE\{"http://finance.yahoo.com/q?s=SUNW&amp;d=v1&amp;o=t" pattern="^.\*?&gt;SUNW&lt;/a&gt;[^&lt;]+(.\*?)\\s+\\S+\\s+&lt;small.\*"\}%**</code>
 - You get:
   - SUNW:
 
 ### <a name="4. Display the temperature in Sa"></a> 4. Display the temperature in San Francisco
 
 - You type:
-  - <code>**San Francisco: %INCLUDE\{"http://weather.yahoo.com/forecast/San\_Francisco\_CA\_US\_f.html" pattern="^.\*?([0-9]+\\&amp;ordm\\;F).\*"\}%**</code><br />
+  - <code>**San Francisco: %INCLUDE\{"http://weather.yahoo.com/forecast/San\_Francisco\_CA\_US\_f.html" pattern="^.\*?([0-9]+\\&amp;ordm\\;F).\*"\}%**</code>
 - You get:
   - San Francisco:
 
 See also other [[TWikiVariables]].
 
--- [[PeterThoeny]] - 25 Jun 2001 <br />
+-- [[PeterThoeny]] - 15 Jan 2003