From: <de...@de...> - 2006-10-16 01:59:27
|
Author: PeterThoeny Date: 2006-10-15 08:28:37 -0500 (Sun, 15 Oct 2006) New Revision: 11723 Modified: twiki/branches/MAIN/data/TWiki/TWikiPreferences.txt twiki/branches/MAIN/data/TWiki/TWikiRenderingShortcut.txt twiki/branches/MAIN/data/TWiki/TWikiVariables.txt twiki/branches/MAIN/data/TWiki/VarBB.txt twiki/branches/MAIN/data/TWiki/VarBB2.txt twiki/branches/MAIN/data/TWiki/VarBB3.txt twiki/branches/MAIN/data/TWiki/VarBB4.txt twiki/branches/MAIN/data/TWiki/VarBR.txt twiki/branches/MAIN/data/TWiki/VarBULLET.txt Log: Item2553: Cleaning up TWiki variables Modified: twiki/branches/MAIN/data/TWiki/TWikiPreferences.txt =================================================================== --- twiki/branches/MAIN/data/TWiki/TWikiPreferences.txt 2006-10-14 17:29:09 UTC (rev 11722) +++ twiki/branches/MAIN/data/TWiki/TWikiPreferences.txt 2006-10-15 13:28:37 UTC (rev 11723) @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="TWikiContributor" date="1155085246" format="1.1" version="$Rev $"}% +%META:TOPICINFO{author="TWikiContributor" date="1160958216" format="1.1" version="$Rev $"}% ---+!! <nop>%WIKITOOLNAME% Site-Level Preferences This topic defines __site-level__ settings that apply to all users and webs on this TWikiSite. @@ -208,6 +208,7 @@ * Set DISABLEDPLUGINS = The DISABLEDPLUGINS variable is no longer supported * Set INSTALLEDPLUGINS = The INSTALLEDPLUGINS variable is no longer supported. You can set the Plugins execution order using the [[%SCRIPTURLPATH{"configure"}%][configure]] interface. +#RenderingShortcuts ---++ Rendering Shortcuts Settings * Line break: @@ -216,7 +217,7 @@ * Bullet sign: * Set BULLET = • - * %VBAR% symbol: + * Vertical bar / pipe symbol: * Set VBAR = | * Line break and bullet with different levels of indentation: @@ -225,6 +226,22 @@ * Set BB3 = <br /> • * Set BB4 = <br /> • + * __Hint:__ Above shortcuts are useful in TWiki tables where you cannot use newlines + +#DocGraphics + * Graphics used in TWiki documentation - view all images in %ICONTOPIC%. _(There are various ways to set up common icons as text variables. This is simply one quick approach.)_: + * Set H = <img src="%ICONURLPATH{help}%" alt="HELP" title="HELP" width="16" height="16" border="0" /> + * Set I = <img src="%ICONURLPATH{tip}%" alt="IDEA!" title="IDEA!" width="16" height="16" border="0" /> + * Set M = <img src="%ICONURLPATH{arrowright}%" alt="MOVED TO..." title="MOVED TO..." width="16" height="16" border="0" /> + * Set N = <img src="%ICONURLPATH{new}%" alt="NEW" title="NEW" width="30" height="16" border="0" /> + * Set P = <img src="%ICONURLPATH{pencil}%" alt="REFACTOR" title="REFACTOR" width="16" height="16" border="0" /> + * Set Q = <img src="%ICONURLPATH{help}%" alt="QUESTION?" title="QUESTION?" width="16" height="16" border="0" /> + * Set S = <img src="%ICONURLPATH{starred}%" alt="PICK" title="PICK" width="16" height="16" border="0" /> + * Set T = <img src="%ICONURLPATH{tip}%" alt="TIP" title="TIP" width="16" height="16" border="0" /> + * Set U = <img src="%ICONURLPATH{updated}%" alt="UPDATED" title="UPDATED" width="55" height="16" border="0" /> + * Set X = <img src="%ICONURLPATH{warning}%" alt="ALERT!" title="ALERT!" width="16" height="16" border="0" /> + * Set Y = <img src="%ICONURLPATH{choice-yes}%" alt="DONE" title="DONE" width="16" height="16" border="0" /> + * Colored text: (see more StandardColors) | You type: | =%<nop>RED% red text %<nop>ENDCOLOR% and %<nop>GREEN% green text %<nop>ENDCOLOR%= | | You get: | %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR% | @@ -271,21 +288,6 @@ * Set ENDCOLOR = </font> </verbatim> -#DocGraphics - * Graphics used in TWiki documentation - view all images in %ICONTOPIC%. _(There are various ways to set up common icons as text variables. This is simply one quick approach.)_: - * Set H = <img src="%ICONURLPATH{help}%" alt="HELP" title="HELP" width="16" height="16" border="0" /> - * Set I = <img src="%ICONURLPATH{tip}%" alt="IDEA!" title="IDEA!" width="16" height="16" border="0" /> - * Set M = <img src="%ICONURLPATH{arrowright}%" alt="MOVED TO..." title="MOVED TO..." width="16" height="16" border="0" /> - * Set N = <img src="%ICONURLPATH{new}%" alt="NEW" title="NEW" width="30" height="16" border="0" /> - * Set P = <img src="%ICONURLPATH{pencil}%" alt="REFACTOR" title="REFACTOR" width="16" height="16" border="0" /> - * Set Q = <img src="%ICONURLPATH{help}%" alt="QUESTION?" title="QUESTION?" width="16" height="16" border="0" /> - * Set S = <img src="%ICONURLPATH{starred}%" alt="PICK" title="PICK" width="16" height="16" border="0" /> - * Set T = <img src="%ICONURLPATH{tip}%" alt="TIP" title="TIP" width="16" height="16" border="0" /> - * Set U = <img src="%ICONURLPATH{updated}%" alt="UPDATED" title="UPDATED" width="55" height="16" border="0" /> - * Set X = <img src="%ICONURLPATH{warning}%" alt="ALERT!" title="ALERT!" width="16" height="16" border="0" /> - * Set Y = <img src="%ICONURLPATH{choice-yes}%" alt="DONE" title="DONE" width="16" height="16" border="0" /> - - ---++ Miscellaneous Settings * Background color of non existing topic: ( default =cornsilk= or =#FFFFCE= ) @@ -298,9 +300,9 @@ * Set PREVIEWBGIMAGE = %PUBURLPATH%/%TWIKIWEB%/PreviewBackground/preview2bg.gif * User-friendly synonyms for MAINWEB and TWIKIWEB - * Set USERSWEB = %MAINWEB% - * Set SYSTEMWEB = %TWIKIWEB% - * Set DOCWEB = %TWIKIWEB% + * Set USERSWEB = %MAINWEB% + * Set SYSTEMWEB = %TWIKIWEB% + * Set DOCWEB = %TWIKIWEB% ---++ Access Control Settings Modified: twiki/branches/MAIN/data/TWiki/TWikiRenderingShortcut.txt =================================================================== --- twiki/branches/MAIN/data/TWiki/TWikiRenderingShortcut.txt 2006-10-14 17:29:09 UTC (rev 11722) +++ twiki/branches/MAIN/data/TWiki/TWikiRenderingShortcut.txt 2006-10-15 13:28:37 UTC (rev 11723) @@ -1,17 +1,16 @@ -%META:TOPICINFO{author="TWikiContributor" date="1152050131" format="1.2" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1160951440" format="1.2" version="$Rev$"}% %META:TOPICPARENT{name="TWikiPreferences"}% ----+++ Rendering Shortcuts -- easy ways to save some typing +---+ Rendering Shortcuts +_Easy ways to save some typing_ -Some TWiki preferences are just shortcuts for convenience, to either -save typing or to easily allow line breaks in format strings and the like. -These variables are not intended to be customized, though it is not -forbidden to do so. Your mileage will vary. +Some TWiki preferences variables are just shortcuts for convenience, to either save typing or to easily allow line breaks in format strings and the like. These variables are not intended to be customized, though it is not forbidden to do so. - *The following variables are classified as rendering shortcuts:* -%SEARCH{"Type:.*TWikiRenderingShortcut" type="regex" topic="Var*" format=" * $topic" nonoise="on"}% +%SEARCH{ "Type:.*TWikiRenderingShortcut" type="regex" topic="Var*" +format=" * [[$topic][%<nop>$pattern(.*?\-\++ *([^ ]*).*)%]] - $pattern(.*?\-\+.*?-- ([^\n\r]*).*)" nonoise="on" }% -*See also:* +__See also:__ * TWikiVariables - an alphabetical list of all variables - * TWikiPreferences - where rendering shortcuts are defined + * TWikiPreferences#RenderingShortcuts - where rendering shortcuts are defined + * TWikiShorthand - summary of the TWiki markup language Modified: twiki/branches/MAIN/data/TWiki/TWikiVariables.txt =================================================================== --- twiki/branches/MAIN/data/TWiki/TWikiVariables.txt 2006-10-14 17:29:09 UTC (rev 11722) +++ twiki/branches/MAIN/data/TWiki/TWikiVariables.txt 2006-10-15 13:28:37 UTC (rev 11723) @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="TWikiContributor" date="1142799790" format="1.0" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1160958216" format="1.0" version="$Rev$"}% %META:TOPICPARENT{name="WebHome"}% %TOC% %STARTSECTION{type="include"}% @@ -15,7 +15,7 @@ To use a variable type its name. For example, * type =%<nop>T%= to get %T% (a preferences variable) * type =%<nop>TOPIC%= to get =%TOPIC%= (a predefined variable) - * type =%<nop>CALC{ "$UPPER(Text)" }%= to get =TEXT= (a variable defined by Plugin) + * type =%<nop>CALC{ "$UPPER(Text)" }%= to get =TEXT= (a variable defined by a plugin) __Note:__ * To leave a variable unexpanded, precede it with an exclamation point, e.g. type =!%<nop>TOPIC%= to get =%<nop>TOPIC%= @@ -25,7 +25,7 @@ ---++ Variable Names Variable names must start with a letter. The following characters can be letters, numbers and the underscore '_'. You can use both upper-case and lower-case letters and you can mix the characteres. E.g. =%<nop>MYVAR%=, =%<nop>MyVar%=, =%<nop>My2ndVar%=, and =%<nop>My_Var%= are all valid variable names. Variables are case sensitive. =%<nop>MyVAR%= and =%<nop>MYVAR%= are not the same variable. -By convention all settings, predefined variables and variables used by plugins are always UPPER-CASE. +By convention all settings, predefined variables and variables used by plugins are always UPPERCASE. #SettingPrefs #PreferencesVariables @@ -87,7 +87,7 @@ ---+++ Frequently Used Preferences Variables -The following preferences variables are frequently used. They are defined in TWikiPreferences#Miscellaneous_Settings: +The following preferences variables are frequently used. They are defined in TWikiPreferences#RenderingShortcuts: * =%<nop>BR%= - line break * =%<nop>BULLET%= - bullet sign * =%<nop>BB%= - line break and bullet combined Modified: twiki/branches/MAIN/data/TWiki/VarBB.txt =================================================================== --- twiki/branches/MAIN/data/TWiki/VarBB.txt 2006-10-14 17:29:09 UTC (rev 11722) +++ twiki/branches/MAIN/data/TWiki/VarBB.txt 2006-10-15 13:28:37 UTC (rev 11723) @@ -1,16 +1,8 @@ -%META:TOPICINFO{author="TWikiContributor" date="1152050427" format="1.2" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1160951440" format="1.2" version="$Rev$"}% %META:TOPICPARENT{name="TWikiPreferences"}% #VarBB -#VarBB2 -#VarBB3 -#VarBB4 ----+++ BB, BB2, BB3, BB4 -- bullets with different levels of indentation +---+++ BB -- bullet with line break - -Line break and bullet with different levels of indentation. +Line break and bullet without indentation. * Type: Preference variable - TWikiRenderingShortcut. * Current value: BB = %BB% - * Current value: BB2 = %BB2% - * Current value: BB3 = %BB3% - * Current value: BB4 = %BB4% - Modified: twiki/branches/MAIN/data/TWiki/VarBB2.txt =================================================================== --- twiki/branches/MAIN/data/TWiki/VarBB2.txt 2006-10-14 17:29:09 UTC (rev 11722) +++ twiki/branches/MAIN/data/TWiki/VarBB2.txt 2006-10-15 13:28:37 UTC (rev 11723) @@ -1,11 +1,8 @@ -%META:TOPICINFO{author="TWikiContributor" date="1152047758" format="1.2" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1160951440" format="1.2" version="$Rev$"}% %META:TOPICPARENT{name="VarBB"}% #VarBB2 ----+++ BB2 -- level 2 bullet +---+++ BB2 -- level 2 bullet with line break -%STARTINCLUDE% -<!-- intentionally nothing to be included --> -%STOPINCLUDE% Line break and bullet, level 2. * Type: Preference variable - TWikiRenderingShortcut. * Current value: BB2 = %BB2% Modified: twiki/branches/MAIN/data/TWiki/VarBB3.txt =================================================================== --- twiki/branches/MAIN/data/TWiki/VarBB3.txt 2006-10-14 17:29:09 UTC (rev 11722) +++ twiki/branches/MAIN/data/TWiki/VarBB3.txt 2006-10-15 13:28:37 UTC (rev 11723) @@ -1,11 +1,8 @@ -%META:TOPICINFO{author="TWikiContributor" date="1152047758" format="1.2" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1160951440" format="1.2" version="$Rev$"}% %META:TOPICPARENT{name="VarBB"}% #VarBB3 ----+++ BB3 -- level 3 bullet +---+++ BB3 -- level 3 bullet with line break -%STARTINCLUDE% -<!-- intentionally nothing to be included --> -%STOPINCLUDE% Line break and bullet, level 3. * Type: Preference variable - TWikiRenderingShortcut. * Current value: BB3 = %BB3% Modified: twiki/branches/MAIN/data/TWiki/VarBB4.txt =================================================================== --- twiki/branches/MAIN/data/TWiki/VarBB4.txt 2006-10-14 17:29:09 UTC (rev 11722) +++ twiki/branches/MAIN/data/TWiki/VarBB4.txt 2006-10-15 13:28:37 UTC (rev 11723) @@ -1,11 +1,8 @@ -%META:TOPICINFO{author="TWikiContributor" date="1152047758" format="1.2" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1160951440" format="1.2" version="$Rev$"}% %META:TOPICPARENT{name="VarBB"}% #VarBB4 ----+++ BB4 -- level 4 bullet +---+++ BB4 -- level 4 bullet with line break -%STARTINCLUDE% -<!-- intentionally nothing to be included --> -%STOPINCLUDE% Line break and bullet, level 4. * Type: Preference variable - TWikiRenderingShortcut. * Current value: BB4 = %BB4% Modified: twiki/branches/MAIN/data/TWiki/VarBR.txt =================================================================== --- twiki/branches/MAIN/data/TWiki/VarBR.txt 2006-10-14 17:29:09 UTC (rev 11722) +++ twiki/branches/MAIN/data/TWiki/VarBR.txt 2006-10-15 13:28:37 UTC (rev 11723) @@ -1,8 +1,7 @@ -%META:TOPICINFO{author="TWikiContributor" date="1152047758" format="1.2" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1160951440" format="1.2" version="$Rev$"}% %META:TOPICPARENT{name="TWikiPreferences"}% #VarBR ----+++ BR -- shortcut for line break +---+++ BR -- line break - * Type: Preference variable - TWikiRenderingShortcut. * Current value: BR = %BR% Modified: twiki/branches/MAIN/data/TWiki/VarBULLET.txt =================================================================== --- twiki/branches/MAIN/data/TWiki/VarBULLET.txt 2006-10-14 17:29:09 UTC (rev 11722) +++ twiki/branches/MAIN/data/TWiki/VarBULLET.txt 2006-10-15 13:28:37 UTC (rev 11723) @@ -3,6 +3,5 @@ #VarBULLET ---+++ BULLET -- bullet character - * Type: Preference variable - TWikiRenderingShortcut. * Current value: BULLET = %BULLET% |