updated readme for decorator
authorThomas Bläsius <thomas.blaesius@kit.edu>
Wed, 26 Aug 2015 11:54:35 +0000 (13:54 +0200)
committerThomas Bläsius <thomas.blaesius@kit.edu>
Wed, 26 Aug 2015 11:54:35 +0000 (13:54 +0200)
ipelets/decorator/README.md [moved from ipelets/decorator/wiki.markdown with 50% similarity]
ipelets/decorator/decorator.png [new file with mode: 0644]

similarity index 50%
rename from ipelets/decorator/wiki.markdown
rename to ipelets/decorator/README.md
index aaec204f2457219958290e6e09522b46e892a709..c8141eb0086d4b924cabbd9e7599be76f41e9897 100644 (file)
@@ -1,28 +1,35 @@
-# 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 ([Ipe file](decorator.ipe)) illustrates the usage.
-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.
+![Decorator examples](decorator.png) 
 # Download & Installation #
-Download [decorator.lua](Decorator_Ipelet/attachment/decorator.lua) and copy it to ~/.ipe/ipelets/ (or to some other directory for ipelets).
+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).
+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
 # 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.
+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/").
+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 #
diff --git a/ipelets/decorator/decorator.png b/ipelets/decorator/decorator.png
new file mode 100644 (file)
index 0000000..fe5e4f5
Binary files /dev/null and b/ipelets/decorator/decorator.png differ