Menu
▾
▴
[TWiki-Dev] [SVN] SopanShewale r17799 - in twiki/branches/TWikiRelease04x02: data/TWiki twikiplugins/TWikiUserMappingContrib/data/TWiki
|
From: <de...@de...> - 2009-01-30 09:51:31
|
Author: SopanShewale Date: 2009-01-30 03:51:27 -0600 (Fri, 30 Jan 2009) New Revision: 17799 Trac url: http://develop.twiki.org/trac/changeset/17799 Modified: twiki/branches/TWikiRelease04x02/data/TWiki/TWikiTemplates.txt twiki/branches/TWikiRelease04x02/data/TWiki/VarENDSECTION.txt twiki/branches/TWikiRelease04x02/data/TWiki/VarSTARTSECTION.txt twiki/branches/TWikiRelease04x02/twikiplugins/TWikiUserMappingContrib/data/TWiki/NewUserTemplate.txt Log: Item3647: Usability: Control over variable expansion in topic templates - adding document Modified: twiki/branches/TWikiRelease04x02/data/TWiki/TWikiTemplates.txt =================================================================== --- twiki/branches/TWikiRelease04x02/data/TWiki/TWikiTemplates.txt 2009-01-29 04:20:50 UTC (rev 17798) +++ twiki/branches/TWikiRelease04x02/data/TWiki/TWikiTemplates.txt 2009-01-30 09:51:27 UTC (rev 17799) @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="TWikiContributor" date="1210999363" format="1.1" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1233237220" format="1.1" version="$Rev$"}% %STARTINCLUDE% ---+ TWiki Templates @@ -155,8 +155,10 @@ 1 <nop>WebTopicEditTemplate in the %SYSTEMWEB% web #TemplateTopicsVars ----+++ Variable Expansion +---+++ Control over Variable Expansion +---++++ List of default variables eligible for Expansion + When the following variables are used in a template topic, they automatically get expanded when new topic is created based on it: | *Variable:* | *Description:* | @@ -183,8 +185,43 @@ =%<nop>NOP%= can be used to prevent expansion of TWiki variables that would otherwise be expanded during topic creation e.g.i escape =%<nop>SERVERTIME%= with =%<nop>SER%<nop>NOP%VERTIME%=. -All other variables are unchanged, e.g. are carried over "as is" into the new topic. +---++++ Forcefully expanding variables +You can forcefully expand variables from section of template content into the topics using syntax similar to +<verbatim> +%STARTSECTION{ type="expandvariables" }% ... %ENDSECTION{ type="expandvariables" }% +</verbatim> + +Example: + +If you add following content in template for topic creation +<verbatim> + +%STARTSECTION{ type="expandvariables" }% + * %TWIKIWEB%.ATasteOfTWiki - view a short introductory presentation on TWiki for beginners + * %TWIKIWEB%.WelcomeGuest - starting points on TWiki + * %TWIKIWEB%.TWikiUsersGuide - complete TWiki documentation, Quick Start to Reference + * Sandbox.%HOMETOPIC% - try out TWiki on your own + * Sandbox.%TOPIC%Sandbox - just for me +%ENDSECTION{ type="expandvariables" }% + +</verbatim> + +this can get expanded to + +<verbatim> + * TWiki.ATasteOfTWiki - view a short introductory presentation on TWiki for beginners + * TWiki.WelcomeGuest - starting points on TWiki + * TWiki.TWikiUsersGuide - complete TWiki documentation, Quick Start to Reference + * Sandbox.WebHome - try out TWiki on your own + * Sandbox.JimmyNewtronSandbox - just for me + +</verbatim> + +in the topic. + +Any variables which is not added into section similar to above or the variable is not from the default list (eligible for expansion) is never expanded in the topic content. + ---+++ Specifying a Form When you create a new topic based on a template, you often want the new topic to have a form attached to it. You can attach a form to the template topic, in which case it will be copied into the new topic. @@ -246,4 +283,5 @@ __Related Topics:__ TWikiSkins, DeveloperDocumentationCategory, AdminDocumentationCategory %STOPINCLUDE% --- __Contributors:__ TWiki:Main.PeterThoeny, TWiki:Main.MikeMannix, TWiki:Main.DavidLeBlanc, TWiki:Main.CrawfordCurrie +-- __Contributors:__ TWiki:Main.PeterThoeny, TWiki:Main.MikeMannix, TWiki:Main.DavidLeBlanc, TWiki:Main.CrawfordCurrie, TWiki:Main.SopanShewale + Modified: twiki/branches/TWikiRelease04x02/data/TWiki/VarENDSECTION.txt =================================================================== --- twiki/branches/TWikiRelease04x02/data/TWiki/VarENDSECTION.txt 2009-01-29 04:20:50 UTC (rev 17798) +++ twiki/branches/TWikiRelease04x02/data/TWiki/VarENDSECTION.txt 2009-01-30 09:51:27 UTC (rev 17799) @@ -1,13 +1,13 @@ -%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.1" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1233237974" format="1.1" version="$Rev$"}% %META:TOPICPARENT{name="TWikiVariables"}% #VarENDSECTION ---+++ ENDSECTION{"name"} -- marks the end of a named section within a topic * Syntax: =%<nop>ENDSECTION{"name"}%= * Syntax: =%<nop>ENDSECTION{type="include"}%= + * Syntax: =%<nop>ENDSECTION{type="expandvariables"}%= * Supported parameter: | *Parameter:* | *Description:* | | ="name"= | Name of the section. | - | =type="..."= | Type of the section being terminated; supported types ="section"=, ="include"=, ="templateonly"=. | + | =type="..."= | Type of the section being terminated; supported types ="section"=, ="include"=, ="templateonly"=, ="expandvariables"= | * If the =STARTSECTION= is named, the corresponding =ENDSECTION= must also be named with the same name. If the =STARTSECTION= specifies a type, then the corresponding =ENDSECTION= must also specify the same type. If the section is unnamed, =ENDSECTION= will match with the nearest unnamed =%<nop>STARTSECTION%= *of the same type* above it. * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSTARTSECTION][STARTSECTION]] - Modified: twiki/branches/TWikiRelease04x02/data/TWiki/VarSTARTSECTION.txt =================================================================== --- twiki/branches/TWikiRelease04x02/data/TWiki/VarSTARTSECTION.txt 2009-01-29 04:20:50 UTC (rev 17798) +++ twiki/branches/TWikiRelease04x02/data/TWiki/VarSTARTSECTION.txt 2009-01-30 09:51:27 UTC (rev 17799) @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.1" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1233237850" format="1.1" version="$Rev$"}% %META:TOPICPARENT{name="TWikiVariables"}% #VarSTARTSECTION ---+++ STARTSECTION -- marks the start of a section within a topic @@ -7,14 +7,15 @@ * =type="section"= - the default, used for a generic section, such as a named section used by [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarINCLUDE][INCLUDE]]. * =type="include"= - like =%<nop>STARTINCLUDE%= ... =%<nop>STOPINCLUDE%= except that you can have as many include blocks as you want (=%<nop>STARTINCLUDE%= is restricted to only one). * =type="templateonly"= - start position of text to be removed when a template topic is used. This is used to embed text that you _do not_ want expanded when a new topic based on the template topic is created. See TWikiTemplates for more information. + * =type="expandvariables"= -This can be used if you want to expand the variables enclosed within the section defined with this type when new topic is created using the template. Please see TWikiTemplates for more information * Syntax: =%<nop>STARTSECTION{"name"}% ................ %<nop>ENDSECTION{"name"}%= * Syntax: =%<nop>STARTSECTION{type="include"}% ........ %<nop>ENDSECTION{type="include"}%= * Syntax: =%<nop>STARTSECTION{type="templateonly"}% ... %<nop>ENDSECTION{type="templateonly"}%= + * Syntex: =%<nop>STARTSECTION{type="expandvariables"}% ... %<nop>ENDSECTION{type="expandvariables"}%= * Supported parameters: | *Parameter:* | *Description:* | *Default* | | ="name"= | Name of the section. Must be unique inside a topic. | Generated name | - | =type="..."= | Type of the section; type ="section"=, ="include"= or ="templateonly"= | ="section"= | + | =type="..."= | Type of the section; type ="section"=, ="include"=, ="templateonly"=, or ="expandvariables"= | ="section"= | * __%X% Note:__ If a section is not given a name, it will be assigned one. Unnamed sections are assigned names starting with =_SECTION0= for the first unnamed section in the topic, =_SECTION1= for the second, etc.. * __%X% Note:__ You can define nested sections. It is not recommended to overlap sections, although it is valid in TWiki. Use named sections to make sure that the correct START and ENDs are matched. Section markers are *not* displayed when a topic is viewed. * Related: [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarENDSECTION][ENDSECTION]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarINCLUDE][INCLUDE]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarNOP][NOP]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSTARTINCLUDE][STARTINCLUDE]], [[%IF{"'%INCLUDINGTOPIC%'='TWikiVariables'" then="#"}%VarSTOPINCLUDE][STOPINCLUDE]] - Modified: twiki/branches/TWikiRelease04x02/twikiplugins/TWikiUserMappingContrib/data/TWiki/NewUserTemplate.txt =================================================================== --- twiki/branches/TWikiRelease04x02/twikiplugins/TWikiUserMappingContrib/data/TWiki/NewUserTemplate.txt 2009-01-29 04:20:50 UTC (rev 17798) +++ twiki/branches/TWikiRelease04x02/twikiplugins/TWikiUserMappingContrib/data/TWiki/NewUserTemplate.txt 2009-01-30 09:51:27 UTC (rev 17799) @@ -1,9 +1,11 @@ -%META:TOPICINFO{author="TWikiContributor" date="1167346194" format="1.0" version="$Rev$"}% +%META:TOPICINFO{author="TWikiContributor" date="1233235567" format="1.1" version="$Rev$"}% %SPLIT% * %KEY%: %VALUE%%SPLIT% ---++ My Links +%STARTSECTION{ type="expandvariables" }% + * %TWIKIWEB%.ATasteOfTWiki - view a short introductory presentation on TWiki for beginners * %TWIKIWEB%.WelcomeGuest - starting points on TWiki * %TWIKIWEB%.TWikiUsersGuide - complete TWiki documentation, Quick Start to Reference @@ -11,7 +13,10 @@ * Sandbox.%TOPIC%Sandbox - just for me * * +%ENDSECTION{ type="expandvariables" }% + + ---++ My Personal Data Note: if personal data is being stored using a secret database, then it is only visible to the user and to administrators. @@ -87,7 +92,8 @@ * %MAKETEXT{"[_1] lists all TWiki user tools" args="%TWIKIWEB%.UserToolsCategory"}% %ENDSECTION{type="templateonly"}% -%META:FORM{name="%TWIKIWEB%.UserForm"}% + +%META:FORM{name="%25TWIKIWEB%25.UserForm"}% %META:FIELD{name="FirstName" attributes="" title="<nop>FirstName" value=""}% %META:FIELD{name="LastName" attributes="" title="<nop>LastName" value=""}% %META:FIELD{name="OrganisationName" attributes="" title="<nop>OrganisationName" value=""}% |