Changes between Version 3 and Version 4 of uste/ParserSyntax


Ignore:
Timestamp:
02/03/13 15:44:23 (11 years ago)
Author:
ph3-der-loewe
Comment:

+ Encodings

Legend:

Unmodified
Added
Removed
Modified

  • uste/ParserSyntax

    v3 v4  
    2525So software like web servers can detect the file to be a uste template there is the uste magic number. This magic is the special command ''TEMPLATE'' (@@@TEMPLATE@@@). This magic should be used at the begin of each template so it can be detected by such software. This special command is stripped while rendering and will not generate any output. 
    2626 
     27== Encodings == 
     28Encodings are ways to render data. Whenever a variable is printed the encoding can be set. 
     29The following encodings exist as of writing this document: 
     30* ''literal'' (default): The variable is printed unprocessed. 
     31* ''html'': The variable is processed in a way characters with special meanings in HTML are escaped. 
     32* ''xml'': The variable is processed in a way characters with special meanings in XML are escaped. 
     33* ''uri'': The variable is processed in way it could be used within an URL (e.g. `"file?name=@@@var name as uri@@@"`). 
     34* ''int'': An integer representation of the variable is printed. 
     35* ''numeric'': An numeric representation of the variable is printed. 
     36* ''hex'': An base 16 representation is printed. 
     37* ''discid'': CDDB DiscID representation as used by the RoarAudio PlayList Daemon. 
     38* ''uuid'': UUID in dashed-hex format. 
     39 
    2740== Basic command syntax == 
    2841Each command is started and ended with ''@@@'' if not in uste mode. The first word of the command is the command name. In addition command parameters can follow. After the parameters there can be the ''extra'' parameter which is always a string literal.