|go text: || - [ features ~ ] - ToDo -
||topics: || - [ expandvars ] - updatevars - simplevars - attribvars - printerfriendly - sitemapstyle - filelist -

expandvars = direct comment variables


   <!--mksite:expandvars--> 
   <!--mksite:noexpandvars--> 

The option can be selected in the sitefile, per default we do expand direct comment variables. <!--mksite:nocommentvars--> disables this feature as well.

   input: some <!--$varname--> text
  output: some Value text
 default: some  text

   input: some <!--added $varname--> text
  output: some added Value text
 default: some  text

   input: section <!--of $varname?--> !
  output: section of value !
 default: section !

   input: section <!--$varname?--> !
  output: section - value !
  output: section (value) !
 default: section !

This is the preferred method of expanding variables. They are invisible in the source htm file. They add some text to the result. The variant expansions can be selected via "?" after the variable name. The variant expansion has always (a) the lowercased variant of the original value and (b) any markup removed from the original value. That makes it most usueful to be pasted into <title> tag contents.

The direct usage of the variant name (without even some whitspace inside the comment markup) makes for an additional modification where the variant is usually (a) hyphenated for toplevel variables or (b) parenthesed for secondary variables. The toplevel variables are "DC.title" and "DC.author" that can be selected as "$title" and "$author". The secondary variables are usually those of "DC.date", e.g. "DC.date.modified" and "DC.date.issued" that can be selected as "$modified" and "$issued".

The specification of variants stems from times when there was no complex expansion of variables available that would allow additional formatting within the comment box. See the simplevars for those. Therefore the most common formatting was done in the mksite.sh script making for the usual editing of those values. The variant expansions have survived can still be used in that mode and make sometimes for a little shorter input text, e.g. for <title> content specs.