SET{"name" value="..."} -- set a variable
- Set a named variable that can be retrieved later with
%GET{}%
. No output is shown, e.g.%SET{}%
resolves to an empty string. It is also possible to set a JSON object using a JSON path. The%SET{}%
and%GET{}%
variables are handled by the SetGetPlugin. - Syntax:
%SET{ "name" value="..." remember="1" }%
- Parameters:
Parameter Description Default "name"
Name of variable. Alphanumeric characters, dashes and underscores can be used. (required) remember="1"
If set, the variable will be stored persistently so that it can be used later in any TWiki topic. Alternatively use the store
parameter. See important notes."0"
store="..."
Specify a store name to persistently store the variable, such as store="Parts"
. Use alphanumeric characters, dashes and underscores for the name. For better performance, store is preferred over the remember parameter if you need to store a large dataset. See important notes.""
value="..."
Value of variable. Escape double quotes with backslash. (required, may be empty) - Example:
%SET{"lunch" value="Sushi"}%
- see more examples. - JSON Syntax:
%SET{ name = { ... } remember="1" }%
- see description.- An optional
remember="1"
orstore="..."
parameter can be appended. If specified, the JSON object will be stored persistently so that it can be used later in any TWiki topic.
- An optional
- Example to set, modify and get a JSON object:
-
%SET{ menu = { "File": { "New": [ "new", "F" ], "Open": [ "open", "F" ] }, "Edit": { "Copy": [ "cpy", "F" ], "Paste": [ "pst", "F" ] } } }%
- set a JSON object -
%GET{ menu }%
- returns:{"File":{"New":["new","F"],"Open":["open","F"]},"Edit":{"Copy":["cpy","F"],"Paste":["pst","F"]}}
-
%SET{ menu.File.Open[1] = "T" }%
- modify a JSON object -
%GET{ menu }%
- returns:{"File":{"New":["new","F"],"Open":["open","T"]},"Edit":{"Copy":["cpy","F"],"Paste":["pst","F"]}}
-
%SET{ menu.Edit.Cut = [ "cut", "T" ] }%
- add to a JSON object -
%GET{ menu }%
- returns:{"File":{"New":["new","F"],"Open":["open","T"]},"Edit":{"Copy":["cpy","F"],"Paste":["pst","F"],"Cut":["cut","T"]}}
-
- Category: ApplicationsAndComponentsVariables, DevelopmentVariables
- Related: GET, IF, SETGETDUMP, SetGetPlugin, SpreadSheetPlugin