Changeset 697


Ignore:
Timestamp:
11/15/08 12:29:49 (4 years ago)
Author:
KennethLavrsen
Message:

Item109: More TWikiVariables to Macros updates

Location:
branches/Release04x02/data/TWiki
Files:
47 edited
1 moved

Legend:

Unmodified
Added
Removed

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

    r695 r697  
    192192---+++ Obfuscating Webs 
    193193 
    194 Another way of hiding webs is to keep them hidden by not publishing the URL and by preventing the ==all webs== search option from accessing obfuscated webs. Do so by enabling the ==NOSEARCHALL== variable in %WEBPREFSTOPIC%: 
     194Another way of hiding webs is to keep them hidden by not publishing the URL and by preventing the ==all webs== search option from accessing obfuscated webs. Do so by enabling the ==NOSEARCHALL== setting in %WEBPREFSTOPIC%: 
    195195   * ==Set <nop>NOSEARCHALL = on== 
    196196 

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

    r605 r697  
    88 
    99   1 Create a TWiki Form and define fields (see DataForms for details) 
    10    1 Add the form in the list of Web Forms. Set the variable WEBFORMS in WebPreferences 
     10   1 Add the form in the list of Web Forms. Set the preference WEBFORMS in WebPreferences 
    1111   1 Create a Template Topic 
    1212   1 In edit mode add the [[DataForms][Data Form]] you defined to the Template Topic using the "Add Form" button 

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

    r695 r697  
    6363            * If not set: =6= 
    6464            * Possible values: =1= to =6= 
    65             * Can be overridden by =depth= parameter of [[%SYSTEMWEB%.VarTOC2][variable TOC]] 
     65            * Can be overridden by =depth= parameter of [[%SYSTEMWEB%.VarTOC2][TOC]] 
    6666      * The default TOC title: 
    6767         * Set TOC_TITLE = 
    6868            * If not set: nothing 
    6969            * Possible values: any string, for example =On this page:= 
    70             * Can be overridden by =title= parameter of [[%SYSTEMWEB%.VarTOC2][variable TOC]] 
     70            * Can be overridden by =title= parameter of [[%SYSTEMWEB%.VarTOC2][TOC]] 
    7171      * Do not show a TOC if the topic it contains is included in another topic: 
    7272         * Set TOC_HIDE_IF_INCLUDED = 
    … …  
    128128   * List of <nop>%WIKITOOLNAME% webs - on the first line of the upper toolbar (to add a new web, see ManagingWebs and %SYSTEMWEB%.SiteMap): 
    129129      * Set WIKIWEBLIST = [[%USERSWEB%.%HOMETOPIC%][%USERSWEB%]] %SEP% [[%SYSTEMWEB%.%HOMETOPIC%][%SYSTEMWEB%]] %SEP% [[Sandbox.%HOMETOPIC%][Sandbox]] 
    130       * %T% *NOTE:* To automatically list all non-hidden webs in alphabetical order, use the =%<nop>WEBLIST{}%= variable instead: <br /> 
     130      * %T% *NOTE:* To automatically list all non-hidden webs in alphabetical order, use the =%<nop>WEBLIST{}%= macro instead: <br /> 
    131131        %WEBLIST{"[[$name.%HOMETOPIC%][$name]]" separator=" | "}% 
    132132 
    … …  
    145145   * Default type for search, one of: keyword (for search engine like syntax), regex (for RegularExpression search), or literal (for verbatim search) 
    146146      * Set SEARCHDEFAULTTTYPE = keyword 
    147    * Default for =%<nop>SEARCH{}%= variable, one of: keyword, regex, or literal 
     147   * Default for =%<nop>SEARCH{}%= macro, one of: keyword, regex, or literal 
    148148      * Set SEARCHVARDEFAULTTYPE = literal 
    149149   * Stop words, e.g., common words and characters to exclude from a keyword search: 
    … …  
    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% TWiki variable to be a list of plugins to disable e.g. 
     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. 
    217217      * <nop>Set DISABLEDPLUGINS = SpreadSheetPlugin,EditTablePlugin 
    218218      * Currently, %<nop>DISABLEDPLUGINS% is set to "%DISABLEDPLUGINS%" 
    … …  
    222222   * Detailed diagnostics can be found in InstalledPlugins 
    223223   * Legacy settings: 
    224       * Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS variable is no longer supported. You can set the Plugins execution order using the [[%SCRIPTURLPATH{"configure"}%][configure]] interface. 
     224      * Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS macro is no longer supported. You can set the Plugins execution order using the [[%SCRIPTURLPATH{"configure"}%][configure]] interface. 
    225225 
    226226#RenderingShortcuts 
    … …  
    339339      * S<nop>et WEBBGCOLOR = #FFFFC0 
    340340   * Preferences are used as [[%SYSTEMWEB%.Macros][Macros]] by enclosing the name in percent signs: ==%==. Example: 
    341       * When you write variable ==%WEB<nop>BGCOLOR%==, it gets expanded to =%WEBBGCOLOR%= . 
     341      * When you write ==%WEB<nop>BGCOLOR%==, it gets expanded to =%WEBBGCOLOR%= . 
    342342 
    343343   * %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. 

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

    r551 r697  
    1 %META:TOPICINFO{author="ProjectContributor" date="1222844046" format="1.1" version="$Rev: 17552 $"}% 
     1%META:TOPICINFO{author="ProjectContributor" date="1222844046" format="1.1" version="$Rev: 16040 $"}% 
    22---+!! TWiki Documentation Graphics and Filetype icons 
    33 
    … …  
    343343Shorthand notation: 
    344344<blockquote> 
    345 In [[%USERSWEB%.DefaultPreferences!]] set a variable to an ICON, for example: 
     345In [[%USERSWEB%.DefaultPreferences!]] set a macro for an ICON, for example: 
    346346 
    347347=<nop>   * Set H = %<nop>ICON{help}%= 
    … …  
    349349Now you can use the icon by writing =%<nop>H%= 
    350350 
    351 For extended use, check out TWiki:Plugins.SmiliesPlugin that uses a different short hand than =<nop>%VARIABLES%=. 
     351For extended use, check out TWiki:Plugins.SmiliesPlugin that uses a different short hand than =<nop>%MACROS%=. 
    352352</blockquote> 
    353353 

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

    r695 r697  
    3939Three or more dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a top level heading, two pluses a second level heading, etc. The maximum heading depth is 6. 
    4040 
    41 You can create a table of contents with the [[VarTOC][%<nop>TOC%]] variable. If you want to *exclude* a heading from the TOC, put =!!= after the =---+=. 
     41You can create a table of contents with the [[VarTOC][%<nop>TOC%]] macro. If you want to *exclude* a heading from the TOC, put =!!= after the =---+=. 
    4242 
    4343%X% Empty headings are allowed, but won't appear in the table of contents. 

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

    r695 r697  
    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%= variable of the DefaultPreferences, currently set at %ATTACHFILESIZELIMIT% KB. 
     32      * TWiki can limit the file size. This is defined by the =%<nop>ATTACHFILESIZELIMIT%= preference setting, 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

    r491 r697  
    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!]] variable =FORCENEWREVISIONCHECKBOX= controls whether this is checked by default or not. 
     6The [[%SYSTEMWEB%.DefaultPreferences!]] 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/FormatTokens.txt

    r3 r697  
    33TWiki defines some standard special tokens that can be used to replace characters in some parameters - notably those to FormattedSearch and IfStatements - to defer evaluation of the parameter until later. These special tokens are often called "escapes", because they allow the character to "escape" from its normal meaning.  
    44%STARTINCLUDE%| =$n= or =$n()= | New line. Use =$n()= if followed by alphanumeric character, e.g. write =Foo$n()Bar= instead of =Foo$nBar= | 
    5 | =$nop= or =$nop()= | Is a "no operation". This variable gets removed; useful for nested search | 
     5| =$nop= or =$nop()= | Is a "no operation". This token gets removed; useful for nested search | 
    66| =$quot= | Double quote (="=) (\" also works) | 
    77| =$percnt= | Percent sign (=%=) | 

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

    r695 r697  
    180180---+++ Embedding search forms to return a formatted result 
    181181 
    182 Use an HTML form and an embedded formatted search on the same topic. You can link them together with an =%<nop>URLPARAM{"..."}%= variable. Example: 
     182Use an HTML form and an embedded formatted search on the same topic. You can link them together with an =%<nop>URLPARAM{"..."}%= macro. Example: 
    183183 
    184184*Write this:* 

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

    r695 r697  
    88In the example above, if CONDITION evaluates to TRUE, then THEN will be included in the topic; otherwise ELSE will be included. 
    99 
    10 Note that because of the way TWiki evaluates, then whatever is in the THEN and ELSE parameters will already have been expanded by the time the condition is actually evaluated. The standard FormatTokens can be used in the THEN and ELSE parameters when you need to delay evaluation of (for example) a TWiki variable. 
     10Note that because of the way TWiki evaluates, then whatever is in the THEN and ELSE parameters will already have been expanded by the time the condition is actually evaluated. The standard FormatTokens can be used in the THEN and ELSE parameters when you need to delay evaluation of (for example) a macro. 
    1111 
    1212The basic syntax of a condition is the same as [[QuerySearch][the syntax used for queries]], with the addition of the following special operators: 
    … …  
    1919| defined | True if a preference setting or url parameter of this name is defined. | 
    2020| 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, settings and user-defined preference settings are supported. You can pass a limited subset of parameters to macros by enclosing the variable name in single quotes; for example, =$ 'VARIABLE{value}'=. The ='VARIABLE{value}'= string may *not* contain quotes (' or "). | 
    22 | {X} | expands to the value of the configuration variable {X} - for example, ={ScriptUrlPath}= | 
     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 "). | 
     22| {X} | expands to the value of the =configure= setting {X} - for example, ={ScriptUrlPath}= | 
    2323 
    2424__Examples:__ 
    2525 
    26 1. TWiki variable defined or not 
     261. Macro defined or not 
    2727<verbatim> 
    2828%IF{"defined 'WIKINAME'" then="WIKINAME is defined" else="WIKINAME is not defined"}% 
    2929</verbatim> 
    3030 
    31 2. Compare TWiki variable 
     312. Compare macro definition 
    3232<verbatim> 
    3333You are %IF{ "$ WIKINAME='WikiGuest' and not defined 'OPEN_DAY'" then="not" }% allowed to 

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

    r481 r697  
    11%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev$"}% 
    2 ---+!! Include Topics and Web Pages Using =%<nop>INCLUDE{...}%= Variable 
     2---+!! Include Topics and Web Pages Using =%<nop>INCLUDE{...}%= Macro 
    33 
    4 Use the =%<nop>INCLUDE{...}%= variable to embed the content of another topic or web page inside a TWiki topic. The whole content or only parts of a page can be included. If needed, set a proxy server in %WIKIPREFSTOPIC%. 
     4Use the =%<nop>INCLUDE{...}%= macro to embed the content of another topic or web page inside a TWiki topic. The whole content or only parts of a page can be included. If needed, set a proxy server in %WIKIPREFSTOPIC%. 
    55 
    66%TOC% 
    … …  
    1212The =pattern= parameter is optional and allows you to extract some parts of a web page. Specify a %SYSTEMWEB%.RegularExpression that scans from start (='^'=) to end and contains the text you want to keep in parenthesis, e.g., =pattern="^.*?(from here.*?to here).*"=. You need to make sure that the integrity of a web page is not compromised; for example, if you include a table, make sure to include everything including the table end tag. 
    1313 
    14 The example parameters PARAMETER1 and PARAMETER2 will be defined as a variable within the scope of the included topic. The example parameters shown will result in %PARAMETER1% and %PARAMETER2% being defined within the included topic. 
     14The example parameters PARAMETER1 and PARAMETER2 will be defined as macros within the scope of the included topic. The example parameters shown will result in %PARAMETER1% and %PARAMETER2% being defined within the included topic. 
    1515 
    1616VarINCLUDE explains the other parameters. 

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

    r528 r697  
    1 %META:TOPICINFO{author="ProjectContributor" date="1159249788" format="1.1" version="$Rev: 17114 $"}% 
     1%META:TOPICINFO{author="ProjectContributor" date="1159249788" format="1.1" version="$Rev: 15598 $"}% 
    22---+ Installed Plugins 
    33Plugins are mainly user-contributed add-ons that enhance and extend TWiki features and capabilities. A limited number of plugins are included in the core TWiki distribution - and any of those can be removed - while the rest are optional, available from TWiki:Plugins.PluginPackage. 
    … …  
    1919%FAILEDPLUGINS% 
    2020 
    21 __Note:__ The diagnostics are provided by the =%<nop>FAILEDPLUGINS%= variable 
     21__Note:__ The diagnostics are provided by the =%<nop>FAILEDPLUGINS%= macro 
    2222 
    2323__Related Topics:__ [[Plugins]], %WIKIPREFSTOPIC%, AdminDocumentationCategory, AdminToolsCategory, TWikiSkinBrowser 

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

    r695 r697  
    2323*What we are doing* 
    2424 
    25 We want to set variable 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* 
    … …  
    4545 
    4646   1 Go to WebPreferences in each web, and edit the topic. 
    47    2 In WEBTOPICLIST variable, replace =WebIndex= with =WebTopicList=, and save. 
     47   2 In the WEBTOPICLIST setting, replace =WebIndex= with =WebTopicList=, and save. 
    4848 
    4949---+++ Simple way to create %RED% colored text %ENDCOLOR% and graphics 
    … …  
    6161You may find it easier to write shorthand graphic notation. You can create your own image macros by defining them in a preference topic (most likely [[%USERSWEB%.%WIKIPREFSTOPIC%]].) 
    6262 
    63 A variable name may be one letter, like =Y=, or may be longer like =HELP=, =WARN= etc. You can also add your own images, e.g. a =NEW=, or a =ASK= to ask question. 
     63A macro name may be one letter, like =Y=, or may be longer like =HELP=, =WARN= etc. You can also add your own images, e.g. a =NEW=, or a =ASK= to ask question. 
    6464 
    6565For instance, if we want to write =%<nop>DOWN%= instead of =%<nop>ICON{"arrowbdown"}%=, define the new macro like this: 
    … …  
    8080TOC is Table-Of-Content, generated automagically from headers (defined like that: ==---++== , see TWikiShorthand). 
    8181 
    82 For example, you may want to put all your custom variables in [[%LOCALSITEPREFS%]] right on top of the page, and generate table of contents, like: 
     82For example, you may want to put all your custom settings in [[%LOCALSITEPREFS%]] right on top of the page, and generate table of contents, like: 
    8383 
    8484   * Preferences for easy creating nice pages  
    … …  
    136136*End Copy* 
    137137 
    138 The SEARCH variable has many more formatting options, see [[Macros]]. 
     138The SEARCH macro has many more formatting options, see [[Macros]]. 
    139139 
    140140---+++ Recently changed pages  

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

    r695 r697  
    1616*Documentation Graphics:* There are many graphics available to use in your topics. Use =%<nop>ICON{"help"}%=, =%<nop>ICON{"tip"}%=, and =%<nop>ICON{"warning"}%= to get: %H%, %T%, and %X%, respectively. DocumentGraphics lists them all. 
    1717 
    18 %ICON{"tip"}% To "escape" a variable, prefix it with an exclamation mark. Write: =!%<nop>SOMEVARIABLE%= to get: !%SOMEVARIABLE%. 
     18%ICON{"tip"}% To "escape" a macro, prefix it with an exclamation mark. Write: =!%<nop>SOMEMACRO%= to get: !%SOMEMACRO%. 
    1919%STOPINCLUDE% 

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

    r695 r697  
    5757---+++ META:TOPICMOVED 
    5858 
    59 This is optional, exists if topic has ever been moved.  If a topic is moved more than once, only the most recent META:TOPICMOVED meta variable exists in the topic, older ones are to be found in the rcs history. 
     59This is optional, exists if topic has ever been moved.  If a topic is moved more than once, only the most recent META:TOPICMOVED meta datum exists in the topic, older ones are to be found in the rcs history. 
    6060 
    6161=%<nop>META:TOPICMOVED{from="Codev.OldName" to="Codev.NewName" by="talintj" date="976762680"}%= 
    … …  
    134134---++ Rendering Meta Data 
    135135 
    136 Meta Data is rendered with the %<nop>META% variable. This is mostly used in the =view=, =preview= and =edit= scripts. 
     136Meta Data is rendered with the %<nop>META% macro. This is mostly used in the =view=, =preview= and =edit= scripts. 
    137137 
    138 You can render form fields in topic text by using the FORMFIELD variable. Example:%BR% 
     138You can render form fields in topic text by using the FORMFIELD macro. Example:%BR% 
    139139=%<nop>FORMFIELD{"TopicClassification"}%= %BR% 
    140140For details, see VarFORMFIELD. 
    … …  
    142142Current support covers: 
    143143 
    144 | *Variable usage:*   | *Comment:*  | 
     144| *Macro usage:*   | *Comment:*  | 
    145145| =%<nop>META{"form"}%= | Show form data, see DataForms. | 
    146146| =%<nop>META{"formfield"}%= | Show form field value. Parameter: ==name="field_name"==. Example:%BR% =%<nop>META{ "formfield" name="TopicClassification" }%= | 

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

    r695 r697  
    139139 
    140140   * =$TWiki::Plugins::VERSION= in the =TWiki::Plugins= module contains the TWiki plugin API version, currently *%PLUGINVERSION{}%*. 
    141       * You can also use the =[[VarPLUGINVERSION][%<nop>PLUGINVERSION{}%]]= variable to query the plugin API version or the version of installed plugins. 
     141      * You can also use the =[[VarPLUGINVERSION][%<nop>PLUGINVERSION{}%]]= macro to query the plugin API version or the version of installed plugins. 
    142142 
    143143---+++ Security 
    … …  
    206206*Example:* &lt;<i>Include an example of the plugin in action. Possibly include a static HTML version of the example to compare if the installation was a success!</i>&gt;" 
    207207 
    208 *Plugin Settings:* &lt;<i>Description and settings for custom plugin %<nop>VARIABLES%, and those required by TWiki.</i>&gt;" 
     208*Plugin Settings:* &lt;<i>Description and settings for custom plugin settings, and those required by TWiki.</i>&gt;" 
    209209 
    210210   * *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;" 

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

    r491 r697  
    1 %META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 9245 $"}% 
     1%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 7725 $"}% 
    22%META:TOPICPARENT{name="WebSearch"}% 
    33---+!! Search Help 
    … …  
    3131---++ Formatted Searches 
    3232 
    33 You can embed a nicely [[FormattedSearch][formatted search]] in a topic by using the =%<nop>SEARCH{}%= variable described in VarSEARCH. 
     33You can embed a nicely [[FormattedSearch][formatted search]] in a topic by using the =%<nop>SEARCH{}%= macro described in VarSEARCH. 
    3434 
    3535---++ Search Preferences 
    … …  
    3939   * =SEARCHDEFAULTTTYPE=: Default search type for search forms which calls the =search= script 
    4040      * Currently =%SEARCHDEFAULTTTYPE%= 
    41    * =SEARCHVARDEFAULTTYPE=: Default search type for =%<nop>SEARCH{}= variable  
     41   * =SEARCHVARDEFAULTTYPE=: Default search type for =%<nop>SEARCH{}= macro  
    4242      * Currenty =%SEARCHVARDEFAULTTYPE%= 
    4343   * =SEARCHSTOPWORDS=: List of stop words (common words and characters to exclude from a keyword search) 

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

    r695 r697  
    3131      * ==%<nop>TMPL:P{"var"}%==: Includes a previously defined block. 
    3232      * ==%<nop>{...}%==: is a comment. 
    33    * Two-pass processing lets you use a variable before or after declaring it. 
     33   * Two-pass processing lets you use a defined block before or after declaring it. 
    3434   * For example, you can create a skin that overloads only the =twiki.tmpl= master skin template, like =twiki.print.tmpl=, that redefines the header and footer. 
    3535   * %H% Use of template macros is optional: templates work without them. 
    … …  
    126126==twiki.tmpl== is the default master template. It defines the following sections. 
    127127 
    128 | *Template variable:* | *Defines:* | 
     128| *Template directive:* | *Defines:* | 
    129129| =%<nop>TMPL:DEF{"sep"}%= | "&#124;" separator | 
    130130| =%<nop>TMPL:DEF{"htmldoctype"}%= | Start of all HTML pages | 

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

    r621 r697  
    1 %META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 8265 $"}% 
     1%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 6745 $"}% 
    22Welcome to <nop>%WIKITOOLNAME%. This page assumes that you are a new user to <nop>%WIKITOOLNAME%, and that you've never heard of Wiki before. Here are the most important pages you should know about to get you up to speed on what Wiki is, and how to use it. Follow any of the links below that interest you and use your browser's back button to return to this page if you need to.  
    33 
    … …  
    55 
    66   * WelcomeGuest: A brief intro for first-time visitors 
    7    * *[[TwentyMinuteTutorial]]*: A compact, 20-minute TWiki primer 
     7   * *[[TwentyMinuteTutorial]]*: A compact, 20-minute primer 
    88   * %HOMETOPIC%: Entry point for this TWiki web. 
    99   * TWikiSite: Explains what a TWiki site is 
    1010   * WebChanges: Newest topic changes in the <nop>%WEB% web 
    11    * FrequentlyAskedQuestions: Common questions about TWiki use 
     11   * FrequentlyAskedQuestions: Common questions about how to use the program 
    1212 
    1313   * GoodStyle: Things to consider when changing text 
    … …  
    1616   * TextFormattingFAQ: Common how-to questions about posting in TWiki 
    1717 
    18    * TWikiVariables: How to easily embed text, graphics, dynamic content  
     18   * [[%SYSTEMWEB%.Macros][Macros]]: How to easily embed text, graphics, dynamic content  
    1919 
    2020   * MainFeatures: The main features of the TWiki collaboration platform 

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

    r695 r697  
    1 %META:TOPICINFO{author="ProjectContributor" date="1177803014" format="1.1" version="$Rev: 14760 $"}% 
     1%META:TOPICINFO{author="ProjectContributor" date="1177803014" format="1.1" version="$Rev: 13239 $"}% 
    22%STARTINCLUDE% 
    33---+ TWiki Site Tools 
    … …  
    1414Each 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. 
    1515 
    16    * You can create a WebNotify link using [[Macros]] with ==%<nop>NOTIFYTOPIC%== 
     16   * You can create a WebNotify link using [[%SYSTEMWEB%.Macros][Macros]] with ==%<nop>NOTIFYTOPIC%== 
    1717 
    1818%INCLUDE{"WebChangesAlert"}% 
    … …  
    3030   * many more 
    3131 
    32 See also: SearchHelp for help; [[Macros]] and FormattedSearch for including hard-coded searches in text. 
     32See also: SearchHelp for help; [[%SYSTEMWEB%.Macros][Macros]] and FormattedSearch for including hard-coded searches in text. 
    3333 
    3434#WebChanges 
    … …  
    6565You 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. 
    6666 
    67    * You can create a WebStatistics link using [[Macros]] with ==%<nop>STATISTICSTOPIC%== 
     67   * You can create a WebStatistics link using [[%SYSTEMWEB%.Macros][Macros]] with ==%<nop>STATISTICSTOPIC%== 
    6868 
    6969---+++ Configuring for automatic operation 
    7070 
    7171   * You can automatically generate usage statistics for all webs. To enable this: 
    72       * Make sure variable *{Log}{view}*, *{Log}{save}* and *{Log}{upload} in are set in [[%SCRIPTURLPATH{"configure"}%][configure]]. This will generate log file entries (see below). 
     72      * Make sure configure settings *{Log}{view}*, *{Log}{save}* and *{Log}{upload} in are set in [[%SCRIPTURLPATH{"configure"}%][configure]]. This will generate log file entries (see below). 
    7373      * The WebStatistics topic must be present in all webs where you want to have statistics. You can use the topic in the Main web as a template. 
    7474      * Call the =twiki/bin/statistics= script from a cron job, once a day is recommended. This will update the WebStatistics topics in all webs. 
    … …  
    126126Outgoing mail is required for TWikiRegistration and for [[#WebNotify][recent changes alert]]. 
    127127 
    128 TWiki will use the ==Net::SMTP== module if it is installed on your system. Set this with the ==SMTPMAILHOST== variable in DefaultPreferences. 
     128TWiki will use the ==Net::SMTP== module if it is installed on your system. Set this with the ==SMTPMAILHOST== preference setting in DefaultPreferences. 
    129129 
    130130The notify e-mail uses the default =changes.tmpl= template, or a skin if activated in the DefaultPreferences. 
    … …  
    136136!   * %H% Net::SMTP can be easily disabled (if there is an installation error) by setting ==SMTPMAILHOST== in DefaultPreferences to an empty value. 
    137137 
    138    * %T% You can set a separate ==SMTPSENDERHOST== variable to define the mail sender host (some SMTP installations require this). 
     138   * %T% You can set a separate ==SMTPSENDERHOST== preference setting to define the mail sender host (some SMTP installations require this). 
    139139 
    140140---+++ Setting the automatic e-mail schedule 

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

    r672 r697  
    1 %META:TOPICINFO{author="ProjectContributor" date="1200013119" format="1.1" version="$Rev: 16189 $"}% 
     1%META:TOPICINFO{author="ProjectContributor" date="1200013119" format="1.1" version="$Rev: 14667 $"}% 
    22%STARTINCLUDE% 
    33---+ TWiki Upgrade Guide 
    … …  
    105105---+++ Apply Preferences From Old Installation 
    106106 
    107    * Transfer any customized and local settings from [[%SYSTEMWEB%.TWikiPreferences]] or [[%SYSTEMWEB%.DefaultPreferences]] to the topic pointed at by {LocalSitePreferences} ([[%LOCALSITEPREFS%]]). Per default this is =%USERSWEB%.SitePreferences=. This avoids having to write over files in the distribution on a later upgrade. 
     107   * Transfer any customized and local settings from [[%SYSTEMWEB%.DefaultPreferences]] to the topic pointed at by {LocalSitePreferences} ([[%LOCALSITEPREFS%]]). Per default this is =%USERSWEB%.SitePreferences=. This avoids having to write over files in the distribution on a later upgrade. 
    108108   * If you changed any of the topics in the original TWiki distribution, you will have to transfer your changes to the new install manually. There is no simple way to do this, though a suggestion is to use 'diff' to find changed files in the =data/TWiki= of the old and new TWiki installation, and transfer the changes into the new TWiki install. If you can run a GUI on your server, you may find that using a visual diff tool like !WinMerge, meld, kdiff3, xxdiff, etc. is helpful. 
    109109   * Compare the =WebPreferences= topics in the old TWiki Installation with the default from the new TWiki installation and add any new Preferences that may be relevant. 
    … …  
    127127 
    128128   * Attach a favicon.ico file to !WebPreferences in each web. 
    129    * Preferred: Change the setting of the location of favicon.ico in !%USERSWEB%.SitePreferences so all webs use the favicon.ico from the TWiki web. This is the fastest and easiest solution. 
    130  
    131 To change the location of favicon.ico in !DefaultPreferences to the %SYSTEM% web add this line to !%USERSWEB%.SitePreferences 
     129   * Preferred: Change the setting of the location of favicon.ico in !%SYSTEMWEB%.DefaultPreferences or !%USERSWEB%.SitePreferences so all webs use the favicon.ico from the TWiki web. This is the fastest and easiest solution. 
     130 
     131To change the location of favicon.ico to the TWiki web add this line to %USERSWEB%.SitePreferences 
    132132 
    133133<verbatim> 

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

    r695 r697  
    2626| =%<nop>GMTIME%= | Date/time. See VarGMTIME | 
    2727| =%<nop>GMTIME{...}%= | Formatted date/time. See VarGMTIME2 | 
    28 | =%<nop>NOP%= | A no-operation variable that gets removed. Useful to prevent a SEARCH from hitting an edit template topic; also useful to escape a variable, such as =%<nop>URLPA%<nop>NOP%RAM{...}%= escaping URLPARAM | 
     28| =%<nop>NOP%= | A no-operation macro that gets removed. Useful to prevent a SEARCH from hitting an edit template topic; also useful to escape a variable, such as =%<nop>URLPA%<nop>NOP%RAM{...}%= escaping URLPARAM | 
    2929| =%<nop>STARTSECTION{type="templateonly"}%%BR%...%BR%%<nop>ENDSECTION{type="templateonly"}%= | Text that gets removed when a new topic based on the template topic is created. See notes below. | 
    3030| =%<nop>SERVERTIME%= | Date/time. See VarSERVERTIME | 
    … …  
    9999See CommandAndCgiScripts#edit for details of the parameters that the =edit= script understands. 
    100100 
    101 %T% *TIP:* You can use the =%<nop>WIKIUSERNAME%= and =%<nop>DATE%= macros in your template topics to include the signature of the person creating a new topic. The variables are expanded into fixed text when a new topic is created. The standard signature is: <br /> 
     101%T% *TIP:* You can use the =%<nop>WIKIUSERNAME%= and =%<nop>DATE%= macros in your template topics to include the signature of the person creating a new topic. The macros are expanded into fixed text when a new topic is created. The standard signature is: <br /> 
    102102==-- %<nop>WIKIUSERNAME% - %<nop>DATE%== 
    103103 

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

    r695 r697  
    1 %META:TOPICINFO{author="ProjectContributor" date="1197351701" format="1.1" version="$Rev: 15968 $"}% 
     1%META:TOPICINFO{author="ProjectContributor" date="1197351701" format="1.1" version="$Rev: 14446 $"}% 
    22---++ Text Formatting FAQ 
    33 
    … …  
    1616 
    1717You can create six sizes of headings - &lt;h1&gt;...&lt;h6&gt; in HTML - by typing, from the beginning of a line, three dashes (-), from one to six plus signs (+), a space, and your heading text. The FAQ questions on this page are created with: =---+++ Have a question?=. 
    18    * You can insert a nested table of contents, generated from headings, by placing =%<nop>TOC%= wherever you like on a page (see [[%SYSTEMWEB%.Macros][Macros]] for more =%<nop>TOC%= options). 
     18   * You can insert a nested table of contents, generated from headings, by placing =%<nop>TOC%= wherever you like on a page (see [[Macros]] for more =%<nop>TOC%= options). 
    1919 
    2020----- 
    … …  
    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:__ VARIABLES are still Set within verbatim tags (this is a historical peculiarity) 
     73__NOTE:__ preference settings are still Set 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/TopicsAndWebs.txt

    r695 r697  
    6565      * custom formatting for outputting lists or tables, optional layout, headings, summary, etc. 
    6666   * macros 
    67       * similar to a command line context with site wide and locally defined variables 
     67      * site wide and locally defined macros 
    6868      * over-ride topic, TWiki web or site 
    6969   * [[%SYSTEMWEB%.DataForms][forms]] 

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

    r695 r697  
    1515%WIKITOOLNAME% authentication is very flexible, and can either stand alone or integrate with existing authentication schemes. You can set up %WIKITOOLNAME% to require authentication for every access, or only for changes. Authentication is also essential for access control. 
    1616 
    17 *Quick Authentication Test* - Use the %<nop>USERINFO% variable to return your current identity: 
     17*Quick Authentication Test* - Use the %<nop>USERINFO% macro to return your current identity: 
    1818   * You are %USERINFO%  
    1919 
    … …  
    132132You don't _have_ to enable sessions to support logins in %WIKITOOLNAME%. However it is *strongly* recommended. %WIKITOOLNAME% needs some way to remember the fact that you logged in from a particular browser, and it uses sessions to do this. If you don;t enable sessions, %WIKITOOLNAME% will try hard to remember you, but due to limitations in the browsers it may also forget you (and then suddenly remember you again later!). So for the best user experience, you should enable sessions. 
    133133 
    134 There are a number of [[%SYSTEMWEB%.Macros][Macros]] available that you can use to interrogate your current session. You can even add your own session variables to the %WIKITOOLNAME% cookie. Session variables are referred to as "sticky" variables. 
     134There are a number of [[%SYSTEMWEB%.Macros][macros]] available that you can use to interrogate your current session. You can even add your own session variables to the %WIKITOOLNAME% cookie. Session variables are referred to as "sticky" variables. 
    135135 
    136136---+++ Getting, Setting, and Clearing Session Variables 
    … …  
    161161<nop>%WIKITOOLNAME% internally manages two usernames: Login Username and TWiki Username. 
    162162 
    163    * *Login Username:* When you login to the intranet, you use your existing login username, ex: ==pthoeny==. This name is normally passed to TWiki by the ==REMOTE_USER== environment variable, and used internally. Login Usernames are maintained by your system administrator. 
     163   * *Login Username:* When you login to the intranet, you use your existing login username. This name is normally passed to TWiki by the ==REMOTE_USER== environment variable, and used internally. Login Usernames are maintained by your system administrator. 
    164164 
    165165   * *TWiki Username:* Your name in WikiNotation, ex: ==PeterThoeny==, is recorded when you register using TWikiRegistration; doing so also generates a personal home page in the %USERSWEB% web. 

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

    r692 r697  
    44 
    55---+++ CARET -- caret symbol 
    6    * The caret variable can be used in TWiki tables. 
     6   * The CARET macro is useful in TML tables. 
    77   * Type: ShortcutMacro 
    88   * Current value: CARET = %CARET% 

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

    r695 r697  
    66   * __Note:__ For security reasons, only those environment variables whose names match the regular expression in ={AccessibleENV}= in the *Security Settings/Miscellaneous* section of =configure= can be displayed. Any other variable will just be shown as an empty string, irrespective of its real value. 
    77   * Example: =%<nop>ENV{MOD_PERL}%= displays as: %ENV{MOD_PERL}% 
    8    * If a variable is undefined (as against being set to the empty string) it will be returned as =not set=. 
     8   * If an environment variable is undefined (as against being set to the empty string) it will be returned as =not set=. 
    99   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarHTTPHOST][HTTP_HOST]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarREMOTEADDR][REMOTE_ADDR]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarREMOTEPORT][REMOTE_PORT]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarREMOTEUSER][REMOTE_USER]] 

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

    r692 r697  
    55   * Expands to a formatted list of user groups in your %WIKITOOLNAME%. 
    66   * Syntax: =%<nop>GROUPS%= 
    7    * The variable is intended to be used in %USERSWEB%.WikiGroups, to allow a 
     7   * The macro is intended to be used in %USERSWEB%.WikiGroups, to allow a 
    88     group listing for various user mapping managers. 
    99   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarREMOTEUSER][REMOTE_USER]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarUSERINFO][USERINFO]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarUSERNAME][USERNAME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWIKIUSERNAME][WIKIUSERNAME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWIKIUSERSTOPIC][WIKIUSERSTOPIC]] 

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

    r695 r697  
    2020     | =warn="off"= | Warn if topic include fails: Fail silently (if =off=); output default warning (if set to =on=); else, output specific text (use =$topic= for topic name) | =%<nop>INCLUDEWARNING%= [[DefaultPreferences][preferences]] setting | 
    2121     | =section="name"= | Includes only the specified named section, as defined in the included topic by the [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSTARTSECTION][STARTSECTION]] and [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarENDSECTION][ENDSECTION]] macros. Nothing is shown if the named section does not exists. =section=""= is equivalent to not specifying a section | | 
    22      | =PARONE="val 1"%BR% PARTWO="val 2"= | Any other parameter will be defined as a variable within the scope of the included topic. The example parameters on the left will result in =%<nop>PARONE%= and =%<nop>PARTWO%= being defined within the included topic. | | 
     22     | =PARONE="val 1"%BR% PARTWO="val 2"= | Any other parameter will be defined as a macro within the scope of the included topic. The example parameters on the left will result in =%<nop>PARONE%= and =%<nop>PARTWO%= being defined within the included topic. | | 
    2323   * __Note:__ !JavaScript in included webpages is filtered out as a security precaution per default (disable filter with =disableremovescript= parameter) 
    2424   * Examples: See IncludeTopicsAndWebPages 

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

    r691 r697  
    3131        *cannot* use translatable phrases starting with an underscore. 
    3232      * Make sure that the translatable string is _constant_. Specially, do *not* 
    33         include <code>%<nop>VARIABLES%</code> inside the translatable strings 
     33        include <code>%<nop>MACROS%</code> inside the translatable strings 
    3434        (since they will get expanded *before* the <code>%<nop>MAKETEXT{...}%</code> 
    3535        itself is handled). 

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

    r692 r697  
    33#VarMETA 
    44---+++ META -- displays meta-data 
    5    * Provided mainly for use in templates, this variable generates the parts of the topic view that relate to meta-data (attachments, forms etc.) The =formfield= item is the most likely to be useful to casual users. 
     5   * Provided mainly for use in templates, this macro generates the parts of the topic view that relate to meta-data (attachments, forms etc.) The =formfield= item is the most likely to be useful to casual users. 
    66   * Syntax: =%<nop>META{ "item" ...}%= 
    77   * Parameters: 

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

    r695 r697  
    22%META:TOPICPARENT{name="Macros"}% 
    33#VarREMOTEUSER 
    4 ---+++ REMOTE_USER -- CGI environment variable 
     4---+++ REMOTE_USER -- environment variable 
    55   * Syntax: =%<nop>REMOTE_USER%= 
    66   * Expands to: <code>%REMOTE_USER%</code> 

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

    r695 r697  
    1010     | ="text"= | Search term. Is a keyword search, literal search, regular expression search, or query, depending on the =type= parameter. SearchHelp has more | required | 
    1111     | =search="text"= | (Alternative to above) | N/A | 
    12      | =web="Name"= <br /> =web="%USERSWEB%, Know"= <br /> =web="all"= | Comma-separated list of webs to search. You can specifically *exclude* webs from an =all= search using a minus sign - for example, =web="all,-Secretweb"=. The special word =all= means all webs that do *not* have the =NOSEARCHALL= variable set to =on= in their %WEBPREFSTOPIC%. Note that [[AccessControl][AccessControls]] are respected when searching webs; it is *much* better to use them than =NOSEARCHALL=. | Current web | 
     12     | =web="Name"= <br /> =web="%USERSWEB%, Know"= <br /> =web="all"= | Comma-separated list of webs to search. You can specifically *exclude* webs from an =all= search using a minus sign - for example, =web="all,-Secretweb"=. The special word =all= means all webs that do *not* have the =NOSEARCHALL= preference set to =on= in their %WEBPREFSTOPIC%. Note that [[AccessControl][AccessControls]] are respected when searching webs; it is *much* better to use them than =NOSEARCHALL=. | Current web | 
    1313     | =topic="%WEBPREFSTOPIC%"= <br /> =topic="*Bug"= | Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. __Note__ this is a list of *topic names* and must *not* include web names. | All topics in a web | 
    1414     | =excludetopic="Web*"= <br /> =excludetopic="%HOMETOPIC%, <nop>WebChanges"= | Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. __Note__ this is a list of *topic names* and must *not* include web names. | None | 
    … …  
    3131     | =expandvariables="on"= | Expand embedded macros before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin =%<nop>CALC{}%= instead of the formula | Raw text | 
    3232     | =multiple="on"= | Multiple hits per topic. Each hit can be [[FormattedSearch][formatted]]. The last token is used in case of a regular expression ";" _and_ search | Only one hit per topic | 
    33      | =nofinalnewline="on"= | If =on=, the search variable does not end in a line by itself. Any text continuing immediately after the search variable on the same line will be rendered as part of the table generated by the search, if appropriate. | =off= | 
     33     | =nofinalnewline="on"= | If =on=, the search variable does not end in a line by itself. Any text continuing immediately after the SEARCH macro on the same line will be rendered as part of the table generated by the search, if appropriate. | =off= | 
    3434     | =recurse="on"= | Recurse into subwebs, if subwebs are enabled. | =off= | 
    3535     | =separator=", "= | Line separator _between_ search hits | ="$n"= (Newline) | 
    … …  
    3737   * Example: =%<nop>SEARCH{"wiki" web="%USERSWEB%" scope="topic"}%= 
    3838   * Example with format: =%<nop>SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="<nop>| $topic | $summary |"}%= _(displays results in a table with header - [[FormattedSearch][details]])_ 
    39    * %H% Hint: If the TWiki:Plugins.TablePlugin is installed, you may set a =%<nop>TABLE{}%= variable just before the =%<nop>SEARCH{}%= to alter the output of a search.  Example: =%<nop>TABLE{ tablewidth="90%" }%= 
     39   * %H% Hint: If the TWiki:Plugins.TablePlugin is installed, you may put a =%<nop>TABLE{}%= macro just before the =%<nop>SEARCH{}%= to alter the output of a search.  Example: =%<nop>TABLE{ tablewidth="90%" }%= 
    4040   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarMETASEARCH][METASEARCH]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarTOPICLIST][TOPICLIST]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWEBLIST][WEBLIST]], FormattedSearch, QuerySearch, SearchHelp, SearchPatternCookbook, RegularExpression 

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

    r692 r697  
    66   * Expands to: =%SERVERTIME%= 
    77   * Date format defined as {DefaultDateFormat} in [[%SCRIPTURLPATH{"configure"}%][configure]] 
    8    * __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details. 
     8   * __%X% Note:__ When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details. 
    99   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarDISPLAYTIME][DISPLAYTIME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarGMTIME][GMTIME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSERVERTIME2][SERVERTIME{"format"}]] 
    1010 

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

    r692 r697  
    66   * Syntax: =%<nop>SERVERTIME{"format"}%= 
    77   * Example: =%<nop>SERVERTIME{"$hou:$min"}%= expands to =%SERVERTIME{"$hou:$min"}%= 
    8    * __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details. 
     8   * __%X% Note:__ When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details. 
    99   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarDISPLAYTIME][DISPLAYTIME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarGMTIME][GMTIME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSERVERTIME][SERVERTIME]] 
    1010 

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

    r692 r697  
    66   * Syntax: =%<nop>SPACEDTOPIC%= 
    77   * Expands to: =%SPACEDTOPIC%= 
    8    * __%X% Note:__ This is a deprecated variable. It can be duplicated with =%<nop>ENCODE{%<nop>SPACEOUT{"%<nop>TOPIC%" separator=" *"}%}%= 
     8   * __%X% Note:__ This is a deprecated macro. It can be duplicated with =%<nop>ENCODE{%<nop>SPACEOUT{"%<nop>TOPIC%" separator=" *"}%}%= 
    99   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSPACEOUT][SPACEOUT]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarTOPIC][TOPIC]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarENCODE][ENCODE]] 
    1010 

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

    r692 r697  
    33#VarSTARTINCLUDE 
    44---+++ STARTINCLUDE -- start position of topic text if included 
    5    * If present in included topic, start to include text from this location up to the end, or up to the location of the =%<nop>STOPINCLUDE%= variable. A normal view of the topic shows everything exept the =%<nop>STARTINCLUDE%= variable itself. 
     5   * If present in included topic, start to include text from this location up to the end, or up to the location of the =%<nop>STOPINCLUDE%= macro. A normal view of the topic shows everything exept the =%<nop>STARTINCLUDE%= macro itself. 
    66   * __Note:__ If you want more than one part of the topic included, use =%<nop>STARTSECTION{type="include"}%= instead 
    77   * Syntax: =%<nop>STARTINCLUDE%= 

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

    r692 r697  
    33#VarSTOPINCLUDE 
    44---+++ STOPINCLUDE -- end position of topic text if included 
    5    * If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the =%<nop>STOPINCLUDE%= variable itself. 
     5   * If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the =%<nop>STOPINCLUDE%= macro itself. 
    66   * Syntax: =%<nop>STOPINCLUDE%= 
    77   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarINCLUDE][INCLUDE]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSTARTINCLUDE][STARTINCLUDE]] 

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

    r695 r697  
    1919      * URL parameters passed into HTML form fields must be entity [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarENCODE][ENCODEd]]. 
    2020      * Double quotes in URL parameters must be escaped when passed into other macros.%BR% Example: =%<nop>SEARCH{ "%<nop>URLPARAM{ "search" encode="quotes" }%" noheader="on" }%= 
    21       * When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details. 
     21      * When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details. 
    2222      * Watch out for TWiki internal parameters, such as =rev=, =skin=, =template=, =topic=, =web=; they have a special meaning in TWiki. Common parameters and view script specific parameters are documented at TWikiScripts. 
    2323      * If you have =%<nop>URLPARAM{= in the value of a URL parameter, it will be modified to =%&lt;nop&gt;URLPARAM{=. This is to prevent an infinite loop during expansion. 
    24       * There is a risk that this variable could be misused for cross-site scripting. 
     24      * There is a risk that this macro could be misused for cross-site scripting. 
    2525   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarENCODE][ENCODE]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarSEARCH][SEARCH]], FormattedSearch, [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarQUERYSTRING][QUERYSTRING]] 

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

    r692 r697  
    66   * Syntax: =%<nop>USERNAME%= 
    77   * Expands to: =%USERNAME%= 
    8    * __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details. 
     8   * __%X% Note:__ When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details. 
    99   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarREMOTEUSER][REMOTE_USER]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarUSERINFO][USERINFO]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWIKINAME][WIKINAME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWIKIUSERNAME][WIKIUSERNAME]], UserAuthentication 
    1010 

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

    r695 r697  
    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= variable 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/VarWIKINAME.txt

    r692 r697  
    66   * Syntax: =%<nop>WIKINAME%= 
    77   * Expands to: =%WIKINAME%= 
    8    * __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create  new topic. See TemplateTopics#TemplateTopicsVars for details. 
     8   * __%X% Note:__ When used in a template topic, this macro will be expanded when the template is used to create  new topic. See TemplateTopics#TemplateTopicsVars for details. 
    99   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarREMOTEUSER][REMOTE_USER]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarUSERINFO][USERINFO]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarUSERNAME][USERNAME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWIKIUSERNAME][WIKIUSERNAME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWIKIUSERSTOPIC][WIKIUSERSTOPIC]] 
    1010 

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

    r692 r697  
    66   * Syntax: =%<nop>WIKIUSERNAME%= 
    77   * Expands to: =%WIKIUSERNAME%=, renders as %WIKIUSERNAME% 
    8    * __%X% Note:__ When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details 
     8   * __%X% Note:__ When used in a template topic, this macro will be expanded when the template is used to create a new topic. See TemplateTopics#TemplateTopicsVars for details 
    99   * Related: [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarREMOTEUSER][REMOTE_USER]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarUSERINFO][USERINFO]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarUSERNAME][USERNAME]], [[%IF{"'%INCLUDINGTOPIC%'='Macros'" then="#"}%VarWIKINAME][WIKINAME]] 
    1010 

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

    r694 r697  
    1 %META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 17162 $"}% 
     1%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 15648 $"}% 
    22---+!! <nop>%WEB% Web Preferences 
    33 
    … …  
    2323      * The first header level to appear in the TOC: 
    2424         * Set TOC_MIN_DEPTH = 2 
     25      * Use auto linking for the TWiki documentation pages: 
     26         * Set NOAUTOLINK = 0 
    2527 
    2628   * Default template for *new topics* for this web: 
    2729      * WebTopicEditTemplate: Site-level default topic template 
    2830 
    29    * Comma separated list of *forms* that can be attached to topics in this web. See %SYSTEMWEB%.DataForms for more information. 
     31   * Comma separated list of *forms* that can be attached to topics in this web. See [[%SYSTEMWEB%.DataForms][DataForms]] for more information. 
    3032      * Set WEBFORMS = DefaultPreferencesForm 
    3133 

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

    r695 r697  
    66   * Preferences are used as [[%SYSTEMWEB%.Macros][Macros]] by enclosing the name in percent signs. Example: 
    77      * 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%= variable. 
     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. 
    99   * You can introduce your own preference settings and use them in your topics and templates. 
    1010 

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

    r481 r697  
    1 %META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 14617 $"}% 
     1%META:TOPICINFO{author="ProjectContributor" date="1111929255" format="1.0" version="$Rev: 13096 $"}% 
    22---+ Wiki name 
    33Your name, usually your first and last name connected without a space. 
    … …  
    77%X% Your name is also a potentially valid WikiWord when used within a topic. However the home pages of registered users on this site are stored in the *%USERSWEB%* web. When you sign your username in a topic, prefix it with =%USERSWEB%.= (including the dot). That is, write ==%USERSWEB%.%WIKINAME%== to link to %USERSWEB%.%WIKINAME%, your personal home page in the %USERSWEB% web. For convenience, your signature is also provided for copying and pasting when editing a topic. 
    88 
    9 %Y% Though rarely used in common practice, you can use the special ==%<nop>USERSWEB%== [[TWikiVariables][variable]] prefix for user names, for example, ==%<nop>USERSWEB%.%WIKINAME%==. 
     9%Y% Though rarely used in common practice, you can use the special ==%<nop>USERSWEB%== [[%SYSTEMWEB%.Macros][macro]] prefix for user names, for example, ==%<nop>USERSWEB%.%WIKINAME%==. 

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

    r695 r697  
    4444     =unformatted text!= %BR% 
    4545     =<b>&lt;/verbatim&gt;</b>= %BR%%BR% 
    46      __%X% NOTE:__ VARIABLES can be set within verbatim tags, that is, they are not disabled 
     46     __%X% NOTE:__ preferences can still be set within verbatim tags, that is, they are not disabled. This is a historical peculiarity. 
    4747 
    4848   * Use ==&lt;literal&gt;== to enclose anything that TWiki must not touch under any circumstances, such as in-line HTML code. 
Note: See TracChangeset for help on using the changeset viewer.