ipelets/decorator/README.md

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