none
authorPeterThoeny <PeterThoeny>
Wed, 17 Mar 2004 07:03:50 +0000 (07:03 +0000)
committerPeterThoeny <PeterThoeny>
Wed, 17 Mar 2004 07:03:50 +0000 (07:03 +0000)
TWiki/FormattedSearch.mdwn
TWiki/TWikiVariables.mdwn
TWiki/TextFormattingFAQ.mdwn
TWiki/TextFormattingRules.mdwn
TWiki/WelcomeGuest.mdwn

index 8420720..3129702 100644 (file)
         </li>
       </ul>
     </li>
+    <li><a href="#TWiki Installation Error">TWiki Installation Error</a><ul>
+        <li>
+          <ul>
+            <li><a href="#Embedding search forms to return"> Embedding search forms to return a formatted result</a></li>
+          </ul>
+        </li>
+      </ul>
+    </li>
     <li><a href="#TWiki Installation Error">TWiki Installation Error</a></li>
   </ul>
 </div>
@@ -64,7 +72,7 @@ Variables that can be used in the format string:
   </tr>
   <tr>
     <td><code>$web</code></td>
-    <td> Name of the web(s), separated by commas, or 'all' </td>
+    <td> Name of the web </td>
   </tr>
   <tr>
     <td><code>$topic</code></td>
@@ -92,33 +100,53 @@ Variables that can be used in the format string:
   </tr>
   <tr>
     <td><code>$date</code></td>
-    <td> Time stamp of last topic update, like <code>29 Jun 2010 - 15:43</code></td>
+    <td> Time stamp of last topic update, e.g. <code>29 Jun 2010 - 15:44</code></td>
   </tr>
   <tr>
     <td><code>$isodate</code></td>
-    <td> Time stamp of last topic update, like <code>2010-06-29T15:43Z</code></td>
+    <td> Time stamp of last topic update, e.g. <code>2010-06-29T15:44Z</code></td>
   </tr>
   <tr>
     <td><code>$rev</code></td>
-    <td> Number of last topic revision, like <code>1.4</code></td>
+    <td> Number of last topic revision, e.g. <code>1.4</code></td>
   </tr>
   <tr>
     <td><code>$username</code></td>
-    <td> Login name of last topic update, like <code>jsmith</code></td>
+    <td> Login name of last topic update, e.g. <code>jsmith</code></td>
   </tr>
   <tr>
     <td><code>$wikiname</code></td>
-    <td> Wiki user name of last topic update, like <code>JohnSmith</code></td>
+    <td> Wiki user name of last topic update, e.g. <code>JohnSmith</code></td>
   </tr>
   <tr>
     <td><code>$wikiusername</code></td>
     <td> Wiki user name of last topic update, like <code>Main.JohnSmith</code></td>
   </tr>
   <tr>
+    <td><code>$createdate</code></td>
+    <td> Time stamp of topic revision 1.1 </td>
+  </tr>
+  <tr>
+    <td><code>$createusername</code></td>
+    <td> Login name of topic revision 1.1, e.g. <code>jsmith</code></td>
+  </tr>
+  <tr>
+    <td><code>$createwikiname</code></td>
+    <td> Wiki user name of topic revision 1.1, e.g. <code>JohnSmith</code></td>
+  </tr>
+  <tr>
+    <td><code>$createwikiusername</code></td>
+    <td> Wiki user name of topic revision 1.1, e.g. <code>Main.JohnSmith</code></td>
+  </tr>
+  <tr>
     <td><code>$summary</code></td>
     <td> Topic summary </td>
   </tr>
   <tr>
+    <td><code>$formname</code></td>
+    <td> The name of the form attached to the topic; empty if none </td>
+  </tr>
+  <tr>
     <td><code>$formfield(name)</code></td>
     <td> The field value of a form field; for example, <code>$formfield(TopicClassification)</code> would get expanded to <code>PublicFAQ</code>. This applies only to topics that have a [[Main/TWikiForms]]</td>
   </tr>
@@ -136,7 +164,7 @@ Variables that can be used in the format string:
   </tr>
   <tr>
     <td><code>$pattern(reg-exp)</code></td>
-    <td> A regular expression pattern to extract some text from a topic. In case of a <code>multiple="on"</code> search, the pattern is applied to the line found in each search hit. For example, <code>$pattern(.*?\*.*?Email\:\s*([^\n\r]+).*)</code> extracts the email address from a bullet of format <code>* Email: ...</code>. </td>
+    <td> A regular expression pattern to extract some text from a topic (does not search meta data; use <code>$formfield</code> instead). In case of a <code>multiple="on"</code> search, the pattern is applied to the line found in each search hit. The pattern must cover the whole text (topic or line). For example, <code>$pattern(.*?\*.*?Email\:\s*([^\n\r]+).*)</code> extracts the email address from a bullet of format <code>* Email: ...</code>. This example has non-greedy <code>.*?</code> patterns to scan for the first occurance of the Email bullet; use greedy <code>.*</code> patterns to scan for the last occurance. </td>
   </tr>
   <tr>
     <td><code>$n</code> or <code>$n()</code></td>
@@ -225,7 +253,7 @@ Here is an example. Let's search for all topics that contain the word "culture"
 - First search:
   - `%SEARCH{ "culture" format="   * $topic is referenced by: (list all references)" nosearch="on" nototal="on" }%`
 - Second search. For each hit we want this search:
-  - `%SEARCH{ "(topic found in first search)" format="   $topic" nosearch="on" nototal="on" }%`
+  - `%SEARCH{ "(topic found in first search)" format="$topic" nosearch="on" nototal="on" separator=", " }%`
 - Now let's nest the two. We need to escape the second search, e.g. the first search will build a valid second search string. Note that we escape the second search so that it does not get evaluated prematurely by the first search:
   - Use `$percnt` to escape the leading percent of the second search
   - Use `\"` to escape the double quotes
@@ -234,7 +262,7 @@ Here is an example. Let's search for all topics that contain the word "culture"
 
 **Write this:**
 
-`%SEARCH{ "culture" format="   * $topic is referenced by:$n      * $percntSEARCH{ \"$topic\" format=\"   $dollartopic\" nosearch=\"on\" nototal=\"on\" }$nop%" nosearch="on" nototal="on" }%`
+`%SEARCH{ "culture" format="   * $topic is referenced by:$n      * $percntSEARCH{ \"$topic\" format=\"$dollartopic\" nosearch=\"on\" nototal=\"on\" separator=\", \" }$nop%" nosearch="on" nototal="on" }%`
 
 **To get this:**
 
@@ -254,4 +282,28 @@ Incorrect format of searchformat template (missing sections? There should be 4 %
 
 Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
 
--- TWiki:Main.PeterThoeny - 15 Dec 2003
+### <a name="Embedding search forms to return"></a> Embedding search forms to return a formatted result
+
+Use an HTML form and an embedded formatted search on the same topic. You can link them together with an `%URLPARAM{"..."}%` variable. Example:
+
+**Write this:**
+
+    <form action="%SCRIPTURLPATH%/view%SCRIPTSUFFIX%/%WEB%/%TOPIC%">
+    Find Topics:
+    <input type="text" name="q" size="32" value="%URLPARAM{"q"}%" />
+    <input type="submit" value="Search" />
+    </form>
+    Result:
+    %SEARCH{ search="%URLPARAM{"q"}%" format="   * $web.$topic: %BR% $summary" nosearch="on" }%
+
+**To get this:**
+
+<form action="http://www.dementia.org/twiki//view/%WEB%/%TOPIC%"> Find Topics: <input name="q" size="32" type="text" value="" /> <input type="submit" value="Search" /></form>
+
+Result:
+
+# <a name="TWiki Installation Error"></a> TWiki Installation Error
+
+Incorrect format of searchformat template (missing sections? There should be 4 %SPLIT% tags)
+
+-- TWiki:Main.PeterThoeny - 16 Mar 2004
index 8999f77..972355d 100644 (file)
@@ -85,7 +85,7 @@ This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - expands the
         </tr>
         <tr>
           <td><code>newline="&lt;br /&gt;"</code></td>
-          <td> Convert newlines to other delimiters </td>
+          <td> Convert newlines in textarea to other delimiters </td>
           <td> no conversion </td>
         </tr>
         <tr>
@@ -98,6 +98,16 @@ This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - expands the
           <td> Encode special characters for URL parameter use, like a double quote into <code>%22</code></td>
           <td> no encoding </td>
         </tr>
+        <tr>
+          <td><code>multiple="on"</code> %BR% <code>multiple="[[$item]]"</code></td>
+          <td> If set, gets all selected elements of a <code>&lt;select multiple="multiple"&gt;</code> tag. A format can be specified, with <code>$item</code> indicating the element, e.g. <code>multiple="Option: $item"</code></td>
+          <td> first element </td>
+        </tr>
+        <tr>
+          <td><code>separator=", "</code></td>
+          <td> Separator between multiple selections. Only relevant if multiple is specified </td>
+          <td><code>"\n"</code> (new line) </td>
+        </tr>
       </table> Example: <code>%URLPARAM{"skin"}%</code> returns <b>print</b> for a <code>.../view/%WEB%/%TOPIC%?skin=print</code> URL. Is <b></b></td>
   </tr>
   <tr>
@@ -277,7 +287,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:43</b></td>
+    <td> GM time, is <b>29 Jun 2010 - 15:44</b></td>
   </tr>
   <tr>
     <td><code>%GMTIME{"format"}%</code></td>
@@ -288,54 +298,87 @@ This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - expands the
           <th bgcolor="#99CCCC"><strong> Example </strong></th>
         </tr>
         <tr>
-          <td> $seconds </td>
+          <td><code>$seconds</code></td>
           <td> seconds </td>
           <td> 59 </td>
         </tr>
         <tr>
-          <td> $minutes </td>
+          <td><code>$minutes</code></td>
           <td> minutes </td>
           <td> 59 </td>
         </tr>
         <tr>
-          <td> $hours </td>
+          <td><code>$hours</code></td>
           <td> hours </td>
           <td> 23 </td>
         </tr>
         <tr>
-          <td> $day </td>
+          <td><code>$day</code></td>
           <td> day of month </td>
           <td> 31 </td>
         </tr>
         <tr>
-          <td> $month </td>
+          <td><code>$wday</code></td>
+          <td> day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) </td>
+          <td> Thu </td>
+        </tr>
+        <tr>
+          <td><code>$month</code></td>
           <td> month in ISO format </td>
           <td> Dec </td>
         </tr>
         <tr>
-          <td> $mo </td>
+          <td><code>$mo</code></td>
           <td> 2 digit month </td>
           <td> 12 </td>
         </tr>
         <tr>
-          <td> $year </td>
+          <td><code>$year</code></td>
           <td> 4 digit year </td>
           <td> 1999 </td>
         </tr>
         <tr>
-          <td> $ye </td>
+          <td><code>$ye</code></td>
           <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:43:57</b></td>
+        <tr>
+          <td><code>$tz</code></td>
+          <td> either "GMT" (if set to gmtime), or "Local" (if set to servertime) </td>
+          <td> GMT </td>
+        </tr>
+        <tr>
+          <td><code>$iso</code></td>
+          <td> ISO format timestamp </td>
+          <td> 2010-06-29T15:44:40Z </td>
+        </tr>
+        <tr>
+          <td><code>$rcs</code></td>
+          <td> RCS format timestamp </td>
+          <td> 2010/06/29 15:44:40 </td>
+        </tr>
+        <tr>
+          <td><code>$http</code></td>
+          <td> E-mail &amp; http format timestamp </td>
+          <td> Tue, 29 Jun 2010 15:44:40 GMT </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:44:40</b></td>
   </tr>
   <tr>
     <td><code>%SERVERTIME%</code></td>
-    <td> Server time, is <b>29 Jun 2010 - 11:43</b></td>
+    <td> Server time, is <b>29 Jun 2010 - 11:44</b></td>
   </tr>
   <tr>
     <td><code>%SERVERTIME{"format"}%</code></td>
-    <td> Formatted server time. <br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:43</b></td>
+    <td> Formatted server time. Same format qualifiers as <code>%GMTIME%</code><br /> Example: <code>%SERVERTIME{"$hou:$min"}%</code> is <b>11:44</b></td>
+  </tr>
+  <tr>
+    <td><code>%DISPLAYTIME%</code></td>
+    <td> Display time, is <b>29 Jun 2010 - 15:44</b></td>
+  </tr>
+  <tr>
+    <td><code>%DISPLAYTIME{"format"}%</code></td>
+    <td> Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as <code>%GMTIME%</code><br /> Example: <code>%DISPLAYTIME{"$hou:$min"}%</code> is <b>15:44</b></td>
   </tr>
   <tr>
     <td><code>%HTTP_HOST%</code></td>
@@ -480,13 +523,13 @@ This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - expands the
           <td><code>"text"</code></td>
         </tr>
         <tr>
-          <td><code>order="topic"</code><br /><code>order="modified"</code><br /><code>order="editby"</code><br /><code>order=<br /> "formfield(name)"</code></td>
-          <td> Sort the results of search by the topic names, last modified time, last editor, or named field of [[Main/TWikiForms]]</td>
+          <td><code>order="topic"</code><br /><code>order="created"</code><br /><code>order="modified"</code><br /><code>order="editby"</code><br /><code>order=<br /> "formfield(name)"</code></td>
+          <td> Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of [[Main/TWikiForms]]. The sorting is done web by web; in case you want to sort across webs, create a [[Main/FormattedSearch]] table and sort it with [[Main/TablePlugin]]'s initsort </td>
           <td> Sort by topic name </td>
         </tr>
         <tr>
           <td><code>limit="all"</code><br /><code>limit="16"</code></td>
-          <td> Limit the number of results returned </td>
+          <td> Limit the number of results returned. This is done after sorting in case <code>order</code> is specified </td>
           <td> All results </td>
         </tr>
         <tr>
@@ -530,6 +573,11 @@ This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - expands the
           <td> Results in table </td>
         </tr>
         <tr>
+          <td><code>expandvariables="on"</code></td>
+          <td> Expand variables before applying a [[Main/FormattedSearch]] on a search hit. Useful to show the expanded text, e.g. to show the result of a [[Main/SpreadSheetPlugin]] <code>%CALC{}%</code> instead of the formula </td>
+          <td> Raw text </td>
+        </tr>
+        <tr>
           <td><code>multiple="on"</code></td>
           <td> Multiple hits per topic. Each hit can be [[Main/FormattedSearch]]. The last token is used in case of a regular expression ";" <em>and</em> search </td>
           <td> Only one hit per topic </td>
@@ -750,4 +798,4 @@ Additional variables are defined in the preferences ( site-level ( **_SL_** ) in
 > - To place a logo anywhere in a web by typing <code>**%MYLOGO%**</code>, define the Variable on the web's [[WebPreferences]] page, and upload a logo file, ex: `mylogo.gif`. You can upload by [[attaching the file|Main/FileAttachment]] to [[WebPreferences]], or, to avoid clutter, to any other topic in the same web, ex: `LogoTopic`:
 >   - <code>**Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif**</code>
 
--- TWiki:Main.PeterThoeny - 14 Jan 2004 <br /> -- TWiki:Main.MikeMannix - 12 May 2002
+-- TWiki:Main.PeterThoeny - 16 Mar 2004 <br /> -- TWiki:Main.MikeMannix - 12 May 2002
index b9f3bf8..8f987c9 100644 (file)
@@ -181,8 +181,8 @@ The most frequently asked questions about text formatting are answered. Also, [[
 >
 > If you need more colors you can use HTML, like `<font color="#ff0000"> red text </font>`. You can also use the up-to-date `style` attribute - ex: `style="color:#ff0000"` - placed in most HTML tags. `span` is an all-purpose choice: `<span style="color:#ff0000">CoLoR</span>`. Only old (like 3.x IE &amp; NS) browsers have a problem with `style`.
 >
-> The code is the _hexadecimal RGB color code_, which is simply Red, Green and Blue values in hex notation (base 16, 0-F). For pure red, the RGB components are 255-0-0 - full red (255), no green or blue. That's FF-0-0 in hex, or `"#ff000"` for Web page purposes. [[StandardColors]] lists basic colors.
+> The code is the _hexadecimal RGB color code_, which is simply Red, Green and Blue values in hex notation (base 16, 0-F). For pure red, the RGB components are 255-0-0 - full red (255), no green or blue. That's FF-0-0 in hex, or `"#ff0000"` for Web page purposes. [[StandardColors]] lists basic colors.
 >
 > ----
 
--- [[PeterThoeny]] - 21 Feb 2002 <br /> -- [[MikeMannix]] - 14 Sep 2001 <br />
+-- TWiki:Main.PeterThoeny - 16 Mar 2004 <br /> -- TWiki:Main.MikeMannix - 14 Sep 2001 <br />
index 3cbaa03..93555dc 100644 (file)
@@ -171,16 +171,16 @@ class CatAnimal {
     </td>
   </tr>
   <tr bgcolor="#ffffff">
-    <td valign="top"><strong>Definition List:</strong> %BR% Three spaces, the term, a colon, a space, followed by the definition. %BR% <strong><em>Note:</em></strong> Terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the <code>&amp;nbsp;</code> non-breaking-space entity. </td>
+    <td valign="top"><strong>Definition List:</strong> %BR% Three spaces, a dollar sign, the term, a colon, a space, followed by the definition. </td>
     <td valign="top"><span style="background: #FFFFCC"><font color="#990000"> <pre>
-       Sushi: Japan
-       Dim&amp;nbsp;Sum: S.F.
+       $ Sushi: Japan
+       $ Dim Sum: S.F.
 </pre> </font></span></td>
     <td valign="top">
       <dl>
-        <dt> Sushi</dt>
+        <dt> Sushi </dt>
         <dd> Japan </dd>
-        <dt> Dim Sum</dt>
+        <dt> Dim Sum </dt>
         <dd> S.F. </dd>
       </dl>
     </td>
@@ -194,6 +194,7 @@ class CatAnimal {
 | multi span |||
 | A4-6 | four | four |
 |^| five | five |
+
 |^| six | six |
 </pre> </font></span></td>
     <td valign="top">
@@ -398,4 +399,4 @@ TWiki formatting rules are fairly simple to use and quick to type. However, ther
 - **Q:** Why is the `'&'` character sometimes not displayed?
   - **A:** The `'&'` character has a special meaning in HTML, it starts a so called character entity, i.e. `'&copy;'` is the `©` copyright character. You need to escape `'&'` to see it as it is, so write `'&amp;'` instead of `'&'`. <br /> Example: Type `'This &amp; that'` to get `'This & that'`.
 
--- [[MikeMannix]] - 02 Dec 2001 <br /> -- [[PeterThoeny]] - 15 Jul 2003
+-- TWiki:Main.MikeMannix - 02 Dec 2001 <br /> -- TWiki:Main.PeterThoeny - 16 Mar 2004
index 0492262..9508f5b 100644 (file)
@@ -23,7 +23,7 @@ Welcome to %WIKITOOLNAME%! This is a [[TWikiSite]] (pronounced _twee-kee site_),
     - To create a link to an existing topic type its <code>**JoinCapitalizedWords**</code> name. [[WikiWords]] (two or more capitalized words run together) link automatically.
     - To create a link to a new topic, enter a newly <code>**UsedPhrase**</code>.
     - When previewing, the links show and "<u>?</u>" (question marks) are used to create topics.
-    - Another way to create a topic is to type it's [[WikiWord]] in the Go box or URL.
+    - Another way to create a topic is to type its [[WikiWord]] in the Go box or URL.
   2. **Topic history** click <code>**Diffs**</code> at the bottom of a topic
   3. **Attach files** click <code>**Attach**</code> to upload and attach any type of file.
 5. **Organize:** You can learn to use [[TWikiForms]] and [[FormattedSearch]]es to include topic information - for example, classify pages by subject, status, or date.