ipelets/decorator/wiki.markdown

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