ipelets/decorator/wiki.markdown

   1 # Decorator Ipelet #
   2
   3 With the decorator ipelet, you can decorate other objects (by for
   4 example surrounding them with a box).  The ipelet is flexible in the
   5 sense that you can define your own decorator objects.  The following
   6 example (click on the figure to download the ipe-file) illustrates the
   7 usage.
   8
   9 [![example](decorator.svg)](decorator.ipe)
  10
  11 # Download & Installation #
  12
  13 Download [decorator.lua](decorator.lua) and copy it to ~/.ipe/ipelets/
  14 (or to some other directory for ipelets).
  15
  16 # Usage #
  17
  18 Run "Ipelets->Decorator->decorate" to decorate the currently selected
  19 objects.  For that to work, there must be decorator objects (symbols
  20 with prefix "deco/") defined in your stylesheet (see the example
  21 above).
  22
  23 # Creating Decorator Objects #
  24
  25 To create your own decorator object, execute the following steps.
  26
  27 1. Create a rectangle, lets call it R.
  28 2. Create path objects, that decorate R (usually some kind of box
  29    around R).  You can use multiple objects for the decoration.
  30 3. Make sure that R is the front most object (select R and press
  31    Ctrl+F).
  32 4. Group R together with the decoration (select R and the decoration
  33    and press Ctrl+G).
  34 5. Run "Ipelets->Decorator->create deco-object".
  35
  36 Note that "Ipelets->Decorator->create deco-object" only slightly
  37 extends "Ipelets->Symbols->create symbol" (it checks whether the
  38 selected object can be used as decorator object and it automatically
  39 adds the prefix "deco/").
  40
  41 # Changes #
  42
  43 **14. October 2014**
  44 first version of the decorator ipelet online