Changeset 8989

Timestamp:

09/10/10 11:17:24 (21 months ago)

Author:

CrawfordCurrie

Message:

Item8841: doc corrections

File:

• trunk/core/data/System/FormattedSearch.txt (modified) (2 diffs)

trunk/core/data/System/FormattedSearch.txt

@@ -77 +77 @@
 | =$web= | Name of the web |
 | =$topic= | Topic name |
-| =$topic(20)= | Topic name, "<tt>- </tt>" hyphenated each 20 characters |
-| =$topic(30, -&lt;br /&gt;)= | Topic name, hyphenated each 30 characters with separator "<tt>-&lt;br /&gt;</tt>" |
-| =$topic(40, ...)= | Topic name, shortended to 40 characters with "<tt>...</tt>" indication |
+| =$topic(20)= | Topic name, "<tt>- </tt>" hyphenated every 20 characters |
+| =$topic(30, -&lt;br /&gt;)= | Topic name, hyphenated every 30 characters with separator "<tt>-&lt;br /&gt;</tt>" |
+| =$topic(40, ...)= | Topic name, shortened to 40 characters with trailing ellipsis. |
 | =$parent= | Name of parent topic; empty if not set |
-| =$parent(20)= | Name of parent topic, same hyphenation/shortening like =$topic()= |
+| =$parent(20)= | Name of parent topic, same hyphenation/shortening as =$topic()= |
 | =$text= | Formatted topic text. In case of a =multiple="on"= search, it is the line found for each search hit. |
 | =$locked= | LOCKED flag (if any) |
@@ -106 +106 @@
 | =$formname= | The name of the form attached to the topic; empty if none |
 | =$formfield(name)= | The field value of a form field; for example, if FAQWhatIsWikiWiki was a search hit, =$formfield(<nop>TopicClassification)= would get expanded to =%QUERY{"'WhatIsWikiWiki'/TopicClassification"}%=. This applies only to topics that have a [[DataForms][DataForm]]. For multi-line textfields new lines are replace by an HTML &lt;br /&gt; |
-| =$formfield(name, 10)= | Form field value, "<tt>- </tt>" hyphenated each 10 characters |
-| =$formfield(name, 20, -&lt;br /&gt;)= | Form field value, hyphenated each 20 characters with separator "<tt>-&lt;br /&gt;</tt>" |
-| =$formfield(name, 30, ...)= | Form field value, shortended to 30 characters with "<tt>...</tt>" indication |
+| =$formfield(name, 10)= | Form field value, "<tt>- </tt>" hyphenated every 10 characters |
+| =$formfield(name, 20, -&lt;br /&gt;)= | Form field value, hyphenated every 20 characters with separator "<tt>-&lt;br /&gt;</tt>" |
+| =$formfield(name,30,...)= | Form field value, shortened to 30 characters with trailing ellipsis. |
 | =$pattern(reg-exp)= | A regular expression pattern to extract some text from a topic (does not search meta data; use =$formfield= instead). In case of a =multiple="on"= search, the pattern is applied to the line found in each search hit.%BB% Specify a RegularExpression that covers the whole text (topic or line), which typically starts with =.*=, and must end in =.*= %BB% Put text you want to keep in parenthesis, like =$pattern(.*?(from here.*?to here).*)= %BB% Example: =$pattern(.*?\*.*?Email\:\s*([^\n\r]+).*)= extracts the e-mail address from a bullet of format =* Email: ...= %BB% This example has non-greedy =.*?= patterns to scan for the first occurance of the Email bullet; use greedy =.*= patterns to scan for the last occurance %BB% Limitation: Do not use =.*)= inside the pattern, e.g. =$pattern(.*foo(.*)bar.*)= does not work, but =$pattern(.*foo(.*?)bar.*)= does %BB% Note: Make sure that the integrity of a web page is not compromised; for example, if you include an HTML table make sure to include everything including the table end tag |
 | =$count(reg-exp)= | Count of number of times a regular expression pattern appears in the text of a topic (does not search meta data). Follows guidelines for use and limitations outlined above under =$pattern(reg-exp)=. Example: =$count(.*?(---[+][+][+][+]) .*)= counts the number of &lt;H4&gt; headers in a page. |