none
authorPeterThoeny <PeterThoeny>
Wed, 11 Dec 2002 08:18:06 +0000 (08:18 +0000)
committerPeterThoeny <PeterThoeny>
Wed, 11 Dec 2002 08:18:06 +0000 (08:18 +0000)
TWiki/IncludeTopicsAndWebPages.mdwn
TWiki/TWikiMetaData.mdwn
TWiki/TWikiVariables.mdwn

index 7aa3813..7a4eba4 100644 (file)
@@ -20,13 +20,13 @@ Use the <code>**%INCLUDE\{...\}%**</code> variable to embed the content of anoth
 <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.
+  - 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.
+- <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.
 
index 1d61a25..7cefd21 100644 (file)
@@ -97,11 +97,11 @@ This is optional, exists if topic has ever been moved. If a topic is moved more
   </tr>
   <tr>
     <td> from </td>
-    <td> Full name i.e. web.topic </td>
+    <td> Full name, i.e., web.topic </td>
   </tr>
   <tr>
     <td> to </td>
-    <td> Full name i.e. web.topic </td>
+    <td> Full name, i.e., web.topic </td>
   </tr>
   <tr>
     <td> by </td>
@@ -206,7 +206,7 @@ Extra fields that are added if an attachment is moved:
   </tr>
   <tr>
     <td> name </td>
-    <td> A topic name - the topic represents one of the [[Main/TWikiForms]]. Can optionally include the web name i.e. web.topic, but doesn't normally </td>
+    <td> A topic name - the topic represents one of the [[Main/TWikiForms]]. Can optionally include the web name (i.e., web.topic), but doesn't normally </td>
   </tr>
 </table>
 
@@ -252,7 +252,7 @@ The recommended sequence is:
 
 ## <a name="Viewing Meta Data in Page Source"></a> Viewing Meta Data in Page Source
 
-When viewing a topic the <code>**Raw Text**</code> link can be clicked to show the text of a topic (ie: as seen when editing). This is done by adding `raw=on` to URL. `raw=debug` shows the meta data as well as the topic data, ex: [debug view for this topic](http://www.dementia.org/twiki//view/%WEB%/%TOPIC%?raw=debug)
+When viewing a topic the <code>**Raw Text**</code> link can be clicked to show the text of a topic (i.e., as seen when editing). This is done by adding `raw=on` to URL. `raw=debug` shows the meta data as well as the topic data, ex: [debug view for this topic](http://www.dementia.org/twiki//view/%WEB%/%TOPIC%?raw=debug)
 
 <a name="MetaDataRendering"></a>
 
index 58077dc..1b23cfb 100644 (file)
@@ -221,7 +221,7 @@ This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - expands the
   </tr>
   <tr>
     <td><code>%GMTIME%</code></td>
-    <td> GM time, is <b>29 Jun 2010 - 15:37</b></td>
+    <td> GM time, is <b>29 Jun 2010 - 15:38</b></td>
   </tr>
   <tr>
     <td><code>%GMTIME{"format"}%</code></td>
@@ -271,15 +271,15 @@ This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - expands the
           <td> 2 digit year </td>
           <td> 99 </td>
         </tr>
-      </table> Variables can be shortened to 3 characters. Example: <br /><code>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</code> is <br /><b>29 Jun, 2010 - 15:37:42</b></td>
+      </table> Variables can be shortened to 3 characters. Example: <br /><code>%GMTIME{"$day $month, $year - $hour:$min:$sec"}%</code> is <br /><b>29 Jun, 2010 - 15:38:05</b></td>
   </tr>
   <tr>
     <td><code>%SERVERTIME%</code></td>
-    <td> Server time, is <b>29 Jun 2010 - 11:37</b></td>
+    <td> Server time, is <b>29 Jun 2010 - 11:38</b></td>
   </tr>
   <tr>
     <td><code>%SERVERTIME{"format"}%</code></td>
-    <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:37</b></td>
+    <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:38</b></td>
   </tr>
   <tr>
     <td><code>%HTTP_HOST%</code></td>
@@ -299,18 +299,36 @@ This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - expands the
   </tr>
   <tr>
     <td><code>%INCLUDE{"page" ...}%</code></td>
-    <td> Server side include to [[Main/IncludeTopicsAndWebPages]]. Parameters are page name, and an optional <code>pattern="(reg-exp)"</code>. The page name is: <table border="1" cellpadding="0" cellspacing="0">
+    <td> Server side include to [[Main/IncludeTopicsAndWebPages]]: <table border="1" cellpadding="0" cellspacing="0">
+        <tr>
+          <th bgcolor="#99CCCC"><strong> Parameter: </strong></th>
+          <th bgcolor="#99CCCC"><strong> Description: </strong></th>
+          <th bgcolor="#99CCCC"><strong> Default: </strong></th>
+        </tr>
         <tr>
           <td><code>"SomeTopic"</code></td>
           <td> The name of a topic located in the current web, i.e. <code>%INCLUDE{"WebNotify"}%</code></td>
+          <td>   </td>
         </tr>
         <tr>
           <td><code>"Web.Topic"</code></td>
           <td> A topic in another web, i.e. <code>%INCLUDE{"TWiki.SiteMap"}%</code></td>
+          <td>   </td>
         </tr>
         <tr>
           <td><code>"http://..."</code></td>
           <td> A full qualified URL, i.e. <code>%INCLUDE{"http://twiki.org/"}%</code></td>
+          <td>   </td>
+        </tr>
+        <tr>
+          <td><code>pattern="..."</code></td>
+          <td> A [[Main/RegularExpression]] pattern to include a subset of a topic or page </td>
+          <td> none </td>
+        </tr>
+        <tr>
+          <td><code>rev="1.2"</code></td>
+          <td> Include a previous topic revision; N/A for URLs </td>
+          <td> top revision </td>
         </tr>
       </table>
     </td>
@@ -431,7 +449,7 @@ This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - expands the
           <td> Show number </td>
         </tr>
         <tr>
-          <td><code><b>header="..."</b></code><br /><code><b>format="..."</b></code></td>
+          <td><code>header="..."</code><br /><code>format="..."</code></td>
           <td> Custom format results: see <strong>[[Main/FormattedSearch]]</strong> for usage, variables &amp; examples </td>
           <td> Results in table </td>
         </tr>