From: Thomas Bläsius Date: Wed, 26 Aug 2015 11:54:35 +0000 (+0200) Subject: updated readme for decorator X-Git-Url: https://i11git.iti.kit.edu/anon-gitweb/?p=Misc%2Fipe.git;a=commitdiff_plain;h=6c8cb0a57827765ae853889a0843c0fea70a8447 updated readme for decorator --- diff --git a/ipelets/decorator/README.md b/ipelets/decorator/README.md new file mode 100644 index 0000000..c8141eb --- /dev/null +++ b/ipelets/decorator/README.md @@ -0,0 +1,37 @@ +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 ([Ipe file](decorator.ipe)) illustrates the usage. + +![Decorator examples](decorator.png) + +# Download & Installation # + +Download [decorator.lua](decorator.lua) and copy it to ~/.ipe/ipelets/ +(or to some other directory for ipelets). + +# Usage # + +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). + +# Creating Decorator Objects # + +To create your own decorator object, execute the following steps. + +1. Create a rectangle, lets call it R. +2. Create path objects, that decorate R (usually some kind of box around R). You can use multiple objects for the decoration. +3. Make sure that R is the front most object (select R and press Ctrl+F). +4. Group R together with the decoration (select R and the decoration and press Ctrl+G). +5. Run "Ipelets->Decorator->create deco-object". + +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/"). + +# Changes # + +**14. October 2014** +first version of the decorator ipelet online diff --git a/ipelets/decorator/decorator.png b/ipelets/decorator/decorator.png new file mode 100644 index 0000000..fe5e4f5 Binary files /dev/null and b/ipelets/decorator/decorator.png differ diff --git a/ipelets/decorator/wiki.markdown b/ipelets/decorator/wiki.markdown deleted file mode 100644 index aaec204..0000000 --- a/ipelets/decorator/wiki.markdown +++ /dev/null @@ -1,30 +0,0 @@ -# Decorator Ipelet # - -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. - -[![example](Decorator_Ipelet/attachment/decorator.svg)](Decorator_Ipelet/attachment/decorator.ipe) - -# Download & Installation # - -Download [decorator.lua](Decorator_Ipelet/attachment/decorator.lua) and copy it to ~/.ipe/ipelets/ (or to some other directory for ipelets). - -# Usage # - -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). - -# Creating Decorator Objects # - -To create your own decorator object, execute the following steps. - -1. Create a rectangle, lets call it R. -2. Create path objects, that decorate R (usually some kind of box around R). You can use multiple objects for the decoration. -3. Make sure that R is the front most object (select R and press Ctrl+F). -4. Group R together with the decoration (select R and the decoration and press Ctrl+G). -5. Run "Ipelets->Decorator->create deco-object". - -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/"). - -# Changes # - -**14. October 2014** -first version of the decorator ipelet online