Inkscape Wiki - User contributions [en]

Working with Bazaar

2009-12-28T20:22:45Z

Terry brown: update workflow to protect linearity of bzr log

==Bazaar concepts==

It is assumed that you are familiar with the basic concepts of version control, like working copy, committing, updating, conflicts. There will be a section that explains the basic functionality soon.

* '''Branch''' is a working copy of the project's code. Typically you use one branch per set of related changes, for example a new output extension. Once your work is finished, you ''merge'' your branch into a larger project. Initially, there is only one branch, the trunk; all other branches are its (probably indirect) descendants. To create a new branch, you have to copy an existing one.
* '''Checkout''' is a copy of code contained in a branch that is not stored on your computer (a remote branch). Committing to a checkout will immediately apply the changes to the remote branch. Commits will not succeed if somebody else
* When branches A and B have a common ancestor branch but each contain changes not present in the other, they have '''diverged'''. For example, when you work on an improved rectangle tool in your own branch and at the same time somebody else applies a PDF export bugfix to the trunk, your rectangle tool branch becomes diverged from the trunk.
* '''Trunk''' is the main branch, which represents cutting-edge working code. You should start from it when doing any new development.
* '''Merge''' is the process of reconciling changes made between two branches since they diverged. This operation is asymmetric. When you merge A into B, all changes made to A since it was branched from B are applied to B. A is not changed. When you work on some feature, you typically work in a branch, periodically merging the trunk into your branch (to sync up with the latest changes), then you merge your work into the trunk. Merging is similar to applying a patch - it only changes your working copy. To apply a merge, you need to commit the changes it introduced. Merging un-diverges branches.
* '''Repository''' is a place where branches of a project are stored. Having a shared repository reduces the storage requirements of multiple branches of one project. Instead of O(number of branches) space, they take roughly O(size of changes).
* '''Bind''' is the process of converting a non-diverged local branch into a checkout.
* '''Push''' is the process of publishing an exact copy (a mirror) of your branch in some other location. The difference between pushing and checkouts is that a checked out remote branch is updated every time you commit, while a pushed remote branch is updated only when you push to it. You can only push to a branch if the mirror has not diverged from your local copy. This can happen if more than 1 person can push to the same location.
* '''Pull''' is the process of creating a local exact copy (mirror) of a branch, in principle a reverse of pushing.

==First steps==

First you need to tell Bazaar your name. This will appear on all your commits. You should use your real e-mail, but you can obfuscate it if you are afraid of spam.

Obfuscated e-mail example:
$ bzr whoami "John Q. Public <john dot q dot public at-sign bigmail dot com>"
Unobfuscated e-mail example:
$ bzr whoami "John Q. Public <john.q.public@bigmail.com>"

If you have an account on launchpad and want to commit changes there, you need to specify your launchpad login:
$ bzr launchpad-login johnq

Then fetch Inkscape's trunk
$ bzr branch lp:inkscape

==Using a decentralized workflow==

In this case you will be working locally until you are ready to publish your changes. This is the way git works by default.

'''NOTE:''' this workflow has been updated to avoid the "other people's commits become subrevisions of your commit" problem.

Get Inkscape's code
$ bzr branch lp:inkscape myproject

Now work:
$ cd myproject
<work work work>
$ bzr commit -m "Some changes"
<more work work work>
$ bzr commit -m "More changes"
<create new file>
$ bzr add new-file.c

Now, you need to merge your changes into a local copy of the trunk. If you don't have one, do (in the directory ''containing'' myproject):
$ bzr branch lp:inkscape trunk
$ cd trunk

If you already have one on hand, make sure it's up to date:
$ cd trunk
$ bzr pull

Now that you have a local copy of the current trunk:
$ bzr merge ../myproject
$ bzr commit -m'added my feature'
$ bzr push

==Using a centralized (SVN-like) workflow==

In this case, every commit that you make is immediately sent to the central repository. There are two ways of achieving this:

===SVN-style checkout===

Get the latest Inkscape code as a checkout, rather than a branch:
$ bzr checkout lp:inkscape

Now work as in SVN:
<do work>
$ bzr commit
<error, someone else has changed things>
$ bzr update
<check all is okay>
$ bzr commit

If you add new files, add them to version control with <tt>bzr add ''file''</tt>. You can recursively add all new files by writing simply <tt>bzr add</tt> in the top level directory.

===Binding a BZR branch===

Get Inkscape's code the regular bzr way:
$ bzr branch lp:inkscape

Then transform your banch into a checkout:
$ cd inkscape
$ bzr bind lp:inkscape

Now work as in SVN:
<do work>
$ bzr commit
<error, someone else has changed things>
$ bzr update
<check all is okay>
$ bzr commit

===Differences from SVN===

* Commits will fail if your checkout is not up to date, even if there would be no conflicts.
* The revision number is an attribute of the working tree, not of individual files. It is not possible to have different portions of the working tree at different revisions.
* <tt>bzr commit ''file''</tt> works like <tt> svn commit ''file'' && svn update ''project-root''</tt>. After a successful partial commit, the entire tree's revision is increased by 1.
* No special server is needed to publish a branch. You can push branches to anywhere, including simple FTP shares. In our scenario, Launchpad works like a central repository, but it's not required to publish everything there.
* You create branches locally. To simulate creating a SVN-style branch on Launchpad, you need to create a local branch, push it, then bind it to the pushed location.

==Using branches==
This will asumme this directory layout:
inkscape
+-trunk
| +-doc
| +-share
| +-src
| +-po
| +-...
+-my-branch
+-some-other-branch

===Repository setup===
If you are working on several things at once, it's better to use one branch per feature. Here is how to work with branches.

* Create a shared repository for your branches. This brings significant space savings if you have several branches, but is not mandatory: <tt>bzr init-repo --rich-root inkscape</tt>. This will create the directory <tt>inkscape</tt>, which will contain a shared repository used by all branches within it, in the rich root format. This is the format currently used by our Launchpad repository - if you choose another format, you might not be able to push your branches to Launchpad. Enter the directory just created: <tt>cd inkscape</tt>
* Create a new branch: <tt>bzr branch lp:inkscape my-branch</tt>. This will retrieve the main branch of Inkscape and put it in the subdirectory <tt>my-branch</tt>.
* Make changes. Commit them locally using <tt>bzr commit</tt>. Note that this doesn't touch the trunk on Launchpad; you are only committing to your local repository.
* If somebody else modified the trunk, resync with it: <tt>bzr merge</tt> (merging will automatically use the parent branch if none is specified)

===Publishing branches on Launchpad===
To publish branches on Launchpad, you have to add an SSH key to your account. You can generate a key using the program <tt>ssh-keygen</tt>.

When you added a key to your account, you can now use the Launchpad integration features.

* First you have to log in: <tt>bzr launchpad-login ''launchpad-username''</tt>. You need to use your username, not your display name.
* Publish your branch on Launchpad: <tt>bzr push lp:~''launchpad-username''/inkscape/my-branch</tt>. Of course if you're working with a different project, substitute <tt>inkscape</tt> with its Launchpad name.
* The push location will be saved. To update the branch on Launchpad, write <ttbzr push</tt> after your commits.
* If you want to always commit directly to the remote branch on Launchpad, write <tt>bzr bind lp:~''launchpad-username''/inkscape/my-branch</tt> after the initial push. This will convert your local branch into a checkout of the remote branch.

===Merging branches into trunk===

Way A: commit to a checkout of the trunk. This requires a trunk checkout, but for some people is more logical.

* Navigate to a checkout of the trunk.
* Execute <tt>bzr merge ''branch-url''</tt>. This will modify the files to receive the changes from the specified branch but will not modify the trunk.
* After verifying the changes (e.g. compile the program and see whether it doesn't crash on startup), execute <tt>bzr commit</tt> to apply the changes from the merge to the trunk.

Way B: merge from trunk, then push. It doesn't require a trunk checkout, but it may be less obvious what is happening.

* Navigate to the branch you want to merge.
* Execute <tt>bzr merge ''trunk-location''</tt>, where ''trunk-location'' might be your local trunk checkout or <tt>lp:inkscape</tt>
* Verify the changes, then execute <tt>bzr commit</tt>.
* Push to trunk: <tt>bzr push lp:inkscape</tt>

===Local branching===

Naturally, all this also works locally. For example, when you're in the <tt>inkscape</tt> directory, you can write <tt>bzr branch trunk export-dialog</tt> to create a new branch of the trunk called <tt>export-dialog</tt>, where you'll work only on improving the export dialog. Similarly, you can merge between local branches.

==Best Practicals for Inkscape Project==

===Registering Bugfixes===

Launchpad will automatically mark a bug "Fix Available" (rather than "Fix Committed") once somebody commits using the flag --fixes, e.g. (if you fix those two bugs in one commit):
bzr commit --fixes lp:123456 --fixes lp:123457 -m 'patch description'
Then, bugs can be changed automatically from "Fix Available" to "Fix Released"

[http://doc.bazaar-vcs.org/bzr.dev/en/tutorials/using_bazaar_with_launchpad.html#changing-the-state-in-launchpad-while-committing-in-bazaar Read more: "Changing the state in Launchpad while committing in Bazaar"]

==External links==
* [http://doc.bazaar-vcs.org/latest/en/ Bazaar manual]

File:Extrudedemo.jpg

2008-08-14T20:51:11Z

Terry brown:

ExtrudeEffect

2008-08-14T20:50:46Z

Terry brown: /* Extrude effect */

Extrude effect

To use the extrude effect, you just select two paths and run the effect
from the effects menu.

To get the extrude effect copy
[[http://www.greygreen.org/files/inkscape/extrude/extrude.inx extrude.inx]]
and
[[http://www.greygreen.org/files/inkscape/extrude/extrude.py extrude.py]]
into your Inkscape extensions directory.

[[Image:extrudedoc.jpg]]

Here's another example:

[[Image:extrudedemo.jpg]]

ExtrudeTool

2008-08-14T20:26:52Z

Terry brown:

== Aim ==
To have a simple way to give a profile path depth, using the mouse to manipuate the type of extrusion, similar to functionality in the 3D Box tool and in Blender.

== Status ==

[[ExtrudeEffect]] implements something like this, although it doesn't handle
shading (as shown below) automatically. At time of writing [[ExtrudeEffect]]
is in SVN and accessed as "Extrude2" on the "Generate from Path" Effects menu.
The older "Extrude" effect only connects points with lines, and the shape
at either end has to be identical.

== Concept ==

[[Image:Extrude.png]]

== UI Bits and pieces ==
*Toggle button to specify if extrusion path replaces original or add to the document
*Radio buttons or drop-down select to choose shading options (darken extrusion, lighte extrusion
*Slider to control amount/subtlty of shading (how dark/light are the extrusions made, etc.)
* Options/defaults in preferences dialogue?

== Useful code ==
tbnorth on IRC provided a [http://pastebin.com/f3f5c04d9 python extension] and [http://pastebin.com/f6fdc825d .inx file] which 'draws lines between vertices of two selected paths', which are archived at pastebin.

ExtrudeEffect

2008-08-14T19:33:39Z

Terry brown: /* Extrude effect */

= Extrude effect =

To use the extrude effect, you just select two paths and run the effect
from the effects menu.

To get the extrude effect copy
[[http://www.greygreen.org/files/inkscape/extrude/extrude.inx extrude.inx]]
and
[[http://www.greygreen.org/files/inkscape/extrude/extrude.py extrude.py]]
into your Inkscape extensions directory.

[[Image:extrudedoc.jpg]]

ExtrudeEffect

2008-08-14T19:22:39Z

Terry brown: /* Extrude effect */

= Extrude effect =

To use the extrude effect, you just select two paths and run the effect
from the effects menu.

[[Image:extrudedoc.jpg]]

File:Extrudedoc.jpg

2008-08-14T19:22:04Z

Terry brown:

ExtrudeEffect

2008-08-14T19:20:21Z

Terry brown: /* Extrude effect */

= Extrude effect =

To use the extrude effect, you just select two paths and run the effect
from the effects menu.

[[Image:extrudedoc.png]]

ExtrudeEffect

2008-08-14T19:20:00Z

Terry brown:

= Extrude effect =

To use the extrude effect, you just select two paths and run the effect
from the effects menu.

[[Image:Example.jpg]]

ExtrudeEffect

2008-08-14T19:19:27Z

Terry brown: New page: To use the extrude effect, you just select two paths and run the effect from the effects menu. Image:Example.jpg

To use the extrude effect, you just select two paths and run the effect
from the effects menu.

[[Image:Example.jpg]]

Extension repository

2008-08-14T19:18:22Z

Terry brown:

It would be very useful to have a central Internet repository for Inkscape extensions, similarly as Firefox has. This way, Inkscape could update installed extensions from the web site, with no need for the user to know if an extension is updated.

What extensions are there? We can start listing them here:
* [http://www.ekips.org/comp/inkscape/ Inkscape Effects] - Aaron Spikes set of extensions is now included in Inkscape.
* [[ExtrudeEffect]] - extrude polygons to "3d", also make "string art"
* [http://www.colibre.com.br/bin/view/Aurium/InkscapeCalendarShellScript InkscapeCalendarShellScript] - Create Calendars sucks or is impracticable if you do not have something that automatizes the process of to put the days organized in blocks of months to you. To format manually is easy, but this extension can help you on this too [Bash script, works for win32 with cygwin].
* [http://www.colibre.com.br/bin/view/Aurium/InkscapeAreaCuter InkscapeAreaCutter] - For Webdesigners, layout for sites, slice area into .png images. util! (pt_BR)
* [http://julvitard.free.fr/eqtexsvg/ EQTeXSVG] - EQTeXSVG is an extension for Inkscape used to convert an inline LATEX equation into SVG path using Python.
* [http://www.kono.cis.iwate-u.ac.jp/~arakit/inkscape/inklatex.html InkLaTeX] Insert LaTeX text or equations into Inkscape.
* [http://www.iki.fi/pav/software/textext/ TexText] Embed re-editable LaTeX objects in SVG drawings.
* [http://math.univ-lille1.fr/~barraud/Inkscape/pathdeform/ PathDeform] - Here is an Inkscape extension whose purpose is to bend a path according to another one. Note: it was added to Inkscape 0.45 as "Pattern along Path".
* [http://www.inkbar.lineaire.net/ InkBar] - This is an Inkscape extension whose purpose is to draw EAN13 bar code.
* [http://technoargia.free.fr/swftools/ SWF output] - A little extension to save as Swf from Inkscape.
* [http://www.colivre.coop.br/bin/view/Aurium/Puff Puff] - Fluffs elements! :-D
* [http://www.colivre.coop.br/bin/view/Aurium/InkSudoku Sudoku Generator] - Generates Sudoku square with the solution ''(in a small square if you want)''.
* [[CalligraphedOutlineFill]] - helps to fill in the inside area of shapes drawn with the Calligraphy tool
* [http://edlab.die.unipd.it/Site4.html SlotStar] - helps to draw the star of slot of a winding of an electrical machine
* [http://richard.henwood.googlepages.com/inkscapelatexextension inkscapeLatexExtension] - Extract text in an inkscape drawing to a latex picture environment.
* [http://saws.googlecode.com s.a.w.s] - export the svg Inkscape file in valid xhtml / css files.

== For Programers: ==

* [http://www.colivre.coop.br/bin/view/Aurium/RubyInk RubyInk] - Inkscape extension with Ruby
* [http://www.colivre.coop.br/bin/view/Aurium/InkBash Ink-Bash] - <nowiki>ShellScript</nowiki> Forever!
* [http://www.colivre.coop.br/bin/view/Aurium/InkMoz InkMoz] - the Bridge from Inkscape to Mozilla (Inkscape extension with Javascript and more)

[[Category:Developer Documentation]]
[[Category:Extensions]]

Extension repository

2008-08-14T19:13:39Z

Terry brown:

It would be very useful to have a central Internet repository for Inkscape extensions, similarly as Firefox has. This way, Inkscape could update installed extensions from the web site, with no need for the user to know if an extension is updated.

What extensions are there? We can start listing them here:
* [http://www.ekips.org/comp/inkscape/ Inkscape Effects] - Aaron Spikes set of extensions is now included in Inkscape.
* [ExtrudeEffect] - extrude polygons to "3d", also make "string art"
* [http://www.colibre.com.br/bin/view/Aurium/InkscapeCalendarShellScript InkscapeCalendarShellScript] - Create Calendars sucks or is impracticable if you do not have something that automatizes the process of to put the days organized in blocks of months to you. To format manually is easy, but this extension can help you on this too [Bash script, works for win32 with cygwin].
* [http://www.colibre.com.br/bin/view/Aurium/InkscapeAreaCuter InkscapeAreaCutter] - For Webdesigners, layout for sites, slice area into .png images. util! (pt_BR)
* [http://julvitard.free.fr/eqtexsvg/ EQTeXSVG] - EQTeXSVG is an extension for Inkscape used to convert an inline LATEX equation into SVG path using Python.
* [http://www.kono.cis.iwate-u.ac.jp/~arakit/inkscape/inklatex.html InkLaTeX] Insert LaTeX text or equations into Inkscape.
* [http://www.iki.fi/pav/software/textext/ TexText] Embed re-editable LaTeX objects in SVG drawings.
* [http://math.univ-lille1.fr/~barraud/Inkscape/pathdeform/ PathDeform] - Here is an Inkscape extension whose purpose is to bend a path according to another one. Note: it was added to Inkscape 0.45 as "Pattern along Path".
* [http://www.inkbar.lineaire.net/ InkBar] - This is an Inkscape extension whose purpose is to draw EAN13 bar code.
* [http://technoargia.free.fr/swftools/ SWF output] - A little extension to save as Swf from Inkscape.
* [http://www.colivre.coop.br/bin/view/Aurium/Puff Puff] - Fluffs elements! :-D
* [http://www.colivre.coop.br/bin/view/Aurium/InkSudoku Sudoku Generator] - Generates Sudoku square with the solution ''(in a small square if you want)''.
* [[CalligraphedOutlineFill]] - helps to fill in the inside area of shapes drawn with the Calligraphy tool
* [http://edlab.die.unipd.it/Site4.html SlotStar] - helps to draw the star of slot of a winding of an electrical machine
* [http://richard.henwood.googlepages.com/inkscapelatexextension inkscapeLatexExtension] - Extract text in an inkscape drawing to a latex picture environment.
* [http://saws.googlecode.com s.a.w.s] - export the svg Inkscape file in valid xhtml / css files.

== For Programers: ==

* [http://www.colivre.coop.br/bin/view/Aurium/RubyInk RubyInk] - Inkscape extension with Ruby
* [http://www.colivre.coop.br/bin/view/Aurium/InkBash Ink-Bash] - <nowiki>ShellScript</nowiki> Forever!
* [http://www.colivre.coop.br/bin/view/Aurium/InkMoz InkMoz] - the Bridge from Inkscape to Mozilla (Inkscape extension with Javascript and more)

[[Category:Developer Documentation]]
[[Category:Extensions]]

Extension repository

2008-08-14T19:13:21Z

Terry brown:

It would be very useful to have a central Internet repository for Inkscape extensions, similarly as Firefox has. This way, Inkscape could update installed extensions from the web site, with no need for the user to know if an extension is updated.

What extensions are there? We can start listing them here:
* [http://www.ekips.org/comp/inkscape/ Inkscape Effects] - Aaron Spikes set of extensions is now included in Inkscape.
* ExtrudeEffect - extrude polygons to "3d", also make "string art"
* [http://www.colibre.com.br/bin/view/Aurium/InkscapeCalendarShellScript InkscapeCalendarShellScript] - Create Calendars sucks or is impracticable if you do not have something that automatizes the process of to put the days organized in blocks of months to you. To format manually is easy, but this extension can help you on this too [Bash script, works for win32 with cygwin].
* [http://www.colibre.com.br/bin/view/Aurium/InkscapeAreaCuter InkscapeAreaCutter] - For Webdesigners, layout for sites, slice area into .png images. util! (pt_BR)
* [http://julvitard.free.fr/eqtexsvg/ EQTeXSVG] - EQTeXSVG is an extension for Inkscape used to convert an inline LATEX equation into SVG path using Python.
* [http://www.kono.cis.iwate-u.ac.jp/~arakit/inkscape/inklatex.html InkLaTeX] Insert LaTeX text or equations into Inkscape.
* [http://www.iki.fi/pav/software/textext/ TexText] Embed re-editable LaTeX objects in SVG drawings.
* [http://math.univ-lille1.fr/~barraud/Inkscape/pathdeform/ PathDeform] - Here is an Inkscape extension whose purpose is to bend a path according to another one. Note: it was added to Inkscape 0.45 as "Pattern along Path".
* [http://www.inkbar.lineaire.net/ InkBar] - This is an Inkscape extension whose purpose is to draw EAN13 bar code.
* [http://technoargia.free.fr/swftools/ SWF output] - A little extension to save as Swf from Inkscape.
* [http://www.colivre.coop.br/bin/view/Aurium/Puff Puff] - Fluffs elements! :-D
* [http://www.colivre.coop.br/bin/view/Aurium/InkSudoku Sudoku Generator] - Generates Sudoku square with the solution ''(in a small square if you want)''.
* [[CalligraphedOutlineFill]] - helps to fill in the inside area of shapes drawn with the Calligraphy tool
* [http://edlab.die.unipd.it/Site4.html SlotStar] - helps to draw the star of slot of a winding of an electrical machine
* [http://richard.henwood.googlepages.com/inkscapelatexextension inkscapeLatexExtension] - Extract text in an inkscape drawing to a latex picture environment.
* [http://saws.googlecode.com s.a.w.s] - export the svg Inkscape file in valid xhtml / css files.

== For Programers: ==

* [http://www.colivre.coop.br/bin/view/Aurium/RubyInk RubyInk] - Inkscape extension with Ruby
* [http://www.colivre.coop.br/bin/view/Aurium/InkBash Ink-Bash] - <nowiki>ShellScript</nowiki> Forever!
* [http://www.colivre.coop.br/bin/view/Aurium/InkMoz InkMoz] - the Bridge from Inkscape to Mozilla (Inkscape extension with Javascript and more)

[[Category:Developer Documentation]]
[[Category:Extensions]]

InkSlide

2008-02-01T02:56:16Z

Terry brown: /* Code */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
InkSlide: Features
++++++++++++++++++

Features include wrapped top level text and
- mulitple
- levels
- of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A group or layer called ''gr_text'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group or layer called ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

"A group or layer called 'X'" indicates either a group with an '''@id'''
of 'X' ''or'' a layer with a '''label''' (name) of 'X'. When both exist the group will take precedence.

Optional contents:

*A background, which should be placed in a group or layer called `gr_bg`
*A foreground, which should be placed in a group or layer called `gr_fg`
*Affiliation text and logos you want to appear on every slide, this could go in the background, or another named group or layer.
*A blurred clone of the gr_title element, offset and behind it. It's easier to do this is `gr_title` is a group rather than a layer.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible. Likewise the Texts layer should be visible, as well as any Instance layers.
=== Text Input ===

InkSlide uses [http://docutils.sourceforge.net/rst.html reStructuredText] for markup, although it renders only a subset of rst.

<pre>
Inkslide: an example
++++++++++++++++++++

This text will appear as a top level paragraph.

- Dash prefix indicates this text will appear as a bulleted item.

- Indented dash prefix -> second level bulleted list.

.. is:pause

Two slides will be produced for this input, one with everything up to the
".. is:pause", and one with that plus the remaining content.
Incremental list display can be done this way.

The is:id tag below indicates that a file with a name like
'extra/is_intro.svg' should be inspected for extra content
for this particular slide.

.. is:id is_intro

Inkslide: the next slide...
+++++++++++++++++++++++++++
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features. Remember you can
use the slide specific editing feature to do any of these things and
anything else you can do in Inkscape already, these will just be more
convenient in the text input when they're done.

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*<strike>Simple image inclusion</strike>
*more helper tools to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

Matt Harrison suggested using reStructured text as the markup language.

=== Code ===

<pre>
"""
"""

# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path
from docutils.core import publish_string

import sys # for debug
class inkSlide(object):
def __init__(self):

self.NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
self.tabLevels = 4

self._nextId = 0

self.gap = {
'bIMAGE': 15, # gap before image
'aIMAGE': 15, # gap after image
'aTAB0': 10, # gap after top level text
'aTAB1': 10, # gap after level 1 bullet
'aTAB2': 10, # gap after level 2 bullet
'aTAB3': 10, # gap after level 3 bullet
'fVCENTER': 1, # flag - center vertically
'dHEIGHT': 728, # dimension, bottom of page
'fHCENTER': 1, # flag - center vertically
'dWIDTH': 1024, # dimension, bottom of page
}

self.dimCache = {}
self.is_reads, self.is_cache = 0, 0
def __del__(self):
print '%d reads, %d cache hits' % (self.is_reads, self.is_cache)
def nextId(self):
"""return an unsed Id"""
# FIXME, should inspect template doc.
self._nextId += 1
return 'is'+str(self._nextId)

def clearId(self, x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if not NS: NS = self.NS
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(self, fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""

hsh = fn+Id+what
if hsh in self.dimCache:
self.is_cache += 1
return self.dimCache[hsh]

cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)

proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
self.dimCache[hsh] = proc.stdout.read()
if self.dimCache[hsh].strip() == '':
print "Warning: '%s' not found" % Id
self.is_reads += 1
return self.dimCache[hsh]
def textReader(self, text):
"""NOT USED iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

def textReaderRst(self, text):

xml = publish_string(text.replace('\t',' '), writer_name = 'xml')
doc = ET.fromstring(xml)
# yield {'type':'TITLE', 's':doc.xpath('/document/@title')[0]}
nodes = 'paragraph', 'comment', 'title', 'image'
for i in doc.xpath('//%s' % '|//'.join(nodes)):

if i.tag == 'title':
yield {'type':'TITLE', 's':i.text}
if i.tag == 'paragraph':
tabs = len(i.xpath('ancestor::list_item'))
yield {'type':'TAB', 'tabs':tabs, 's':i.text, 'e':i}
if i.tag == 'image':
tabs = len(i.xpath('ancestor::list_item'))
yield {'type':'IMAGE', 'uri':i.get('uri')}
if i.tag == 'comment':

comparts = i.text.split(None, 1)

if len(comparts) > 1:
ctag, cval = comparts
elif len(comparts) == 1:
ctag = comparts[0]
else:
continue # empty comment had no meaning to InkView

if ctag == 'is:id':
try:
yield {'type':'ID', 's':cval}
except:
raise Exception('"id" comment requires a value')
elif ctag == 'is:notitle':
yield {'type':'DROP', 'what':('gr_title',)}
elif ctag == 'is:notext':
yield {'type':'DROP', 'what':('gr_text',)}
elif ctag == 'is:nobackground':
yield {'type':'DROP', 'what':('gr_bg',)}
elif ctag == 'is:noforeground':
yield {'type':'DROP', 'what':('gr_fg',)}
elif ctag == 'is:blank':
yield {'type':'DROP', 'what':('gr_title','gr_text')}
elif ctag == 'is:empty':
yield {'type':'DROP', 'what':('gr_bg','gr_title','gr_text','gr_fg')}
elif ctag == 'is:no':
try:
yield {'type':'DROP', 'what':(cval,)}
except:
raise Exception('"no" comment requires a value')

if ctag == 'is:dim':
dim, val = cval.strip().split()
yield {'type':'DIM', 'dim':dim, 'val':val}
def groupOrLayer(self, g):
dst = self.doc.xpath('//s:g[@id="%s"]'%g, self.NS)
if not dst: dst = self.doc.xpath('//s:g[@i:label="%s"]'%g, self.NS)
if not dst: return dst # let the caller test, don't raise exception here
dst = dst[0]
return dst
def instanceFromTemplate(self, template, instance, text, pauseOk = True):

slide = 0

hlist = []
self.doc = ET.parse(template)
slideId = None

for t in self.textReaderRst(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
if hlist:
self.process(instance, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
self.doc = ET.parse(template)
slideId = None
else:
hlist.append(t)

print t['s']

dst = self.groupOrLayer('gr_title')
src = self.doc.xpath('//s:flowRoot[@id="fr_title"]', self.NS)[0]
cpy = self.clearId(copy.deepcopy(src))
Id = self.nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',self.NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
self.process(instance, hlist, slideId, slide)
slide = slide + 1
continue

if t['type'] == 'BLANK':
hlist.append(t)
continue

if t['type'] == 'TAB':
hlist.append(t)
dst = self.groupOrLayer('gr_text')
src = self.doc.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], self.NS)[0]
cpy = self.clearId(copy.deepcopy(src))
Id = self.nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
# cpy.xpath('s:flowPara',self.NS)[0].text = t['s']
self.flowParaFromElement(
cpy.xpath('s:flowPara',self.NS)[0], t['e'])
dst.append(cpy)
continue

if t['type'] == 'IMAGE':
hlist.append(t)
dst = self.groupOrLayer('gr_image')
if not dst:
dst = self.groupOrLayer('gr_text')
img = ET.Element('image')
img.set('{%s}href'%self.NS['xlink'], t['uri'])
Id = self.nextId()
img.set('id', Id)
hlist[-1]['id']=Id
dst.append(img)
continue

hlist.append(t) # whatever it was

self.process(instance, hlist, slideId, slide)
def flowParaFromElement(self, fp, e):
fp.text = e.xpath('string(.)')
def process(self, instance, hlist, slideId, slide):

instanceName = instance.replace('%s', '%04d'%slide)

instance = 'tmp.svg' # reusing allows caching in getDim, but relies on nextId ensuring
# that the changing parts have new ids

self.doc.write(file(instance, 'w'))

drop = []

bullDim = {}
tabDim = {}
for n in range(0,self.tabLevels):
b = {}
x = self.doc.xpath('//*[@id="bu_%d"]'%n, self.NS)
if x:
# self.clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(self.getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = self.doc.xpath('//*[@id="fr_tab%d"]'%n, self.NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(self.getDim(instance, 'fr_tab%d'%n, i))
x = x[0].xpath('.//s:rect',self.NS)[0]
b['max-width'] = float(x.get('width'))
b['max-height'] = float(x.get('height'))
tabDim[n] = b

delta = 0.
firstVert = True
placed_xy = []
placed_transform = []

for n, i in enumerate(hlist):

this = hlist[n]
prev = hlist[n-1]

if this['type'] == 'DROP': drop += this['what']

if this['type'] == 'DIM':
if this['dim'] not in self.gap or this['val'][0] not in '+-':
self.gap[this['dim']] = float(this['val'])
else:
self.gap[this['dim']] += float(this['val'])

zeroHeight = ['TITLE', 'DROP', 'DIM']

# don't do this - need to add height from prev to delta
#if this['type'] in zeroHeight:
# continue # already in right place, not a vertical element

hgt = 0
if prev['type'] == 'BLANK':
hgt = 30
elif prev['type'] not in zeroHeight:
hgt = float(self.getDim(instance, prev['id'], 'height'))

# risky gambit to space bullets properly when some lines
# have no ascenders etc.
if prev['type'] == 'TAB' and prev['tabs'] > 0:
lnh = tabDim[prev['tabs']]['height']
hgt = lnh * int(hgt/lnh+0.5)

# TAB0, TAB1, TITLE, IMAGE, etc.
# gap after previous
hsh = 'a' + prev['type'] + str(prev.get('tabs',''))
hgt += self.gap.get(hsh, 0)
# gap before current
hsh = 'b' + this['type'] + str(this.get('tabs',''))
hgt += self.gap.get(hsh, 0)

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if this['type'] == 'BLANK': continue

if this['type'] == 'TAB':
tabs = this['tabs']

r = self.doc.xpath('//s:flowRoot[@id="%s"]' % this['id'], self.NS)[0]
self.clearId(r, what='transform')
r = r.xpath('.//s:rect', self.NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))
placed_xy.append([r, this['id']])

if (this['type'] == 'TAB' and this['tabs'] in bullDim
and 'isDone' not in this):
this['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
# dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
dst = self.groupOrLayer('gr_text')
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%self.NS['xlink'], '#bu_%d'%tabs)
placed_transform.append([clone, dx, dy])
dst.append(clone)

if this['type'] == 'IMAGE':

xpath = '//s:image[@id="%s"]' % this['id'] # doesn't work?
xpath = '//*[@id="%s"]' % this['id']
i = self.doc.xpath(xpath, self.NS)[0]
w = float(self.getDim(instance, this['id'], 'width'))
x = tabDim[0]['x']+tabDim[0]['max-width']/2-w/2
i.set('x', str(x))
y = tabDim[0]['y'] + delta
i.set('y', str(y))
placed_xy.append([i,this['id']])

if self.gap['fVCENTER']:

if 'id' in this:
delta += float(self.getDim(instance, this['id'], 'height'))

recenter = (self.gap['dHEIGHT'] - delta - tabDim[0]['y']) * 0.45

for i in placed_transform:
i[0].set('transform', 'translate(%f,%f)'%(i[1],i[2]+recenter))
i[2] += recenter # so it's not lost below
for i in placed_xy:
i[0].set('y', str(float(i[0].get('y'))+recenter))

if self.gap['fHCENTER']:

maxX = 0
for i in placed_xy:
x = float(self.getDim(instance, i[1], 'x'))
x += float(self.getDim(instance, i[1], 'width'))
if x > maxX: maxX = x

recenter = (self.gap['dWIDTH'] - maxX - tabDim[0]['x']) * 0.5

for i in placed_transform:
i[0].set('transform', 'translate(%f,%f)'%(i[1]+recenter,i[2]))
i[1] += recenter # in case it's used again
for i in placed_xy:
if i[0].tag != 'image': # images already centered
# print i[0].tag
i[0].set('x', str(float(i[0].get('x'))+recenter))

# look for instance specific parts
if slideId:
f = self.instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = self.doc.xpath('//s:svg', self.NS)[0]
g = "{%s}g"%self.NS['s']
k = "{%s}label"%self.NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), self.NS)
if x:
x = x[0]
cpy = self.clearId(copy.deepcopy(x))
# cpy = self.textCopy(x)
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', self.NS)
dst = self.doc.xpath('//s:svg/s:defs', self.NS)[0]
for d in defs:
Id = d.get('id')
current = self.doc.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, self.NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

for i in drop:
e = self.groupOrLayer(i)
if e:
e.xpath('..')[0].remove(e)

# problem losing xlink ns?
for i in self.doc.xpath('//*[@href]'):
i.set('{%s}href'%self.NS['xlink'], i.get('href'))

self.doc.write(file(instanceName, 'w'))

return slideId
def textCopy(self, ele):
"""copy the element ele via xml->text->xml, as deepcopy seems to lose text"""
txt = ET.tostring(ele)
# print txt
return ET.fromstring(txt)
def instancePath(self, slideId):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(self, inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', self.NS):
k = "{%s}label"%self.NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = self.instancePath(slideId)

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
x = inkSlide()
x.instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())

</pre>

InkSlide

2007-10-23T17:36:58Z

Terry brown: Undo revision 16497 by Terry brown (Talk)

InkSlide

2007-10-23T17:30:58Z

Terry brown: /* Download */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
InkSlide: Features
=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

InkSlide is undergoing rapid development at the moment and the code below may be out of date and may not match these instructions.

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A group or layer called ''gr_text'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group or layer called ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

"A group or layer called 'X'" indicates either a group with an '''@id'''
of 'X' ''or'' a layer with a '''label''' (name) of 'X'. When both exist the group will take precedence.

Optional contents:

*A background, which should be placed in a group or layer called `gr_bg`
*A foreground, which should be placed in a group or layer called `gr_fg`
*Affiliation text and logos you want to appear on every slide, this could go in the background, or another named group or layer.
*A blurred clone of the gr_title element, offset and behind it. It's easier to do this is `gr_title` is a group rather than a layer.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible. Likewise the Texts layer should be visible, as well as any Instance layers.
=== Text Input ===

InkSlide uses [http://docutils.sourceforge.net/rst.html reStructuredText] for markup, although it renders only a subset of rst.

<pre>
Inkslide: an example
====================

This text will appear as a top level paragraph.

- Dash prefix indicates this text will appear as a bulleted item.

- Indented dash prefix -> second level bulleted list.

.. is:pause

Two slides will be produced for this input, one with everything up to the
".. is:pause", and one with that plus the remaining content.
Incremental list display can be done this way.

The is:id tag below indicates that a file with a name like
'extra/is_intro.svg' should be inspected for extra content
for this particular slide.

.. is:id is_intro

Inkslide: the next slide...
===========================
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features. Remember you can
use the slide specific editing feature to do any of these things and
anything else you can do in Inkscape already, these will just be more
convenient in the text input when they're done.

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*<strike>Simple image inclusion</strike>
*more helper tools to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

Matt Harrison suggested using reStructured text as the markup language.

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-23T17:29:26Z

Terry brown: /* InkSlide - quick and easy presentations using Inkscape */

InkSlide

2007-10-23T17:27:37Z

Terry brown: /* The Template File */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
InkSlide: Features
==================

Features include wrapped top level text and
- mulitple
- levels
- of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A group or layer called ''gr_text'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group or layer called ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

"A group or layer called 'X'" indicates either a group with an '''@id'''
of 'X' ''or'' a layer with a '''label''' (name) of 'X'. When both exist the group will take precedence.

Optional contents:

*A background, which should be placed in a group or layer called `gr_bg`
*A foreground, which should be placed in a group or layer called `gr_fg`
*Affiliation text and logos you want to appear on every slide, this could go in the background, or another named group or layer.
*A blurred clone of the gr_title element, offset and behind it. It's easier to do this is `gr_title` is a group rather than a layer.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

InkSlide uses [http://docutils.sourceforge.net/rst.html reStructuredText] for markup, although it renders only a subset of rst.

<pre>
Inkslide: an example
====================

This text will appear as a top level paragraph.

- Dash prefix indicates this text will appear as a bulleted item.

- Indented dash prefix -> second level bulleted list.

.. is:pause

Two slides will be produced for this input, one with everything up to the
".. is:pause", and one with that plus the remaining content.
Incremental list display can be done this way.

The is:id tag below indicates that a file with a name like
'extra/is_intro.svg' should be inspected for extra content
for this particular slide.

.. is:id is_intro

Inkslide: the next slide...
===========================
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features. Remember you can
use the slide specific editing feature to do any of these things and
anything else you can do in Inkscape already, these will just be more
convenient in the text input when they're done.

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*<strike>Simple image inclusion</strike>
*more helper tools to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

Matt Harrison suggested using reStructured text as the markup language.

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-23T17:21:09Z

Terry brown: /* How it works */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
InkSlide: Features
==================

Features include wrapped top level text and
- mulitple
- levels
- of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

InkSlide uses [http://docutils.sourceforge.net/rst.html reStructuredText] for markup, although it renders only a subset of rst.

<pre>
Inkslide: an example
====================

This text will appear as a top level paragraph.

- Dash prefix indicates this text will appear as a bulleted item.

- Indented dash prefix -> second level bulleted list.

.. is:pause

Two slides will be produced for this input, one with everything up to the
".. is:pause", and one with that plus the remaining content.
Incremental list display can be done this way.

The is:id tag below indicates that a file with a name like
'extra/is_intro.svg' should be inspected for extra content
for this particular slide.

.. is:id is_intro

Inkslide: the next slide...
===========================
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features. Remember you can
use the slide specific editing feature to do any of these things and
anything else you can do in Inkscape already, these will just be more
convenient in the text input when they're done.

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*<strike>Simple image inclusion</strike>
*more helper tools to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

Matt Harrison suggested using reStructured text as the markup language.

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-23T17:19:46Z

Terry brown: /* InkSlide - quick and easy presentations using Inkscape */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
InkSlide: Features
==================

Features include wrapped top level text and
- mulitple
- levels
- of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

InkSlide uses [http://docutils.sourceforge.net/rst.html reStructuredText] for markup, although it renders only a subset of rst.

<pre>
Inkslide: an example
====================

This text will appear as a top level paragraph.

- Dash prefix indicates this text will appear as a bulleted item.

- Indented dash prefix -> second level bulleted list.

.. is:pause

Two slides will be produced for this input, one with everything up to the
".. is:pause", and one with that plus the remaining content.
Incremental list display can be done this way.

The is:id tag below indicates that a file with a name like
'extra/is_intro.svg' should be inspected for extra content
for this particular slide.

.. is:id is_intro

Inkslide: the next slide...
===========================
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features. Remember you can
use the slide specific editing feature to do any of these things and
anything else you can do in Inkscape already, these will just be more
convenient in the text input when they're done.

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*<strike>Simple image inclusion</strike>
*more helper tools to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

Matt Harrison suggested using reStructured text as the markup language.

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-23T17:18:47Z

Terry brown: /* Text Input */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

InkSlide uses [http://docutils.sourceforge.net/rst.html reStructuredText] for markup, although it renders only a subset of rst.

<pre>
Inkslide: an example
====================

This text will appear as a top level paragraph.

- Dash prefix indicates this text will appear as a bulleted item.

- Indented dash prefix -> second level bulleted list.

.. is:pause

Two slides will be produced for this input, one with everything up to the
".. is:pause", and one with that plus the remaining content.
Incremental list display can be done this way.

The is:id tag below indicates that a file with a name like
'extra/is_intro.svg' should be inspected for extra content
for this particular slide.

.. is:id is_intro

Inkslide: the next slide...
===========================
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features. Remember you can
use the slide specific editing feature to do any of these things and
anything else you can do in Inkscape already, these will just be more
convenient in the text input when they're done.

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*<strike>Simple image inclusion</strike>
*more helper tools to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

Matt Harrison suggested using reStructured text as the markup language.

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-23T17:13:38Z

Terry brown: /* Author / Credits */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above,
and one with that plus the remaining content.
Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should
be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features. Remember you can
use the slide specific editing feature to do any of these things and
anything else you can do in Inkscape already, these will just be more
convenient in the text input when they're done.

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*<strike>Simple image inclusion</strike>
*more helper tools to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

Matt Harrison suggested using reStructured text as the markup language.

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-23T17:11:54Z

Terry brown: /* To do / status */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above,
and one with that plus the remaining content.
Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should
be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features. Remember you can
use the slide specific editing feature to do any of these things and
anything else you can do in Inkscape already, these will just be more
convenient in the text input when they're done.

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*<strike>Simple image inclusion</strike>
*more helper tools to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T19:52:48Z

Terry brown: /* To do / status */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above,
and one with that plus the remaining content.
Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should
be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features. Remember you can
use the slide specific editing feature to do any of these things and
anything else you can do in Inkscape already, these will just be more
convenient in the text input when they're done.

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T19:50:27Z

Terry brown: /* Text Input */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above,
and one with that plus the remaining content.
Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should
be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T19:50:09Z

Terry brown: /* Text Input */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above,
and one with that plus the remaining content. Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should
be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T17:03:36Z

Terry brown: /* To do / status */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above,
and one with the remaining content. Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should
be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

Currently InkSlide is slow, because it must invoke Inkscape once for every single dimension it needs to retrieve. I'll try and get a --query-all switch into 0.46.

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T17:00:34Z

Terry brown: /* Download */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)

Here is an [[Media:template0.svg|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above,
and one with the remaining content. Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should
be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

File:Template0.svg

2007-10-17T16:57:54Z

Terry brown: Example template for InkSlide

Example template for InkSlide

InkSlide

2007-10-17T16:53:03Z

Terry brown: /* Download */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'.

Here is an [[Media:template0.svg|example template]].

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above,
and one with the remaining content. Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should
be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T16:52:29Z

Terry brown: /* Download */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'.

Here is an [[Media:template0.svg example template]]

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above,
and one with the remaining content. Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should
be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T16:51:38Z

Terry brown: /* Text Input */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above,
and one with the remaining content. Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should
be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T16:50:32Z

Terry brown: /* The Template File */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.
*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above, and one with the remaining content. Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T16:45:15Z

Terry brown: /* The Template File */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above, and one with the remaining content. Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T16:44:35Z

Terry brown: /* The Template File */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

Required contents:

*A layer called ''Texts'', into which text will be placed.
*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

Optional contents:

*A background
*Affiliation text and logos you want to appear on every slide
*A blurred clone of the gr_title element, offset and behind it.

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above, and one with the remaining content. Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T16:29:47Z

Terry brown: /* InkSlide - quick and easy presentations using Inkscape */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>

Creates / updates the Inkscape file you can edit to add special content to this particular slide. '''NOT IMPLEMENTED YET''' - the code exists, but not the command line hook.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== The Template File ===

=== Text Input ===

<pre>
%title Inkslide: an example
This text will appear as a top level paragraph.
Indented by a single tab, this text will appear as a bulleted item.
Two tabs -> second level bulleted list.

A gap will be left for the preceeding line.
%pause
Two slides will be produced for this input, one with everything up to the %pause above, and one with the remaining content. Incremental list display can be done this way.

The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should be inspected for extra content for this particular slide.
%id is_intro
%title Inkslide: the next slide...
</pre>

=== The GUI ===

A GUI for InkSlide is available as a plug-in for the [http://webpages.charter.net/edreamleo/front.html Leo] outline editor. This makes slide re-arranging easy, and adds some macro substitution capability. It also adds buttons for editing slide specific content in Inkscape.

FIXME: post plug-in on Leo wiki and link.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides
*command line flags for generating specific slides

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author / Credits ===

InkSlide was written by Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T16:03:55Z

Terry brown: /* How it works */

== InkSlide - quick and easy presentations using Inkscape ==

InkSlide produces slides like this:

[[Image:slide0004.jpg]]

from simple text input like this:

<pre>
%slide InkSlide: Features
Features include wrapped top level text and
mulitple
levels
of wrapped bulleted lists with bullets and font
information taken from the template file.

Slide specific content like this:

which is updated when the template changes.
</pre>

An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

=== Download ===

Copy the [[InkSlide#Code|text below]] into a file called 'inkslide.py'.

=== Use ===

<pre>python inkslide.py myTemplate.svg mySlides.txt</pre>

This creates a slide00xx.svg for each slide in your presentation.

=== How it works ===

First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

Finally, InkSlide checks to see if there's an %id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

=== To do / status ===

InkSlide is very usable, but is missing some features:

*Inline text formatting (bold, color, etc.) for part of a piece of text
*Justification switching
*Verbatim code display
*Simple image inclusion
**currently you can do this using the Inkscape editing features
*more helper tool to make PNG and PDF versions of slides
*configuring / using a directory for edited slides

=== Bugs ===

*There may be an issue with the way slide specific content is merged into the template producing conflicting @id attributes, but I haven't seen this happen yet.

=== Author ===

Terry Brown, terry-n-brown@yahoo.com - but use underscore, not '-'.

=== Code ===

<pre>
# inkslide.py $Id$
# Author: Terry Brown
# Created: Thu Oct 11 2007

import lxml.etree as ET

import copy
import subprocess
import os.path

NS = { 'i': 'http://www.inkscape.org/namespaces/inkscape',
's': 'http://www.w3.org/2000/svg',
'xlink' : 'http://www.w3.org/1999/xlink'}

# number of defined tablevels, FIXME, could derive from template?
tabLevels = 4
def clearId(x, what='id', NS={}):
"""recursively clear @id on element x and descendants"""
if what in x.keys():
del x.attrib[what]
for i in x.xpath('.//*[@%s]'%what, NS):
del i.attrib[what]
return x
def getDim(fn, Id, what):
"""return dimension of element in fn with @id Id, what is
x, y, width, height
"""
cmd = ('inkscape', '--without-gui', '--query-id', Id, '--query-'+what, fn)
proc = subprocess.Popen(cmd, stdout = subprocess.PIPE,
stderr = subprocess.PIPE)
# make new pipe for stderr to supress chatter from inkscape
proc.wait()
return proc.stdout.read()
def textReader(text):
"""iterate parts in input text"""
if not text: return
for line in text.split('\n'):
if line.startswith('%slide '):
yield {'type':'TITLE', 's':line[7:].strip()}
continue
if line.startswith('%pause'):
yield {'type':'PAUSE'}
continue
if line.startswith('%id '):
yield {'type':'ID', 's':line[4:].strip()}
continue
if not line.strip():
yield {'type':'BLANK'}
continue
tabs = len(line) - len(line.lstrip('\t'))
yield {'type':'TAB', 'tabs':tabs, 's':line.strip()}

nid = 0
def nextId():
"""return an unsed Id"""
# FIXME, should inspect templat doc.
global nid
nid += 1
return 'is'+str(nid)

def instanceFromTemplate(template, instance, text, pauseOk = True):

slide = 0

hlist = []
doc0 = ET.parse(template)
slideId = None

for t in textReader(text):

if t['type'] == 'ID':
slideId = t['s']
continue

if t['type'] == 'TITLE':
print t['s']
if hlist:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
hlist = [t]
doc0 = ET.parse(template)
slideId = None
else:
hlist.append(t)
dst = doc0.xpath('//s:g[@id="gr_title"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_title"]', NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
continue

if t['type'] == 'PAUSE':
if pauseOk:
process(instance, doc0, hlist, slideId, slide)
slide = slide + 1
continue

hlist.append(t)

if t['type'] == 'BLANK':
continue
if t['type'] == 'TAB':
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
src = doc0.xpath('//s:flowRoot[@id="fr_tab%d"]' % t['tabs'], NS)[0]
cpy = clearId(copy.deepcopy(src))
Id = nextId()
cpy.set('id', Id)
hlist[-1]['id']=Id
cpy.xpath('s:flowPara',NS)[0].text = t['s']
dst.append(cpy)
#break
continue

process(instance, doc0, hlist, slideId, slide)
def process(instance, doc0, hlist, slideId, slide):

instance = instance.replace('%s', '%04d'%slide)
doc0.write(file(instance, 'w'))

bullDim = {}
tabDim = {}
for n in range(0,tabLevels):
b = {}
x = doc0.xpath('//*[@id="bu_%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'width', 'height':
b[i] = float(getDim(instance, 'bu_%d'%n, i))
bullDim[n] = b
b = {}
x = doc0.xpath('//*[@id="fr_tab%d"]'%n, NS)
if x:
# clearId(x[0], what='transform')
for i in 'x', 'y', 'height':
b[i] = float(getDim(instance, 'fr_tab%d'%n, i))
tabDim[n] = b

delta = 0.
firstVert = True
for n, i in enumerate(hlist):
if hlist[n]['type'] in ['TITLE']:
continue # already in right place, not a vertical element

hgt = 0
if hlist[n-1]['type'] == 'BLANK':
hgt = 30
else:
hgt = float(getDim(instance, hlist[n-1]['id'], 'height'))

hgt += 5

if firstVert:
hgt = 0
firstVert = False

delta += hgt

if hlist[n]['type'] == 'BLANK': continue

tabs = hlist[n]['tabs']

r = doc0.xpath('//s:flowRoot[@id="%s"]' % hlist[n]['id'], NS)[0]
clearId(r, what='transform')
r = r.xpath('.//s:rect', NS)[0]
r.set('x', str(tabDim[tabs]['x']))
y = tabDim[tabs]['y'] + delta
#print '%s -> %s' % (str(r.get('y')), str(y))
#print tabDim[tabs]['y']
r.set('y', str(y))

if (hlist[n]['type'] == 'TAB' and hlist[n]['tabs'] in bullDim
and 'isDone' not in hlist[n]):
hlist[n]['isDone'] = True
dx = (tabDim[tabs]['x']
- bullDim[tabs]['x']
- 1.5*bullDim[tabs]['width']
)
dy = (y
+ tabDim[tabs]['height'] / 2.
- bullDim[tabs]['y']
- bullDim[tabs]['height'] / 2.
)
dst = doc0.xpath('//s:g[@i:label="Texts"]', NS)[0]
#print y, tabDim[tabs]['height'], bullDim[tabs]['y'], bullDim[tabs]['height'], dy
clone = ET.Element('svg:use')
clone.set('transform', 'translate(%f,%f)' % (dx,dy))
clone.set('{%s}href'%NS['xlink'], '#bu_%d'%tabs)
dst.append(clone)

#path = ET.Element('svg:path')
#path.set('d', ('M %f,%f' + ' L %f,%f'*5 + ' z') % (
# bullDim[tabs]['x'], bullDim[tabs]['y'],
# bullDim[tabs]['x']+20, bullDim[tabs]['y']+bullDim[tabs]['height']/2.,
# bullDim[tabs]['x'], bullDim[tabs]['y']+bullDim[tabs]['height'],
# tabDim[tabs]['x'], tabDim[tabs]['y'],
# tabDim[tabs]['x']+20, tabDim[tabs]['y']+tabDim[tabs]['height']/2.,
# tabDim[tabs]['x'], tabDim[tabs]['y']+tabDim[tabs]['height'],
# ))
#dst.append(path)
#break

# look for instance specific parts
if slideId:
f = instancePath(slideId)
if os.path.isfile(f):
comp = ET.parse(f)
svg = doc0.xpath('//s:svg', NS)[0]
g = "{%s}g"%NS['s']
k = "{%s}label"%NS['i']
for n, i in enumerate(svg.getchildren()):
if i.tag == g and i.get(k, '').startswith('Instance'):
x = comp.xpath('//s:svg//s:g[@i:label="%s"]'%i.get(k), NS)
if x:
x = x[0]
cpy = clearId(copy.deepcopy(x))
svg[n] = cpy
defs = comp.xpath('//s:svg/s:defs/*', NS)
dst = doc0.xpath('//s:svg/s:defs', NS)[0]
for d in defs:
Id = d.get('id')
current = doc0.xpath('//s:svg/s:defs/*[@id="%s"]'%Id, NS)
if not current:
cpy = copy.deepcopy(d)
dst.append(cpy)

doc0.write(file(instance, 'w'))

return slideId
def instancePath(slideId, component = None):
"""return path to component for slide"""
# return os.path.join(slideId, component)
return slideId+'.svg'
def writeComponents(inkscapeFile, slideId):
"""write components from file for slide"""
if not slideId: return
doc0 = ET.parse(inkscapeFile)
hasComponents = False
for i in doc0.xpath('//s:svg//s:g', NS):
k = "{%s}label"%NS['i']
# print i.keys(),k
if (k in i.keys() and i.get(k).startswith('Instance')):
if len(i) > 0:
hasComponents = True
break
# ET.ElementTree(i).write(f)

f = instancePath(slideId, 'components')

if hasComponents:
if (os.path.abspath(os.path.realpath(inkscapeFile)) !=
os.path.abspath(os.path.realpath(f))):
file(f, 'w').write(file(inkscapeFile).read())
else:
if os.path.isfile(f):
os.remove(f)

if __name__ == '__main__':
import sys
instanceFromTemplate(sys.argv[1], 'slide%s.svg', file(sys.argv[2]).read())
</pre>

InkSlide

2007-10-17T15:48:48Z

Terry brown: /* To do / status */

InkSlide

2007-10-17T15:43:53Z

Terry brown: /* InkSlide - quick and easy presentations using Inkscape */

InkSlide

2007-10-17T15:22:21Z

Terry brown: /* Download */

InkSlide

2007-10-17T15:21:28Z

Terry brown: /* InkSlide - quick and easy presentations using Inkscape */

File:Slide0004.jpg

2007-10-17T15:13:14Z

Terry brown: Example of a slide created with InkSlide

Example of a slide created with InkSlide

InkSlide

2007-10-17T15:12:08Z

Terry brown: New page: == InkSlide - quick and easy presentations using Inkscape == InkSlide produces slides like this: Image:slide0004.jpg from simple text input like this: <pre> %slide InkSlide: Featur...

Tools

2007-10-17T15:01:35Z

Terry brown: /* Multipage presentation or book */

=== SVG Validator ===
A [http://jiggles.w3.org/svgvalidator/ validator service] (and downloadable tool) is provided by the [[W3C]]. It will complain about sodipodi or inkscape namespaced items in the document, unless you've exported to plain SVG.

=== SVG::Metadata ===
[http://search.cpan.org/CPAN/authors/id/B/BR/BRYCE/SVG-Metadata-0.10.tar.gz Perl module and set of scripts] to help in adding and processing metadata in SVG files.

== Vectorize/trace ==
=== Potrace ===
[[Potrace]] is now embedded into Inkscape. You don't need to run it separately.
*[[Potrace|Using Potrace through Inkscape]]
*[http://potrace.sourceforge.net/ Potrace page at Sourceforge]

=== Autotrace and Frontline (alternatives to Potrace) ===
'''Autotrace''' an open source vectorization program by Martin Weber. That means you can convert bitmap images (like scans) to vector graphics. While not optimal for photos, it does good job on line art and poster-like images. Doesn't do too well with color.

Autotrace has some features not available in the embedded [[Potrace]] dialog in Inkscape. For example, there is a ''centerline'' switch that is especially usefull for tracing roads (in maps) or font characters.

'''Frontline''' is GUI frontend to Autotrace by Masatake Yamato. Frontline can be run as standalone aplication, but it can also be directly accessed from Inkscape and GIMP.

If you want to have tracing option, you have to install both Autotrace and Frontline before compiling Inkscape. Inkscape automatically detects these programs, and adds inline raster to vector conversion option to image menu.

Both Autotrace and Frontline can be downloaded from [http://autotrace.sourceforge.net/ Sourceforge]. Binaries are available for windows and linux.

=== Delineate ===
Front end written in java that does interesting things with color images.
*[http://delineate.sourceforge.net/ Delineate at Sourceforge]

== Convert to SVG ==
=== svg2pdf ===

This simple but useful application is kindly provided by Carl Worth ([http://cairographics.org/ cairo]).
==== How to obtain it: ====
git clone git://people.freedesktop.org/~cworth/svg2pdf
And to update it dive into newly created directory called '''''svg2pdf''''' and type this in console:
git pull
(You must of course have '''git''' package installed)

==== Building ====
If build-time dependencies are satisfied
librsvg and cairo
you only need to type
make

==== Usage ====
./svg2pdf input_file.svg output_file.pdf

Note: from version 0.46 Inkscape can both read and write PDFs directly from the open/save dialogs. These tools however allow this conversion where 0.46 is not available, and also provide a means of validating if bugs encountered are Inkscape related.

=== [[uniconvertor]] ===
UniConvertor is an universal vector graphics translator. The project uses sK1 engine to convert one format to another. Project has following import filters: CDR, CMX, AI, CGM, WMF, XFIG, SVG, SK, SK1, AFF and export filters: AI, SVG, SK, SK1, CGM, WMF.
*[http://sourceforge.net/projects/uniconvertor/ Uniconvertor]

=== ill2svg ===
ill2svg (Illustrator to SVG) is a small script that helps turn Adobe
Illustrator .ai files into SVG. While it doesn't always do a perfect job,
it can sometimes be of great help.

To use the program, just type:

<pre>ill2svg.pl [-l "string" -h] infile > outfile.svg

options:
-l specify the file's line-ending convention: dos, mac,
or unix; the default is unix

-h print this message and exit
</pre>

=== ai2svg.py ===
ai2svg (Illustrator to SVG, recoded in python) is as well a small script that helps turn Adobe Illustrator .ai files into SVG. The Python recode aims to help developers more familiar to python than perl, as well fixing some lacks from ill2svg.pl - supports dashes, layers, textboxes (ascii-latin), and joined pathes.

To use the program, just type:

<pre>python ai2svg.py drawing.ai

the result will appear as neighbour, named drawing.ai.svg

options:
--help print this message and exit
</pre>

available at http://www15.brinkster.com/nitrofurano/python/ (that .zip file, in the tools folder) (404 Page not found on 2007-10-15)

=== fig2vect ===
fig2vector (fig vector format to other vector formats, including SVG) is a converter from 'Fig format' long time used (at least since 1998) unix vector format ([http://epb.lbl.gov/xfig/ Xfig], figurine, jfig, winfig...), large kind of application output on this format in unix, mostly scientific applications.

* [http://fig2vect.sourceforge.net/ fig2vect]

=== gimp2sodipodi ===
Shandy Brown has assembled a somewhat obscure but useful set of tools to get from GIMP to Sodipodi (and thus to Inkscape). That is, convert raster to vector.
*[http://sjbrown.users.geeky.net/gimp2sodi/HOWTO.html gimp2sodipodi instructions]

=== GIMP ===
GIMP is a bitmap graphics tool in the first place, but:
* it imports SVG (with help of librsvg) into bitmap or vector path, exports SVG.
* GIMP's selection can be converted to a vector path, and paths can be exported/imported as SVG.

GIMP can be used to create nice textures to use in Inkscape or shapes that can be vectorized in Inkscape. Importing SVG drawings from Inkscape to GIMP allows you to do several effects by filling and stroking shapes.

There is a limited support for drag'n'drop between GIMP and Inkscape:
* path, can be drag'n'droped from Gimp path dialog to Inkscape
* pictures can be drag'n'droped from Gimp document history to Inkscape if it's in a file format that Inkscape understands.

*[http://www.gimp.org gimp.org]

=== ConversionSVG ===

ConversionSVG is a GUI that send command line to Inkscape to export in batch SVG to PNG, PS, PDF or EPS. It features a Wizard to help novice to use it. You can choose a size in pixels for your export and give some others parameters.

*http://sourceforge.net/projects/conversionsvg/

=== Kig ===
Kig is a geometry educational tool, it can import from most of the free geom softwares format : kig (own format), kigz (own format compresed), kgeo, seg (Kseg), fgeo (Dr Geo) anf fig, and can export them to SVG, xfig, latex, and image. This can be useful to integrate a geometry activity in a more complet document realized in Inkscape for web reading or printing for schools.

*http://edu.kde.org/kig

== Color scheme & palettes ==
=== Agave ===
Agave is a color scheme tool allowing to create palettes based on standard color composition rules, it export it's palettes in the format managed by Gimp and Inkscape.

*[http://home.gna.org/colorscheme/ Agave]

== Video editing, for building animation ==
=== Linux Video Editing System ===
LIVES is the Linux Video Editing System that permits editing and
making video without worries about formats, frame sizes, or frame
rates. It doesn't support SVG directly yet, but you can create animated
works by moving your shapes in Inkscape and exporting as numbered
png's.

*[http://www.xs4all.nl/%7Esalsaman/lives/ LIVES]

=== Kdenlive ===
Kdenlive is a non-linear video editor for Linux, that allow editing, mixing several video and audio using several timelines with previews, add audio/video effects using effects stacks, add text for title or subtitle. It support SVG (but not svgz, at least in svn 20070410).

*[http://kdenlive.org/ Kdenlive]

=== Open Movie Editor ===
Open Movie Editor is a non linear video editor, allowing editing, mixing several audio and vido, don't know if it supports svg, but as LIVES it can be used for work with png frames to build animation

*[http://openmovieeditor.sourceforge.net Open Movie Editor]

== Multipage presentation or book ==

=== [[InkSlide]] ===

[[InkSlide]] is a presentation creation tool (a small python program) that uses an Inkscape SVG file as a template for rapidly producing slides with text, bulleted lists, images and slide specific SVG content.

* [[InkSlide]]

=== slides ===

Slides is a command-line unix utility to create a multi-page PDF file from a sequence of SVG files. This is very helpful for creating slide presentations. For example, it is excellent for making lectures. You can make incremental slides very easily (i.e., slides which grow with each step, such as listings). This is done by marking incremental slides in your inkscape svg document. A tutorial is available on the web page.

*[http://volition.leeds.ac.uk/slides/ Slides]

=== Scribus ===

Scribus is a publishing software supporting SVG, allowing to organise Inkscape documents as a full featured pre-press tool. It doesn't support SVG filters (blur/blend modes...), but manage most of other features.

*[http://www.scribus.net/ Scribus]

[[Category:About Inkscape]]

== Charts & Graphs ==
=== Gnuplot ===
Gnuplot, the command line (with several frontends) driven interactive data and function plotting tool has SVG output for graphs & charts.
* Input can be functions or datasets
* Output in 2D, 3D...
* http://www.gnuplot.info/

=== matplotlib ===
Matplotlib is a python plotting library and can also output SVG.
* http://matplotlib.sourceforge.net/

=== Gnumeric ===
Gnumeric, the Gnome spreadsheet output a variety of graphs/charts in SVG format.
* http://www.gnome.org/projects/gnumeric/

=== SVG Charter ===
SVG charter is a perl script dedicated to generate SVG charts on web servers.
* http://charter.sourceforge.net/

== Diagrams ==
=== Graphviz ===
Graphviz is a tool for automatic graph drawing, it produces structural information as diagrams of abstract graphs and networks in SVG and other vector formats. Several diagrams softwares use this tool or dot file managed by this tool in variety application domains including:
* UML
* databases
* networks
* source code analysers objects/functions relations
* code profiling analalysis
* web server log analyser
* packages dependencies
* ...

*[http://www.graphviz.org/ graphviz]
*[http://freshmeat.net/search/?q=graphviz Some free software using graphviz to output diagrams]