Changeset 707


Ignore:
Timestamp:
11/15/08 14:57:29 (4 years ago)
Author:
CrawfordCurrie
Message:

Item109: merged 685:704 from trunk

Location:
branches/Release04x02
Files:
156 edited
1 copied

Legend:

Unmodified
Added
Removed
  • branches/Release04x02

  • branches/Release04x02/data/Main/AdminUser.txt

    • Property svn:mergeinfo changed (with no actual effect on merging)
  • branches/Release04x02/data/Main/SitePreferences.txt

    • Property svn:mergeinfo changed (with no actual effect on merging)
  • branches/Release04x02/data/Main/WikiGroups.txt

    • Property svn:mergeinfo changed (with no actual effect on merging)
  • branches/Release04x02/data/Main/WikiGuest.txt

    • Property svn:mergeinfo changed (with no actual effect on merging)
  • branches/Release04x02/data/TWiki

  • branches/Release04x02/data/TWiki/AccessControl.txt

    r697 r707  
    235235---+++ Hide Control Settings 
    236236 
    237 __%T% Tip:__ To hide access control settings from normal browser viewing, you can put them into the _topic preference settings_ by clicking the link =Edit topic preference settings= under =More topic actions= menu. Preferences set in this manner are not visible in the topic text, but take effect nevertheless. Access control settings added as topic preference settings are stored in the topic meta data and they override settings defined in the topic text. 
     237__%T% Tip:__ To hide access control settings from normal browser viewing, you can put them into the _topic [[%SYSTEMWEB%.PreferenceSettings][preference settings]]_ by clicking the link =Edit topic preference settings= under =More topic actions= menu. Preferences set in this manner are not visible in the topic text, but take effect nevertheless. Access control settings added as topic preference settings are stored in the topic meta data and they override settings defined in the topic text. 
    238238 
    239239Alternatively, place them in HTML comment markers, but this exposes the access setting during ordinary editing. 
  • branches/Release04x02/data/TWiki/DataForms.txt

    r695 r707  
    205205A Form Template specifies the fields in a form. A Form Template is simply a page containing a TWiki table, where each row of the table specifies one form field. 
    206206#UsingFormData 
    207 ---+++ Searching for Form Data 
    208 Data Forms accept user-input data, stored as MetaData. Meta data also contains program-generated info about changes, attachments, etc. To find, format and display form and other meta data, see MetaData, ==FORMFIELD==, ==SEARCH== and ==METASEARCH== in [[%SYSTEMWEB%.Macros][Macros]], and [[FormattedSearch][TWiki Formatted Search]]. 
    209  
    210 <blockquote> 
    211 *Example* %BR% 
    212 TWiki users often want to have an overview of topics they contributed to. With the ==$formfield== parameter it is easy to display the value of a classification field next to the topic link: 
    213 <verbatim> 
    214 | *Topic* | *Classification* | 
    215 %SEARCH{"%USERSWEB%.UserName" scope="text" nosearch="on" nototal="on" order="modified" reverse="on" 
    216 format="|<b>[[$web.$topic][$topic]]</b> |<nop>$formfield(TopicClassification) |" web="Sandbox"}% 
    217 </verbatim> 
    218 </blockquote>  
    219  
    220 Searching forms this way is obviously pretty inefficient, but it's easy to do. If you want better performance, take a look at some of the structured wiki extensions that support higher performance searching e.g. TWiki:Plugins.DBCachePlugin. 
     207---+++ Searching in Form Data 
     208The best way to search in form data is using the structured query language in the SEARCH macro. See QuerySearch for more information. 
     209 
    221210---+++ Gotcha! 
    222211   * Some browsers may strip linefeeds from =text= fields when a topic is saved. If you need linefeeds in a field, make sure it is a =textarea=. 
  • branches/Release04x02/data/TWiki/DefaultPreferences.txt

    r697 r707  
    214214 
    215215   * You can enable/disable Plugins using the [[%SCRIPTURLPATH{"configure"}%][configure]] interface. 
    216    * You can also disable installed plugins in individual webs/topics by defining the %<nop>DISABLEDPLUGINS% preference setting to be a list of plugins to disable e.g. 
     216   * You can also disable installed plugins in individual webs/topics by defining the DISABLEDPLUGINS [[preference setting]] to be a list of plugins to disable e.g. 
    217217      * <nop>Set DISABLEDPLUGINS = SpreadSheetPlugin,EditTablePlugin 
    218218      * Currently, %<nop>DISABLEDPLUGINS% is set to "%DISABLEDPLUGINS%" 
     
    335335---++ Creating New Preference Settings 
    336336  
    337 You can introduce new preference settings and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts). 
     337You can introduce new [[%SYSTEMWEB%.PreferenceSettings][preference settings]] and use them in your topics and templates. There is no need to change the TWiki engine (Perl scripts). 
    338338   * A preference is defined in a TWikiShorthand bullet item: ==[3 spaces] * [space] Set NAME = value== <br /> Example (as a nested bullet item, indented 6 spaces): 
    339339      * S<nop>et WEBBGCOLOR = #FFFFC0 
     
    341341      * When you write ==%WEB<nop>BGCOLOR%==, it gets expanded to =%WEBBGCOLOR%= . 
    342342 
    343    * %X% The sequential order of the preference settings is significant. Define preferences that use other preferences FIRST. For example, set ==<nop>WEBCOPYRIGHT== before ==<nop>WIKIWEBMASTER== since the copyright notice uses the Wiki administrator e-mail address. 
     343   * %X% The sequential order of the [[%SYSTEMWEB%.PreferenceSettings][preference settings]] is significant. Define preferences that use other preferences FIRST. For example, set ==<nop>WEBCOPYRIGHT== before ==<nop>WIKIWEBMASTER== since the copyright notice uses the Wiki administrator e-mail address. 
    344344   * %X% In order to protect your custom preferences from being overwritten when upgrading the [[%SYSTEMWEB%.%TOPIC%]] topic, it is recommended that all custom settings are defined in [[%USERSWEB%.%TOPIC%]]. 
    345345 
  • branches/Release04x02/data/TWiki/DocumentGraphics.txt

    r697 r707  
    343343Shorthand notation: 
    344344<blockquote> 
    345 In [[%USERSWEB%.DefaultPreferences!]] set a macro for an ICON, for example: 
     345In [[%USERSWEB%.SitePreferences!]] set a macro for an ICON, for example: 
    346346 
    347347=<nop>   * Set H = %<nop>ICON{help}%= 
  • branches/Release04x02/data/TWiki/DontNotify.txt

    r695 r707  
    44__Note:__ No new revision is created in case you save the same topic again within a certain time frame (default is one hour). You only need to checkmark the "Minor change, don't notify" checkbox once within this time frame, because subsequent save operations do not notify users. 
    55 
    6 __Note:__ The initial state of the checkbox can be set to on with the =DONTNOTIFYCHECKBOX= preference setting. See DefaultPreferences for more. 
    7  
     6__Note:__ The initial state of the checkbox can be set to on with the =DONTNOTIFYCHECKBOX= [[%SYSTEMWEB%.PreferenceSettings][preference setting]]. 
    87 
    98__Related Topics:__ UserDocumentationCategory 
  • branches/Release04x02/data/TWiki/EditingShorthand.txt

    r697 r707  
    311311%X% Dots ='.'= are used to separate webs and subwebs from topic names and therefore cannot be used in topic names. 
    312312 
    313 It's generally a good idea to use the [[%SYSTEMWEB%.Macros][Macros]] %<nop>SYSTEMWEB% and %<nop>USERSWEB% instead of %SYSTEMWEB% and %USERSWEB%. 
     313It's generally a good idea to use the [[%SYSTEMWEB%.Macros][macros]] %<nop>SYSTEMWEB% and %<nop>USERSWEB% instead of %SYSTEMWEB% and %USERSWEB%. 
    314314</td><td> 
    315315<verbatim> 
  • branches/Release04x02/data/TWiki/FileAttachment.txt

    r697 r707  
    2222 
    2323   * Through your Web browser, you can easily upload graphics (or sound files, or anything else you want to link to on a page) and place them on a single page, or use them across a web, or site-wide. 
    24       * __NOTE:__ You can also add graphics - any files - directly, typically by FTP upload. This requires FTP access, and may be more convenient if you have a large number of files to load. FTP-ed files can't be managed using browser-based Attachment controls. You can use your browser to create [[%SYSTEMWEB%.Macros][Macros]] shortcuts, like this %<nop>H% = %H%. 
     24      * __NOTE:__ You can also add graphics - any files - directly, typically by FTP upload. This requires FTP access, and may be more convenient if you have a large number of files to load. FTP-ed files can't be managed using browser-based Attachment controls. You can also create [[%SYSTEMWEB%.Macros][macro shortcuts]], like this %<nop>H% = %H%. 
    2525 
    2626---++ Uploading Files 
     
    3030      * Any type of file can be uploaded. Some files that might pose a security risk are renamed, ex: =*.php= files are renamed to =*.php.txt= so that no one can place code that would be read in a .php file.  
    3131      * The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it, again you can copy the previous upload path into the Local file field. 
    32       * TWiki can limit the file size. This is defined by the =%<nop>ATTACHFILESIZELIMIT%= preference setting, currently set at %ATTACHFILESIZELIMIT% KB. 
     32      * TWiki can limit the file size. This is defined by the =%<nop>ATTACHFILESIZELIMIT%= [[%SYSTEMWEB%.PreferenceSettings][preference settings]], currently set at %ATTACHFILESIZELIMIT% KB. 
    3333         * %X% It's not recommended to upload files greater than a few hundred K through a browser. Large files can be extremely slow-loading, and often time out. Use an FTP site for large file uploads. 
    3434   * Automatic attachments: 
  • branches/Release04x02/data/TWiki/ForceNewRevision.txt

    r697 r707  
    44The "Force New Revision" checkbox is a way to force it to create a separate revision each time you save. 
    55 
    6 The [[%SYSTEMWEB%.DefaultPreferences!]] setting =FORCENEWREVISIONCHECKBOX= controls whether this is checked by default or not. 
     6The [[%SYSTEMWEB%.PreferenceSettings][preference setting]] =FORCENEWREVISIONCHECKBOX= controls whether this is checked by default or not. 
    77 
    88On a related note, you can force __every__ save to be a new revision number by setting =ReplaceIfEditedAgainWithin= to 0. 
  • branches/Release04x02/data/TWiki/GlossaryOfTerms.txt

    r695 r707  
    55 
    66| *Term* | *Definition* | 
    7 | Attachment: | Any type of file that is uploaded via browser and attached to a _topic_, where it can be viewed and downloaded. [[FileAttachments][Details...]] | 
    8 | Data Form: | Web form at the bottom of a page that can be filled in with additional info and classification for the particular topic [[DataForms][Details...]] | 
    9 | Macro: | Text-strings of the form =%<nop>MACRO%= that are expanded into text, images, or any other type of embedded content; there are _system macros_ coded into the core, _preferences_, and _Plugin settings_. [[Macros][Details...]] | 
    10 | Page: | A regular Web page. A page in TWiki is composed of the _template/skin_ decoration and _topic_ content. | 
    11 | Plugin: | Prepackaged server-side extension that adds all sorts of additional functions, seamlessly integrated into TWiki. [[Plugins][Details...]] | 
    12 | Plugin API: | The standard interface for creating TWiki _Plugins_ and add-on programs that ensure a perfect integration. [[TWikiFuncDotPm][Details...]] | 
    13 | Preferences: | The site-wide, single _web_ and single user-level preference settings. The settings are stored in DefaultPreferences, WebPreferences and %USERSWEB%.WikiUsers home pages. [[Macros#SettingPrefs][Details...]] | 
    14 | Site: | A TWiki installation consisting of one or more _webs_. [[TWikiSite][Details...]] | 
    15 | Skin: | Skins overlay regular _templates_ with alternate header/footer layout of _pages_; topic text is not affected. Skins are typically enabled site-wide or per _web_. [[Skins][Details...]] | 
    16 | Templates: | (1) Regular templates define header/footer layout of _pages_; topic text is not affected. (2) Template topics set the default content for new _topics_. [[SkinTemplates][Details...]] | 
    17 | Topic: | The content of a TWiki _page_, consisting of text, an optional _form_ and optional _attachments_. It has a WikiName that's unique within its _web_. [[TopicsAndWebs][Details...]] | 
    18 | TWiki: | A web-based collaboration platform targeting the corporate world. Contraction of "TakeFive Wiki". By chance, also happens to be the name of the AI robot star of the Buck Rogers 1979 movie and TV series. Features include browser based editing, automatic linking of text (based on ideas of the original <nop>WikiWikiWeb), revision control, file _attachments_, _form_ handling, _preferences_ settings, access control and more. [[http://TWiki.org/][Details...]] | 
    19 | TWiki.org: |Official home site, center of all development. [[http://TWiki.org/][Details...]] | 
    20 | Variables: | An archaic term for Macros | 
    21 | Web: | A collection of _topics_ under a common name. Various features, like search, access privileges, Plugin availability, template design, can be controlled on a web-wide basis. [[ManagingWebs][Details...]] | 
     7| Attachment | Any type of file that is uploaded via browser and attached to a _topic_, where it can be viewed and downloaded. [[FileAttachments][Details...]] | 
     8| Data Form | Form at the bottom of a page that can be filled in with additional info and classification for the particular topic [[DataForms][Details...]] | 
     9| Macro | Text strings of the form =%<nop>MACRO{}%= that are expanded into text, images, or any other type of embedded content; there are _system macros_ coded into the core, and more can be defined by Plugins. See [[Macros][Details...]] | 
     10| Page | A rendered web page. A page is composed of the _template/skin_ decoration and _topic_ content. | 
     11| Plugin | Prepackaged server-side extension that adds all sorts of additional functions. [[Plugins][Details...]] | 
     12| Plugin API | The standard interface for creating _Plugins_ and add-on programs that ensure a perfect integration. [[TWikiFuncDotPm][Details...]] | 
     13| Preference | One of the site-wide, _web_ and single user-level [[%SYSTEMWEB%.PreferenceSettings][preference settings]] | 
     14| Site | An end-user installation accessible via the web. [[TWikiSite][Details...]] | 
     15| Skin Templates | Skins define the header/footer layout of _pages_; topic text is not affected. Skins are typically enabled site-wide or per _web_. [[Skins][Details...]] | 
     16| Template Topics | Set the default content for new _topics_. [[SkinTemplates][Details...]] | 
     17| Topic | The content of a TWiki _page_, consisting of text, an optional _form_ and optional _attachments_. It has a WikiName that's unique within its _web_. [[TopicsAndWebs][Details...]] | 
     18| Web | A collection of _topics_ under a common name. Various features, like search, access privileges, Plugin availability, template design, can be controlled on a web-wide basis. [[ManagingWebs][Details...]] | 
    2219 
    2320__Related Topics:__ UserDocumentationCategory 
  • branches/Release04x02/data/TWiki/IfStatements.txt

    r697 r707  
    1717| isweb | =isweb 'X'= is true if web 'X' exists | 
    1818| ingroup | ='X' ingroup 'Y'= is true if user 'X' is in group 'Y'. 'X' can be a login name or a wikiname. | 
    19 | defined | True if a preference setting or url parameter of this name is defined. | 
    20 | isempty | True if a preference setting, url parameter or session variable of this name has an empty value. It is equivalent to the expression =(!defined(x) || $x='')= | 
    21 | $ | expands a URL parameter or [[Macros][macro]] name. Plugin handlers *are not called*. Built-in macros, system preference settings and user-defined preference settings are supported. You can pass a limited subset of parameters to macros by enclosing the parameter string in single quotes; for example, =$ 'MACRO{value}'=. The ='MACRO{value}'= string may *not* contain quotes (' or "). | 
     19| defined | True if a [[preference setting]] or url parameter of this name is defined. | 
     20| isempty | True if a [[preference setting]], url parameter or session variable of this name has an empty value. It is equivalent to the expression =(!defined(x) || $x='')= | 
     21| $ | expands a URL parameter or [[Macros][macro]] name. Plugin handlers *are not called*. You can pass a limited subset of parameters to macros by enclosing the parameter string in single quotes; for example, =$ 'MACRO{value}'=. The ='MACRO{value}'= string may *not* contain quotes (' or "). | 
    2222| {X} | expands to the value of the =configure= setting {X} - for example, ={ScriptUrlPath}= | 
    2323 
  • branches/Release04x02/data/TWiki/InstallationGuide.txt

    r672 r707  
    127127Preferences for customizing many aspects of TWiki are set simply by editing a special topic with TWiki. 
    128128 
    129    * =%SYSTEMWEB%.DefaultPreferences=. Read through it and identify any additional settings or changes you think you might need. You can edit the settings in =%SYSTEMWEB%.DefaultPreferences= but these will be overwritten when you later upgrade to a newer TWiki version. Instead copy any settings or variables that you want to customize from =%SYSTEMWEB%.DefaultPreferences= and paste them into =%USERSWEB%.SitePreferences=.  When you later upgrade TWiki simply avoid overwriting the =data/%SYSTEMWEB%/DefaultPreferences.txt= file and all your settings will be kept. Settings in =%USERSWEB%.SitePreferences= overrides settings in both =%SYSTEMWEB%.DefaultPreferences= and any settings defined in Plugin topics. See notes at top of =%SYSTEMWEB%.DefaultPreferences= for more information. 
     129   * =%SYSTEMWEB%.DefaultPreferences=. Read through it and identify any additional settings or changes you think you might need. Do not edit the settings in =%SYSTEMWEB%.DefaultPreferences= because these will be overwritten when you later upgrade to a newer TWiki version. Instead copy any settings that you want to customize from =%SYSTEMWEB%.DefaultPreferences= and paste them into =%USERSWEB%.SitePreferences=.  When you later upgrade TWiki simply avoid overwriting the =data/%SYSTEMWEB%/DefaultPreferences.txt= file and all your settings will be kept. Settings in =%USERSWEB%.SitePreferences= overrides settings in both =%SYSTEMWEB%.DefaultPreferences= and any settings defined in Plugin topics. See notes at top of =%SYSTEMWEB%.DefaultPreferences= for more information. 
    130130 
    131131---++ Enable Email Notification 
  • branches/Release04x02/data/TWiki/InstantEnhancements.txt

    r697 r707  
    44These quick enhancements are aimed at improving and customising your TWiki.  New TWiki site administrators are especially encouraged to review this document for ideas before deploying a new TWikiSite. The metaphor of building a house is useful.  The listed enhancements are some of the details possible when moving into a new office or home. These small changes can make a *big* differences for user satisfaction at your site. All modifications can be done through your Web browser, and they don't take more then in a couple of minutes.  No system administration expertise is required. Some of these enhancements are also mentioned in the reference manual and other topics. 
    55 
    6 Many of these tips are based on setting some special [[Macros]]. 
     6Many of these tips are based on setting some special [[WebPreferencesHelp][preferences]]. 
    77 
    88%S% We recommend implementing at least __some__ of these enhancements __right after installation__ to get a taste for what is possible.  Some of these tips and enhancements _should_ be implemented before or during initial roll-out. 
     
    2323*What we are doing* 
    2424 
    25 We want to set the preference WEBBGCOLOR in topic WebPreferences to one of the StandardColors. <nop>WebPreferences is, as you can guess, a topic which holds all kind of preference setting for each TWiki Web[[ManagingWebs][{*}]]. Each web has its own <nop>WebPreferences, and you can set them differently for each web. 
     25We want to set the preference WEBBGCOLOR in topic WebPreferences to one of the StandardColors. <nop>WebPreferences is, as you can guess, a topic which holds all kind of [[preference setting]] for each TWiki Web[[ManagingWebs][{*}]]. Each web has its own <nop>WebPreferences, and you can set them differently for each web. 
    2626 
    2727*How to do it* 
     
    2929   1 Pick color code from company or product references, the StandardColors table (recommended for 8-bit client compatibility), or some other color reference.  
    3030   2 Go to WebPreferences in each web, and edit the topic. 
    31    3 Set your preferred WEBBGCOLOR preference setting, and save the topic. 
     31   3 Set your preferred WEBBGCOLOR [[%SYSTEMWEB%.PreferenceSettings][preference settings]], and save the topic. 
    3232   4 %X% Add a new line immediately after the color code. If there is (invisible) space after the color code, the page header might get strange colors (e.g. black). 
    3333 
     
    3636---+++ Set Page Background Color  
    3737 
    38 Without getting into the [[skin templates]] system yet, you can easily edit the ==view.tmpl== (in the =templates= directory). In the HTML at the top, the body tag has the page background hardcoded to white ==bgcolor="#ffffff"==. You can change that color value to a new setting. First, define a new preference setting in the site-level [[%LOCALSITEPREFS%]], e.g. =* Set =PAGEBGCOLOR = #d0d0d0=, then edit the ==view.tmpl== template file and change ==bgcolor="#ffffff"== to ==bgcolor="%<nop>PAGEBGCOLOR%"==. If you want, you can set the page background color individually per web, simple add a =* Set =PAGEBGCOLOR = #d0d0d0= bullet to the WebPreferences to overload the site-level preferences. (Without font color control, you'll have to stick to light colors.) 
     38Without getting into the [[skin templates]] system yet, you can easily edit the ==view.tmpl== (in the =templates= directory). In the HTML at the top, the body tag has the page background hardcoded to white ==bgcolor="#ffffff"==. You can change that color value to a new setting. First, define a new[[%SYSTEMWEB%.PreferenceSettings][preference setting]] in the site-level [[%LOCALSITEPREFS%]], e.g. =* Set =PAGEBGCOLOR = #d0d0d0=, then edit the ==view.tmpl== template file and change ==bgcolor="#ffffff"== to ==bgcolor="%<nop>PAGEBGCOLOR%"==. If you want, you can set the page background color individually per web, simple add a =* Set =PAGEBGCOLOR = #d0d0d0= bullet to the WebPreferences to overload the site-level preferences. (Without font color control, you'll have to stick to light colors.) 
    3939 
    4040---+++ Titles-Only Topic List - !WebTopicList 
     
    136136*End Copy* 
    137137 
    138 The SEARCH macro has many more formatting options, see [[Macros]]. 
     138The [[VarSEARCH][SEARCH macro]] has many more formatting options. 
    139139 
    140140---+++ Recently changed pages  
  • branches/Release04x02/data/TWiki/Macros.txt

    r697 r707  
    77 
    88Macros are text strings - =%<nop>MACRONAME%= or =%<nop>MACRONAME{ parameter="value" }%= - that expand into content whenever a topic is rendered for viewing. There are two types of macros: 
    9    1 Preferences macros: Can be defined and changed by the user 
     9   1 Preference settings: Can be defined and changed by the user 
    1010   1 Predefined macros: Defined by the TWiki system or by Plugins (for example, the SpreadSheetPlugin introduces a =%<nop>CALC{}%= macro) 
    1111 
     
    1515 
    1616To use a macro type its name. For example, 
    17    * type =%<nop>T%= to get %T% (a preferences macro) 
    18    * type =%<nop>TOPIC%= to get =%TOPIC%= (a predefined macro) 
    19    * type =%<nop>CALC{ "$UPPER(Text)" }%= to get =TEXT= (a macro defined by Plugin) 
     17   * type =%<nop>T%= to get %T% (a [[%SYSTEMWEB%.PreferenceSettings][preference settings]]) 
     18   * type =%<nop>TOPIC%= to get =%TOPIC%= (a predefined [[macro]]) 
     19   * type =%<nop>CALC{ "$UPPER(Text)" }%= to get =TEXT= (a [[macro]] defined by a Plugin) 
    2020 
    2121__Note:__ 
     
    3030 
    3131#SettingPrefs 
    32 #PreferencesVariables 
    3332#PreferencesMacros 
    34 ---++ Preferences Macros 
     33---++ Preferences 
    3534 
    36 Unlike predefined macros, preferences macros can be defined by the user in various places. 
     35_Preferences settings_ are simple macros that do _not_ accept parameters, and are 
     36defined in topics. A lot of the macros you will encounter are of this type. 
    3737 
    38 ---+++ Setting Preferences Macros 
     38Preferences can be defined by the user in various places. 
     39 
     40---+++ Setting Preferences 
    3941You can set macros in all the following places: 
    40    1 local site level in [[%SYSTEMWEB%.DefaultPreferences][%SYSTEMWEB%.DefaultPreferences]] 
     42   1 default level in [[%SYSTEMWEB%.DefaultPreferences][%SYSTEMWEB%.DefaultPreferences]] (*not* recommended) 
    4143   1 plugin topics (see [[Plugins]]) 
    4244   1 local site level in [[%LOCALSITEPREFS%][%LOCALSITEPREFS%]] 
    4345   1 user level in individual user topics in %USERSWEB% web 
    44    1 web level in %WEBPREFSTOPIC% of each web 
     46   1 web level in %WEBPREFSTOPIC% of a parent web 
     47   1 web level in %WEBPREFSTOPIC% of the web 
    4548   1 topic level in topics in webs 
    4649   1 session macros (if sessions are enabled) 
     
    4851Settings at higher-numbered levels override settings of the same macro at lower numbered levels, unless the macro was included in the setting of FINALPREFERENCES at a lower-numbered level, in which case it is locked at the value it has at that level. 
    4952 
    50 If you are setting a macro and using it in the same topic, note that TWiki reads all the macro settings from the saved version of the topic before it displays anything.  This means you can use a macro anywhere in the topic, even if you set it somewhere inconspicuous near the end. *But beware:*  it also means that if you change the setting of a macro you are using in the same topic, ==Preview== will show the wrong thing, and you must ==Save== the topic to see it correctly. 
     53If you are setting a preference and using it in the same topic, note that TWiki reads all the [[%SYSTEMWEB%.PreferenceSettings][preference settings]] from the saved version of the topic before it displays anything.  This means you can use a macro anywhere in the topic, even if you set it somewhere inconspicuous near the end. *But beware:*  it also means that if you change the setting of a macro you are using in the same topic, ==Preview== will show the wrong thing, and you must ==Save== the topic to see it correctly. 
    5154 
    5255The syntax for setting macros is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): <br /> =[multiple of 3 spaces] * [space] Set [space] MACRONAME [space] = [space] value= 
     
    6972<blockquote> 
    7073*Example: Create a custom logo macro* <br /> 
    71    * To place a logo anywhere in a web by typing ==%<nop>MYLOGO%==, define the Macro on the web's WebPreferences topic, and upload a logo file, ex: =mylogo.gif=. You can upload by [[FileAttachment][attaching the file]] to WebPreferences, or, to avoid clutter, to any other topic in the same web, e.g. =LogoTopic=. Sample macro setting in WebPreferences: 
     74   * To place a logo anywhere in a web by typing ==%<nop>MYLOGO%==, define the [[%SYSTEMWEB%.PreferenceSettings][preference settings]] on the web's WebPreferences topic, and upload a logo file, ex: =mylogo.gif=. You can upload by [[FileAttachment][attaching the file]] to WebPreferences, or, to avoid clutter, to any other topic in the same web, e.g. =LogoTopic=. Sample preference setting in WebPreferences: 
    7275      * ==<nop>Set MYLOGO = %<nop>PUBURL%/%<nop>WEB%/LogoTopic/mylogo.gif== 
    7376</blockquote> 
    7477 
    75 You can also set preferences macros on a topic by clicking the link =Edit topic preference settings= under =More topic actions=. Preferences set in this manner are not visible in the topic text, but take effect nevertheless. 
     78You can also set [[%SYSTEMWEB%.PreferenceSettings][preference settings]] in a topic by clicking the link =Edit topic preference settings= under =More topic actions=. Preferences set in this manner are not visible in the topic text, but take effect nevertheless. 
    7679 
    77 ---+++ Access Control Macros 
     80---+++ Access Control Settings 
    7881 
    79 These are special types of preferences macros to control access to content. AccessControl explains these security settings in detail. 
     82These are special types of preference settings to control access to content. AccessControl explains these security settings in detail. 
    8083 
    81 ---+++ Local values for macros 
     84---+++ Local values for preferences 
    8285Certain topics (a users home topic, web site and default preferences topics) have a problem; macros defined in those topics can have two meanings. For example, consider a user topic. A user may want to use a double-height edit box when they are editing their home topic - but *only* when editing their home topic. The rest of the time, they want to have a normal edit box. This separation is achieved using =Local= in place of =Set= in the macro definition. For example, if the user sets the following in their home topic: 
    8386<verbatim> 
     
    9093Use this powerful feature with great care! =%<nop>ALLVARIABLES%= can be used to get a listing of the values of all macros in their evaluation order, so you can see macro scope if you get confused. 
    9194 
    92 ---+++ Frequently Used Preferences macros 
     95#PreDef 
     96---++ Predefined Macros 
    9397 
    94 The following macros are frequently used in topic content. They are defined in DefaultPreferences#Miscellaneous_Settings: 
     98Most predefined macros return values that were either set in the configuration when TWiki was installed, or taken from server info (such as current username, or date and time). Some, like =%<nop>SEARCH%=, are powerful and general tools. 
     99 
     100   * %X% Predefined macros can be overridden by [[%SYSTEMWEB%.PreferenceSettings][preference settings]] (except TOPIC and WEB) 
     101   * %X% Plugins may extend the set of predefined macros (see individual Plugins topics for details) 
     102   * %T% *Take the time to thoroughly read through ALL preference macros.* If you actively configure your site, review macros periodically. They cover a wide range of functions, and it can be easy to miss the one perfect macro for something you have in mind. For example, see =%<nop>INCLUDINGTOPIC%=, =%<nop>INCLUDE%=, and the mighty =%<nop>SEARCH%=. 
     103 
     104This version of TWiki - %WIKIVERSION% - predefines the following macros: 
     105 
     106%SEARCH{ 
     107    "^Var[A-Z_0-9]+$" 
     108    casesensitive="on" 
     109    type="regex" 
     110    scope="topic" 
     111    format="$percntINCLUDE{$web.$topic}$percnt" 
     112    nonoise="on" 
     113}% 
     114 
     115---+++ Shortcuts 
     116 
     117The following macros are [[%SYSTEMWEB%.PreferenceSettings][preference settings]] and are frequently used in topic content. 
    95118   * =%<nop>BR%= - line break 
    96119   * =%<nop>BULLET%= - bullet sign 
     
    110133   * =%<nop>Y%= - %Y% Done icon 
    111134 
    112 !There are additional useful preferences macros defined in DefaultPreferences, in [[%LOCALSITEPREFS%]], and in WebPreferences of every web. 
    113  
    114 #PreDef 
    115 ---++ Predefined Macros 
    116  
    117 Most predefined macros return values that were either set in the configuration when TWiki was installed, or taken from server info (such as current username, or date and time). Some, like =%<nop>SEARCH%=, are powerful and general tools. 
    118  
    119    * %X% Predefined macros can be overridden by [[#PreferencesMacros][preferences macros]] (except TOPIC and WEB) 
    120    * %X% Plugins may extend the set of predefined macros (see individual Plugins topics for details) 
    121    * %T% *Take the time to thoroughly read through ALL preference macros.* If you actively configure your site, review macros periodically. They cover a wide range of functions, and it can be easy to miss the one perfect macro for something you have in mind. For example, see =%<nop>INCLUDINGTOPIC%=, =%<nop>INCLUDE%=, and the mighty =%<nop>SEARCH%=. 
    122  
    123 This version of TWiki - %WIKIVERSION% - predefines the following macros: 
    124  
    125 %SEARCH{ 
    126     "^Var[A-Z_0-9]+$" 
    127     casesensitive="on" 
    128     type="regex" 
    129     scope="topic" 
    130     format="$percntINCLUDE{$web.$topic}$percnt" 
    131     nonoise="on" 
    132 }% 
     135See ShortcutMacros for a full list of predefined shortcuts. 
    133136 
    134137%ENDSECTION{type="include"}% 
  • branches/Release04x02/data/TWiki/MacrosQuickStart.txt

    r697 r707  
    44%STARTINCLUDE% 
    55 
    6 Macros are names enclosed in percent signs that are that are expanded to some other text when the topic 
    7 is displayed. For example, =%<nop>TOPIC%= is expanded to %TOPIC%. 
     6Macros are names enclosed in percent signs that are that are expanded to some other text when the topic is displayed. For example, =%<nop>TOPIC%= is expanded to %TOPIC%. 
     7 
    88Some macros can take arguments in curly braces - for example, =%<nop>INCLUDE{"OtherTopic" ARG="arg"}%=. 
    99 
    10 Many macro definitions are built-in, and others (preference settings) are predefined for your convenience. You can also define your own 
    11 preference settings at the entire site, individual web, or individual topic level. For more information, 
    12 go to *[[Macros]]* 
     10Many macro definitions are built-in, and others ([[%SYSTEMWEB%.PreferenceSettings][preference settings]]) are predefined for your convenience. You can also define your own 
     11[[%SYSTEMWEB%.PreferenceSettings][preference settings]] at the entire site, individual web, or individual topic level. For more information, see *[[Macros]]* 
    1312 
    1413Macros are fully expanded _before_ any of the TWiki text formatting rules are applied. 
  • branches/Release04x02/data/TWiki/MainFeatures.txt

    r695 r707  
    1313   * *Revision control:* All changes to pages and attachments are tracked. Retrieve previous page revisions; compare differences; find out who changed what and when. 
    1414   * *Access control:* Define groups and impose fine-grained read and write [[AccessControl][access restrictions]] based on groups and users. 
    15    * *Macros:* Use [[Macros]] to dynamically compose your pages. This allows you for example to dynamically build a table of contents, include other pages, or show a search result embedded in a page. 
     15   * *Macros:* Use [[macros]] to dynamically compose your pages. This allows you for example to include other pages, or show a search result embedded in a page. 
    1616   * *TWiki plugins:* Easily install program enhancements using external [[Plugins][plug-in modules]]. Developers can create plug-ins in Perl using the TWiki Plugin API. 
    1717   * *Templates and skins:* A flexible [[SkinTemplates][templating system]] separates program logic and presentation. [[Skins]] overwrite template headers and footers; page content is unaffected. 
     
    1919   * *Managing users:* Web-based [[TWikiRegistration][user registration]] and [[ChangePassword][change of password]]. 
    2020   * *Statistics:* Create statistics of TWiki webs. Find out most popular pages and top contributors. 
    21    * *Preferences:* Three levels of preferences: DefaultPreferences for site-level, WebPreferences for each web, and user level preferences. 
     21   * *Preferences:* Multiple levels of preferences: DefaultPreferences for site-level, WebPreferences for each web, user level preferences, individual topics etc. 
    2222   * *[[SimultaneousEdits][simultaneous page editing]]:*  
    2323   * *Referred-By:* Find the pages that contain links to a topic. 
  • branches/Release04x02/data/TWiki/ManagingWebs.txt

    r695 r707  
    1818The second method is to use an existing web as a template web.  This may be useful if you already have a web that you would like to use as a starting point.  Only topics that have names beginning with *Web...* (like "%HOMETOPIC%", "%NOTIFYTOPIC%", etc.) are copied. 
    1919 
    20 In either case you will want to be sure to verify that your new web has all the custom modifications that you desire. Any [[%SYSTEMWEB%.Macros][Macros]] defined in the form below will automatically be set in the !WebPreferences of the new web. 
     20In either case you will want to be sure to verify that your new web has all the custom modifications that you desire. Any [[macros]] defined in the form below will automatically be set in the !WebPreferences of the new web. 
    2121 
    2222#CreateNewWeb 
     
    5656---+++ Subweb Preferences are Inherited 
    5757 
    58 The preferences of a subweb are inherited from the parent web and overridden locally.  Preferences are ultimately inherited from the [[%SYSTEMWEB%.DefaultPreferences]] topic. 
     58The [[preference settings]] of a subweb are inherited from the parent web and overridden locally.  Preferences are ultimately inherited from the [[%SYSTEMWEB%.DefaultPreferences]] topic. 
    5959 
    6060*Example Preference Inheritance for =Sandbox/TestWeb/SubWeb.SubWebTopic= topic:* 
    6161 
    62    1. =%SYSTEMWEB%.DefaultPreferences= site-wide preferences 
    63    2. =Sandbox.%WEBPREFSTOPIC%= inherits from and overrides settings in =%SYSTEMWEB%.DefaultPreferences= 
    64    3. =Sandbox/TestWeb.%WEBPREFSTOPIC%= inherits from and overrides settings in =Sandbox.%WEBPREFSTOPIC%= 
    65    4. =Sandbox/TestWeb/SubWeb.%WEBPREFSTOPIC%= inherits from and overrides settings in =Sandbox/TestWeb.%WEBPREFSTOPIC%=  
    66    5. =Sandbox/TestWeb/SubWeb.SubWebTopic= inherits from and overrides settings in =Sandbox/TestWeb/SubWeb.%WEBPREFSTOPIC%=  
     62   1 =%SYSTEMWEB%.DefaultPreferences= default settings 
     63   1 =%USERSWEB%.SitePreferences= site-wide settings inherits from and overrides settings in =%SYSTEMWEB%.DefaultPreferences= 
     64   1 =Sandbox.%WEBPREFSTOPIC%= inherits from and overrides settings in =%USERSWEB%.SitePreferences= 
     65   1 =Sandbox/TestWeb.%WEBPREFSTOPIC%= inherits from and overrides settings in =Sandbox.%WEBPREFSTOPIC%= 
     66   1 =Sandbox/TestWeb/SubWeb.%WEBPREFSTOPIC%= inherits from and overrides settings in =Sandbox/TestWeb.%WEBPREFSTOPIC%=  
     67   1 =Sandbox/TestWeb/SubWeb.SubWebTopic= inherits from and overrides settings in =Sandbox/TestWeb/SubWeb.%WEBPREFSTOPIC%=  
    6768 
    6869---+++ Navigation 
     
    8081   * You must be allowed to rename and changes topics in the web you want to rename 
    8182   * You must be allowed to rename topics in the parent web of the web you want to rename 
    82 !   * If the web is a root web (i.e. it has no parent web) then you must have permission to both create and rename root webs. These permissions are controlled by the ALLOWROOTCHANGE preference, which can be set in [[%USERSWEB%.DefaultPreferences]]. 
     83!   * If the web is a root web (i.e. it has no parent web) then you must have permission to both create and rename root webs. These permissions are controlled by the ALLOWROOTCHANGE preference, which can be set in [[%USERSWEB%.SitePreferences]]. 
    8384   * If you move the web to another parent web you must be allowed to create and change topics in the new parent web. 
    8485    
  • branches/Release04x02/data/TWiki/MetaData.txt

    r697 r707  
    1818---++ Meta Data Syntax 
    1919 
    20    * Format is the same as in [[%SYSTEMWEB%.Macros][Macros]], except all fields have a key. 
     20   * Format is the same as in [[%SYSTEMWEB%.Macros][macros]], except all fields have a key. 
    2121      * =%<nop>META:&lt;type&gt;{key1="value1" key2="value2" ...}%= 
    2222 
  • branches/Release04x02/data/TWiki/Plugins.txt

    r697 r707  
    7070---+++ Plugin-Specific Settings 
    7171 
    72 Some plugins are configured with plugin preference settings, newer plugins with =configure= settings. 
     72Some plugins are configured with plugin [[%SYSTEMWEB%.PreferenceSettings][preference settings]], newer plugins with =configure= settings. 
    7373 
    7474=configure= settings are accessible though the [[%SCRIPTURLPATH{"configure"}%][configure]] interface.  
    7575 
    76 Plugin preference settings are defined in the plugin topic and can be overloaded. The SHORTDESCRIPTION setting is always present, it is needed for the automation in the extensions repository. Example preference settings defined in the TablePlugin topic: 
     76Plugin [[%SYSTEMWEB%.PreferenceSettings][preference settings]] are defined in the plugin topic and can be overloaded. The SHORTDESCRIPTION setting is always present, it is needed for the automation in the extensions repository. Example preference settings defined in the TablePlugin topic: 
    7777 
    7878   * =Set SHORTDESCRIPTION = Control attributes of tables and sorting of table columns= 
    7979  
    80 Preference settings of active plugins can be retrieved anywhere in TWiki with =%&lt;pluginname&gt;_&lt;var&gt;%=, such as =%<nop>TABLEPLUGIN_SHORTDESCRIPTION%=. They can also be redefined with the =%&lt;pluginname&gt;_&lt;var&gt;%= setting at a lower level in the [[%LOCALSITEPREFS%]] or at the web level. For an easier upgrade it is recommended to customize plugin preference settings in <nop>%LOCALSITEPREFS% only. 
     80[[Preference settings]] of active plugins can be retrieved anywhere in TWiki with =%&lt;pluginname&gt;_&lt;var&gt;%=, such as =%<nop>TABLEPLUGIN_SHORTDESCRIPTION%=. They can also be redefined with the =%&lt;pluginname&gt;_&lt;var&gt;%= setting at a lower level in the [[%LOCALSITEPREFS%]] or at the web level. For an easier upgrade it is recommended to customize plugin preference settings in <nop>%LOCALSITEPREFS% only. 
    8181 
    8282---+++ Listing Active Plugins 
     
    208208*Plugin Settings:* &lt;<i>Description and settings for custom plugin settings, and those required by TWiki.</i>&gt;" 
    209209 
    210    * *Plugins Preferences* &lt;<i>If user settings are needed, explain... Entering values works exactly like %SYSTEM!WEB%.DefaultPreferences and WebPreferences: six (6) spaces and then:</i>&gt;" 
    211       * *Set &lt;<i>EXAMPLE = value added</i>&gt;* 
     210   * *Plugins Preferences* &lt;<i>If user settings are needed, link to [[%SYSTEMWEB%.PreferenceSettings][preference settings]] and explain the role of the plugin name prefix 
    212211 
    213212*Plugin Installation Instructions:* &lt;<i>Step-by-step set-up guide, user help, whatever it takes to install and run, goes here.</i>&gt;" 
     
    285284#ConfigSpec 
    286285---++ Integrating with <code>configure</code> 
    287 Some extensions have setup requirements that are best integrated into =configure= rather than trying to use preference settings. These extensions use =Config.spec= files to publish their configuration requirements. 
     286Some extensions have setup requirements that are best integrated into =configure= rather than trying to use [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. These extensions use =Config.spec= files to publish their configuration requirements. 
    288287 
    289288=Config.spec= files are read during configuration. Once a =Config.spec= has defined a configuration item, it is available for edit through the standard =configure= interface. =Config.spec= files are stored in the 'plugin directory' e.g. =lib/TWiki/Plugins/BathPlugin/Config.spec=. 
  • branches/Release04x02/data/TWiki/PreviewBackground.txt

    r481 r707  
    22---+ Background Image for Preview 
    33 
    4 Preview looks like the real page, but the links lead to an oops dialog warning users of not-yet-saved topics. In addition, a background with a "PREVIEW" watermark is shown to have visual clue that you are previewing a topic. You can change the background image by specifying the name of an attached background image file in the PREVIEWBGIMAGE variable in the %WIKIPREFSTOPIC%. 
     4Preview looks like the real page, but the links lead to an oops dialog warning users of not-yet-saved topics. In addition, a background with a "PREVIEW" watermark is shown to have visual clue that you are previewing a topic. You can change the background image by specifying the name of an attached background image file in the PREVIEWBGIMAGE setting in the %WIKIPREFSTOPIC%. 
    55 
    66Remarks: 
    77 
    88   * You also could attach a new image file to this topic. 
    9    * You can override the PREVIEWBGIMAGE preference variable in your personal home page. 
     9   * You can override the PREVIEWBGIMAGE setting in your personal home page. 
    1010 
    1111__Related Topics:__ UserDocumentationCategory, AdminDocumentationCategory 
  • branches/Release04x02/data/TWiki/ProjectLogos.txt

    r590 r707  
    6969---++ Logo Customization 
    7070 
    71 TWiki is shipped with the official TWiki logo in the banner. Site owners may replace the banner logo with their own logo. The logo can be changed in the =WIKILOGOIMG= setting (site-wide in DefaultPreferences, or per web in WebPreferences of any web). 
     71The logo can be changed by redefining the =WIKILOGOIMG= [[%SYSTEMWEB%.PreferenceSettings][preference setting]]. 
    7272 
    7373If you use the official TWiki.org artwork on your own site you can link back to TWiki.org. Use this HTML (with any logo file on this page): 
  • branches/Release04x02/data/TWiki/QuerySearch.txt

    r691 r707  
    126126   * =History<nop>Form[name='Age'].value>2= - true if the topic has a =HistoryForm=, and the form has a field called =Age= with a value > 2 
    127127   * =History<nop>Form.Age > 2= - shortcut for the previous query 
    128    * =preferences[name='FaveColour' AND value='Tangerine']= - true if the topic has the given preference setting and value 
     128   * =preferences[name='FaveColour' AND value='Tangerine']= - true if the topic has the given [[%SYSTEMWEB%.PreferenceSettings][preference settings]] and value 
    129129   * =Person/(ClothesForm[name='Headgear'].value ~ '*Bowler*' AND attachments[name~'*hat.gif' AND date < d2n('2007-01-01')])= - true if the form attached to the topic has a field called =Person= that has a value that is the name of a topic, and that topic contains the form =ClothesForm=, with a field called =Headgear=, and the value of that field contains the string ='Bowler'=, and the topic also has at least one attachment that has a name matching =*hat.gif= and a date before 1st Jan 2007. (Phew!) 
    130130 
  • branches/Release04x02/data/TWiki/ReleaseHistory.txt

    r672 r707  
    1 %META:TOPICINFO{author="ProjectContributor" date="1200423469" format="1.1" version="$Rev: 17584 $"}% 
     1%META:TOPICINFO{author="ProjectContributor" date="1200423469" format="1.1" version="$Rev: 15785 $"}% 
    22%STARTINCLUDE% 
    33---+ Appendix A: TWiki Development Time-line 
     
    66 
    77#FreetownRelease 
    8 ---++ TWiki Release 4.2.4 (Freetown) released %$DATE% 
     8---++ TWiki Release 4.2.1 (Freetown) released %$DATE% 
    99 
    1010Patch release following the 4.2.0 released 22 Jan 2008 
     
    8888 
    8989 
     90 
    9091#EdinburghRelease 
    9192---++ TWiki Release 4.1 (Edinburgh), 16 Jan 2007 
     
    132133      * Change in WikiWord definition: Numbers are treated as lower case letters, e.g. !Y2K is now a !WikiWord. 
    133134      * Configurable template load path. Advanced feature for those that work with customized templates. 
    134       * Added %<nop>VBAR% to TWikiPreferences for vertical bar symbol. 
     135      * Added %<nop>VBAR% to !TWikiPreferences for vertical bar symbol. 
    135136      * On topic creation, force initial letter of topic name to be upper case. 
    136137      * Allow date format in form fields. 
     
    486487      * New =%<nop>WIKITOOLNAME%= variable in %WIKIPREFSTOPIC%; replacing =$wikiToolName= in TWiki.cfg 
    487488   * *31 May 2002* - TWiki:Main.PeterThoeny 
    488       * New =%<nop>EDITBOXSTYLE%= preferences variable which sets the edit box width automatically to the window width 
     489      * New =%<nop>EDITBOXSTYLE%= preferences setting which sets the edit box width automatically to the window width 
    489490   * *17 May 2002* - TWiki:Main.PeterThoeny 
    490491      * New =%<nop>URLENCODE{}%= variable to encodes a string for using in a URL parameter, e.g. =%<nop>URLENCODE{"spaced name"}%= returns =spaced%20name= 
     
    525526      * Convert to XHTML 1.0 function: first step to XHTML-ifying TWiki 
    526527   * *26 Jun 2001* - TWiki:Main.JohnTalintyre 
    527       * Category information to forms using the !TWikiMetaData format, see !TWikiForms 
     528      * Category information to forms using the TWikiMetaData format, see !TWikiForms 
    528529   * *07 Jun 2001* - TWiki:Main.PeterThoeny 
    529530      * New topic templates as topics instead of templates. Customize by editing the topic. Retired =notedited.tmpl=, =notext.tmpl= and =notwiki.tmpl= templates. More in TWikiTemplates.  
     
    537538      * Forms to change/reset/install passwords, see ChangePassword &amp; ResetPassword 
    538539   * *01 May 2001* - TWiki:Main.AndreaSterbini 
    539       * The %MAINWEB%.AdminGroup (or other group) can be enabled as a [[TWikiAccessControl#SuperAdminGroup][SuperAdminGroup]]. Members have browser edit access to _all_ locked topics.  
     540      * The %MAINWEB%.AdminGroup (or other group) can be enabled as a [[AccessControl#SuperAdminGroup][SuperAdminGroup]]. Members have browser edit access to _all_ locked topics.  
    540541   * *01 May 2001* - TWiki:Main.JohnTalintyre 
    541542      * Meta information format, see TWikiMetaData 
     
    575576      * Better error handling when saving a topic.  
    576577   * *05 Jan 2001* - TWiki:Main.PeterThoeny 
    577       * View authorization based on groups. Define who is allowed to see a TWiki web. More in TWikiAccessControl and TWiki:Codev/AuthenticationBasedOnGroups.  
     578      * View authorization based on groups. Define who is allowed to see a TWiki web. More in AccessControl and TWiki:Codev/AuthenticationBasedOnGroups.  
    578579   * *05 Dec 2000* - TWiki:Main.PeterThoeny 
    579580      * Improved include handling. Infinite recursion of includes are prevented; new variables =%<nop>BASEWEB%=, =%<nop>INCLUDINGWEB%=, =%<nop>BASETOPIC%= and =%<nop>INCLUDINGTOPIC%= to have more control over include handling. More in TWikiVariables and TWiki:Codev/IncludeHandlingImprovements.  
     
    590591      * Added a "Cancel" link in edit that releases the edit lock.  
    591592   * *23 Oct 2000* - TWiki:Main.PeterThoeny 
    592       * Authorization based on groups. Define fine graned control who is allowed to change or create topics. More in TWikiAccessControl and TWiki:Codev/AuthenticationBasedOnGroups.  
     593      * Authorization based on groups. Define fine graned control who is allowed to change or create topics. More in AccessControl and TWiki:Codev/AuthenticationBasedOnGroups.  
    593594   * *05 Oct 2000* - TWiki:Main.PeterThoeny 
    594595      * Remember user by IP address so that =view= "knows" the user once authenticated in =edit=. More in TWikiUserAuthentication.  
     
    606607      * Ref-By link searches all webs (not just the current web.)  
    607608   * *16 Aug 2000* - TWiki:Main.PeterThoeny 
    608       * New TWikiPreferences variables =%<nop>HTTP_EQUIV_ON_VIEW%= , =%<nop>HTTP_EQUIV_ON_EDIT%= and =%<nop>HTTP_EQUIV_ON_PREVIEW%= that define the =&lt;meta http-equiv="..."&gt;= meta tags for the TWiki templates. This can be used for example to set a document expiration time.  
     609      * New !TWikiPreferences settings =%<nop>HTTP_EQUIV_ON_VIEW%= , =%<nop>HTTP_EQUIV_ON_EDIT%= and =%<nop>HTTP_EQUIV_ON_PREVIEW%= that define the =&lt;meta http-equiv="..."&gt;= meta tags for the TWiki templates. This can be used for example to set a document expiration time.  
    609610   * *29 Jul 2000* - TWiki:Main.PeterThoeny 
    610611      * New variables =%<nop>GMTIME{"..."}%= and =%<nop>SERVERTIME{"..."}%= . More in TWikiVariables.  
     
    641642      * TWikiRegistration is done separately for Intranet use (depends on remote_user) or Internet use (depends on .htpasswd file).  
    642643   * *20 Mar 2000* - TWiki:Main.PeterThoeny 
    643       * Uploading a file (topic file attachment) will optionally create a link to the uploaded file at the end of the topic. The preference variable =%<nop>ATTACHLINKBOX%= controls the default state of the __link__ check box in the attach file page.  
     644      * Uploading a file (topic file attachment) will optionally create a link to the uploaded file at the end of the topic. The preference setting =%<nop>ATTACHLINKBOX%= controls the default state of the __link__ check box in the attach file page.  
    644645   * *11 Mar 2000* - TWiki:Main.PeterThoeny 
    645646      * Better security with taint checking ( =Perl -T= option )  
    646647   * *25 Feb 2000* - TWiki:Main.PeterThoeny 
    647       * New preference variables =%<nop>EDITBOXWIDTH%= and =%<nop>EDITBOXHEIGHT%= to specify the edit box size.  
     648      * New preference settings =%<nop>EDITBOXWIDTH%= and =%<nop>EDITBOXHEIGHT%= to specify the edit box size.  
    648649   * *25 Feb 2000* - TWiki:Main.PeterThoeny 
    649       * Edit preferences topics to set TWiki variables. There are three level of preferences Site-level (TWikiPreferences), web-level (WebPreferences in each web) and user-level preferences (for each of the Main.WikiUsers). With this, discontinue use of server side include of =wikiwebs.inc= , =wikiwebtable.inc= , =weblist.inc= , =webcopyright.inc= and =webcolors.inc= files.   
     650      * Edit preferences topics to set TWiki variables. There are three level of preferences Site-level (!TWikiPreferences), web-level (WebPreferences in each web) and user-level preferences (for each of the Main.WikiUsers). With this, discontinue use of server side include of =wikiwebs.inc= , =wikiwebtable.inc= , =weblist.inc= , =webcopyright.inc= and =webcolors.inc= files.   
    650651   * *11 Feb 2000* - TWiki:Main.PeterThoeny 
    651652      * New variable =%<nop>SCRIPTSUFFIX%= / $scriptSuffix containing an optional file extension of the TWiki Perl script. Templates have been changed to use this variable. This allows you to rename the Perl script files to have a file extension like for example ".cgi".  
     
    657658      * Inline search. New variable =%<nop>SEARCH{"str" ...}%= to show a search result embedded in a topic text. TWikiVariables has more on the syntax. Inline search combined with the category table feature can be used for example to create a simple bug tracking system.  
    658659   * *04 Feb 2000* - TWiki:Main.PeterThoeny 
    659       * Access statistics. Each web has a WebStatistics topic that shows monthy statistics with number of topic views and changes, most popular topics, and top contributors. (It needs to be enabled, TWikiDocumentation has more.)  
     660      * Access statistics. Each web has a WebStatistics topic that shows monthy statistics with number of topic views and changes, most popular topics, and top contributors. (It needs to be enabled, CompleteDocumentation has more.)  
    660661   * *29 Jan 2000* - TWiki:Main.PeterThoeny 
    661662      * Fixed bug where TWiki would not initialize correctly under certain circumstances, i.e. when running it under mod_perl. Sub =initialize= in =wiki.pm= did not handle =$thePathInfo= correctly.  
     
    716717      * Signature is shown below the text area when editing a topic. Use this to easily copy & paste your signature into the text.  
    717718   * *07 Dec 1998* - TWiki:Main.PeterThoeny 
    718       * Possible to add a category table to a TWiki topic. This permits storing and searching for more structured information. Editing a topic shows a HTML form with the usual text area and a table with selectors, checkboxes, radio buttons and text fields. TWikiDocumentation has more on setup. The TWiki.Know web uses this category table to set classification, platform and OS version.   
     719      * Possible to add a category table to a TWiki topic. This permits storing and searching for more structured information. Editing a topic shows a HTML form with the usual text area and a table with selectors, checkboxes, radio buttons and text fields. CompleteDocumentation has more on setup. The TWiki.Know web uses this category table to set classification, platform and OS version.   
    719720   * *18 Nov 1998* - TWiki:Main.PeterThoeny 
    720721      * Internal log of topic save actions to the file <code>data/logYYYYMM.txt</code>, where <code>YYYYMM</code> the year and month in numeric format is. Intended for auditing only, not accessible from the web.  
     
    772773   * TWiki:Codev.DocsToDo: feature documentation pending 
    773774   * TWiki:Codev.FeatureDocumented: documented feature 
    774    * CompleteDocumentation: reference manual for the latest TWiki 
     775   * ReferenceManual: reference manual for the latest TWiki 
    775776 
    776777__Related Topics:__ DeveloperDocumentationCategory 
  • branches/Release04x02/data/TWiki/ReleaseNotes01x00.txt

    r672 r707  
    211211---++ Deprecation Notices 
    212212 
    213 The %<nop>MAINWEB% and %<nop>SYSTEMWEB% variables have been deprecated. For compatibility reasons they are unlikely to ever be removed completely, but you should use the %<nop>USERSWEB% and %<nop>SYSTEMWEB% variables instead. 
     213The %<nop>MAINWEB% and %<nop>SYSTEMWEB% macros have been deprecated. For compatibility reasons they are unlikely to ever be removed completely, but you should use the %<nop>USERSWEB% and %<nop>SYSTEMWEB% macros instead. 
    214214 
    215215In Func getOopsUrl and permissionsSet have been declared deprecated. There is no plan to remove them yet. 
     
    396396| [[%BUGS%/Item3909][Item3909]] | Pattern skin template documentation update | 
    397397| [[%BUGS%/Item3902][Item3902]] | Reset Password is broken in MAIN branch | 
    398 | [[%BUGS%/Item3900][Item3900]] | New CARET preferences variable | 
     398| [[%BUGS%/Item3900][Item3900]] | New CARET preferences setting | 
    399399| [[%BUGS%/Item3897][Item3897]] | Fix sanitizeAttachmentName | 
    400400| [[%BUGS%/Item3895][Item3895]] | Structure the TWiki version number to make accessible from plugins (code included) | 
  • branches/Release04x02/data/TWiki/SearchHelp.txt

    r697 r707  
    1818   * Use double quotes if you want to search for a leading minus sign, like ="-nowarn"= 
    1919   * *Stop words* are excluded from a keyword search: 
    20       * Stop words are common words and characters such as ="how"= and ="where"=, defined in the SEARCHSTOPWORDS setting in the DefaultPreferences 
     20      * Stop words are common words and characters such as ="how"= and ="where"=, defined by the SEARCHSTOPWORDS [[%SYSTEMWEB%.PreferenceSettings][preference setting]] 
    2121      * If you want to search for a word in the stop word list, prefix the word with a plus sign 
    2222   * *Example:* To search for all topics that contain ="SOAP"=, ="WSDL"=, a literal ="web service"=, but not ="shampoo"=,%BR% enter this: =soap +wsdl "web service" -shampoo= 
     
    3535---++ Search Preferences 
    3636 
    37 !DefaultPreferences defines these search preferences: 
     37The default search preferences are: 
    3838 
    3939   * =SEARCHDEFAULTTTYPE=: Default search type for search forms which calls the =search= script 
  • branches/Release04x02/data/TWiki/SearchPatternCookbook.txt

    r695 r707  
    174174---+++ Solution 1: Using META 
    175175 
    176 Since TWiki 4.0 you can now use the META variable: 
     176Since TWiki 4.0 you can now use the META macro: 
    177177 
    178178=%<nop>META{ "parent" dontrecurse="on" }%= 
     
    271271---+++ Alternative solution 
    272272 
    273 This result can also be accomplished with the %<nop>WEBLIST% variable. 
     273This result can also be accomplished with the %<nop>WEBLIST% macro. 
    274274 
    275275<form> 
  • branches/Release04x02/data/TWiki/ShortcutMacros.txt

    r698 r707  
    88 
    99*The following settings are classified as rendering shortcuts:* 
    10 %SEARCH{ "Type:.*ShortcutMacro" type="regex" topic="Var*"  
     10%SEARCH{ "parent.name='ShortcutMacros'" type="query" topic="Var*"  
    1111format="   * [[$topic][%<nop>$pattern(.*?\-\++ *([^ ]*).*)%]] - $pattern(.*?\-\+.*?-- ([^\n\r]*).*) %$pattern(.*?\-\++ *([^ ]*).*)%" nonoise="on" }% 
    1212 
     
    1515   * DefaultPreferences#RenderingShortcuts - where shortcuts are defined  
    1616   * TWikiShorthand - summary of the TWiki markup language 
     17   * [[StandardColors#ShortCuts]] - shortcuts for some standard colours 
  • branches/Release04x02/data/TWiki/SkinTemplates.txt

    r697 r707  
    4242 
    4343Any alphanumeric characters can be used in parameter names. 
    44 You are highly recommended to use parameter names that cannot be confused with [[Macros]]. 
     44You are highly recommended to use parameter names that cannot be confused with [[macros]]. 
    4545 
    4646Note that three parameter names, =context=, =then= and =else= are *reserved*. 
     
    105105   I. =%SYSTEMWEB%.ExampleTemplate= 
    106106 
    107 Template names are usually derived from the name of the currently executing script; however it is also possible to override these settings in the =view= and =edit= scripts, for example when a topic-specific template is required. Two preference settings can be used to override the skin templates used: 
     107Template names are usually derived from the name of the currently executing script; however it is also possible to override these settings in the =view= and =edit= scripts, for example when a topic-specific template is required. Two [[%SYSTEMWEB%.PreferenceSettings][preference settings]] can be used to override the skin templates used: 
    108108   * =VIEW_TEMPLATE= sets the template to be used for viewing a topic 
    109109   * =EDIT_TEMPLATE= sets the template for editing a topic. 
  • branches/Release04x02/data/TWiki/Skins.txt

    r695 r707  
    104104and then set =SKIN=yourlocal,pattern=. 
    105105 
    106 Because ClassicSkin and the default templates use the same Template definition names, you can over-ride the edit links in them (or any skin derived from them) using the same =view.yourlocal.tmpl= (just set SKIN=yourlocal,classic either in %USERSWEB%.DefaultPreferences for globally, or a Web's <nop>Webname.<nop>WebPreferences for a particular web)  
     106Because ClassicSkin and the default templates use the same Template definition names, you can over-ride the edit links in them (or any skin derived from them) using the same =view.yourlocal.tmpl= (just set SKIN=yourlocal,classic either in %USERSWEB%.SitePreferences for globally, or a Web's <nop>Webname.<nop>WebPreferences for a particular web)  
    107107 
    108108---++ Settings in Skins 
     
    219219---++ Activating Skins 
    220220 
    221 TWiki uses a _skin search path_, which lets you combine skins additively. The skin path is defined using a combination of [[Macros]] and URL parameters. 
     221TWiki uses a _skin search path_, which lets you combine skins additively. The skin path is defined using a combination of [[macros]] and URL parameters. 
    222222 
    223223TWiki works by asking for a template for a particular function - for example, 'view'. The detail of how templates are searched for is described in SkinTemplates, but in summary, the templates directory is searched for a file called <code>view.</code><i>skin</i><code>.tmpl</code>, where _skin_ is the name of the skin e.g. =pattern=. If no template is found, then the fallback is to use =view.tmpl=. Each skin on the path is searched for in turn. For example, if you have set the skin path to =local,pattern= then =view.local.tmpl= will be searched for first, then =view.pattern.tmpl= and finally =view.tmpl=. 
  • branches/Release04x02/data/TWiki/StandardColors.txt

    r481 r707  
    122122   * http://www.cloford.com/resources/colours/websafe2.htm - Web-safe colors 
    123123 
     124#ShortCuts 
     125---+ Shortcut macros for colors 
     126%SEARCH{ "parent.name='StandardColors'" type="query" topic="Var*"  
     127format="   * $percnt<nop>$pattern(.*?\-\++ *([^ ]*).*)$percnt $percnt$pattern(.*?\-\++ *([^ ]*).*)$percnt Lorem ipsum.... $percntENDCOLOR$percnt $percnt<nop>ENDCOLOR$percnt" nonoise="on" }% 
     128 
    124129__Related Topics:__ UserDocumentationCategory, AdminDocumentationCategory 
  • branches/Release04x02/data/TWiki/TWikiScripts.txt

    r695 r707  
    6060 
    6161| *Parameter* | *Description* | *Default* | 
    62 | =action= | Optional. Use the editaction template instead of the standard edit. If action=text, then hide the form. If action=form hide the normal text area and only edit the form. You can change the Edit/Edit Raw buttons to always append the action parameter in skins like Pattern and Classic by setting the topic or preference setting [[VarEDITACTION][EDITACTION]] to the value =text= or =form=. To edit the topic once the EDITACTION is defined as form simply remove the action=form from the browser URL of the edit script and reload the edit window | | 
     62| =action= | Optional. Use the editaction template instead of the standard edit. If action=text, then hide the form. If action=form hide the normal text area and only edit the form. You can change the Edit/Edit Raw buttons to always append the action parameter in skins like Pattern and Classic by setting the topic or [[preference setting]] [[VarEDITACTION][EDITACTION]] to the value =text= or =form=. To edit the topic once the EDITACTION is defined as form simply remove the action=form from the browser URL of the edit script and reload the edit window | | 
    6363| =onlynewtopic= | If set, error if topic already exists | | 
    6464| =onlywikiname= | If set, error if topic name is not a WikiWord | | 
  • branches/Release04x02/data/TWiki/TWikiSiteTools.txt

    r697 r707  
    1212---++ <nop>WebNotify - recent changes alert 
    1313 
    14 Each TWiki web has an automatic e-mail alert service that sends a list of recent changes on a preset schedule, like once a day. Users can subscribe and unsubscribe using %NOTIFYTOPIC% in each web. The Perl script =mailnotify= is called by a background process at regular intervals. The script sends an automated e-mail to subscribed users if topics were changed in a web since the script was last run. 
    15  
    16    * You can create a WebNotify link using [[%SYSTEMWEB%.Macros][Macros]] with ==%<nop>NOTIFYTOPIC%== 
    17  
    1814%INCLUDE{"WebChangesAlert"}% 
    19  
    20 You can also use =%<nop>USERSWEB%= instead of =Main=, but this is not necessary even if you have renamed the main web by configuring ={MainWebName}= in [[%SCRIPTURLPATH{"configure"}%][configure]]. 
    2115 
    2216#WebSearch 
    2317---++ <nop>WebSearch - search TWiki site 
    2418 
    25 WebSearch is an extremely fast and flexible search facility, part of the core TWiki feature set. WebSearchAdvanced offers more options, including: 
     19WebSearch is a flexible search facility, part of the core feature set. WebSearchAdvanced offers more options, including: 
    2620   * topic title or full-text search 
    2721   * regular expressions 
     
    6559You can generate a listing manually, or on an automated schedule, of visits to individual pages, on a per web basis. Compiled as a running total on a monthly basis. Includes totals for Topic Views, Topic Saves, Attachment Uploads, Most Popular Topics with number of views, and Top Contributors showing total of saves and attachment uploads. Previous months are saved. 
    6660 
    67    * You can create a WebStatistics link using [[%SYSTEMWEB%.Macros][Macros]] with ==%<nop>STATISTICSTOPIC%== 
     61   * You can create a WebStatistics link using ==%<nop>STATISTICSTOPIC%== 
    6862 
    6963---+++ Configuring for automatic operation 
     
    126120Outgoing mail is required for TWikiRegistration and for [[#WebNotify][recent changes alert]]. 
    127121 
    128 TWiki will use the ==Net::SMTP== module if it is installed on your system. Set this with the ==SMTPMAILHOST== preference setting in DefaultPreferences. 
     122TWiki will use the ==Net::SMTP== module if it is installed on your system. Set this with the ==SMTPMAILHOST== [[preference setting]]. 
    129123 
    130 The notify e-mail uses the default =changes.tmpl= template, or a skin if activated in the DefaultPreferences. 
     124The notify e-mail uses the default =changes.tmpl= template, or a skin if activated by a [[%SYSTEMWEB%.PreferenceSettings][preference setting]]. 
    131125 
    132126mailnotify also relies on two hidden files in each =twiki/data/Web= directory: =.changes= and =.mailnotify.= Make sure both are writable by your web server process. =.changes= contains a list of changes; go ahead and make this empty. =.mailnotify= contains a timestamp of the last time notification was done. 
     
    134128You can use an external mail program, such as ==sendmail==, if the =Net::SMTP= module is not installed. Set the program path in =={MailProgram}== in [[%SCRIPTURLPATH{"configure"}%][configure]]. 
    135129 
    136 !   * %H% Net::SMTP can be easily disabled (if there is an installation error) by setting ==SMTPMAILHOST== in DefaultPreferences to an empty value. 
     130!   * %H% Net::SMTP can be easily disabled (if there is an installation error) by setting the ==SMTPMAILHOST== [[%SYSTEMWEB%.PreferenceSettings][preference setting]] to an empty value. 
    137131 
    138    * %T% You can set a separate ==SMTPSENDERHOST== preference setting to define the mail sender host (some SMTP installations require this). 
     132   * %T% You can set a separate ==SMTPSENDERHOST== [[preference setting]] to define the mail sender host (some SMTP installations require this). 
    139133 
    140134---+++ Setting the automatic e-mail schedule 
  • branches/Release04x02/data/TWiki/TextFormattingFAQ.txt

    r697 r707  
    7171The =pre= tag is standard HTML; =verbatim= is a special TWiki tag that forces text to fixed font mode, and also prevents other tags and TWiki shortcuts from being expanded. 
    7272 
    73 __NOTE:__ preference settings are still Set within verbatim tags (this is a historical peculiarity) 
     73__NOTE:__ [[%SYSTEMWEB%.PreferenceSettings][preference settings]] still work within verbatim tags (this is a historical peculiarity) 
    7474 
    7575__NOTE:__ The =verbatim= opening and closing tags are converted into =pre= tags; any HTML attributes (e.g., =class=, =id=) in the opening =verbatim= tag are included in the corresponding =pre= tag. 
  • branches/Release04x02/data/TWiki/TextFormattingRules.txt

    r661 r707  
    4747%PLUGINDESCRIPTIONS% 
    4848 
    49 Check on current Plugin status and settings for this site in DefaultPreferences. 
     49Check on current Plugin status and settings for this site in [[%SYSTEMWEB%.Plugins]]. 
    5050 
    5151---++ Common Editing Errors 
  • branches/Release04x02/data/TWiki/TwentyMinuteTutorial.txt

  • branches/Release04x02/data/TWiki/UserAuthentication.txt

  • branches/Release04x02/data/TWiki/UserDocumentationCategory.txt

    r481 r707  
    33---+ A List of TWiki User Documentation 
    44 
    5 %SEARCH{"%TOPIC%" excludetopic="%TOPIC%" nonoise="on" format="   * $web.$topic$n      * $summary(100, noheader)"}% 
     5%SEARCH{"%TOPIC%" excludetopic="%TOPIC%,WebLeftBar" nonoise="on" format="   * [[$web.$topic][$percntSPACEOUT{$quot$topic$quot}$percnt]]$n      * $summary(100, noheader)"}% 
  • branches/Release04x02/data/TWiki/UsersGuide.txt

  • branches/Release04x02/data/TWiki/VarAQUA.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarAQUA 
    44---+++ AQUA -- start aqua colored text 
  • branches/Release04x02/data/TWiki/VarBB.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1176595629" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarBB 
    44---+++ BB -- bullet with line break 
    55   * Line break and bullet without indentation. 
    6    * Type: ShortcutMacro 
    76   * Current value: BB = %BB% 
    87   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBR][BR]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBULLET][BULLET]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB2][BB2]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB3][BB3]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB4][BB4]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarCARET][CARET]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarVBAR][VBAR]] 
  • branches/Release04x02/data/TWiki/VarBB2.txt

    r692 r707  
    11!%META:TOPICINFO{author="ProjectContributor" date="1160951440" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="VarBB"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarBB2 
    44---+++ BB2 -- level 2 bullet with line break 
    55   * Line break and bullet, level 2. 
    6    * Type: ShortcutMacro 
    76   * Current value: BB2 = %BB2% 
    87   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBR][BR]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBULLET][BULLET]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB][BB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB3][BB3]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB4][BB4]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarVBAR][VBAR]] 
  • branches/Release04x02/data/TWiki/VarBB3.txt

    r692 r707  
    11%META:TOPICINFO{author="!ProjectContributor" date="1160951440" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="VarBB"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarBB3 
    44---+++ BB3 -- level 3 bullet with line break 
    55   * Line break and bullet, level 3. 
    6    * Type: ShortcutMacro 
    76   * Current value: BB3 = %BB3% 
    87   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBR][BR]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBULLET][BULLET]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB][BB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB2][BB2]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB4][BB4]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarVBAR][VBAR]] 
  • branches/Release04x02/data/TWiki/VarBB4.txt

    r692 r707  
    11%META:TOPICINFO{author="!ProjectContributor" date="1160951440" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="VarBB"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarBB4 
    44---+++ BB4 -- level 4 bullet with line break 
    55   * Line break and bullet, level 4. 
    6    * Type: ShortcutMacro 
    76   * Current value: BB4 = %BB4% 
    87   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBR][BR]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBULLET][BULLET]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB][BB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB2][BB2]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB3][BB3]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarVBAR][VBAR]] 
  • branches/Release04x02/data/TWiki/VarBLACK.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarBLACK 
    44---+++ BLACK -- start black colored text 
  • branches/Release04x02/data/TWiki/VarBLUE.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarBLUE 
    44---+++ BLUE -- start blue colored text 
  • branches/Release04x02/data/TWiki/VarBR.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1176595597" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarBR 
    44 
    55---+++ BR -- line break 
    6    * Type: ShortcutMacro 
    76   * Current value: BR = %BR% 
    87   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBULLET][BULLET]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB][BB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB2][BB2]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB3][BB3]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB4][BB4]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarCARET][CARET]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarVBAR][VBAR]] 
  • branches/Release04x02/data/TWiki/VarBROWN.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarBROWN 
    44---+++ BROWN -- start brown colored text 
  • branches/Release04x02/data/TWiki/VarBULLET.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1176595670" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarBULLET 
    44 
    55---+++ BULLET -- bullet character 
    6    * Type: ShortcutMacro 
    76   * Current value: BULLET = %BULLET% 
    87   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBR][BR]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB][BB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB2][BB2]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB3][BB3]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB4][BB4]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarCARET][CARET]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarVBAR][VBAR]] 
  • branches/Release04x02/data/TWiki/VarCARET.txt

    r697 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1176595420" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarCARET 
    44 
    55---+++ CARET -- caret symbol 
    66   * The CARET macro is useful in TML tables. 
    7    * Type: ShortcutMacro 
    87   * Current value: CARET = %CARET% 
    98   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBR][BR]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBULLET][BULLET]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB][BB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB2][BB2]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB3][BB3]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB4][BB4]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarVBAR][VBAR]] 
  • branches/Release04x02/data/TWiki/VarEDITACTION.txt

    r691 r707  
    44---+++ EDITACTION -- Selects an edit template 
    55 
    6    * EDITACTION defined in a topic or preference setting will define the use of an editaction template instead of the standard edit. If EDITACTION is defined as =text=, then hide the form. If EDITACTION is defined as =form= hide the normal text area and only edit the form. 
     6   * The EDITACTION [[preference setting]] lets you define the use of an editaction template instead of the standard edit. If EDITACTION is defined as =text=, then hide the form. If EDITACTION is defined as =form= hide the normal text area and only edit the form. 
    77   * Syntax: Set EDITACTION = text|form 
    88   * Expands to: %EDITACTION% 
    99   * Related: TWikiScripts#edit 
    10    * %X% When EDITACTION is defined as text or form the Edit and Edit Raw buttons simply add =;action=text= or =;action=form= to the URL for the edit script. If you have defined EDITACTION in a topic setting or preference setting you can still edit the topic content or the form by removing the =;action=form= or =;action=text= from the edit URL in the browser and reload. 
     10   * %X% When EDITACTION is defined as text or form the Edit and Edit Raw buttons simply add =;action=text= or =;action=form= to the URL for the edit script. If you have defined an EDITACTION [[preference setting]] you can still edit the topic content or the form by removing the =;action=form= or =;action=text= from the edit URL in the browser and reload. 
  • branches/Release04x02/data/TWiki/VarENDCOLOR.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
    32#VarENDCOLOR 
    43---+++ ENDCOLOR -- end colored text 
  • branches/Release04x02/data/TWiki/VarGRAY.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarGRAY 
    44---+++ GRAY -- start gray colored text 
  • branches/Release04x02/data/TWiki/VarGREEN.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarGREEN 
    44---+++ GREEN -- start green colored text 
  • branches/Release04x02/data/TWiki/VarH.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1152047754" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarH 
    44---+++ H -- help icon 
    5    * Type: ShortcutMacro 
    65   * Current value: H = %H% 
    76   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarI][I]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarM][M]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarN][N]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarP][P]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarQ][Q]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarS][S]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarT][T]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarU][U]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarX][X]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarY][Y]] 
  • branches/Release04x02/data/TWiki/VarI.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1152046313" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarI 
    44---+++ I -- idea icon 
    5    * Type: ShortcutMacro 
    65   * Current value: I = %I% 
    76   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarH][H]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarM][M]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarN][N]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarP][P]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarQ][Q]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarS][S]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarT][T]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarU][U]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarX][X]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarY][Y]] 
  • branches/Release04x02/data/TWiki/VarLIME.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarLIME 
    44---+++ LIME -- start lime colored text 
  • branches/Release04x02/data/TWiki/VarM.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1152047756" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="ShortcutMacros!"}% 
    33#VarM 
    44---+++ M -- moved to... icon 
    5    * Type: ShortcutMacro 
    65   * Current value: M = %M% 
    76   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarH][H]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarI][I]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarN][N]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarP][P]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarQ][Q]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarS][S]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarT][T]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarU][U]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarX][X]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarY][Y]] 
  • branches/Release04x02/data/TWiki/VarMAROON.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarMAROON 
    44---+++ MAROON -- start maroon colored text 
  • branches/Release04x02/data/TWiki/VarMETASEARCH.txt

    r695 r707  
    2222%STOPINCLUDE% 
    2323 
    24 __Related Topics:__ UserDocumentationCategory 
    2524%META:TOPICINFO{author="ProjectContributor" date="1130377817" format="1.1" version="$Rev: 8869 $"}% 
    2625%META:TOPICPARENT{name="Macros"}% 
  • branches/Release04x02/data/TWiki/VarN.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1152047754" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarN 
    44---+++ N -- "new" icon 
    5    * Type: ShortcutMacro 
    65   * Current value: N = %N% 
    76   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarH][H]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarI][I]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarM][M]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarP][P]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarQ][Q]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarS][S]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarT][T]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarU][U]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarX][X]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarY][Y]] 
  • branches/Release04x02/data/TWiki/VarNAVY.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarNAVY 
    44---+++ NAVY -- start navy blue colored text 
  • branches/Release04x02/data/TWiki/VarOLIVE.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarOLIVE 
    44---+++ OLIVE -- start olive green colored text 
  • branches/Release04x02/data/TWiki/VarORANGE.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarORANGE 
    44---+++ ORANGE -- start orange colored text 
  • branches/Release04x02/data/TWiki/VarP.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1152044726" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarP 
    44---+++ P -- pencil icon 
    5    * Type: ShortcutMacro 
    65   * Current value: P = %P% 
    76   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarH][H]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarI][I]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarM][M]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarN][N]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarQ][Q]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarS][S]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarT][T]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarU][U]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarX][X]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarY][Y]] 
  • branches/Release04x02/data/TWiki/VarPINK.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarPINK 
    44---+++ PINK -- start pink colored text 
  • branches/Release04x02/data/TWiki/VarPURPLE.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarPURPLE 
    44---+++ PURPLE -- start purple colored text 
  • branches/Release04x02/data/TWiki/VarQ.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1152044726" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarQ 
    44---+++ Q -- question icon 
    5    * Type: ShortcutMacro 
    65   * Current value: Q = %Q% 
    76   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarH][H]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarI][I]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarM][M]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarN][N]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarP][P]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarS][S]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarT][T]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarU][U]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarX][X]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarY][Y]] 
  • branches/Release04x02/data/TWiki/VarRED.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarRED 
    44---+++ RED -- start red colored text 
  • branches/Release04x02/data/TWiki/VarS.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1152044726" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarS 
    44---+++ S -- red star icon 
    5    * Type: ShortcutMacro 
    65   * Current value: S = %S% 
    76   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarH][H]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarI][I]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarM][M]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarN][N]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarP][P]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarQ][Q]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarT][T]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarU][U]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarX][X]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarY][Y]] 
  • branches/Release04x02/data/TWiki/VarSILVER.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="StandardColors!"}% 
    33#VarSILVER 
    44---+++ SILVER -- start silver colored text 
  • branches/Release04x02/data/TWiki/VarSYSTEMWEB.txt

    r692 r707  
    33#VarSYSTEMWEB 
    44---+++ SYSTEMWEB -- name of TWiki documentation web 
    5    * The web containing all documentation and default preference settings 
     5   * The web containing all documentation and default [[%SYSTEMWEB%.PreferenceSettings][preference settings]] 
    66   * Syntax: =%<nop>SYSTEMWEB%= 
    77   * Expands to: =%SYSTEMWEB%= 
  • branches/Release04x02/data/TWiki/VarT.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1152044728" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarT 
    44---+++ T -- tip icon 
    5    * Type: ShortcutMacro 
    65   * Current value: T = %T% 
    76   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarH][H]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarI][I]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarM][M]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarN][N]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarP][P]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarQ][Q]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarS][S]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarU][U]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarX][X]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarY][Y]] 
  • branches/Release04x02/data/TWiki/VarTEAL.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarTEAL 
    44---+++ TEAL -- start teal colored text 
  • branches/Release04x02/data/TWiki/VarTOPICURL.txt

    r695 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarTOPICURL 
    44---+++ TOPICURL -- shortcut to viewing the current topic 
    55   * This macro always expands to an url pointing to the current base topic. 
    6    * Type: ShortcutMacro 
    76   * Current value: TOPICURL = %TOPICURL% 
  • branches/Release04x02/data/TWiki/VarU.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1152047756" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarU 
    44---+++ U -- "updated" icon 
    5    * Type: ShortcutMacro 
    65   * Current value: U = %U% 
    76   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarH][H]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarI][I]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarM][M]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarN][N]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarP][P]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarQ][Q]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarS][S]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarT][T]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarX][X]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarY][Y]] 
  • branches/Release04x02/data/TWiki/VarVBAR.txt

    r695 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1176595550" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarVBAR 
    44 
    55---+++ VBAR -- vertical bar 
    6    * The vertical bar macro can be used in TWiki tables. 
    7    * Type: ShortcutMacro 
     6   * The vertical bar macro can be used in tables. 
    87   * Current value: VBAR = %VBAR% 
    98   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBR][BR]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBULLET][BULLET]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB][BB]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB2][BB2]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB3][BB3]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarBB4][BB4]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarCARET][CARET]] 
  • branches/Release04x02/data/TWiki/VarWEBLIST.txt

    r697 r707  
    33#VarWEBLIST 
    44---+++ WEBLIST{"format"} -- index of all webs 
    5    * List of all webs. Obfusticated webs are excluded, e.g. webs with a =NOSEARCHALL = on= preference setting. The ="format"= defines the format of one web item. The =$name= gets expanded to the name of the web, =$qname= gets expanded to double quoted name, =$marker= to =marker= where web matches =selection=. 
     5   * List of all webs. Obfusticated webs are excluded, e.g. webs with a =NOSEARCHALL = on= [[preference setting]]. The ="format"= defines the format of one web item. The =$name= gets expanded to the name of the web, =$qname= gets expanded to double quoted name, =$marker= to =marker= where web matches =selection=. 
    66   * Syntax: =%<nop>WEBLIST{"format" ...}%= 
    77   * Supported parameters: 
  • branches/Release04x02/data/TWiki/VarWHITE.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarWHITE 
    44---+++ WHITE -- start white colored text 
  • branches/Release04x02/data/TWiki/VarWIKIHOMEURL.txt

    r692 r707  
    55   * Syntax =%<nop>WIKIHOMEURL%= 
    66   * Expands to =%WIKIHOMEURL%= 
    7    * Defined in %SYSTEMWEB%!.DefaultPreferences and normally per default set to =%<nop>SCRIPTURLPATH{"view"}%= 
     7   * Normally by default set to =%<nop>SCRIPTURLPATH{"view"}%= 
    88   * __%X% Note:__ For the top bar logo URL use =%<nop>WIKILOGOURL%= defined in WebPreferences instead. 
    99   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarVarWIKITOOLNAME][WIKITOOLNAME]] 
  • branches/Release04x02/data/TWiki/VarX.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1152044733" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarX 
    44---+++ X -- warning icon 
    5    * Type: ShortcutMacro 
    65   * Current value: X = %X% 
    76   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarH][H]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarI][I]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarM][M]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarN][N]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarP][P]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarQ][Q]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarS][S]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarT][T]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarU][U]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarY][Y]] 
  • branches/Release04x02/data/TWiki/VarY.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1152044733" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences!"}% 
     2%META:TOPICPARENT{name="ShortcutMacros"}% 
    33#VarY 
    44---+++ Y -- "yes" icon 
    5    * Type: ShortcutMacro 
    65   * Current value: Y = %Y% 
    76   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarH][H]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarI][I]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarICON][ICON]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarM][M]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarN][N]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarP][P]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarQ][Q]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarS][S]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarT][T]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarU][U]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarX][X]] 
  • branches/Release04x02/data/TWiki/VarYELLOW.txt

    r692 r707  
    11%META:TOPICINFO{author="ProjectContributor" date="1160971176" format="1.1" version="$Rev$"}% 
    2 %META:TOPICPARENT{name="DefaultPreferences"}% 
     2%META:TOPICPARENT{name="StandardColors"}% 
    33#VarYELLOW 
    44---+++ YELLOW -- start yellow colored text 
  • branches/Release04x02/data/TWiki/WebPreferences.txt

    r697 r707  
    88---++ Web Preferences Settings 
    99 
    10 These settings override the defaults for this web only. See [[%SYSTEMWEB%.DefaultPreferences#DefaultWebPreferences][full list of defaults with explanation]]. 
     10These [[%SYSTEMWEB%.PreferenceSettings][preference settings]] override the defaults for this web and it's subwebs only. 
    1111 
    1212   * Web settings: 
  • branches/Release04x02/data/TWiki/WebPreferencesHelp.txt

    r697 r707  
    1 ---++ Help on Preferences 
    2    * A preference setting is defined by: <br /> =3 or 6 spaces * Set NAME = value= <br /> Example: 
    3       * S<nop>et WEBBGCOLOR = #FFFFC0 
    4    * A preferences setting can be disabled with a # sign. Remove the # sign to enable a local customisation. Example:%BR% 
    5       * #Set DENYWEBCHANGE = %USERSWEB%.UnknownUser 
    6    * Preferences are used as [[%SYSTEMWEB%.Macros][Macros]] by enclosing the name in percent signs. Example: 
    7       * When you write =%WEB<nop>BGCOLOR%= , it gets expanded to =%WEBBGCOLOR%= 
    8    * The sequential order of the preference settings is significant. Define preferences that use other preferences first, i.e. set =<nop>WEBCOPYRIGHT= before =<nop>WIKIWEBMASTER= since =%<nop>WEBCOPYRIGHT%= uses the =%<nop>WIKIWEBMASTER%= setting. 
    9    * You can introduce your own preference settings and use them in your topics and templates. 
     1%INCLUDE{"%SYSTEMWEB%.PreferenceSettings"}% 
     2---++ Tools 
     3%INCLUDE{"%SYSTEMWEB%.RenameWeb"}% 
    104 
    115---++ Related Topics 
    126   * [[%SYSTEMWEB%.%WIKIPREFSTOPIC%]], [[%LOCALSITEPREFS%]] - site-level preferences 
    137   * [[%USERSWEB%.%WIKIUSERSTOPIC%][%WIKIUSERSTOPIC%]] - list of user topics. User topics can have optional user preferences 
    14    * [[%SYSTEMWEB%.Macros][Macros]] - list of common Macros 
     8   * [[%SYSTEMWEB%.Macros][Macros]] - what macros are and how to use them, including a list of common macros 
    159   * [[%SYSTEMWEB%.AccessControl][AccessControl]] - explains how to restrict access by users or groups 
    16  
    17 ---++ Tools 
    18 %INCLUDE{"%SYSTEMWEB%.RenameWeb"}% 
  • branches/Release04x02/data/TWiki/WikiWord.txt

    r610 r707  
    7878      * Numbers are considered lowercase which makes =Year2K= and =Y2K= !WikiWords but not =Y2000= and =Y2k=. 
    7979   * Turn acronyms into !WikiWords, i.e. take =FaqIndex= for a "FAQ index" topic. 
    80    * It is possible to turn off the auto-linking of !WikiWords and to rely only on the bracket notation. See NOAUTOLINK setting in DefaultPreferences!#Default_Web_Preferences. 
     80   * It is possible to turn off the auto-linking of !WikiWords and to rely only on the bracket notation using the NOAUTOLINK [[%SYSTEMWEB%.PreferenceSettings][preference setting]]. 
    8181   * %X% When linking to a <nop>%HOMETOPIC% topic _in another web_, the link will be rendered as the name of the web, e.g. =Sandbox.%HOMETOPIC%= becomes Sandbox.%HOMETOPIC%. 
    8282   * %X% Dots (.) are used as seperators between webs, subwebs, and topics. It is not possible to use dots in topic names. TWiki does not attempt to guess if a dot could be part of a topic name. 
  • branches/Release04x02/data/TestCases/TestCaseAutoFormatting.txt

    r699 r707  
    563563<!-- expected expand --> 
    564564<span class="twikiNewLink">AnchorLink#AnchorName<a href="%SCRIPTURLPATH{"edit"}%/TestCases/AnchorLink?topicparent=TestCases.TestCaseAutoFormatting" rel="nofollow" title="Create this topic">?</a></span> 
    565 <a class="twikiAnchorLink" href="%SCRIPTURLPATH{"view"}%/TWiki/Macros#VarWEBLIST">Macros#VarWEBLIST</a> 
     565<a class="twikiAnchorLink" href="%SCRIPTURLPATH{"view"}%/%SYSTEMWEB%/Macros#VarWEBLIST">Macros#VarWEBLIST</a> 
    566566<!-- /expected --> 
    567567---+++ Actual 
    568568<!-- actual --> 
    569569AnchorLink#AnchorName 
    570 [[TWiki.Macros#VarWEBLIST]] 
     570%SYSTEMWEB%.Macros#VarWEBLIST 
    571571<!-- /actual --> 
    572572 
  • branches/Release04x02/data/TestCases/TestCaseSpacedWikiWordPlugin.txt

    r699 r707  
    3030</verbatim> 
    3131 
    32    * Core spaced out word: %SPACEOUT{"WebHome"}% 
     32   * Core spaced out word: %SPACEOUT{"%SYSTEMWEB%.WebHome"}% 
    3333   * Plugin spaced out: WebHome 
    3434      * Testing if the T and W don't show a gap 
  • branches/Release04x02/data/_default/WebPreferences.txt

    r672 r707  
    2727      * #Set WEBLOGOALT = %WEBLOGOALT% 
    2828 
    29    * List this web in the %SYSTEMWEB%.SiteMap. If you want the web listed, then set SITEMAPLIST to =on=, do not set NOSEARCHALL, and add the "what" and "use to..." description for the site map. Use links that include the name of the web, i.e. <nop>%WEB%.Topic links.%BR% 
    30       __Note:__ Unlike other variables, the setting of SITEMAPLIST is *not* inherited from parent webs. It has to be set in *every* web that is to be listed in the %SYSTEMWEB%.SiteMap %BR% 
     29   * List this web in the [[%SYSTEMWEB%.SiteMap][SiteMap]]. If you want the web listed, then set SITEMAPLIST to =on=, do not set NOSEARCHALL, and add the "what" and "use to..." description for the site map. Use links that include the name of the web, i.e. <nop>%WEB%.Topic links.%BR% 
     30      __Note:__ Unlike other settings, SITEMAPLIST is *not* inherited from parent webs. It has to be set in *every* web that is to be listed in the [[%SYSTEMWEB%.SiteMap][SiteMap]] %BR% 
    3131      * Set SITEMAPLIST = on 
    3232      * Set SITEMAPWHAT =  
  • branches/Release04x02/lib

  • branches/Release04x02/tools

  • branches/Release04x02/twikiplugins

  • branches/Release04x02/twikiplugins/BehaviourContrib/data/TWiki/BehaviourContrib.txt

    r503 r707  
    273273   * Set SHORTDESCRIPTION = =Behaviour= Javascript event library to create javascript based interactions that degrade well when javascript is not available 
    274274 
    275 You can also set the global TWiki variable BEHAVIOURCONTRIB_DEBUG to 1 to make the contrib use uncompressed javascript sources, in the event of problems. 
     275You can also set the global [[%SYSTEMWEB%.PreferenceSettings][preference settings]] BEHAVIOURCONTRIB_DEBUG to 1 to make the contrib use uncompressed javascript sources, in the event of problems. 
    276276 
    277277---++ Contrib Info 
  • branches/Release04x02/twikiplugins/BuildContrib

  • branches/Release04x02/twikiplugins/CommentPlugin/data/TWiki/CommentPlugin.txt

    r691 r707  
    153153</pre> 
    154154 
    155 ---++++ Special variables 
    156 As well as support for all the usual TWiki variables in templates, the following special variables are supported in the =PROMPT= definition: 
    157          | *Variable* | *Description* | 
     155---++++ Special macros 
     156As well as support for all the usual macros in templates, the following special macros are supported in the =PROMPT= definition: 
     157         | *Macro* | *Description* | 
    158158         | =%<nop>DISABLED%= | Set to 'disabled' when you cannot comment (e.g. in preview mode). | 
    159159         | =%<nop>MESSAGE%= | The text specified by =default=. This may be overridden by a helpful message when the prompt is DISABLED. | 
     
    202202 
    203203---+++ The =OUTPUT= template 
    204 The =OUTPUT= template defines the format for the text that actually gets embedded into the topic. All the usual TWiki variables are available in the =PROMPT= definition, but note that they get expanded _when the comment is inserted in the text_, so time, date and username will refer to the time and date when the comment was made, and the user who made it. 
     204The =OUTPUT= template defines the format for the text that actually gets embedded into the topic. All the usual macros are available in the =PROMPT= definition, but note that they get expanded _when the comment is inserted in the text_, so time, date and username will refer to the time and date when the comment was made, and the user who made it. 
    205205 
    206206There are also four position tags that are used to indicate where the comment should be placed, relative to the =location= defined in the =%COMMENT= tag: 
     
    214214         | =%<nop>COMMENTPROMPT%= | Use with a custom form. If present, the comment prompt will be positioned here. | 
    215215          
    216 All the usual [[%SYSTEMWEB%.Macros][Macros]] that can be used in a topic template can also be used in an =OUTPUT= template. See [[%SYSTEMWEB%.Macros][Macros]] for details. 
     216All the [[TemplateTopics#TemplateTopicsVars][usual macros]] that can be used in a topic template can also be used in an =OUTPUT= template. 
    217217 
    218218---++ Settings 
     
    224224                * Set DEFAULT_TYPE = above 
    225225--> 
    226 Two TWiki Preference variables are recognised by the CommentPlugin: 
     226Two [[%SYSTEMWEB%.PreferenceSettings][preference settings]] are recognised by the CommentPlugin: 
    227227| *Preference* | *Default* | *Description* | 
    228228| =%<nop>COMMENTPLUGIN_TEMPLATES%= | =comments= | Name of template file in the 'templates' directory that contains the comment templates. The default 'comments.tmpl' automatically includes user templates from %SYSTEMWEB%.CommentPluginTemplate, which in turn includes %SYSTEMWEB%.UserCommentsTemplate. | 
    229229| =%<nop>COMMENTPLUGIN_DEFAULT_TYPE%= | =above= | Default template type | 
    230 These can be set in !%SYSTEMWEB%.DefaultPreferences, !%USERSWEB%.SitePreferences, in !WebPreferences, or in individual topics. 
     230These can be set in !%USERSWEB%.SitePreferences, in !WebPreferences, or in individual topics. 
    231231 
    232232#Installation 
     
    285285|  Feedback: | TWiki:Plugins/%TOPIC%Dev | 
    286286 
    287 __Related Topics:__ %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences, [[%SYSTEMWEB%.Plugins][Plugins]] 
     287__Related Topics:__ %USERSWEB%.SitePreferences, [[%SYSTEMWEB%.Plugins][Plugins]] 
    288288 
    289289%META:FILEATTACHMENT{name="wikiringlogo20x20.png" attr="h" comment="" version="1"}% 
  • branches/Release04x02/twikiplugins/CommentPlugin/data/TWiki/CommentPluginTemplate.txt

    r657 r707  
    66See [[%SYSTEMWEB%.CommentPlugin#Customisation][CommentPlugin: Customisation]] for help. 
    77 
    8 While this topic can be viewed as a TWiki topic, it is used by the CommentPlugin as a template file. The syntax is the same as used for the templates used for presentation in skins - see SkinTemplates. The important content in here is in the verbatim blocks. The rest of the topic is just comments. 
     8While this topic can be viewed as a topic, it is used by the CommentPlugin as a template file. The syntax is the same as used for the templates used for presentation in skins - see SkinTemplates. The important content in here is in the verbatim blocks. The rest of the topic is just comments. 
    99 
    1010%ICON{"hand"}% See CommentPluginExamples to view rendered templates 
     
    7878 
    7979---++++ bulletabove 
    80 Bullet item added immediately before anchor. The input field width is passed with variable =inputsize=, for example: 
     80Bullet item added immediately before anchor. The input field width is passed with parameter =inputsize=, for example: 
    8181<blockquote><verbatim> 
    8282%COMMENT{type="bulletabove" inputsize="20"}% 
  • branches/Release04x02/twikiplugins/EditTablePlugin/data/TWiki/EditTablePlugin.txt

    r692 r707  
    44Edit TWiki tables in place, using edit fields and drop down boxes, without having to edit the complete topic.  
    55 
    6 Simply add an *[&nbsp;Edit&nbsp;table&nbsp;]* button to an existing table by writing =%<nop>EDITTABLE{}%= directly above the table. This can be added to tables that are formatted with TablePlugin: add the =EDITTABLE= variable just above or below the =TABLE= tag. It can also be used without any =TABLE= tag. 
     6Simply add an *[&nbsp;Edit&nbsp;table&nbsp;]* button to an existing table by writing =%<nop>EDITTABLE{}%= directly above the table. This can be added to tables that are formatted with TablePlugin: add the =EDITTABLE= macro just above or below the =TABLE= tag. It can also be used without any =TABLE= tag. 
    77 
    88Customize entry fields by specifying the format: use a text field, a drop down box, a date field, radio buttons or checkboxes. 
     
    1414---++ Per Table Settings 
    1515 
    16 Add a =%<nop>EDITTABLE{...}%= variable just before an existing table to make it editable, or add the variable anywhere in a topic to start a new table. 
     16Add a =%<nop>EDITTABLE{...}%= macro just before an existing table to make it editable, or add the variable anywhere in a topic to start a new table. 
    1717%INCLUDE{"%SYSTEMWEB%.VarEDITTABLE" section="edittable_attributes"}% 
    1818 
    19 ---+++ Using TWiki Variables in the Format Parameter 
    20  
    21 By default, variables in =&lt;initial value&gt;= (of text input field) and =&lt;label text&gt;= (of fixed label) get expanded when a new row is added. This can be used for example to add a timestamp to a label. You can escape characters with format tokens if you do not want that. 
    22  
    23 Any TWiki variable inside a table cell will be preserved. For instance, =%<nop>TOPIC%= will not get expanded to the current topic name. 
     19---+++ Using Macros in the Format Parameter 
     20 
     21By default, macros in =&lt;initial value&gt;= (of text input field) and =&lt;label text&gt;= (of fixed label) get expanded when a new row is added. This can be used for example to add a timestamp to a label. You can escape characters with format tokens if you do not want that. 
     22 
     23Any macro inside a table cell will be preserved. For instance, =%<nop>TOPIC%= will not get expanded to the current topic name. 
    2424 
    2525The format tokens are the same as with %SYSTEMWEB%.FormattedSearch: 
     
    4343---++ Per Cell Settings 
    4444 
    45 An individual edit field type can be defined for each table cell. Place an =%<nop>EDITCELL{ "type, ..." }%= variable at the end of the cell content. This is useful to override the per column =%<nop>EDITTABLE{ format="..." }%= settings, or to create tables with key/value rows. All edit field types of the =format="..."= parameter are supported. For example, to define a text field, type: =| cell content %<nop>EDITCELL{ "text, 20" }% |= 
     45An individual edit field type can be defined for each table cell. Place an =%<nop>EDITCELL{ "type, ..." }%= macro at the end of the cell content. This is useful to override the per column =%<nop>EDITTABLE{ format="..." }%= settings, or to create tables with key/value rows. All edit field types of the =format="..."= parameter are supported. For example, to define a text field, type: =| cell content %<nop>EDITCELL{ "text, 20" }% |= 
    4646 
    4747It is also possible to place the edit button inside a cell instead of default location below the table. Type =| %<nop>EDITCELL{ "editbutton, 1, Edit this table" }% |= to show a button, or =| %<nop>EDITCELL{ "editbutton, 1, Edit table, Image-URL" }% |= to show a button image with alternate text. 
    4848 
    49 __Note:__ The =%<nop>EDITCELL{ }%=variable cannot be used by itself; place an =%<nop>EDITTABLE{ }%=variable at the beginning of a table where you want to use =%<nop>EDITCELL{ }%= variables. 
     49__Note:__ The =%<nop>EDITCELL{ }%= macro cannot be used by itself; place an =%<nop>EDITTABLE{ }%=variable at the beginning of a table where you want to use =%<nop>EDITCELL{ }%= variables. 
    5050 
    5151---++ Table Buttons 
     
    149149---++ Plugin Settings 
    150150 
    151 Plugin settings are stored as preferences variables. To reference 
     151Plugin settings are stored as [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. To reference 
    152152a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>EDITTABLEPLUGIN_SHORTDESCRIPTION%== 
    153153 
  • branches/Release04x02/twikiplugins/EditTablePlugin/data/TWiki/VarEDITTABLE.txt

    r691 r707  
    33#VarEDITTABLE 
    44---+++ EDITTABLE{ _attributes_ } -- edit TWiki tables using edit fields and other input fields 
    5    * The =%<nop>EDITTABLE{}%= variable is handled by the EditTablePlugin 
     5   * The =%<nop>EDITTABLE{}%= macro is handled by the EditTablePlugin 
    66   * Syntax: =%<nop>EDITTABLE{ _attributes_ }%= 
    77%STARTSECTION{"edittable_attributes"}% 
     
    1313     | =quietsave= | Quiet Save button is shown if ="on"=, hidden if ="off"= | =QUIETSAVE= %BR% plugin setting | 
    1414     | =include= | Other topic defining the EDITTABLE parameters. The first %<nop>EDITTABLE% in the topic is used. This is useful if you have many topics with the same table format and you want to update the format in one place. | (none) | 
    15      | =helptopic= | Topic name containing help text shown below the table when editing a table. The %<nop>STARTINCLUDE% and %<nop>STOPINCLUDE% variables can be used in the topic to specify what is shown. | (no help text) | 
     15     | =helptopic= | Topic name containing help text shown below the table when editing a table. The %<nop>STARTINCLUDE% and %<nop>STOPINCLUDE% macros can be used in the topic to specify what is shown. | (no help text) | 
    1616     | =headerislabel= | Table header cells are read-only (labels) if ="on"=; header cells can be edited if ="off"= or "0" | ="on"= | 
    1717     | =editbutton= | Set edit button text, e.g. ="Edit this table"=; set button image with alt text, e.g. ="Edit table, %<nop>PUBURL%/%<nop>SYSTEMWEB%/DocumentGraphics/edittopic.gif"=; hide edit button at the end of the table with ="hide"= (Note: Button is automatically hidden if an edit button is present in a cell) | =EDITBUTTON= %BR% plugin setting | 
  • branches/Release04x02/twikiplugins/EmptyPlugin/data/TWiki/EmptyPlugin.txt

    r528 r707  
    1616---++ Plugin Settings 
    1717 
    18 Plugin settings are stored as preferences variables. To reference 
     18Plugin settings are stored as [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. To reference 
    1919a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>EMPTYPLUGIN_SHORTDESCRIPTION%== 
    2020 
  • branches/Release04x02/twikiplugins/InterwikiPlugin/data/TWiki/InterWikis.txt

    r528 r707  
    1111        * Each entry must be of format: <br /> ==| External site alias | URL | Tooltip help text |==. 
    1212        * The Alias must start with an upper case letter and may contain alphanumeric letters. 
    13         * The URL and Tooltip Text may contain optional ==$page== variables; the variable gets expanded to the page name. 
     13        * The URL and Tooltip Text may contain optional ==$page== formatting tokens; the token gets expanded to the page name. 
    1414        * __Note:__ The Tooltip Text must not contain any HTML tags (including ==&lt;nop&gt;== escape code), no internal %SYSTEMWEB%.WikiWord links, and no external links. Hint: Escape =='WikiWords'== and =='$page'==. 
    1515 
  • branches/Release04x02/twikiplugins/InterwikiPlugin/data/TWiki/InterwikiPlugin.txt

    r528 r707  
    1414   * Each entry must be of format: <br /> ==| External site alias | URL | Tooltip help text |==. 
    1515   * Site aliases must start with an upper case letter and may contain alphanumeric letters. 
    16    * The URL and Tooltip Text may contain optional ==$page== variables; the variable gets expanded to the page name. 
     16   * The URL and Tooltip Text may contain optional ==$page== fromatting tokens; the token gets expanded to the page name. 
    1717   * %H% For TWiki sites, both the *web* and the *topic* have to be specified: ==<nop>TWikisite:Webname/<nop>SomePage== 
    1818      * TWiki:Plugins/InterwikiPlugin or TWiki:Plugins.InterwikiPlugin 
     
    2020---++ <nop>%TOPIC% Settings 
    2121 
    22 Plugin settings are stored as Preferences variables. To reference 
     22Plugin settings are stored as [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. To reference 
    2323a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%== 
    2424 
     
    2929      * Set RULESTOPIC =  
    3030 
    31    * Inter-link format, with variables: 
     31   * Inter-link format, with formatting tokens: 
     32     | *Token* | *Meaning* | 
    3233     | $site | Site alias | 
    3334     | $page | Page (part after colon) | 
     
    8485|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal | 
    8586 
    86 __Related Topics:__ [[%SYSTEMWEB%.Plugins][Plugins]], %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences, %SYSTEMWEB%.InterWikis 
     87__Related Topics:__ [[%SYSTEMWEB%.Plugins][Plugins]], %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %USERSWEB%.SitePreferences, %SYSTEMWEB%.InterWikis 
    8788 
    8889-- TWiki:Main.PeterThoeny - 25 Nov 2007 
  • branches/Release04x02/twikiplugins/JSCalendarContrib/data/TWiki/JSCalendarContrib.txt

    r605 r707  
    7676|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal | 
    7777 
    78 __Related Topics:__ %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences 
     78__Related Topics:__ %USERSWEB%.SitePreferences 
    7979 
    8080%META:FILEATTACHMENT{name="screenshot.gif" attr="h" comment="" version="1"}% 
  • branches/Release04x02/twikiplugins/PatternSkin/data/TWiki/PatternSkin.txt

    r546 r707  
    5555---+++ Troubleshooting 
    5656 
    57 If you have set the SKIN variable setting to =pattern= and you still don't see the layout as on the <a href="%ATTACHURL%/patternskin_screenshot_full.png">screenshot</a>, a few settings in may have been disabled. 
     57If you have set the SKIN [[preference setting]] to =pattern= and you still don't see the layout as on the <a href="%ATTACHURL%/patternskin_screenshot_full.png">screenshot</a>, a few settings in may have been disabled. 
    5858 
    59 Check these variables here: 
     59Check these [[%SYSTEMWEB%.PreferenceSettings][preference settings]] here: 
    6060   * TWIKILAYOUTURL = %TWIKILAYOUTURL% 
    6161   * TWIKISTYLEURL = %TWIKISTYLEURL% 
     
    6363   * SKIN = %SKIN% 
    6464 
    65 If TWIKILAYOUTURL or TWIKISTYLEURL don't give a value or point to non-existing files, check in %SYSTEMWEB%.DefaultPreferences and in %USERSWEB%.SitePreferences that the following variables do exist and that they are set to on: 
     65If TWIKILAYOUTURL or TWIKISTYLEURL don't give a value or point to non-existing files, check in %SYSTEMWEB%.DefaultPreferences and in %USERSWEB%.SitePreferences that the following preferences do exist and that they are set to on: 
    6666<pre> 
    6767   * %<nop>SYSTEMWEB%.PatternSkin settings: 
  • branches/Release04x02/twikiplugins/PatternSkin/data/TWiki/PatternSkinColorSettings.txt

    r505 r707  
    1212 
    1313---+++!! Step 2 
    14 Edit this topic, and change the color variables as you like. 
     14Edit this topic, and change the color [[%SYSTEMWEB%.PreferenceSettings][preference settings]] as you like. 
    1515 
    1616---+++!! Step 3 
     
    2121%ICON{"info"}% For more help on customizing styles, see [[PatternSkinCustomization]]. 
    2222 
    23 ---++!! Color variables 
     23---++!! Color preference settings 
    2424%TOC% 
    2525 
     
    183183   * Set FORM_HEADER_TEXT = #036 
    184184 
    185 <!-- END OF COLOR VARIABLES --> 
     185<!-- END OF COLOR PREFERENCES --> 
    186186 
    187187Do not change the text below this line unless you know what you are doing! 
  • branches/Release04x02/twikiplugins/PatternSkin/data/TWiki/PatternSkinCssCookbook.txt

    r503 r707  
    2222   * Create a new topic that will contain your new CSS files 
    2323   * Attach 3 new style sheets to the topic 
    24    * Point the CSS variables in [[%SYSTEMWEB%.DefaultPreferences]] or [[%USERSWEB%.SitePreferences]] to your new files: 
     24   * Point the CSS [[%SYSTEMWEB%.PreferenceSettings][preference settings]] in [[%SYSTEMWEB%.DefaultPreferences]] or [[%USERSWEB%.SitePreferences]] to your new files: 
    2525<pre> 
    2626      * <nop>Set TWIKILAYOUTURL = %<nop>PUBURLPATH%/%<nop>SYSTEMWEB%/YourNewTopic/layout.css 
     
    3131---+++ When you need to make small adjustments: Adding to existing CSS 
    3232With CSS you cannot remove already defined classes, you can only add to it, or overwrite existing styles. <br /> 
    33 Overriding default CSS is done with 3 variables: =USERLAYOUTURL=, =USERSTYLEURL=, =USERCOLORSURL=. 
     33Overriding default CSS is done with 3 [[%SYSTEMWEB%.PreferenceSettings][preference settings]]: =USERLAYOUTURL=, =USERSTYLEURL=, =USERCOLORSURL=. 
    3434   * Create a new topic that will contain your new CSS files 
    3535   * Attach 1, 2 or 3 new style sheets to the topic, dependent on your CSS setup (if you don't change much, you might as well put everything in one CSS file, layout, margins and colors) 
    36    * Point the CSS variables in [[%SYSTEMWEB%.DefaultPreferences]] or [[%USERSWEB%.SitePreferences]] to your new files (below the =TWIKIXXXURL= variables): 
     36   * Point the CSS [[%SYSTEMWEB%.PreferenceSettings][preference settings]] in [[%SYSTEMWEB%.DefaultPreferences]] or [[%USERSWEB%.SitePreferences]] to your new files (below the =TWIKIXXXURL= preferences): 
    3737<pre> 
    3838      * <nop>Set USERLAYOUTURL = %<nop>PUBURLPATH%/%<nop>SYSTEMWEB%/YourNewTopic/layout.css 
     
    4545 </pre> 
    4646 
    47 Instead of setting these variables in [[%SYSTEMWEB%.DefaultPreferences]] or [[%USERSWEB%.SitePreferences]], you can set these in your home topic, or in any other topic. Setting style URL variables in: 
     47Instead of setting these preferences in [[%SYSTEMWEB%.DefaultPreferences]] or [[%USERSWEB%.SitePreferences]], you can set these in your home topic, or in any other topic. Setting style URL preferences in: 
    4848   * [[%SYSTEMWEB%.DefaultPreferences]] or [[%USERSWEB%.SitePreferences]]: the style is visible for all users, site-wide 
    4949   * WebPreferences: the style is visible for all users in one web 
  • branches/Release04x02/twikiplugins/PatternSkin/data/TWiki/PatternSkinCssCookbookCenterPageBorder.txt

    r503 r707  
    1313</div> 
    1414 
    15 Add the dynamic variable link to the logo image to the topic text: 
     15Add the dynamic link to the logo image to the topic text: 
    1616<verbatim> 
    1717<style type="text/css" media="all"> 
  • branches/Release04x02/twikiplugins/PatternSkin/data/TWiki/PatternSkinCssCookbookNoTopBar.txt

    r503 r707  
    1313</div> 
    1414 
    15 Add the dynamic variable link to the logo image to the topic text: 
     15Add the dynamic link to the logo image to the topic text: 
    1616<verbatim> 
    1717<style type="text/css" media="all"> 
  • branches/Release04x02/twikiplugins/PatternSkin/data/TWiki/PatternSkinCustomization.txt

    r671 r707  
    9797 
    9898By default the logo at the top left of each web points to the image with name =logo.gif= that is attached to each web's WebPreferences. <br /> 
    99 The default variables that cause this behavior are defined in [[%WIKIPREFSTOPIC%]]. 
    100  
    101 Redefine your custom variables in [[%LOCALSITEPREFS%]] (to keep %WIKIPREFSTOPIC% intact): 
     99The [[%SYSTEMWEB%.PreferenceSettings][preference settings]] that cause this behavior are defined in [[%WIKIPREFSTOPIC%]]. 
     100 
     101Redefine your custom [[%SYSTEMWEB%.PreferenceSettings][preference settings]] in [[%LOCALSITEPREFS%]] (to keep %WIKIPREFSTOPIC% intact): 
    102102<blockquote><pre> 
    103103   * Set <nop>WEBLOGONAME = logo.gif 
     
    113113   * Create a new image named =logo.gif= and attach it to the web's WebPreferences topic. %TWIKIWEB%.PatternSkin's stylesheet assumes the logo is 40px high. More about that later. 
    114114   * You can also upload the image with FTP to =/pub/YourWeb/WebPreferences/=. 
    115    * Copy the above instructions ("Redefine your custom variables") and insert your logo name. 
     115   * Copy the above instructions ("Redefine your custom preference settings") and insert your logo name. 
    116116</blockquote> 
    117117*Using a new filename:* 
     
    121121      * Set <nop>WEBLOGONAME = your-logo-name.gif-or-png 
    122122</pre> 
    123    * Copy the above instructions ("Redefine your custom variables") and insert your logo name. 
     123   * Copy the above instructions ("Redefine your custom preference settings") and insert your logo name. 
    124124</blockquote> 
    125125 
    126126---+++ How do I set a site-wide logo? 
    127127 
    128 There is a bunch of site-wide logo variables in [[%LOCALSITEPREFS%]]: =WIKILOGOIMG=, =WIKILOGOURL= and =WIKILOGOALT=. 
     128There are a bunch of site-wide logo [[%SYSTEMWEB%.PreferenceSettings][preference settings]] in [[%LOCALSITEPREFS%]]: =WIKILOGOIMG=, =WIKILOGOURL= and =WIKILOGOALT=. 
    129129To change only the web logo image to site-wide, in [[%LOCALSITEPREFS%]] set: 
    130130<blockquote><pre> 
     
    164164</blockquote> 
    165165 
    166 See also: [[TWiki.VarSEARCH][Search variable]] 
     166See also: [[TWiki.VarSEARCH][Search macro]] 
    167167 
    168168#TopBarChangeHeight 
     
    197197---+++ I want to set or change the top background image 
    198198 
    199 The image at the top is called "header art" - commonly the top image found on blog sites. The image that is displayed by default is set by the variable =WEBHEADERART=, defined in [[%WIKIPREFSTOPIC%]]. 
    200  
    201 Redefine your custom variables in [[%LOCALSITEPREFS%]] (to keep %WIKIPREFSTOPIC% intact): 
     199The image at the top is called "header art" - commonly the top image found on blog sites. The image that is displayed by default is set by the preference =WEBHEADERART=, defined in [[%WIKIPREFSTOPIC%]]. 
     200 
     201Redefine your custom [[%SYSTEMWEB%.PreferenceSettings][preference settings]] in [[%LOCALSITEPREFS%]] (to keep %WIKIPREFSTOPIC% intact): 
    202202<blockquote><pre> 
    203203   * <nop>Set WEBHEADERART = %<nop>PUBURLPATH%/%<nop>TWIKIWEB%/PatternSkin/TWiki_header.gif 
     
    205205</pre></blockquote> 
    206206 
    207 You can also set =WEBHEADERART= per web, by defining the variable in the Web's !WebPreferences. 
     207You can also set =WEBHEADERART= per web, by setting the preference in the Web's !WebPreferences. 
    208208 
    209209---+++ I want to have the web color in the top bar 
     
    356356</verbatim></blockquote> 
    357357 
    358 View any topic with =?skin=myskin,pattern=, or set the =SKIN= variable to =myskin,pattern=. 
     358View any topic with =?skin=myskin,pattern=, or set the =SKIN= preference to =myskin,pattern=. 
    359359 
    360360This will remove the Edit and Attach buttons, and place a History button at the top. 
  • branches/Release04x02/twikiplugins/PreferencesPlugin/data/TWiki/DefaultPreferencesForm.txt

    r671 r707  
    2929| BROADCASTMESSAGE | textarea| |  | Broadcast message on every page, for skins that support it. | S | 
    3030| SEARCHDEFAULTTTYPE | select | 1 | keyword,literal,regex | Default type for search | S | 
    31 | SEARCHVARDEFAULTTYPE | select | 1 | keyword,literal,regex | Default for =%<nop>SEARCH{}%= variable | S | 
     31| SEARCHVARDEFAULTTYPE | select | 1 | keyword,literal,regex | Default for =%<nop>SEARCH{}%= macro | S | 
    3232| SEARCHSTOPWORDS | textarea | | a, all, am, an, and, any, as, at, b, be, by, c, d, e, for, from, g, h, how, i, i'm, i.e., in, is, isn't, it, it's, its, j, k, l, m, n, o, of, on, or, p, q, r, s, t, that, that's, the, this, to, u, v, w, was, wasn't, what, what's, when, where, who, who's, will, with, x, y, z | Stop words, e.g., common words and characters to exclude from a keyword search | S | 
    3333| WIKIWEBMASTER | text | 30 | webmaster@example.com | Wiki administrator e-mail address | S | 
  • branches/Release04x02/twikiplugins/PreferencesPlugin/data/TWiki/PreferencesPlugin.txt

    r605 r707  
    66%TOC% 
    77 
    8 Insert the =%<nop>EDITPREFERENCES%= variable (see below) anywhere in your topic. It will be replaced by a button that allows editing each preference in its predefined input format (or a text box, when no format is defined for this preference). 
     8Insert the =%<nop>EDITPREFERENCES%= preference (see below) anywhere in your topic. It will be replaced by a button that allows editing each preference in its predefined input format (or a text box, when no format is defined for this preference). 
    99 
    1010In edit mode, the edit button is replaced by Save and Cancel buttons, with their obvious meanings. 
     
    1414        * =%<nop>EDITPREFERENCES{ "= _topic_ =" }%= 
    1515                * _topic_ references a [[%SYSTEMWEB%.DataForms][DataForm]] defining the format of the edit fields for preferences. It may be prefixed by a web. 
    16                 * If a preference setting is not mentioned in the form referenced by _topic_, a text input box of the specified length is provided. 
     16                * If a [[preference setting]] is not mentioned in the form referenced by _topic_, a text input box of the specified length is provided. 
    1717                * Otherwise, the input can be through textareas, select, radio, checkbox, date, or text, as provided by %SYSTEMWEB%.DataForms. 
    1818   * =%<nop>EDITPREFERENCES%= 
  • branches/Release04x02/twikiplugins/RenderListPlugin/data/TWiki/RenderListPlugin.txt

    r692 r707  
    66---++ Syntax Rules 
    77 
    8 ---+++ RENDERLIST Variable 
     8---+++ RENDERLIST Macro 
    99 
    1010   * Place a =%<nop>RENDERLIST{ &lt;parameters&gt; }%= before any bullet list 
     
    322322---++ <nop>%TOPIC% Settings 
    323323 
    324 Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>RENDERPLUGIN_SHORTDESCRIPTION%== 
     324Plugin settings are stored as [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>RENDERPLUGIN_SHORTDESCRIPTION%== 
    325325 
    326326   * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic: 
  • branches/Release04x02/twikiplugins/RenderListPlugin/data/TWiki/VarRENDERLIST.txt

    r691 r707  
    33#VarRENDERLIST 
    44---+++ RENDERLIST -- render bullet lists in a variety of formats 
    5    * The =%<nop>RENDERLIST%= variable is handled by the RenderListPlugin 
     5   * The =%<nop>RENDERLIST%= macro is handled by the RenderListPlugin 
    66   * Syntax: =%<nop>RENDERLIST%= 
    77   * Syntax: =%<nop>RENDERLIST{ "org" focus="Sales.WestCoastTeam" }%= 
  • branches/Release04x02/twikiplugins/SlideShowPlugin/data/TWiki/SlideShowPlugin.txt

    r692 r707  
    8383---++ <nop>%TOPIC% Global Settings 
    8484 
    85 Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>SLIDESHOWPLUGIN_SHORTDESCRIPTION%== 
     85Plugin settings are stored as [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>SLIDESHOWPLUGIN_SHORTDESCRIPTION%== 
    8686 
    8787   * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic: 
  • branches/Release04x02/twikiplugins/SlideShowPlugin/data/TWiki/VarSLIDESHOWEND.txt

    r691 r707  
    33#VarSLIDESHOWEND 
    44---+++ SLIDESHOWEND -- end slideshow 
    5    * The =%<nop>SLIDESHOWEND%= variable is handled by the SlideShowPlugin 
     5   * The =%<nop>SLIDESHOWEND%= macro is handled by the SlideShowPlugin 
    66   * Syntax: =%<nop>SLIDESHOWEND%= 
    77   * Example: See SLIDESHOWSTART 
  • branches/Release04x02/twikiplugins/SlideShowPlugin/data/TWiki/VarSLIDESHOWSTART.txt

    r691 r707  
    33#VarSLIDESHOWSTART 
    44---+++ SLIDESHOWSTART -- convert a topic with headings into a slideshow 
    5    * The =%<nop>SLIDESHOWSTART%= variable is handled by the SlideShowPlugin 
     5   * The =%<nop>SLIDESHOWSTART%= macro is handled by the SlideShowPlugin 
    66   * Syntax: =%<nop>SLIDESHOWSTART%= 
    77   * Syntax: =%<nop>SLIDESHOWSTART{ template="MyOwnSlideTemplate" }%= 
  • branches/Release04x02/twikiplugins/SmiliesPlugin/data/TWiki/SmiliesPlugin.txt

    r528 r707  
    3838---++ <nop>%TOPIC% Global Settings 
    3939 
    40 Plugin settings are stored as preferences variables. To reference 
     40Plugin settings are stored as [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. To reference 
    4141a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%== 
    4242 
  • branches/Release04x02/twikiplugins/SpreadSheetPlugin/data/TWiki/SpreadSheetPlugin.txt

    r692 r707  
    3333---++ Syntax Rules 
    3434 
    35 The action of this Plugin is triggered by the ==%<nop>CALC{"..."}%== variable, which gets rendered according to the built-in function(s) found between the quotes. 
     35The action of this Plugin is triggered by the ==%<nop>CALC{"..."}%== macro, which gets rendered according to the built-in function(s) found between the quotes. 
    3636 
    3737        * Built-in function are of format ==$FUNCNAME(parameter)== 
     
    204204#FuncFORMATTIME 
    205205---+++ FORMATTIME( serial, text ) -- convert a serialized date into a date string 
    206         * The following variables in =text= are expanded: =$second= (seconds, 00..59); =$minute= (minutes, 00..59); =$hour= (hours, 00..23); =$day= (day of month, 01..31); =$month= (month, 01..12); =$mon= (month in text format, Jan..Dec); =$year= (4 digit year, 1999); =$ye= (2 digit year, 99), =$wd= (day number of the week, 1 for Sunday, 2 for Monday, etc), =$wday= (day of the week, Sun..Sat), =$weekday= (day of the week, Sunday..Saturday), =$yearday= (day of the year, 1..365, or 1..366 in leap years). Date is assumed to be server time; add =GMT= to indicate Greenwich time zone. 
     206        * The following formatting tokens in =text= are expanded: =$second= (seconds, 00..59); =$minute= (minutes, 00..59); =$hour= (hours, 00..23); =$day= (day of month, 01..31); =$month= (month, 01..12); =$mon= (month in text format, Jan..Dec); =$year= (4 digit year, 1999); =$ye= (2 digit year, 99), =$wd= (day number of the week, 1 for Sunday, 2 for Monday, etc), =$wday= (day of the week, Sun..Sat), =$weekday= (day of the week, Sunday..Saturday), =$yearday= (day of the year, 1..365, or 1..366 in leap years). Date is assumed to be server time; add =GMT= to indicate Greenwich time zone. 
    207207        * Syntax: ==$FORMATTIME( serial, text )== 
    208208        * Example: ==%<nop>CALC{"$FORMATTIME(0, $year/$month/$day GMT)"}%== returns ==1970/01/01 GMT== 
     
    682682---++ Plugin Settings 
    683683 
    684 Plugin settings are stored as preferences variables. To reference 
     684Plugin settings are stored as [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. To reference 
    685685a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>SPREADSHEETPLUGIN_SHORTDESCRIPTION%== 
    686686 
     
    695695 
    696696<noautolink> 
    697         * [[%SYSTEMWEB%.WikiWord][WikiWords]] to exclude from being spaced out by the ==$PROPERSPACE(text)== function. This comma delimited list can be overloaded by a DONTSPACE preferences variable: 
     697        * [[%SYSTEMWEB%.WikiWord][WikiWords]] to exclude from being spaced out by the ==$PROPERSPACE(text)== function. This comma delimited list can be overloaded by a DONTSPACE [[%SYSTEMWEB%.PreferenceSettings][preference setting]]: 
    698698                * Set DONTSPACE = CodeWarrior, MacDonald, McIntosh, RedHat, SuSE 
    699699</noautolink> 
  • branches/Release04x02/twikiplugins/SpreadSheetPlugin/data/TWiki/VarCALC.txt

    r691 r707  
    33#VarCALC 
    44---+++ CALC{"formula"} -- add spreadsheet calculations to tables and outside tables 
    5         * The =%<nop>CALC{"formula"}%= variable is handled by the SpreadSheetPlugin. There are around 80 formulae, such as =$ABS()=, =$EXACT()=, =$EXISTS()=, =$GET()/$SET()=, =$IF()=, =$LOG()=, =$LOWER()=, =$PERCENTILE()=, =$TIME()=, =$VALUE()=. 
     5        * The =%<nop>CALC{"formula"}%= macro is handled by the SpreadSheetPlugin. There are around 80 formulae, such as =$ABS()=, =$EXACT()=, =$EXISTS()=, =$GET()/$SET()=, =$IF()=, =$LOG()=, =$LOWER()=, =$PERCENTILE()=, =$TIME()=, =$VALUE()=. 
    66        * Syntax: =%<nop>CALC{"formula"}%= 
    77        * Examples: 
  • branches/Release04x02/twikiplugins/TablePlugin/data/TWiki/TablePlugin.txt

    r692 r707  
    99        * Table attributes can be set and overridden in this order: 
    1010                * Default =TABLEATTRIBUTES= Plugin setting in this topic. 
    11                 * A =TABLEATTRIBUTES= preferences setting on site-level (%SYSTEMWEB%.DefaultPreferences or %USERSWEB%.SitePreferences) or web-level (any WebPreferences), e.g. 
     11                * A =TABLEATTRIBUTES= preferences setting on site-level (%USERSWEB%.SitePreferences) or web-level (any WebPreferences), e.g. 
    1212                        * =Set TABLEATTRIBUTES = tableborder="0" cellpadding="1" ...= 
    1313                * Before a table using =%<nop>TABLE{...}%= 
     
    4141---++ <nop>%TOPIC% Global Settings 
    4242 
    43 Plugin settings are stored as preferences variables. To reference 
     43Plugin settings are stored as [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. To reference 
    4444a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, for example, ==%<nop>INTERWIKIPLUGIN_SHORTDESCRIPTION%== 
    4545 
     
    175175|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal | 
    176176 
    177 __Related Topics:__ %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences, [[%SYSTEMWEB%.Plugins][Plugins]], %SYSTEMWEB%.StandardColors 
     177__Related Topics:__ %USERSWEB%.SitePreferences, [[%SYSTEMWEB%.Plugins][Plugins]], %SYSTEMWEB%.StandardColors 
  • branches/Release04x02/twikiplugins/TablePlugin/data/TWiki/VarTABLE.txt

    r691 r707  
    33#VarTABLE 
    44---+++ TABLE{ _attributes_ } -- control attributes of tables and sorting of table columns 
    5    * The =%<nop>TABLE{}%= variable is handled by the TablePlugin 
     5   * The =%<nop>TABLE{}%= macro is handled by the TablePlugin 
    66   * Syntax: =%<nop>TABLE{ _attributes_ }%= 
    77%STARTSECTION{"table_attributes"}% 
  • branches/Release04x02/twikiplugins/TestFixturePlugin/data/TWiki/TestFixturePlugin.txt

    r528 r707  
    3030 
    3131=expected= has a number of options that are specified by words after =expected= in the tag - for example, <code>&lt;!-- expected again expand rex --&gt;</code> 
    32 | =expand= | Enables expansion of %variables% ( =TWiki::Func::expandCommonVariables= ). Normally you should _not_ use the expand option. It is intended primarily for expanding TWiki variables in URL components, and is used when testing generated HTML which is specific to the installation. It should be used with extreme caution as it assumes that TWiki doesn't do anything naughty during this expansion. | 
     32| =expand= | Enables expansion of macros ( =TWiki::Func::expandCommonVariables= ). Normally you should _not_ use the expand option. It is intended primarily for expanding macros in URL components, and is used when testing generated HTML which is specific to the installation. It should be used with extreme caution as it assumes that TWiki doesn't do anything naughty during this expansion. | 
    3333| =rex= | If there is text which you know can never be literally matched - for example, a generated time - you can enter a regular expression to match it instead, if the =rex= option is enabled. For example an RE for a time is entered this way: =@REX(\d\d:\d\d)=. Be very careful about using greedy matches. A number of preprogrammed REs, _viz_. =@DATE=, =@TIME= and =@WIKINAME=, are also provided to simplify expected code. | 
    3434| =again= | If you have two tests with the same expected text one after the other, you can re-use the expected text from the previous test using this option. The expected text will then be set to the text expected for the previous test. Remember you may need to repeat the =expand= and =rex= options again as well. | 
  • branches/Release04x02/twikiplugins/TinyMCEPlugin/data/TWiki/TinyMCEPlugin.txt

    r657 r707  
    1515Unlike the other editor integrations in TWiki, which install "Word in a Browser" style editors, this plugin is able to swap out the _standard_ text areas in an edit and replace them with WYSIWYG editors. This means you get WYSIWYG editors for textareas in forms, as well as for the main text of the topic. It can also co-exist alongside other WYSIWYG editors, such as Kupu. 
    1616 
    17 The editor automatically "switches itself off" (i.e. reverts to the old text-only window) when editing topics that contain TWiki content it can't handle, such as complex TWiki variables. 
     17The editor automatically "switches itself off" (i.e. reverts to the old text-only window) when editing topics that contain TWiki content it can't handle, such as complex macros. 
    1818 
    1919---++ Editor Notes 
    20 The editor uses a translator module to convert from TWiki markup language (TML) to HTML and back. The translator converts special TWiki tags - such as %<nop>VARIABLES% - to plain text, and encloses them within HTML spans using a special style called =WYSIWYG_PROTECTED=. In this way the editor can detect text that is not meant to be HTML formatted. This style is _also_ used to protect special text you enter into the editor from being interpreted when the topic is translated back into TML. If you want to add any special TWiki features that are sensitive to formatting, such as =Set= statements, then you have to format those regions using 'Protect on save' or 'Protect forever'. 
     20The editor uses a translator module to convert from TWiki markup language (TML) to HTML and back. The translator converts special macros - such as %<nop>MACROS% - to plain text, and encloses them within HTML spans using a special style called =WYSIWYG_PROTECTED=. In this way the editor can detect text that is not meant to be HTML formatted. This style is _also_ used to protect special text you enter into the editor from being interpreted when the topic is translated back into TML. If you want to add any special features that are sensitive to formatting, such as =Set= statements, then you have to format those regions using 'Protect on save' or 'Protect forever'. 
    2121 
    2222---++ Installation Instructions 
     
    9898      * Set INIT_SAFARI =  
    9999 
    100 You can override these settings in the same way as any other TWiki variable, by setting e.g. =TINYMCEPLUGIN_INIT= in the site, web or topic preferences. You are *not* recommended to edit the setting here. 
     100You can override these settings in the same way as any other [[%SYSTEMWEB%.PreferenceSettings][preference settings]], by setting e.g. =TINYMCEPLUGIN_INIT= in the site, web or topic preferences. You are *not* recommended to edit the setting here. 
    101101 
    102    * You can *disable* the plugin in any web or topic, or for any specific user, by setting the =TINYMCEPLUGIN_DISABLE= variable to 1. 
     102   * You can *disable* the plugin in any web or topic, or for any specific user, by setting the =TINYMCEPLUGIN_DISABLE= preference to 1. 
    103103   * Some browsers don't support !TinyMCE. You can prevent the editor from 
    104104     being invoked on these browsers by setting =TINYMCEPLUGIN_BAD_BROWSERS= to a regular expression that matches the user-agent string for any broken browsers. The default is =(?i-xsm:Konqueror|Opera)=.    
  • branches/Release04x02/twikiplugins/TinyMCEPlugin/data/TWiki/TinyMCEQuickHelp.txt

    r692 r707  
    1616    <li> ==Normal== - Normal text style </li> 
    1717    <li> ==Heading 1-6== - Headings; 1 is largest </li> 
    18     <li> ==VERBATIM== - Text is shown in monospace with line breaks. Wraps &lt;verbatim&gt; tags around the selected text. No TWiki variables are interpreted inside verbatim tags. </li> 
     18    <li> ==VERBATIM== - Text is shown in monospace with line breaks. Wraps &lt;verbatim&gt; tags around the selected text. No macros are interpreted inside verbatim tags. </li> 
    1919    <li> ==LITERAL== - Styled content is saved exactly as it appears in the editor. Saves the selected content as raw HTML and wraps it in &lt;literal> tags. </li> 
    20     <li> ==Protect on save== - Prevent any change to the selected text when the edit is saved. Use this to save advanced TWiki variables where you do not want the Wysiwyg editor to modify the text during save. </li> 
     20    <li> ==Protect on save== - Prevent any change to the selected text when the edit is saved. Use this to save advanced macros where you do not want the Wysiwyg editor to modify the text during save. </li> 
    2121    <li> ==Protect forever== - Content is saved exactly as it is typed, and the protection is still there in future edit sessions. Content is wrapped in &lt;sticky&gt; tags. </li> 
    2222   </ul> 
    2323</td> 
    2424<td rowspan="4" class="secondaryTextcolumn"> 
    25 *Setting a TWiki variable* 
     25*Defining Preference Settings/Macros* 
    2626<ol> 
    2727 <li> Create a list item using the toolbar button</li> 
     
    3030 </li> 
    3131</ol> 
    32 *Using a TWiki Variable* 
     32*Using a Macro* 
    3333<ul> 
    3434<li> Just type it in. When the topic is saved, what you type will be saved just as you wrote it.  </li> 
    35 <li> If any part of your variable parameters is sensitive to spacing, then select the entire TWiki variable and assign the ==PROTECTED== style to it before you save. </li></ul> 
    36 <span class="twikiUnvisited">[[%SYSTEMWEB%.Macros][More on preferences (Macros)]]</span> 
     35<li> If any part of your macro parameters is sensitive to spacing, then select the entire macro and assign the ==PROTECTED== style to it before you save. </li></ul> 
     36<span class="twikiUnvisited">[[%SYSTEMWEB%.Macros][More on macros]]</span> 
    3737 
    3838*Editing the raw text instead of Wysiwyg* 
  • branches/Release04x02/twikiplugins/TipsContrib/data/TWiki/TWikiTip006.txt

    r692 r707  
    33---+ Creating a Table of Contents 
    44 
    5 The [[%SYSTEMWEB%.Macros][Macro]] =%<nop>TOC%= will automatically create a table of contents for a topic based on the headers of the topic. To exclude a heading from a =%<nop>TOC%= add =!!= to the end of the syntax for a header, e.g. write =---+!!= for a =---+= heading. 
     5=%<nop>TOC%= will automatically create a table of contents for a topic based on the headers of the topic. To exclude a heading from a =%<nop>TOC%= add =!!= to the end of the syntax for a header, e.g. write =---+!!= for a =---+= heading. 
    66 
    77[[TWikiTipsOfTheDay][See More Tips...]] 
  • branches/Release04x02/twikiplugins/TipsContrib/data/TWiki/TWikiTip007.txt

    r692 r707  
    33---+ Linking to a file attachment 
    44 
    5 One can create a link to a file attachment using one of the following [[%SYSTEMWEB%.Macros][Macros]], =%<nop>ATTACHURL%= or =%<nop>PUBURL%=. 
     5One can create a link to a file attachment using one of the =%<nop>ATTACHURL%= or =%<nop>PUBURL%= macros. 
    66 
    77=%<nop>ATTACHURL%= is the full URL for attachments in the current topic. For example: 
     
    99=%<nop>ATTACHURL%/image.gif= 
    1010 
    11 To link to a file attachment in another topic, use the =%<nop>PUBURL%= variable.  For example: 
     11To link to a file attachment in another topic, use the =%<nop>PUBURL%= macro.  For example: 
    1212 
    1313=%<nop>PUBURL%/%<nop>WEB%/OtherTopic/image.gif= 
  • branches/Release04x02/twikiplugins/TipsContrib/data/TWiki/TWikiTip018.txt

    r692 r707  
    33---+ Inline search 
    44 
    5 To embed a search in a topic, use the =%<nop>SEARCH{ &lt;parameters&gt; }%= TWiki Variable. The search variable is used by many TWiki based applications. 
     5To embed a search in a topic, use the =%<nop>SEARCH{ &lt;parameters&gt; }%= macro. The search macro is used by many TWiki based applications. 
    66 
    77[[Macros#VarSEARCH][More Information...]] 
  • branches/Release04x02/twikiplugins/TipsContrib/data/TWiki/TWikiTip022.txt

    r481 r707  
    33---+ Edit tables with !EditTablePlugin 
    44  
    5 The EditTablePlugin allows you to edit TWiki tables using edit fields and drop down boxes. Tables have an [ Edit table ] button if preceeded by an =%<nop>EDITTABLE{...}%= variable. Each column can be a text field, a drop down box, a date field, etc. Multiple tables per topic are editable, but only one at a time can be edited. 
     5The EditTablePlugin allows you to edit tables using edit fields and drop down boxes. Tables have an [ Edit table ] button if preceeded by an =%<nop>EDITTABLE{...}%= macro. Each column can be a text field, a drop down box, a date field, etc. Multiple tables per topic are editable, but only one at a time can be edited. 
    66 
    77Example: 
  • branches/Release04x02/twikiplugins/TipsContrib/data/TWiki/TWikiTip023.txt

    r505 r707  
    1111                * Default =TABLEATTRIBUTES= Plugin setting in this topic 
    1212                * A =TABLEATTRIBUTES= preferences setting on site-level ([[%USERSWEB%.SitePreferences]]), web-level (any WebPreferences), or topic level. For example: 
     13 
    1314                        * =Set TABLEATTRIBUTES = tableborder="0" cellpadding="1" ...= 
    1415 
  • branches/Release04x02/twikiplugins/TipsContrib/data/TWiki/TipsContrib.txt

    r503 r707  
    5252|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal | 
    5353 
    54 __Related Topics:__ %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences 
     54__Related Topics:__ %USERSWEB%.SitePreferences 
    5555 
    5656-- TWiki:Main.PeterThoeny - 2007-01-04 
  • branches/Release04x02/twikiplugins/TopicUserMappingContrib

  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/data/Main/AdminGroup.txt

  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/data/Main/GroupTemplate.txt

    • Property svn:mergeinfo changed (with no actual effect on merging)
  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/data/Main/RegistrationAgent.txt

    • Property svn:mergeinfo changed (with no actual effect on merging)
  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/data/TWiki/NewUserTemplate.txt

    r671 r707  
    2121---++ My Personal Preferences 
    2222 
    23 Uncomment preferences variables to activate them (remove the #-sign). Help and details on preferences variables are available in [[%SYSTEMWEB%.%WIKIPREFSTOPIC%][%WIKIPREFSTOPIC%]]. 
     23Uncomment [[%SYSTEMWEB%.PreferenceSettings][preference settings]] to activate them (remove the #-sign). Help and details on preference settings are available in [[%SYSTEMWEB%.%WIKIPREFSTOPIC%][%WIKIPREFSTOPIC%]]. 
    2424 
    2525   * Show tool-tip topic info on mouse-over of [[%SYSTEMWEB%.WikiWord][WikiWord]] links, on or off: 
     
    7474---++ %MAKETEXT{"Personal Preferences"}% 
    7575 
    76 %MAKETEXT{"Uncomment preferences variables to activate them (remove the #-sign). Help and details on preferences variables are available in [_1]." args="[[%SYSTEMWEB%.%WIKIPREFSTOPIC%][%WIKIPREFSTOPIC%]]"}% 
     76%MAKETEXT{"Uncomment preference settings to activate them (remove the #-sign). Help and details on preference settings are available in [_1]." args="[[%SYSTEMWEB%.%WIKIPREFSTOPIC%][%WIKIPREFSTOPIC%]]"}% 
    7777 
    7878   * %MAKETEXT{"Show tool-tip topic info on mouse-over of [_1] links, on or off:" args="[[%SYSTEMWEB%.WikiWord][WikiWord]]"}% 
  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/data/TWiki/TWikiRegistration.txt

    r481 r707  
    1515%MAKETEXT{"*Important:* the information provided in this form will be stored in a database on the TWiki server. This database is accessible to anyone who can access the server through the web (though passwords will be encrypted, and e-mail addresses will be obfusticated to help prevent spamming). Your country, or the country where the server is hosted, may have Data Protection laws governing the maintenance of such databases. If you are in doubt, you should contact [_1] for details of the Data Protection Policy of this TWiki server before registering." args="<a href='mailto:%WIKIWEBMASTER%?subject=Data%20Protection%20Policy'>%WIKIWEBMASTER%</a>"}% 
    1616 
    17 <!-- IMPORTANT NOTE if you want to customize this form: You can delete or add new input variables in this form. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly. --> 
     17<!-- IMPORTANT NOTE if you want to customize this form: You can delete or add new input fields in this form. The name="" parameter of the input tags must start with: "Twk0..." (if this is an optional entry), "Twk1..." (if this is a required entry). This will ensure that the fields are processed correctly. --> 
    1818 
    1919<script language="javascript"> 
  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/data/TWiki/TopicUserMappingContrib.txt

  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/data/TWiki/UserSetting.txt

  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/data/TWiki/UsersTemplate.txt

  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/lib/TWiki/Contrib/TopicUserMappingContrib

  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/lib/TWiki/Contrib/TopicUserMappingContrib.pm

  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/lib/TWiki/Users/TopicUserMapping.pm

  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/test/unit/TopicUserMappingContrib

    • Property svn:mergeinfo changed (with no actual effect on merging)
  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/test/unit/TopicUserMappingContrib/TopicUserMappingContrib

  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/test/unit/TopicUserMappingContrib/TopicUserMappingContribSuite.pm

    • Property svn:mergeinfo changed (with no actual effect on merging)
  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/test/unit/TopicUserMappingContrib/TopicUserMappingContribTests.pm

    • Property svn:mergeinfo changed (with no actual effect on merging)
  • branches/Release04x02/twikiplugins/TopicUserMappingContrib/test/unit/TopicUserMappingContrib/TopicUserMappingTests.pm

    • Property svn:mergeinfo changed (with no actual effect on merging)
  • branches/Release04x02/twikiplugins/TwistyContrib/data/TWiki/TwistyContrib.txt

    r505 r707  
    5959Some of my TWiki users are impressed by the optical effect of what can be done with TWiki:Plugins.TwistyPlugin - and they keep asking me: "How do I do that? I don't understand the documentation, and I don't understand the raw text of your topics!" 
    6060 
    61 They indeed have a point here.  The docs aren't easily understood.  It isn't easy to pick all the variables needed from a single example, and just copypasting sometimes fails in embarrassing ways if non-unique =id= attributes are present in a topic.  Maybe it is easy for a power user, but it surely isn't easy _enough_.  There _ought_ to be a way to make it easier. 
     61They indeed have a point here.  The docs aren't easily understood.  It isn't easy to pick all the macros needed from a single example, and just copypasting sometimes fails in embarrassing ways if non-unique =id= attributes are present in a topic.  Maybe it is easy for a power user, but it surely isn't easy _enough_.  There _ought_ to be a way to make it easier. 
    6262 
    6363Well, here you are. 
     
    145145        * Set SHORTDESCRIPTION = Twisty section javascript library to open/close content dynamically  
    146146 
    147 You can also set the global TWiki variable TWISTYCONTRIB_DEBUG to 1 to make the contrib use uncompressed javascript sources, in the event of problems. 
     147You can also set the global [[preference setting]] TWISTYCONTRIB_DEBUG to 1 to make the contrib use uncompressed javascript sources, in the event of problems. 
    148148 
    149149 
  • branches/Release04x02/twikiplugins/TwistyPlugin/data/TWiki/TwistyPlugin.txt

    r692 r707  
    158158</verbatim> 
    159159 
    160 Note that =id= sets a sitewide cookie. To create a unique id, add topic or web variables: 
     160Note that =id= sets a sitewide cookie. To create a unique id, add topic or web macros: 
    161161<verbatim> 
    162162id="%WEB%_%TOPIC%_currentCustomerList" 
     
    365365 
    366366---++ Special syntax: format tokens 
    367 If you use TWiki variables inside TWISTY parameters chances are it will mess up the variable, or the rendered html. Use format tokens to 'delay' rendering of these variables until the Twisty parameters are parsed. 
     367If you use other macros inside TWISTY parameters chances are it will mess up the macro, or the rendered html. Use format tokens to 'delay' rendering of these variables until the Twisty parameters are parsed. 
    368368 
    369369The format tokens are the same as with %SYSTEMWEB%.FormattedSearch: 
     
    538538   * Automatically generates ids 
    539539   * Automatically fills in default values 
    540    * Global preference settings can be set in this topic or locally in individual topics 
     540   * Global [[%SYSTEMWEB%.PreferenceSettings][preference settings]] can be set in this topic or locally in individual topics 
    541541 
    542542#PluginSettings 
    543543---++ Plugin Settings 
    544544 
    545 Plugin settings are stored as preferences variables. To reference 
     545Plugin settings are stored as [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. To reference 
    546546a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>TWISTYPLUGIN_SHORTDESCRIPTION%== 
    547547 
  • branches/Release04x02/twikiplugins/WysiwygPlugin/data/TWiki/WysiwygPlugin.txt

    r528 r707  
    6868 the edit 
    6969   1 The =edit= template containing the JS editor is instantiated. 
    70    1 The following variables are available for expansion in the template: 
     70   1 The following macros are available for expansion in the template: 
    7171      * =%<nop>WYSIWYG_TEXT%= expands to the HTML of the content-to-be-edited. This is suitable for use in a =textarea=. 
    7272      * =%<nop>JAVASCRIPT_TEXT%= expands to the HTML of the content-to-be-edited in a javascript constant. 
     
    9090        TML2HTML translator to prepare the text, which is then returned 
    9191        as =text/plain= to the browser. 
    92       * Two TWiki variables, =%<nop>OWEB%= and %<nop>OTOPIC%=, can be used in the content URL in the edit template to refer to the source topic for the content. 
     92      * Two macros, =%<nop>OWEB%= and %<nop>OTOPIC%=, can be used in the content URL in the edit template to refer to the source topic for the content. 
    9393   1 After edit handling is as for _Generating content directly in a specialised edit template_ 
    9494 
     
    135135WysiwygPlugin is incompatible with plugins that expand non-standard syntax e.g. TWiki:Plugins.MathModePlugin (WysiwygPlugin) 
    136136 
    137 Plugins that extend the syntax using TWiki variables, such as =%MYVARIABLE%=, should work fine. 
     137Plugins that extend the syntax using macros, such as =%MYMACRO%=, should work fine. 
    138138 
    139139---+++ Overlapping styles 
  • branches/Release04x02/twikiplugins/WysiwygPlugin/data/TWiki/WysiwygPluginSettings.txt

    r505 r707  
    11---+ Settings for WysiwygPlugin that are common to most editor integrations 
    22%STARTINCLUDE% 
    3 The *global* TWiki Variable =WYSIWYG_EXCLUDE= can be set to make the plugin sensitive to what is in a topic, before allowing it to be edited. You can set it up to veto an edit if the topic contains: 
     3The *global* [[preference setting]] =WYSIWYG_EXCLUDE= can be set to make the plugin sensitive to what is in a topic, before allowing it to be edited. You can set it up to veto an edit if the topic contains: 
    44   * =html= - HTML tags (e.g. =&lt;div&gt;=, not including &lt;br&gt;), or  
    5    * =variables= - simple variables (e.g. =%<nop>VAR%=) or  
    6    * =calls= - TWiki variables with parameters e.g. =%<nop>VARIABLE{...}%= 
     5   * =macros= - simple macros (e.g. =%<nop>VAR%=) or  
     6   * =calls= - macros with parameters e.g. =%<nop>MACRO{...}%= 
    77   * =pre= blocks (=&lt;pre&gt;=) 
    88   * HTML =comments= (=&lt;!--= ... =--&gt;=) 
    99If the plugin detects an excluded construct in the topic, it will refuse to allow the edit and will redirect to the default editor. 
    1010 
    11 If you excluded =calls= in =WYSIWYG_EXCLUDE=, you can still define a subset of TWiki variables that do *not* block edits. this is done in the *global* TWiki variable =WYSIWYG_EDITABLE_CALLS=, which should be a list of TWiki variable names separated by vertical bars, with no spaces, e.g: =* Set WYSIWYG_EDITABLE_CALLS = COMMENT|CALENDAR|INCLUDE= 
     11If you excluded =calls= in =WYSIWYG_EXCLUDE=, you can still define a subset of macros that do *not* block edits. this is done in the *global* [[preference setting]] =WYSIWYG_EDITABLE_CALLS=, which should be a list of macro names separated by vertical bars, with no spaces, e.g: =* Set WYSIWYG_EDITABLE_CALLS = COMMENT|CALENDAR|INCLUDE= 
    1212 
    1313You should set =WYSIWYG_EXCLUDE= and =WYSIWYG_EDITABLE_CALLS= in %USERSWEB%.SitePreferences, or in %WEBPREFSTOPIC% for each web. 
    1414 
    15 You can define the global variable =WYSIWYGPLUGIN_STICKYBITS= to stop the 
     15You can define the global preference =WYSIWYGPLUGIN_STICKYBITS= to stop the 
    1616plugin from ever trying to convert specific HTML tags into 
    1717HTML when certain specific attributes are present on the tag. This is most 
     
    1919preserved. 
    2020 
    21 This variable is used to tell the translator which attributes, when present 
     21This [[preference setting]] is used to tell the translator which attributes, when present 
    2222on a tag, make it "stick" i.e. block conversion. For example, setting it to 
    2323=table=background,lang;tr=valign= will stop the translator from trying to 
     
    2727You can use perl regular expressions to match tag and attribute names, so =.*=id,on.*= will ensure that any tag with an =on*= event handler is kept as HTML. 
    2828 
    29 The default setting for this variable is: 
     29The default setting for this preference is: 
    3030<verbatim> 
    3131    .*=id,lang,title,dir,on.*; 
  • branches/Release04x02/twikiplugins/WysiwygPlugin/lib/TWiki/Plugins/WysiwygPlugin.pm

    r21 r707  
    364364use vars qw( @VARS ); 
    365365 
    366 # The set of variables that get "special treatment" in URLs 
     366# The set of macros that get "special treatment" in URLs 
    367367@VARS = ( 
    368368    '%ATTACHURL%', 
     
    536536        return "Text contains calls"; 
    537537    } 
    538     if ( $exclusions =~ /variables/ && $_[0] =~ /%([A-Z_]+)%/s ) { 
    539  
    540         #print STDERR "$exclusions WYSIWYG_DEBUG: has variables $1\n"; 
    541         return "Text contains variables"; 
     538    if( $exclusions =~ /(macros|variables)/ && $_[0] =~ /%([A-Z_]+)%/s ) { 
     539        #print STDERR "$exclusions WYSIWYG_DEBUG: has macros $1\n"; 
     540        return "Text contains macros"; 
    542541    } 
    543542    if (   $exclusions =~ /html/ 
  • branches/Release04x02/twikiplugins/WysiwygPlugin/lib/TWiki/Plugins/WysiwygPlugin/TML2HTML.pm

    r21 r707  
    4848# rendered in 'protected' regions to prevent the WYSIWYG editor mussing 
    4949# them up. Note that A is specifically excluded from this list because it 
    50 # is common for href attributes to contain TWiki variables. Users should 
     50# is common for href attributes to contain macros. Users should 
    5151# be encouraged to use square bracket formulations for links instead. 
    5252my @PALATABLE_TAGS = qw( 
     
    8181   * getViewUrl is a reference to a method:<br> 
    8282     getViewUrl($web,$topic) -> $url (where $topic may include an anchor) 
    83    * markVars is true if we are to expand TWiki variables to spans. 
    84      It should be false otherwise (TWiki variables will be left as text). 
     83   * markVars is true if we are to expand macros to spans. 
     84     It should be false otherwise (macros will be left as text). 
    8585 
    8686=cut 
     
    154154} 
    155155 
    156 # Parse and convert twiki variables. If we are not using span markers 
    157 # for variables, we have to change the percent signs into entities 
     156# Parse and convert macros. If we are not using span markers 
     157# for macros, we have to change the percent signs into entities 
    158158# to prevent internal tags being expanded by TWiki during rendering. 
    159159# It's assumed that the editor will have the common sense to convert 
     
    528528    my ( $this, $text ) = @_; 
    529529 
    530     # Expand selected TWiki variables in IMG tags so that images appear in the 
     530    # Expand selected macros in IMG tags so that images appear in the 
    531531    # editor as images 
    532532    $text =~ 
Note: See TracChangeset for help on using the changeset viewer.