State Variables
Wiki state variables are used to set flags and values across an entire book. State variables are defined by the wiki engine and/or plugins. They are typically used to provides flags when parsing or rendering a wiki page. For example, should the title of the page be included on the page? or should the page navigation be included on the page?
wiki module
\set{name}{value}
\use{name}
Sets the state variable for a given wiki page or includes the value of a state variable within the document.
\set{title}{off}
\set{pagenav}{on}
Arguments:
- name
-
The name of the state variable. This must match the predefined wiki state variables or a plugin state variable. The predefined wiki states are provided below:
variable Description title pagenav pageheader pagefooter pagenav pagetrail pagetoc chaptitle chapicon bookicon - value
-
The value that the state variable is set to. For Boolean states, the value can be either on or true to turn on the state or off or false to turn off the state.
Plugin: StateVariable