Calligra/Build Stencils for Flow: Difference between revisions

Latest revision as of 21:19, 27 December 2012

It is very easy to create stencil collections for Flow.

Structure

In Flow, stencils are shape items listed on Stencil Box docker, they are written in openDocument graphic format(.odg). In Flow default stencils are placed at /usr/share/apps/flow/stencils/, user added stencils are usually at directory like ~/.kde4/share/apps/flow/stencils/. Each subdirectory represents one stencil family, under such a directory there is a config file (collection.desktop) to indicate the family name. One stencil consists of 3 files, [stencil_name].odg contains the data of the stencil, [stencil_name].png is the icon shown in stencil box docker, [stencil_name].desktop contains the naming information and additional arguments to the stencil.

collection.desktop

It should be written like this:

[Desktop Entry]
Name=Stencil Family Name
X-KDE-DirType=odg-collection

Translators will care about i18n task, please use English language.

stencil_name.odg

We strongly recommand you use Karbon for the stencils creation to ganrantee compatibility, but considering Karbon is not ready for professional production, you can use your favourite svg drawing applications like inkscape to draw the stencils and import them to Karbon.

After svg files imported, you need to place a text shape on the stencil to provide stencil labels, usually it should be as big as the bounding box to your stencil, unless you need customized label positions or multi labels.

Now group your stencil and the label(make sure the label is placed on top).

Done. Now make icon file and information file.

stencil_name.png

Icon of the stencil to shown in stencil box docker, we're planning to make an icon generator for stencil designers.

stencil_name.desktop

It should be written like this:

[Desktop Entry]
Name=Stencil Name

Stencil name should be in English, translators will handle i18n task. If you want additional arguments supported by Flow, append related entry in the file, currently we only support keep stencils aspect ratio while resizing:

CS-KeepAspectRatio=1

Publish your stencils

After you finished your stencil collection, you can upload it to share with others, this part is unfinished.

@@ Line 3: / Line 3: @@
 == Structure ==
-In Flow, stencils are shape items listed on Stencil Box docker, they are written in openDocument graphic format(.odg). In Flow default stencils are placed at /usr/share/apps/flow/stencils/, each subdirectory represents one stencil family,
+In Flow, stencils are shape items listed on Stencil Box docker, they are written in openDocument graphic format(.odg). In Flow default stencils are placed at /usr/share/apps/flow/stencils/, user added stencils are usually at directory like ~/.kde4/share/apps/flow/stencils/. Each subdirectory represents one stencil family, under such a directory there is a config file (collection.desktop) to indicate the family name. One stencil consists of 3 files, [stencil_name].odg contains the data of the stencil, [stencil_name].png is the icon shown in stencil box docker, [stencil_name].desktop contains the naming information and additional arguments to the stencil.
-under such a directory there is a config file (collection.desktop) and one or several odg files. One group in an odg file(a <draw:g> element in xml) represents a stencil, you can create all stencils in a family in one file, or seperated in several files if you want.
 == collection.desktop ==
-This is a desktop entry file claiming the family name of the stencils under the deirctory, directory without the file won't be read by Stencil Box docker, you can refer to the examples in source code(flow/stencils) to write your own one.
+It should be written like this:
-== Create stencils file ==
+<syntaxhighlight lang="ini">
+[Desktop Entry]
+Name=Stencil Family Name
+X-KDE-DirType=odg-collection
+</syntaxhighlight>
-We strongly recommand you use Karbon for the stencils creation to ganrantee compatibility, but consider Karbon is not ready for professional production, you can use your favourite svg drawing application like inkscape to draw the stencils and import them to Karbon.
+Translators will care about i18n task, please use English language.
+== stencil_name.odg ==
+We strongly recommand you use Karbon for the stencils creation to ganrantee compatibility, but considering Karbon is not ready for professional production, you can use your favourite svg drawing applications like inkscape to draw the stencils and import them to Karbon.
 [[File:Import-graphic.png|200px|thumb|left|Import SVG file.]]
@@ Line 21: / Line 28: @@
 [[File:Draw-text-shape.png|400px|thumb|left|Draw a text shape on top.]]
-Now group your stencil and the label(make sure the label is placed on top), rename the group name to the name of stencil in English language, translators will translate them into local languages with the help of simple perl scripts in source code.
+Now group your stencil and the label(make sure the label is placed on top).
-[[File:Group.png|300px|thumb|left|Group all of them.]]
+[[File:Group.png|400px|thumb|left|Group all of them.]]
 [[File:Group-rename.png|200px|thumb|left|Rename the group.]]
+Done. Now make icon file and information file.
+== stencil_name.png ==
+Icon of the stencil to shown in stencil box docker, we're planning to make an icon generator for stencil designers.
+== stencil_name.desktop ==
+It should be written like this:
+<syntaxhighlight lang="ini">
+[Desktop Entry]
+Name=Stencil Name
+</syntaxhighlight>
+Stencil name should be in English, translators will handle i18n task.
+If you want additional arguments supported by Flow, append related entry in the file, currently we only support keep stencils aspect ratio while resizing:
+<syntaxhighlight lang="ini">
+CS-KeepAspectRatio=1
+</syntaxhighlight>
 == Publish your stencils ==
-After you finished your stencil collection, you can upload it to the Flow stencil library website, currently we need volunteers to help with the site.
+After you finished your stencil collection, you can upload it to share with others, this part is unfinished.