Ignore:
Timestamp:
11/27/08 17:12:26 (3 years ago)
Author:
CrawfordCurrie
Message:

Item319: convert doc searches to queries to make the most of query search optimisation (and eliminate assumptions about embedded META:) Item255: detox more doc topics

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/CommentPlugin/data/System/CommentPlugin.txt

    r878 r1022  
    1818 
    1919Related topics: CommentPluginTemplates, CommentPluginExamples 
    20  
    21 <div class="twikiBroadcastMessage" style="background-color:#ffc;">WARNING: TWiki-4 only. If you want to use this plugin with an earlier version of TWiki, please use [[http://twiki.org/cgi-bin/attach/Plugins/CommentPlugin?filename=CommentPlugin.zip&revInfo=1][revision 31 of the zip]].</div> 
    2220 
    2321---++ Features 
    … …  
    3129---++ Syntax 
    3230#StandardAttrs 
    33 Write =%<nop>COMMENT{<i>attributes</i>}%= anywhere in a TWiki topic. 
     31Write =%<nop>COMMENT{<i>attributes</i>}%= anywhere in a topic. 
    3432%INCLUDE{"%SYSTEMWEB%.VarCOMMENT" section="comment_attributes"}% 
    3533(See also [[#MoreAttrs][additional attributes]]) 
    … …  
    4543will add comments in the current topic, directly below the =%COMMENT= tag. 
    4644 
    47 ---++++ Location relative to a TWiki anchor 
     45---++++ Location relative to an anchor 
    4846The =target= attribute may specify a web, and may also specify an anchor within the target topic; for example,  
    4947<verbatim> 
    5048%COMMENT{type="above" target="%MAINWEB%.PersonalRemarks#InsertHere"}% 
    5149</verbatim> 
    52 This uses a standard TWiki in-topic anchor as the insertion location. See %SYSTEMWEB%.TextFormattingRules for more about TWiki anchors. 
     50This uses a standard in-topic anchor as the insertion location. See %SYSTEMWEB%.TextFormattingRules for more about TWiki anchors. 
    5351 
    5452---++++ Location relative to an arbitrary text string 
    … …  
    9593To define a comment type, you have to provide two simple template definitions in the template file; one for the prompt box, and one for the generated output. If we have a template type "mytype", these are named =PROMPT:mytype= and =OUTPUT:mytype= respectively. See =comments.tmpl= in the templates directory for examples. 
    9694 
    97 The plugin picks up these template definitions from a standard TWiki template file, =templates/comments.tmpl=. This allows different templates to be defined for different TWiki skins. 
     95The plugin picks up these template definitions from a standard template file, =templates/comments.tmpl=. This allows different templates to be defined for different TWiki skins. 
    9896 
    9997---+++ Defining custom templates 
    … …  
    159157         | =%<nop>MESSAGE%= | The text specified by =default=. This may be overridden by a helpful message when the prompt is DISABLED. | 
    160158 
    161 *EXPERT* Note that when a comment is saved, the TWiki =save= script is invoked on the target topic, with a number of parameters provided by the comment form. Normally the CommentPlugin will provide these fields in the form, but experts can also provide the fields themselves in order to get finer control over what is submitted, or you might want to define your own HTML forms that do comment submission. The parameters that the CommentPlugin recognises are as follows: 
     159*EXPERT* Note that when a comment is saved, the =save= script is invoked on the target topic, with a number of parameters provided by the comment form. Normally the CommentPlugin will provide these fields in the form, but experts can also provide the fields themselves in order to get finer control over what is submitted, or you might want to define your own HTML forms that do comment submission. The parameters that the CommentPlugin recognises are as follows: 
    162160| *CGI parameter* | *Description* | 
    163161| =comment_action= | Must be =save= to get the CommentPlugin to perform | 
    … …  
    232230#Installation 
    233231---++ Plugin Installation Instructions 
    234         * This plugin is pre-installed in most TWiki releases. However if you need to upgrade the plugin for any reason: 
     232        * This plugin is pre-installed in most releases. However if you need to upgrade the plugin for any reason: 
    235233        * Download the archive file from the Plugin web (see below) 
    236234        * Unpack the archive in your twiki installation directory. 
    … …  
    248246---++ Plugin Info 
    249247 
    250 Another great TWiki extension from the <a style="text-decoration:none" href="http://wikiring.com"><img src="%ATTACHURLPATH%/wikiringlogo20x20.png" alt="" /> *WikiRing* </a> - working together to improve your wiki experience! 
    251  
    252 |  Plugin Author: | TWiki:Main.CrawfordCurrie http://www.c-dot.co.uk inspired by the work of TWiki:Main.DavidWeller and TWiki:Main.PeterMasiar | 
     248Another great extension from the <a style="text-decoration:none" href="http://wikiring.com"><img src="%ATTACHURLPATH%/wikiringlogo20x20.png" alt="" /> *WikiRing* </a> - working together to improve your wiki experience! 
     249 
     250|  Plugin Author: | Foswiki:Main.CrawfordCurrie http://www.c-dot.co.uk inspired by the work of TWiki:Main.DavidWeller and TWiki:Main.PeterMasiar | 
    253251|  Plugin Version: | 03 Aug 2008 %$VERSION% | 
    254252|  Change History: | | 
Note: See TracChangeset for help on using the changeset viewer.