X-Git-Url: https://git.openafs.org/?p=openafs-wiki.git;a=blobdiff_plain;f=TWiki%2FIncludeTopicsAndWebPages.mdwn;h=8b96732007d913b01e4bb819829d2a4aca82aed6;hp=d84f5fec16aaf3d361d10028da77123417e0462d;hb=165cf333db8ce6374c2f67389ccad3bec8459e11;hpb=20720553ef52f375e4fa2fe45d12dc03d623b943 diff --git a/TWiki/IncludeTopicsAndWebPages.mdwn b/TWiki/IncludeTopicsAndWebPages.mdwn index d84f5fe..8b96732 100644 --- a/TWiki/IncludeTopicsAndWebPages.mdwn +++ b/TWiki/IncludeTopicsAndWebPages.mdwn @@ -1,4 +1,4 @@ -**Include Topics and Web Pages Using **%INCLUDE\{...\}%** Variable** +# Include Topics and Web Pages Using **%INCLUDE\{...\}%** Variable Use the **%INCLUDE\{...\}%** 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 **%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.TWikiWebsTable"\}%** - - 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. @@ -33,31 +35,28 @@ Use the **%INCLUDE\{...\}%** variable to embed the content of anoth ### 1. Display regression test results in a TWiki page 
-      %INCLUDEURL{"http://domain/~qa/v1.1/REDTest.log.txt"}%
+      %INCLUDE{"http://domain/~qa/v1.1/REDTest.log.txt"}%
### 2. Display Yahoo's robot.txt file - You type: - - **%INCLUDE\{"http://www.yahoo.com/robots.txt"\}%**
-- You get: - - %INCLUDE{"http://www.yahoo.com/robots.txt"}% + - **%INCLUDE\{"http://www.yahoo.com/robots.txt"\}%** ### 3. Display the SUNW stock quote in a TWiki page - You type: - - **SUNW: %INCLUDE\{"http://finance.yahoo.com/q?s=SUNW&d=v1&o=t" pattern="^.\*?>SUNW</a>[^<]+(.\*?)\\s+\\S+\\s+<small.\*"\}%**
+ - **SUNW: %INCLUDE\{"http://finance.yahoo.com/q?s=SUNW&d=v1&o=t" pattern="^.\*?>SUNW</a>[^<]+(.\*?)\\s+\\S+\\s+<small.\*"\}%** - You get: - SUNW: ### 4. Display the temperature in San Francisco - You type: - - **San Francisco: %INCLUDE\{"http://weather.yahoo.com/forecast/San\_Francisco\_CA\_US\_f.html" pattern="^.\*?([0-9]+\\&ordm\\;F).\*"\}%**
+ - **San Francisco: %INCLUDE\{"http://weather.yahoo.com/forecast/San\_Francisco\_CA\_US\_f.html" pattern="^.\*?([0-9]+\\&ordm\\;F).\*"\}%** - You get: - San Francisco: See also other [[TWikiVariables]]. --- [[PeterThoeny]] - 25 Jun 2001
+-- [[PeterThoeny]] - 15 Jan 2003