docs/package/pip/smiley.md

   1 # Smiley Package Installation Plugin
   2
   3 Installs new smileys.
   4
   5 ## Components
   6
   7 Each smiley is described as an `<smiley>` element with the mandatory attribute `name`.
   8
   9 ### `<title>`
  10
  11 Short human readable description of the smiley.
  12
  13 ### `<path(2x)?>`
  14
  15 !!! warning "The files must be installed using the [file](file.md) PIP."
  16
  17 File path relative to the root of WoltLab Suite Core.
  18 `path2x` is optional and being used for High-DPI screens.
  19
  20 ### `<aliases>`
  21
  22 <span class="label label-info">Optional</span>
  23
  24 List of smiley aliases.
  25 Aliases must be separated by a line feed character (`\n`, U+000A).
  26
  27 ### `<showorder>`
  28
  29 <span class="label label-info">Optional</span>
  30
  31 Determines at which position of the smiley list the smiley is shown.
  32
  33 ## Example
  34
  35 {jinja{ codebox(
  36   title="smiley.xml",
  37   language="xml",
  38   filepath="package/pip/smiley.xml"
  39 ) }}