Templates.md

   1 ## Templates
   2
   3 See [online wiki](https://github.com/openwrt/luci/wiki/Templates) for latest version.
   4
   5 LuCI has a simple regex based template processor which parses HTML-files to Lua functions and allows to store precompiled template files.
   6 The simplest form of a template is just an ordinary HTML-file. It will be printed out to the user as is.
   7
   8 In LuCI every template is an object with an own scope
   9 It can therefore be instanced and each instance can have a different scope.
  10 As every template processor. LuCI supports several special markups. Those are enclosed in `<% %>`-Tags.
  11
  12 By adding `-` (dash) right after the opening `<%` every whitespace before the markup will be stripped.
  13 Adding a `-` right before the closing `%>` will equivalently strip every whitespace behind the markup.
  14
  15
  16 ## Builtin functions and markups
  17 ### Including Lua code
  18 *Markup:*
  19 ```
  20 <% code %>
  21 ```
  22
  23 ### Writing variables and function values
  24 *Syntax:*
  25 ```
  26 <% write (value) %>
  27 ```
  28
  29 *Short-Markup:*
  30 ```
  31 <%=value%>
  32 ```
  33
  34 ### Including templates
  35 *Syntax:*
  36 ```
  37 <% include (templatename) %>
  38 ```
  39
  40 *Short-Markup:*
  41 ```
  42 <%+templatename%>
  43 ```
  44
  45
  46 ### Translating
  47 *Syntax:*
  48 ```
  49 <%= translate("Text to translate") %>
  50 ```
  51
  52 *Short-Markup:*
  53 ```
  54 <%:Text to translate%>
  55 ```
  56
  57
  58 ### Commenting
  59 *Markup:*
  60 ```
  61 <%# comment %>
  62 ```
  63
  64 ## Builtin constants
  65 * `REQUEST_URI`: The current URL (without server part)
  66 * `controller`: Path to the Luci main dispatcher
  67 * `resource`: Path to the resource directory
  68 * `media`: Path to the active theme directory