Inkscape Wiki - User contributions [en]

Working with Bazaar

2009-12-07T02:48:50Z

Jiho: /* Using a decentralized workflow */

==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.

Get Inkscape's code
$ bzr branch lp:inkscape

Now work:
$ cd inkscape
<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

Update your branch to verify that your changes do not conflict with others
$ bzr pull

If everything is OK and that you are satisfied with your changes, publish them
$ 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]

Working with Bazaar

2009-12-07T02:47:04Z

Jiho: /* Using a centralized (SVN-like) workflow */

==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.

$ cd inkscape
<work work work>
$ bzr commit -m "Some changes"
<more work work work>
$ bzr commit -m "More changes"
<update your branch to verify that your changes do not conflict with others>
$ bzr pull
<if everything is OK and that you are satisfied with your changes, publish them>
$ 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]

Working with Bazaar

2009-12-07T02:42:19Z

Jiho: /* SVN-style checkout */

==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.

$ cd inkscape
<work work work>
$ bzr commit -m "Some changes"
<more work work work>
$ bzr commit -m "More changes"
<update your branch to verify that your changes do not conflict with others>
$ bzr pull
<if everything is OK and that you are satisfied with your changes, publish them>
$ bzr push

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

The basic usage:
$ bzr branch lp:inkscape
$ cd inkscape
$ bzr bind lp:inkscape
<do work>
$ bzr commit
<error, someone else has changed things>
$ bzr update
<check all is okay>
$ bzr commit

===SVN-style checkout===

Bazaar can be used very much like SVN.

* Get the latest Inkscape code: <tt>bzr checkout lp:inkscape</tt>
* Make changes to the files. 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.
* Commit the changes, making them accessible to others: <tt>bzr commit</tt>
* Receive the most up-to-date version of the code: <tt>bzr update</tt>

===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]

Working with Bazaar

2009-12-07T02:41:55Z

Jiho: /* Using a decentralized workflow */

==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.

$ cd inkscape
<work work work>
$ bzr commit -m "Some changes"
<more work work work>
$ bzr commit -m "More changes"
<update your branch to verify that your changes do not conflict with others>
$ bzr pull
<if everything is OK and that you are satisfied with your changes, publish them>
$ bzr push

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

The basic usage:
$ bzr branch lp:inkscape
$ cd inkscape
$ bzr bind lp:inkscape
<do work>
$ bzr commit
<error, someone else has changed things>
$ bzr update
<check all is okay>
$ bzr commit

==SVN-style checkout==

Bazaar can be used very much like SVN.

* Get the latest Inkscape code: <tt>bzr checkout lp:inkscape</tt>
* Make changes to the files. 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.
* Commit the changes, making them accessible to others: <tt>bzr commit</tt>
* Receive the most up-to-date version of the code: <tt>bzr update</tt>

===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]

Working with Bazaar

2009-12-07T02:38:57Z

Jiho: /* First steps */

==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==

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

The basic usage:
$ bzr branch lp:inkscape
$ cd inkscape
$ bzr bind lp:inkscape
<do work>
$ bzr commit
<error, someone else has changed things>
$ bzr update
<check all is okay>
$ bzr commit

==SVN-style checkout==

Bazaar can be used very much like SVN.

* Get the latest Inkscape code: <tt>bzr checkout lp:inkscape</tt>
* Make changes to the files. 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.
* Commit the changes, making them accessible to others: <tt>bzr commit</tt>
* Receive the most up-to-date version of the code: <tt>bzr update</tt>

===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]

Working with Bazaar

2009-12-07T02:38:02Z

Jiho: /* First steps */

==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==

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

The basic usage:
$ bzr branch lp:inkscape
$ cd inkscape
$ bzr bind lp:inkscape
<do work>
$ bzr commit
<error, someone else has changed things>
$ bzr update
<check all is okay>
$ bzr commit

==SVN-style checkout==

Bazaar can be used very much like SVN.

* Get the latest Inkscape code: <tt>bzr checkout lp:inkscape</tt>
* Make changes to the files. 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.
* Commit the changes, making them accessible to others: <tt>bzr commit</tt>
* Receive the most up-to-date version of the code: <tt>bzr update</tt>

===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]

Save as vs export

2008-03-18T11:05:46Z

Jiho: /* Description of the export dialog */

= Sort out ''Save as'' vs ''Export'' formats =

This blueprint stems from several discussions on the mailing list about which format should be available in ''Save as'' or in ''Export'' and whether some should be exclusively available in only one of those.

==Current status==
There are different opinions on the current status of this functionality in Inkscape which is:

; Save
: contains all possible file formats (except PNG) and saves with the same name. If a format other than Inkscape SVG (or SVGZ) is used, a nag screen is displayed at close time, to warn the user about possible data loss.
; Save as
: idem but saves with a new name and this new document is used inside Inkscape. Same nag screen.
; Save a copy
: idem but the new document is not used inside Inkscape. It is just written on the disk and work continues in the current document. Hence saving as a format different from SVG does not cause the nag screen to appear (the working document is still SVG)
; Export
: saves the drawing or part of it as a PNG raster file, with a new name, and keep the working image as SVG. The ''Export'' dialog can stay open at all times.

As a reminder, current save formats are (at least): Inkscape SVG(Z), Plain SVG(Z), PS, EPS, Cairo PDF, Cairo PS, POV, ODG, TEX, AI (8.0), DXF, AutoCAD DXF, EPSI, GPL, XCF, XAML, Inkscape svg with media ZIP, EMF.

Some people are just fine with this, some other think it is a mess, some other think a middle ground should be found between this and changing everything.

==Proposal==

The new behavior is based on the principles that
# The user should not be able to shoot him/herself in the foot by saving only to a lossy format
# The number of items in the file menu should be reduced
# Functionality (or UI at least) should be consistent for all save/export format

Principle 1 means that ''Save'' and ''Save as'' should only save as Inkscape SVG(Z) (and possibly plain SVG for people that only work in plain SVG?).

Principle 2 means that one of ''Save a copy'' and ''Export'' has to go since they are kind of redundant.

Principle 3 means that, when it is possible, saving in vector formats should offer the option to save only one object or a specific part of the canvas to the saved image, as export to PNG does. Furthermore, the UI should be consistent for this functionality.

The proposed behavior is therefore

; Save
: saves only as Inkscape SVG(Z) (Plain SVG(Z)? People, please give opinions on this. I don't personally work with SVG as the end format so can't tell what the workflow is in this case. Plain SVG is lossy from the editing point of view but maybe that is a major pain to have two copies of the same document when working with what is supposed to be Inkscape's native format)
; Save as
: idem, with a new name and setting the working document to be the new file
; Export
: saves to all vector and bitmap (and other e.g. GPL) formats, comprising Inkscape SVG(Z) and Plain SVG(Z), with a new name, keeping the working document in place. The export dialog should present a similar set of options for all file types, disable those not available for the particular file type selected, in a dialog as compact as possible (since it is meant to stay open at all time)

===Description of the export dialog===
* a file chooser at the top, and file type defaulting to "Guess from extension". The chosen filename should be shown relative to the current document and use and ellipsis to always show the extension (so that it is immediately obvious which file type is exported)
* batch export all selected object check box*
* four tabs underneath (Page, Drawing, Objects, Custom)**
* depending on the file type, enable or disable batch export
* when batch export is unchecked/unavailable, enable or disable each tab depending on the file type
** PNG: enable all
** PDF/PS/EPS: enable page, drawing, objects
** other graphic formats: enable page or drawing depending on the behaviour of the file type
** other formats (GPL): disable all

(*) To simplify matters, if batch export is restricted to PNG, it could be made a separate menu entry in the file menu Indeed, there is very little user interaction left in the dialog when it is checked (basically one can only click "Export") so it may be more efficiently done in one action (File > Batch export to bitmap) instead of three (File > Export bitmap, tick batch export, Click export). With SHIFT+ALT+CTRL+E as keyboard shortcut and a discardable nag screen (no they are not always evil) about the fact that it overwrites previous files it seems like a good solution to me.

(**) Selection becomes Objects and exports only selected objects (as with "hide all except selected objects" now). Custom behaves by default as "Selection" does now: the coordinates are the one of current selection and, when only one object is selected, the filename to which it is saved is saved in the SVG. When coordinates are changed manually and it reverts to how custom works currently. Does that make sense? Another solution would be to have Page, Drawing, Object, Selection/Selected area, Custom but it would make the dialog bigger.

===Correspondance between bitmap and vector functionality===
<table border="0" cellspacing="5" cellpadding="5">
<tr><th>Bitmap</th><th>Cairo PDF/PS</th></tr>
<tr><td>page</td><td>page</td></tr>
<tr><td>drawing</td><td>drawing</td></tr>
<tr><td>selection+hide</td><td>by ID</td></tr>
<tr><td>selection-hide</td><td>no equivalent (could be achieved by clipping though, or setting a crop box in the pdf)</td></tr>
<tr><td>custom</td><td>no equivalent (idem)</td></tr>
</table>
(see http://jo.irisson.free.fr/dropbox/test-export.zip for an illustrated version)

Save as vs export

2008-03-18T10:58:43Z

Jiho: Proposal for sorting out export/save as functionality.

= Sort out ''Save as'' vs ''Export'' formats =

This blueprint stems from several discussions on the mailing list about which format should be available in ''Save as'' or in ''Export'' and whether some should be exclusively available in only one of those.

==Current status==
There are different opinions on the current status of this functionality in Inkscape which is:

; Save
: contains all possible file formats (except PNG) and saves with the same name. If a format other than Inkscape SVG (or SVGZ) is used, a nag screen is displayed at close time, to warn the user about possible data loss.
; Save as
: idem but saves with a new name and this new document is used inside Inkscape. Same nag screen.
; Save a copy
: idem but the new document is not used inside Inkscape. It is just written on the disk and work continues in the current document. Hence saving as a format different from SVG does not cause the nag screen to appear (the working document is still SVG)
; Export
: saves the drawing or part of it as a PNG raster file, with a new name, and keep the working image as SVG. The ''Export'' dialog can stay open at all times.

As a reminder, current save formats are (at least): Inkscape SVG(Z), Plain SVG(Z), PS, EPS, Cairo PDF, Cairo PS, POV, ODG, TEX, AI (8.0), DXF, AutoCAD DXF, EPSI, GPL, XCF, XAML, Inkscape svg with media ZIP, EMF.

Some people are just fine with this, some other think it is a mess, some other think a middle ground should be found between this and changing everything.

==Proposal==

The new behavior is based on the principles that
# The user should not be able to shoot him/herself in the foot by saving only to a lossy format
# The number of items in the file menu should be reduced
# Functionality (or UI at least) should be consistent for all save/export format

Principle 1 means that ''Save'' and ''Save as'' should only save as Inkscape SVG(Z) (and possibly plain SVG for people that only work in plain SVG?).

Principle 2 means that one of ''Save a copy'' and ''Export'' has to go since they are kind of redundant.

Principle 3 means that, when it is possible, saving in vector formats should offer the option to save only one object or a specific part of the canvas to the saved image, as export to PNG does. Furthermore, the UI should be consistent for this functionality.

The proposed behavior is therefore

; Save
: saves only as Inkscape SVG(Z) (Plain SVG(Z)? People, please give opinions on this. I don't personally work with SVG as the end format so can't tell what the workflow is in this case. Plain SVG is lossy from the editing point of view but maybe that is a major pain to have two copies of the same document when working with what is supposed to be Inkscape's native format)
; Save as
: idem, with a new name and setting the working document to be the new file
; Export
: saves to all vector and bitmap (and other e.g. GPL) formats, comprising Inkscape SVG(Z) and Plain SVG(Z), with a new name, keeping the working document in place. The export dialog should present a similar set of options for all file types, disable those not available for the particular file type selected, in a dialog as compact as possible (since it is meant to stay open at all time)

===Description of the export dialog===
* a file chooser at the top, and file type defaulting to "Guess from extension".
* batch export all selected object check box*
* four tabs underneath (Page, Drawing, Objects, Custom)**
* depending on the file type, enable or disable batch export
* when batch export is unchecked/unavailable, enable or disable each tab depending on the file type
** PNG: enable all
** PDF/PS/EPS: enable page, drawing, objects
** other graphic formats: enable page or drawing depending on the behaviour of the file type
** other formats (GPL): disable all

(*) To simplify matters, if batch export is restricted to PNG, it could be made a separate menu entry in the file menu Indeed, there is very little user interaction left in the dialog when it is checked (basically one can only click "Export") so it may be more efficiently done in one action (File > Batch export to bitmap) instead of three (File > Export bitmap, tick batch export, Click export). With SHIFT+ALT+CTRL+E as keyboard shortcut and a discardable nag screen about the fact that it overwrites previous files it seems like a good solution to me.

(**) Selection becomes Objects and exports only selected objects (as with "hide all except selected objects" now). Custom behaves by default as "Selection" does now: the coordinates are the one of current selection and, when only one object is selected, the filename to which it is saved is saved in the SVG. When coordinates are changed manually and it reverts to how custom works currently. Does that make sense? Another solution would be to have Page, Drawing, Object, Selection/Selected area, Custom but it would make the dialog bigger.

===Correspondance between bitmap and vector functionality===
<table border="0" cellspacing="5" cellpadding="5">
<tr><th>Bitmap</th><th>Cairo PDF/PS</th></tr>
<tr><td>page</td><td>page</td></tr>
<tr><td>drawing</td><td>drawing</td></tr>
<tr><td>selection+hide</td><td>by ID</td></tr>
<tr><td>selection-hide</td><td>no equivalent (could be achieved by clipping though, or setting a crop box in the pdf)</td></tr>
<tr><td>custom</td><td>no equivalent (idem)</td></tr>
</table>
(see http://jo.irisson.free.fr/dropbox/test-export.zip for an illustrated version)

Change VCS

2008-03-17T13:35:48Z

Jiho: /* Bazaar */

With [[0.47_Refactoring_Plan]] coming along, the idea was brought up to change for a new version control system which would ease refactoring in particular. This page summarizes [http://thread.gmane.org/gmane.comp.graphics.inkscape.devel/25255/focus=25274 various email threads]. The project is to use a Distributed Version Control System instead of subversion.

As a general source of information, see http://en.wikipedia.org/wiki/Comparison_of_revision_control_software

== Why change? ==

Several things make a DVCS preferable to subversion for Inkscape:
* speed
* local commits allow to commit often
* easier branching and merging, which is likely to be useful for feature work or Summer of Code work while the core is refactored
* ... add your favorite feature from the wikipedia page above

This does not come without cost either:
* someone must move the code to the new system
* each dev must potentially learn a new system

== Comparison of DVCS ==

Since past discussions seemed to lead to the concensus that the benefits outweigh the cost, the question remaining is which DCVS to use. The three main contenders are [http://git.or.cz/ git], [http://www.selenic.com/mercurial/ mercurial] and [http://bazaar-vcs.org/ bazaar]. Here is a list of the their cost and benefits in the context of Inkscape development

=== Git ===
Good
* faster: local commits: <1s vs 4s, push a new branch: instantaneous vs 35 min
* ability to follow chunk of codes around, without relying on file names. Probably useful from a refactoring point of view
* probably the fastest growing user base => many tools
* TextMate bundle

Bad
* git is designed with the Linux kernel's hierarchical workflow in mind (few 'push'ers to the central repos), so may require alteration in how Inkscape's workflow works (any dev can commit)
* we would need to set up and administer this ourselves
* revisions are indicated with SHA's rather than numbers
* commands dissimilar to what we're used to with svn (e.g., no 'git update')
* no decent GUI (for windows?)

Not sure
* have to git add all modified files before committing them or resort to `git commit -a`. This is shift from the SVN way of doing things. However with single files, `git commit filename` is equivalent to `svn commit filename`. Plus, with multiple files git basic workflow is probably more powerful: it allows to add a set of files to a commit and only then to actually do the commit. The same thing with svn (or other similarly behaving systems) requires to write a long list of files in a single command line.

=== Mercurial (Hg) ===
Good
* tortoiseHG (remains to be evaluated)
* TextMate bundle

Bad

===Bazaar===
Good
* already integrated in [[http://doc.bazaar-vcs.org/bzr.dev/en/tutorials/using_bazaar_with_launchpad.html launchpad]]
** Associating branches to bugs
** Associating branches to blueprints
** Changes state of bugs in LP when committing in Bazaar
** Web interface for creating branches quickly and easily
* supports bundling changesets
* tortoiseBZR
* Fewer commands - makes it easier to learn
* Supports multiple workflows, including what we use for Inkscape (See http://bazaar-vcs.org/Workflows)
* Easy administration. Mostly done through Launchpad, plus Bzr folks are available to help.

Bad
* no support for line-endings conversion/convention enforcing (but such systems may create the risk of wrongly recognizing binary files)

Not sure
* A good point is that bazaar supports renames but it could actually be considered a "Bad" by git users

Change VCS

2008-03-17T13:34:59Z

Jiho: /* Git */ added some stuff about git's commit behavior

With [[0.47_Refactoring_Plan]] coming along, the idea was brought up to change for a new version control system which would ease refactoring in particular. This page summarizes [http://thread.gmane.org/gmane.comp.graphics.inkscape.devel/25255/focus=25274 various email threads]. The project is to use a Distributed Version Control System instead of subversion.

As a general source of information, see http://en.wikipedia.org/wiki/Comparison_of_revision_control_software

== Why change? ==

Several things make a DVCS preferable to subversion for Inkscape:
* speed
* local commits allow to commit often
* easier branching and merging, which is likely to be useful for feature work or Summer of Code work while the core is refactored
* ... add your favorite feature from the wikipedia page above

This does not come without cost either:
* someone must move the code to the new system
* each dev must potentially learn a new system

== Comparison of DVCS ==

Since past discussions seemed to lead to the concensus that the benefits outweigh the cost, the question remaining is which DCVS to use. The three main contenders are [http://git.or.cz/ git], [http://www.selenic.com/mercurial/ mercurial] and [http://bazaar-vcs.org/ bazaar]. Here is a list of the their cost and benefits in the context of Inkscape development

=== Git ===
Good
* faster: local commits: <1s vs 4s, push a new branch: instantaneous vs 35 min
* ability to follow chunk of codes around, without relying on file names. Probably useful from a refactoring point of view
* probably the fastest growing user base => many tools
* TextMate bundle

Bad
* git is designed with the Linux kernel's hierarchical workflow in mind (few 'push'ers to the central repos), so may require alteration in how Inkscape's workflow works (any dev can commit)
* we would need to set up and administer this ourselves
* revisions are indicated with SHA's rather than numbers
* commands dissimilar to what we're used to with svn (e.g., no 'git update')
* no decent GUI (for windows?)

Not sure
* have to git add all modified files before committing them or resort to `git commit -a`. This is shift from the SVN way of doing things. However with single files, `git commit filename` is equivalent to `svn commit filename`. Plus, with multiple files git basic workflow is probably more powerful: it allows to add a set of files to a commit and only then to actually do the commit. The same thing with svn (or other similarly behaving systems) requires to write a long list of files in a single command line.

=== Mercurial (Hg) ===
Good
* tortoiseHG (remains to be evaluated)
* TextMate bundle

Bad

===Bazaar===
Good
* already integrated in [[http://doc.bazaar-vcs.org/bzr.dev/en/tutorials/using_bazaar_with_launchpad.html launchpad]]
** Associating branches to bugs
** Associating branches to blueprints
** Changes state of bugs in LP when committing in Bazaar
** Web interface for creating branches quickly and easily
* supports renames (could be considered a - by git users)
* supports bundling changesets
* tortoiseBZR
* Fewer commands - makes it easier to learn
* Supports multiple workflows, including what we use for Inkscape (See http://bazaar-vcs.org/Workflows)
* Easy administration. Mostly done through Launchpad, plus Bzr folks are available to help.

Bad
* no support for line-endings conversion/convention enforcing (but such systems may create the risk of wrongly recognizing binary files)

Change VCS

2008-03-17T13:24:06Z

Jiho: Initiated the page as a summary from the long email thread

With [[0.47_Refactoring_Plan]] coming along, the idea was brought up to change for a new version control system which would ease refactoring in particular. This page summarizes [http://thread.gmane.org/gmane.comp.graphics.inkscape.devel/25255/focus=25274 various email threads]. The project is to use a Distributed Version Control System instead of subversion.

As a general source of information, see http://en.wikipedia.org/wiki/Comparison_of_revision_control_software

== Why change? ==

Several things make a DVCS preferable to subversion for Inkscape:
* speed
* local commits allow to commit often
* easier branching and merging, which is likely to be useful for feature work or Summer of Code work while the core is refactored
* ... add your favorite feature from the wikipedia page above

This does not come without cost either:
* someone must move the code to the new system
* each dev must potentially learn a new system

== Comparison of DVCS ==

Since past discussions seemed to lead to the concensus that the benefits outweigh the cost, the question remaining is which DCVS to use. The three main contenders are [http://git.or.cz/ git], [http://www.selenic.com/mercurial/ mercurial] and [http://bazaar-vcs.org/ bazaar]. Here is a list of the their cost and benefits in the context of Inkscape development

=== Git ===
Good
* faster: local commits: <1s vs 4s, push a new branch: instantaneous vs 35 min
* ability to follow chunk of codes around, without relying on file names. Probably useful from a refactoring point of view
* probably the fastest growing user base => many tools
* TextMate bundle

Bad
* git is designed with the Linux kernel's hierarchical workflow in mind (few 'push'ers to the central repos), so may require alteration in how Inkscape's workflow works (any dev can commit)
* we would need to set up and administer this ourselves
* revisions are indicated with SHA's rather than numbers
* commands dissimilar to what we're used to with svn (e.g., no 'git update')
* have to git add all modified files before committing them (or resort to a non specific commit -a)
* no decent GUI (for windows?)

=== Mercurial (Hg) ===
Good
* tortoiseHG (remains to be evaluated)
* TextMate bundle

Bad

===Bazaar===
Good
* already integrated in [[http://doc.bazaar-vcs.org/bzr.dev/en/tutorials/using_bazaar_with_launchpad.html launchpad]]
** Associating branches to bugs
** Associating branches to blueprints
** Changes state of bugs in LP when committing in Bazaar
** Web interface for creating branches quickly and easily
* supports renames (could be considered a - by git users)
* supports bundling changesets
* tortoiseBZR
* Fewer commands - makes it easier to learn
* Supports multiple workflows, including what we use for Inkscape (See http://bazaar-vcs.org/Workflows)
* Easy administration. Mostly done through Launchpad, plus Bzr folks are available to help.

Bad
* no support for line-endings conversion/convention enforcing (but such systems may create the risk of wrongly recognizing binary files)

Output format requirements

2008-02-19T19:32:40Z

Jiho: Reformated

Inkscape's extensions allow for importing and exporting non-SVG file types and direct editing of the current SVG document. For more information about the Extensions that appear in the Effects menu read [[GettingEffectsWorking]].

=== Open *.TXT ===
* install perl
* install SVG perl module

=== Open *.AI ===
* install perl and optionally Image::Magick
* Only handles Illustrator versions prior to version 9 (version 9 onwards stores files as PDF according to https://createpdf.adobe.com/cgi-feeder.pl/formats?BP=&LOC=en_US)

=== Save *.AI ===
* requires pstoedit with the ps2ai filter
* uses Inkscapes internal ps output extension

=== Open *.PS ===
* requires skconvert python script from sketch =>> install sketch

=== Open *.WMF ===
* requires wmf2svg, part of libwmf (http://wvware.sourceforge.net/libwmf.html)

=== Save *.PDF (Win32) ===
* install [[GhostScript]] http://www.cs.wisc.edu/~ghost/doc/AFPL/get851.htm
* create ps2pdf.cmd in %instdir%/share/extensions/

REM BEGIN
@echo off
REM edit %GSDIR% to match the ghostscript installation directory
set GSDIR=%PROGRAMFILES%\gs\gs8.51\
set GSBINDIR=%GSDIR%bin
set GSLIBDIR=%GSDIR%lib
set PATH=%GSBINDIR%;%GSLIBDIR%;%PATH%
ps2pdf.bat %1 -
REM END

* edit pdf_output.inx

<inkscape-extension>
<name>PDF Output</name>
<id>org.inkscape.output.pdf</id>
<dependency type="extension">org.inkscape.output.ps</dependency>
<dependency type="executable" location="extensions">ps2pdf.cmd</dependency>

<output>
<extension>.pdf</extension>
<mimetype>image/x-portable-document-format</mimetype>
<filetypename>Adobe PDF (*.pdf)</filetypename>
<filetypetooltip>Adobe Portable Document Format</filetypetooltip>
</output>
<script>
<command reldir="extensions">ps2pdf.cmd</command>
<helper_extension>org.inkscape.output.ps</helper_extension>
</script>
</inkscape-extension>

=== Save *.XCF ===

??

[[Category:Extensions]]

Extension requirements

2008-02-19T19:29:31Z

Jiho: /* Compiling from source */

== Setting Up Effects in Inkscape ==

For effects to work you need to be using inkscape .42 or later.

For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]

If you are interested in opening special file formats through extensions, see [[GettingExtensionsWorking]].

=== Unhide the Effects menu ===

This is only necessary in verions .41+CVS to .45.

On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects". Close and reopen Inkscape

== Python Effects ==
=== on Debian GNU / Linux ===
apt-get install python python-xml

=== on Microsoft Windows ===
<b>Important note: From version .44 onwards, Inkscape now includes python in the download, and has effects <i>enabled</i> by default. Therefore these steps are outdated and no longer needed.</b>

# Download [http://www.python.org/download/ Python]
# Install python and remember the directory you set it to install to. (e.g. C:\Python24 )
# Set your path variable in Windows. For Windows 2000 or XP read [http://support.microsoft.com/default.aspx?scid=kb;en-us;310519&sd=tech Microsofts instructions] or do
## Right Click My Computer
## Properties
## Advanced Tab
## Environment Variables
## In the system variables section select the one named PATH and hit edit.
## Find the end of all the values in there and add ";*path to python*" where *path to python* is the directory you told python to install to (ie c:\program files\python24)
## hit Ok, Ok, Apply
For more general instructions (including instructions for Windows 95,98,ME,NT,2000 and XP) look at the [http://www.chem.gla.ac.uk/%7Elouis/software/faq/q1.html University of Glasgow's] instructions, just remember that you want to set the PATH varable to the python directory. If there is already a path variable, don't delete it, but just add a semicolon and then the full path to the python directory at the end (e.g. PATH = C:\somthing else ; C:\python_directory)
# Reboot
# Download and Install [http://sourceforge.net/project/showfiles.php?group_id=6473 PyXML] for whatever version Python you chose to install

To get the effects menu showing up:
# Load Inscape
# Go to File > Inkscape Preferences (Shift+Ctrl+P)
# Select the "Misc" tab and tick "Enable script effects..."
# Restart Inkscape

If that didn't work, you may like to try to edit the preferences manually:
# Go to your preferences.xml file (Documents and Settings/USERNAME/Application Data/Inkscape/preferences.xml)
# Search for "id="extensions".
# If you find it: Add the following line above that "show-effects-menu="1".
# If you can't find it just add
<group
show-effects-menu="1"
id="extensions" />
Save the file, start up inkscape and use those sweet effects

=== on Mac OS X ===

Starting with version 0.46, Inkscape contains the python packages needed for the extension system. All python extensions should work out of the box. However in case you still have trouble you can install them in their regular location.

==== Binary packages ====

# Download and open http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# Browse the disk image to find the packages corresponding to your architecture and Python version
#* Your architecture is ppc if you have a G4-G5 based Mac, i386 if you have an Intel Mac
#* By default Panther and Tiger have Python 2.3 and Leopard has Python 2.5. If you have installed a newer version of Python we also provide packages for 2.4
# Copy all the files and folder from the appropriate location to your Python site-packages directory. By default the site-packages directory is /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages on Panther and Tiger, /Library/Python/2.5/site-packages on Leopard. Otherwise it is somewhere in your custom install of python (/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/ for and install of Python 2.4 via MacPorts for example)

==== Compiling from source ====
If you prefer, you can install them from source, it is really easy.

# download the source code for [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] and/or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file <pre>tar -xzf numpy***.tar.gz lxml***.tar.gz</pre>
# for each one <code>cd<code> into the newly created directory
# build C extensions and install (the install is system wide so you need administrator privileges)<pre>sudo python setup.py install</pre>and type your password.

The packages are installed in the site-packages directory of your Python install. This is /Library/Python/2.*/site-packages for the stock install of Python on Mac OS X.

== Perl Effects ==
=== on Debian GNU / Linux ===
apt-get install perl libxml-xql-perl

=== on Gentoo GNU / Linux ===
emerge -a XML-XQL

=== on Microsoft Windows ===
install [http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl [[ActivePerl]]]
install XML::XQL::DOM (perhaps like this?)
1: install prereqs with ppm:
install xml-dom
install parse-yapp
install datemanip
2: download xml-xql from:
http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
3: open command prompt and locate perl"s lib directory with:
perl -e "print qq(@INC)" (mine was C:[[/Perl/site/lib]])
4: unpack xml-xql archive
5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

== Plugin Effects ==
I have absolutely no idea. Please record your success here. :)

== What if it doesn't work? ==
Run Inkscape from the console

Use the error messges printed to the console to diagnose the problem (very often missing dependencies)

On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

[[Category:Extensions]]

Extension requirements

2008-02-19T19:27:41Z

Jiho: /* Compiling from source */

== Setting Up Effects in Inkscape ==

For effects to work you need to be using inkscape .42 or later.

For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]

If you are interested in opening special file formats through extensions, see [[GettingExtensionsWorking]].

=== Unhide the Effects menu ===

This is only necessary in verions .41+CVS to .45.

On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects". Close and reopen Inkscape

== Python Effects ==
=== on Debian GNU / Linux ===
apt-get install python python-xml

=== on Microsoft Windows ===
<b>Important note: From version .44 onwards, Inkscape now includes python in the download, and has effects <i>enabled</i> by default. Therefore these steps are outdated and no longer needed.</b>

# Download [http://www.python.org/download/ Python]
# Install python and remember the directory you set it to install to. (e.g. C:\Python24 )
# Set your path variable in Windows. For Windows 2000 or XP read [http://support.microsoft.com/default.aspx?scid=kb;en-us;310519&sd=tech Microsofts instructions] or do
## Right Click My Computer
## Properties
## Advanced Tab
## Environment Variables
## In the system variables section select the one named PATH and hit edit.
## Find the end of all the values in there and add ";*path to python*" where *path to python* is the directory you told python to install to (ie c:\program files\python24)
## hit Ok, Ok, Apply
For more general instructions (including instructions for Windows 95,98,ME,NT,2000 and XP) look at the [http://www.chem.gla.ac.uk/%7Elouis/software/faq/q1.html University of Glasgow's] instructions, just remember that you want to set the PATH varable to the python directory. If there is already a path variable, don't delete it, but just add a semicolon and then the full path to the python directory at the end (e.g. PATH = C:\somthing else ; C:\python_directory)
# Reboot
# Download and Install [http://sourceforge.net/project/showfiles.php?group_id=6473 PyXML] for whatever version Python you chose to install

To get the effects menu showing up:
# Load Inscape
# Go to File > Inkscape Preferences (Shift+Ctrl+P)
# Select the "Misc" tab and tick "Enable script effects..."
# Restart Inkscape

If that didn't work, you may like to try to edit the preferences manually:
# Go to your preferences.xml file (Documents and Settings/USERNAME/Application Data/Inkscape/preferences.xml)
# Search for "id="extensions".
# If you find it: Add the following line above that "show-effects-menu="1".
# If you can't find it just add
<group
show-effects-menu="1"
id="extensions" />
Save the file, start up inkscape and use those sweet effects

=== on Mac OS X ===

Starting with version 0.46, Inkscape contains the python packages needed for the extension system. All python extensions should work out of the box. However in case you still have trouble you can install them in their regular location.

==== Binary packages ====

# Download and open http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# Browse the disk image to find the packages corresponding to your architecture and Python version
#* Your architecture is ppc if you have a G4-G5 based Mac, i386 if you have an Intel Mac
#* By default Panther and Tiger have Python 2.3 and Leopard has Python 2.5. If you have installed a newer version of Python we also provide packages for 2.4
# Copy all the files and folder from the appropriate location to your Python site-packages directory. By default the site-packages directory is /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages on Panther and Tiger, /Library/Python/2.5/site-packages on Leopard. Otherwise it is somewhere in your custom install of python (/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/ for and install of Python 2.4 via MacPorts for example)

==== Compiling from source ====
If you prefer, you can install them from source, it is really easy.

# download the source code for [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] and/or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file <pre>tar -xzf numpy***.tar.gz lxml***.tar.gz</pre>
# for each one <code>cd<code> into the newly created directory
# build C extensions and install (the install is system wide so you need administrator privileges)<pre>sudo python setup.py install</pre>and type your password.

The packages are installed in the <code>site-packages</code> directory of your Python install. This is <code>/Library/Python/2.*/site-packages/</code> for the stock install of Python on Mac OS X.

== Perl Effects ==
=== on Debian GNU / Linux ===
apt-get install perl libxml-xql-perl

=== on Gentoo GNU / Linux ===
emerge -a XML-XQL

=== on Microsoft Windows ===
install [http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl [[ActivePerl]]]
install XML::XQL::DOM (perhaps like this?)
1: install prereqs with ppm:
install xml-dom
install parse-yapp
install datemanip
2: download xml-xql from:
http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
3: open command prompt and locate perl"s lib directory with:
perl -e "print qq(@INC)" (mine was C:[[/Perl/site/lib]])
4: unpack xml-xql archive
5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

== Plugin Effects ==
I have absolutely no idea. Please record your success here. :)

== What if it doesn't work? ==
Run Inkscape from the console

Use the error messges printed to the console to diagnose the problem (very often missing dependencies)

On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

[[Category:Extensions]]

Extension requirements

2008-02-19T19:24:56Z

Jiho: /* on Microsoft Windows */

== Setting Up Effects in Inkscape ==

For effects to work you need to be using inkscape .42 or later.

For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]

If you are interested in opening special file formats through extensions, see [[GettingExtensionsWorking]].

=== Unhide the Effects menu ===

This is only necessary in verions .41+CVS to .45.

On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects". Close and reopen Inkscape

== Python Effects ==
=== on Debian GNU / Linux ===
apt-get install python python-xml

=== on Microsoft Windows ===
<b>Important note: From version .44 onwards, Inkscape now includes python in the download, and has effects <i>enabled</i> by default. Therefore these steps are outdated and no longer needed.</b>

# Download [http://www.python.org/download/ Python]
# Install python and remember the directory you set it to install to. (e.g. C:\Python24 )
# Set your path variable in Windows. For Windows 2000 or XP read [http://support.microsoft.com/default.aspx?scid=kb;en-us;310519&sd=tech Microsofts instructions] or do
## Right Click My Computer
## Properties
## Advanced Tab
## Environment Variables
## In the system variables section select the one named PATH and hit edit.
## Find the end of all the values in there and add ";*path to python*" where *path to python* is the directory you told python to install to (ie c:\program files\python24)
## hit Ok, Ok, Apply
For more general instructions (including instructions for Windows 95,98,ME,NT,2000 and XP) look at the [http://www.chem.gla.ac.uk/%7Elouis/software/faq/q1.html University of Glasgow's] instructions, just remember that you want to set the PATH varable to the python directory. If there is already a path variable, don't delete it, but just add a semicolon and then the full path to the python directory at the end (e.g. PATH = C:\somthing else ; C:\python_directory)
# Reboot
# Download and Install [http://sourceforge.net/project/showfiles.php?group_id=6473 PyXML] for whatever version Python you chose to install

To get the effects menu showing up:
# Load Inscape
# Go to File > Inkscape Preferences (Shift+Ctrl+P)
# Select the "Misc" tab and tick "Enable script effects..."
# Restart Inkscape

If that didn't work, you may like to try to edit the preferences manually:
# Go to your preferences.xml file (Documents and Settings/USERNAME/Application Data/Inkscape/preferences.xml)
# Search for "id="extensions".
# If you find it: Add the following line above that "show-effects-menu="1".
# If you can't find it just add
<group
show-effects-menu="1"
id="extensions" />
Save the file, start up inkscape and use those sweet effects

=== on Mac OS X ===

Starting with version 0.46, Inkscape contains the python packages needed for the extension system. All python extensions should work out of the box. However in case you still have trouble you can install them in their regular location.

==== Binary packages ====

# Download and open http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# Browse the disk image to find the packages corresponding to your architecture and Python version
#* Your architecture is ppc if you have a G4-G5 based Mac, i386 if you have an Intel Mac
#* By default Panther and Tiger have Python 2.3 and Leopard has Python 2.5. If you have installed a newer version of Python we also provide packages for 2.4
# Copy all the files and folder from the appropriate location to your Python site-packages directory. By default the site-packages directory is /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages on Panther and Tiger, /Library/Python/2.5/site-packages on Leopard. Otherwise it is somewhere in your custom install of python (/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/ for and install of Python 2.4 via MacPorts for example)

==== Compiling from source ====
If you prefer, you can install them from source, it is really easy.

# download the source code for [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] and/or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file <pre>tar -xzf numpy***.tar.gz lxml***.tar.gz</pre>
# for each one <code>cd<code> into the newly created directory
# build C extensions and install (the install is system wide so you need administrator privileges)<pre>sudo python setup.py install</pre>and type your password.

The packages are installed in the <code>site-packages</code> directory of your Python install. This is <code>/Library/Python/2.*/site-packages/<code> for the stock install of Python on Mac OS X.

== Perl Effects ==
=== on Debian GNU / Linux ===
apt-get install perl libxml-xql-perl

=== on Gentoo GNU / Linux ===
emerge -a XML-XQL

=== on Microsoft Windows ===
install [http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl [[ActivePerl]]]
install XML::XQL::DOM (perhaps like this?)
1: install prereqs with ppm:
install xml-dom
install parse-yapp
install datemanip
2: download xml-xql from:
http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
3: open command prompt and locate perl"s lib directory with:
perl -e "print qq(@INC)" (mine was C:[[/Perl/site/lib]])
4: unpack xml-xql archive
5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

== Plugin Effects ==
I have absolutely no idea. Please record your success here. :)

== What if it doesn't work? ==
Run Inkscape from the console

Use the error messges printed to the console to diagnose the problem (very often missing dependencies)

On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

[[Category:Extensions]]

Extension requirements

2008-02-19T19:22:18Z

Jiho: Merged doc from the separate windows page here. It is obsolete anyway

== Setting Up Effects in Inkscape ==

For effects to work you need to be using inkscape .42 or later.

For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]

If you are interested in opening special file formats through extensions, see [[GettingExtensionsWorking]].

=== Unhide the Effects menu ===

This is only necessary in verions .41+CVS to .45.

On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects". Close and reopen Inkscape

== Python Effects ==
=== on Debian GNU / Linux ===
apt-get install python python-xml

=== on Microsoft Windows ===
<b>Important note: From version .44 onwards, Inkscape now includes python in the download, and has effects <i>enabled</i> by default. Therefore these steps are outdated and no longer needed.</b>

# Download [http://www.python.org/download/ Python]
# Install python and remember the directory you set it to install to. (e.g. C:\Python24 )
# Set your path variable in Windows. For Windows 2000 or XP read [http://support.microsoft.com/default.aspx?scid=kb;en-us;310519&sd=tech Microsofts instructions] or do
## Right Click My Computer
## Properties
## Advanced Tab
## Environment Variables
## In the system variables section select the one named PATH and hit edit.
## Find the end of all the values in there and add ";*path to python*" where *path to python* is the directory you told python to install to (ie c:\program files\python24)
## hit Ok, Ok, Apply
For more general instructions (including instructions for Windows 95,98,ME,NT,2000 and XP) look at the [http://www.chem.gla.ac.uk/%7Elouis/software/faq/q1.html University of Glasgow's] instructions, just remember that you want to set the PATH varable to the python directory. If there is already a path variable, don't delete it, but just add a semicolon and then the full path to the python directory at the end (e.g. PATH = C:\somthing else ; C:\python_directory)
# Reboot
# Download and Install [http://sourceforge.net/project/showfiles.php?group_id=6473 [[PyXML]]] for whatever version Python you chose to install

To get the effects menu showing up:
# Load Inscape
# Go to File > Inkscape Preferences (Shift+Ctrl+P)
# Select the "Misc" tab and tick "Enable script effects..."
# Restart Inkscape

If that didn't work, you may like to try to edit the preferences manually:
# Go to your preferences.xml file (Documents and Settings[[/USERNAME/Application]] Data[[/Inkscape/preferences]].xml)
# Search for "id="extensions".
# If you find it: Add the following line above that "show-effects-menu="1".
# If you can't find it just add
<group
show-effects-menu="1"
id="extensions" />
e. Save the file
# Start up inkscape and use those sweet effects

=== on Mac OS X ===

Starting with version 0.46, Inkscape contains the python packages needed for the extension system. All python extensions should work out of the box. However in case you still have trouble you can install them in their regular location.

==== Binary packages ====

# Download and open http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# Browse the disk image to find the packages corresponding to your architecture and Python version
#* Your architecture is ppc if you have a G4-G5 based Mac, i386 if you have an Intel Mac
#* By default Panther and Tiger have Python 2.3 and Leopard has Python 2.5. If you have installed a newer version of Python we also provide packages for 2.4
# Copy all the files and folder from the appropriate location to your Python site-packages directory. By default the site-packages directory is /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages on Panther and Tiger, /Library/Python/2.5/site-packages on Leopard. Otherwise it is somewhere in your custom install of python (/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/ for and install of Python 2.4 via MacPorts for example)

==== Compiling from source ====
If you prefer, you can install them from source, it is really easy.

# download the source code for [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] and/or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file <pre>tar -xzf numpy***.tar.gz lxml***.tar.gz</pre>
# for each one <code>cd<code> into the newly created directory
# build C extensions and install (the install is system wide so you need administrator privileges)<pre>sudo python setup.py install</pre>and type your password.

The packages are installed in the <code>site-packages</code> directory of your Python install. This is <code>/Library/Python/2.*/site-packages/<code> for the stock install of Python on Mac OS X.

== Perl Effects ==
=== on Debian GNU / Linux ===
apt-get install perl libxml-xql-perl

=== on Gentoo GNU / Linux ===
emerge -a XML-XQL

=== on Microsoft Windows ===
install [http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl [[ActivePerl]]]
install XML::XQL::DOM (perhaps like this?)
1: install prereqs with ppm:
install xml-dom
install parse-yapp
install datemanip
2: download xml-xql from:
http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
3: open command prompt and locate perl"s lib directory with:
perl -e "print qq(@INC)" (mine was C:[[/Perl/site/lib]])
4: unpack xml-xql archive
5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

== Plugin Effects ==
I have absolutely no idea. Please record your success here. :)

== What if it doesn't work? ==
Run Inkscape from the console

Use the error messges printed to the console to diagnose the problem (very often missing dependencies)

On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

[[Category:Extensions]]

Extension requirements

2008-02-19T19:15:57Z

Jiho: /* Setting Up Effects in Inkscape */

Extension requirements

2008-02-19T19:15:26Z

Jiho: /* Setting Up Effects in Inkscape */

Extension requirements

2008-02-19T19:07:00Z

Jiho: Updated the status of Python

== Setting Up Effects in Inkscape ==
<i>For effects to work you need to be using inkscape .42 or later.</i><br>
<i>For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]</i><br>
<i>See also [[GettingExtensionsWorking]].</i><br>

=== Unhide the Effects menu ===
(Only necessary in some versions of Inkscape. Between .41 and .45)

On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects" (0.41+CVS onwards only)

Close and reopen Inkscape

== Python Effects ==
=== on Debian GNU / Linux ===
apt-get install python python-xml

=== on Microsoft Windows ===
[[GettingEffectsWorking/Windows]] Tutorial on Getting Effects to work on Windows

=== on Mac OS X ===

Starting with version 0.46, Inkscape contains the python packages needed for the extension system. All python extensions should work out of the box. However in case you still have trouble you can install them in their regular location.

==== Binary packages ====

# Download and open http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
# Browse the disk image to find the packages corresponding to your architecture and Python version
#* Your architecture is ppc if you have a G4-G5 based Mac, i386 if you have an Intel Mac
#* By default Panther and Tiger have Python 2.3 and Leopard has Python 2.5. If you have installed a newer version of Python we also provide packages for 2.4
# Copy all the files and folder from the appropriate location to your Python site-packages directory. By default the site-packages directory is /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages on Panther and Tiger, /Library/Python/2.5/site-packages on Leopard. Otherwise it is somewhere in your custom install of python (/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/ for and install of Python 2.4 via MacPorts for example)

==== Compiling from source ====
If you prefer, you can install them from source, it is really easy.

# download the source code for [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] and/or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file <pre>tar -xzf numpy***.tar.gz lxml***.tar.gz</pre>
# for each one <code>cd<code> into the newly created directory
# build C extensions and install (the install is system wide so you need administrator privileges)<pre>sudo python setup.py install</pre>and type your password.

The packages are installed in the <code>site-packages</code> directory of your Python install. This is <code>/Library/Python/2.*/site-packages/<code> for the stock install of Python on Mac OS X.

== Perl Effects ==
=== on Debian GNU / Linux ===
apt-get install perl libxml-xql-perl

=== on Gentoo GNU / Linux ===
emerge -a XML-XQL

=== on Microsoft Windows ===
install [http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl [[ActivePerl]]]
install XML::XQL::DOM (perhaps like this?)
1: install prereqs with ppm:
install xml-dom
install parse-yapp
install datemanip
2: download xml-xql from:
http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
3: open command prompt and locate perl"s lib directory with:
perl -e "print qq(@INC)" (mine was C:[[/Perl/site/lib]])
4: unpack xml-xql archive
5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

== Plugin Effects ==
I have absolutely no idea. Please record your success here. :)

== What if it doesn't work? ==
Run Inkscape from the console

Use the error messges printed to the console to diagnose the problem (very often missing dependencies)

On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

[[Category:Extensions]]

CompilingMacOsX

2008-02-18T11:28:24Z

Jiho: Added universal compilation with macports

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo +pdf boehmgc gtkmm intltool libxslt lcms popt poppler boost gnome-vfs \
libgnomeprintui automake autoconf subversion</pre>
Grab a cup of cofee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. [http://www.finkproject.org/ Fink] was used in the past but there is no information about wether it meets Inkscape needs currently. Alternatively you could use Inkscape all-in-one universal build script to install them (see below).

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All these steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to known how to use it just type:
<pre>./osx-build.sh help</pre>

= Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script [untested]=

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Compiling a Universal Binary of Inkscape with X11, using MacPorts [in progress]=

Just use the +universal variant of everything to build universal versions.

Port that fail currently
* poppler : Error: Error executing universal: Default universal variant only works with ports based on configure
* docbook-xsl : similar. can be build non universal it is not a runtime dependency. it is just a compile time dependency for gtk-doc. but this is a pain since one cannot just do port install gtk2 +univeral anymore because it tries to find docbook-xsl +universal. so one have to install everything by hand.
* more to come...

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>
Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

== Packaging ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2008-02-18T09:59:30Z

Jiho: /* User Examples */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo +pdf boehmgc gtkmm intltool libxslt lcms popt poppler boost gnome-vfs \
libgnomeprintui automake autoconf subversion</pre>
Grab a cup of cofee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. [http://www.finkproject.org/ Fink] was used in the past but there is no information about wether it meets Inkscape needs currently. Alternatively you could use Inkscape all-in-one universal build script to install them (see below).

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All these steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to known how to use it just type:
<pre>./osx-build.sh help</pre>

= Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script [untested]=

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>
Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his builds [http://jo.irisson.free.fr/?p=34 here] and [http://jo.irisson.free.fr/?p=62 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

== Packaging ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2008-02-18T09:58:48Z

Jiho: /* Native version of Inkscape dependencies */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo +pdf boehmgc gtkmm intltool libxslt lcms popt poppler boost gnome-vfs \
libgnomeprintui automake autoconf subversion</pre>
Grab a cup of cofee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. [http://www.finkproject.org/ Fink] was used in the past but there is no information about wether it meets Inkscape needs currently. Alternatively you could use Inkscape all-in-one universal build script to install them (see below).

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All these steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to known how to use it just type:
<pre>./osx-build.sh help</pre>

= Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script [untested]=

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>
Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/sbin:/Developer/Tools:/usr/local/bin: \
/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>
NB: the \ are just to mark line continuation here, suppress them and put everything in one line.

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his build [http://jo.irisson.free.fr/?p=34 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

== Packaging ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2008-02-18T09:57:35Z

Jiho: Added info on having two separate macports trees

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo +pdf boehmgc gtkmm intltool libxslt lcms popt poppler boost gnome-vfs \
libgnomeprintui automake autoconf subversion</pre>
Grab a cup of cofee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. [http://www.finkproject.org/ Fink] was used in the past but there is no information about wether it meets Inkscape needs currently. Alternatively you could use Inkscape all-in-one universal build script to install them (see below).

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../../Info.plist</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All these steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to known how to use it just type:
<pre>./osx-build.sh help</pre>

= Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script [untested]=

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

Rather than deactivating and reactivating ports, you can also keep two MacPorts trees side by side, provided you install the second one from source. Let say I want to install a new tree for native versions in /opt/local/native, I would do
<pre>export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/X11R6/bin
cd ~/MacPorts-1.x.x/
./configure --prefix=/opt/local-native --with-tclpackage=/Library/Tcl/macports-native
make
sudo make install</pre>
Then you need to have only one version of the port command in the path at any time so you need to setup your .bashrc (or .bash_profile or .profile) accordingly. I use shell aliases to quickly and temporarily switch to the universal version:
<pre>alias portpathregular="export PATH=/opt/local/bin:/opt/local/sbin:/Developer/Tools:/usr/local/bin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"
alias portpathuniv="export PATH=/opt/local-univ/bin:/opt/local-univ/sbin:/Developer/Tools:/usr/local/bin:/usr/X11R6/bin:/bin:/sbin:/usr/bin:/usr/sbin"</pre>

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== User Examples ==
* Adam Strzeleki has outlined some improvements to this process on the Inkscape [http://www.nabble.com/Inkscape-native-Mac-OS-X-build---look-improvements-td14733036.html email list]. See his screenshot from January 10, 2008 [http://www.nabble.com/attachment/14733036/1/Inkscape%20OSX%20PL.gif here].
* JiHO has a video of his build [http://jo.irisson.free.fr/?p=34 here].

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

== Packaging ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

Release notes/0.46

2008-01-11T15:22:02Z

Jiho: /* Other changes and improvements */

=Inkscape 0.46=
'''(not released yet)'''

Highlights in this release:

* Paintbucket tool

* Tweak tool

* 3D Box tool

* Live path effects

* Color management

* New SVG filters and UI

* Native PDF and AI import

* XAML import/export

* Open Clip Art Library integration (import/export)

* Stock patterns

* Bitmap editing extension effects

* Full on-canvas gradient editing

* Engraver's Toolbox in the Calligraphic tool

* Touch selection

* Dockable dialogs

* Command-line access to verbs

* Snapping made usable

* "3D" / axonometric grid

* Angled guidelines

* Significant speed and interactivity improvements

* Hundreds of smaller features and bugfixes

=Speed and interactivity=

* In this version, Inkscape starts using the [http://www.cairographics.org cairo] library for rendering. It is now used for '''outline mode''' display which, thanks to using cairo and other optimizations, redraws '''faster by about 25%'''. More impressive are memory savings: thanks to cairo, in outline mode Inkscape now takes only about '''50% of the memory''' used by 0.45 for the same file.

* '''Smart redraw directionality:''' With complex images and/or on slow computers, you may have noticed that Inkscape redraws the screen image in horizontal strips, and these strips are painted in order from top to bottom. Now the redraw always starts '''at your mouse cursor location''' and proceed upwards and downwards from it, so that the area near the cursor is always redrawn first. This significantly improves program's responsiveness in some situations. For example, when you are node-editing part of a complex path, the entire path needs to be redrawn on each change, but now this redraw starts from the point you're working on. Moreover, the redraw is interruptible, so each mouse movement starts new redraw from the mouse cursor area. As a result, during such operations those parts that you're working on redraw often and feel snappy and responsive, while areas further away may lag behind more.

* '''Faster blur''' for exporting and high quality on-screen rendering: Inkscape now uses an IIR (Infinite Impulse Response) filter for blurring with large radius. This greatly improves the speed of blur redraw at high zooms or in high-resolution export (or simply with very large blur radius). On the other hand, the results are an approximation to a true Gaussian blur, so a drawing may look slightly different from the mathematically precise blur (usually the differences are far from visible, though). This code is mainly based on: ''Recursive Gaussian Derivative Filters'' by L.J. van Vliet, I.T. Young and P.W. Verbeek (see the source code for more detailed references).

:'''Exporting drawings with blur''' was particularly slow in 0.45; some files could take hours to export. Now this is fixed, in part by the faster algorithm mentioned above and in part by a bugfix in the export code. Now even the quite complex files with large blurs export at high resolution in at most a few minutes.

* Minor improvements have been made to gradient rendering performance.

* '''Dragging handles and nodes''' as well as '''dragging and transforming objects''' by mouse became more responsive, so that working in complex drawings and especially editing complex paths is noticeably easier. In particular, this fixes the annoying latency issue where a node or a handle could follow mouse cursor even after you release mouse button after a drag.

* '''Moving objects, nodes, and gradient handles by cursor keys''' as well as '''scaling and rotating objects from keyboard''' and '''zooming by keys''' are much more responsive when working with complex slow-rendering objects. Now, if you press and hold a key, your selection/zoom level will quickly jump to the final position instead of going through all the intermediate steps as before.

* '''Moving the cursor around''' in a file with large and complex paths has become much snappier and more responsive. Previously, in extreme cases Inkscape could freeze for seconds while catching up with the mouse cursor; such delays are now eliminated.

* Several improvements make '''canvas panning and scrolling''' smoother and more interactive in complex slow-rendering documents:

:* When panning by the middle mouse button, Inkscape no longer attempts to redraw the canvas while your mouse button is pressed. Any redrawing only happens after you release the mouse. As a result, the newly revealed parts of the canvas are somewhat more "dirty" but the '''panning is smoother than before''', with few if any "hiccups".

:* '''Redrawing the newly exposed parts of the canvas''' after scrolling, especially diagonal scrolling, is now faster because only the exposed areas are redrawn; before, this often resulted in the entire screen being redrawn which was much slower.

:* Previously, if you started panning with middle button while Inkscape is still redrawing screen in a complex drawing, panning sometimes completely failed or moved canvas just a little step. Now it is '''guaranteed to pan the canvas all the way''' from mouse-press point to mouse-release point in any case, even if sometimes it fails to show the intermediate positions.

:* When pressing and holding Ctrl+arrows to scroll canvas, Inkscape normally accelerates scrolling so that each next scrolling step is bigger than the previous. Previously, in complex drawings this acceleration sometimes got interrupted, which made scrolling annoyingly bumpy and slow. Now this is fixed so that '''scrolling is smoothly accelerated''' even in a slow-rendering document.

:* The default '''starting speed and acceleration''' of Ctrl+arrows scrolling are slightly increased. (They are both settable in Preferences.)

* Better responsiveness and more visual feedback in user interface:

:*When you zoom, the '''zoom control''' on the right end of the statusbar now updates immediately, not after screen redraw as before.

:*Many potentially slow commands (Save, Simplify, Combine, Break Apart and others) now display a '''busy cursor''' and flash a message in the statusbar (e.g. "Saving document...") while they work.

:*The '''statusbar messages''' displayed while you're drawing a shape or a path in Pen tool do not lag behind the mouse movements.

* '''Combine''' and '''Convert to paths''' commands are now orders of magnitude faster when applied to a selection with hundreds or thousands of objects.

* The time it takes to '''snap to objects''' using the selector tool has been reduced dramatically, which is most noticeable for snapping to complex paths.

=Tools=

==Paint Bucket tool==

The new Paint Bucket tool works exactly as you would expect: click in any area bounded on all sides and it will '''fill it with color'''. Being a vector tool, however, Inkscape's Paint Bucket just creates a new ''path'' that "fills in" the area in which you clicked.

===How it works===

It is important to note that the tool is '''perceptual''', not geometric. That is, when looking for the boundaries around the point you clicked, it takes for such boundaries any ''visible'' color changes. This means that filling will stop at gradients, blurs, and even the color boundaries in imported bitmaps, but will ignore any paths or other objects that are fully (or almost) transparent or for any other reason do not stand out from the background. In short, it will work exactly as if you were filling a rasterized version of your image in a bitmap editor like Photoshop or GIMP - but will give you a vector object to work with.

For example, now you can scan a pencil sketch, import the bitmap into Inkscape, and quickly fill all its cells with colors even without tracing the bitmap first. This is a very convenient and interactive way of digitizing your paper drawings, making the '''traditional bitmap tracing unnecessary''' in many cases.

Internally, the tool works by performing a bitmap-based flood fill on a rendered version of the visible canvas, then tracing the resulting fill using [[potrace]] and placing the traced path into the document.

It places the rendered path onto the current layer, so you can have a layer on top (for example, "Inks") and select the layer below ("Colors") and do the fills so that they always appear below the Inks.

The '''resolution''' of the bitmap image used to perform the trace is dependent upon your '''current zoom level''' -- the more zoomed in to an area that you are, the higher the resolution of the bitmap-based flood fill. So, if you are got a fill that is too imprecise, has rough corners, or don't go into small nooks and appendices where it is supposed to go, just undo, zoom in closer and repeat filling from the same point. Conversely, if the fill leaks out through a small gap, zoom out to make the gap less visible and fill again (or use the auto gap closing parameter, see below).

===Style===

Like all object-creating tools, the Paint Bucket may use the '''last-set style''' for the objects it creates (this is the default), or it can use its own '''fixed style'''. You can switch between these modes on this tool's page in Inkscape Preferences (Ctrl+Shift+P). As in all other tools, the '''style swatch''' on the far right of the Controls bar shows the style that will be used for the next fill object you create.

===Controls===

In the tool's '''Controls bar''':

* Paint Bucket's perceptual fill can use either all visible colors or specific color channels. Using the '''Fill by''' drop-down list, you can restrict the fill algorithm to one the following channels:
** Red
** Green
** Blue
** Hue
** Saturation
** Lightness
** Alpha

* The '''Threshold''' (in per cent units) controls how large must be color difference at a point (compared to the initial click point) to stop the fill. Zero tolerance means only the area of strictly the same color will be filled; the larger the tolerance, the easier it will be for the fill to leak into adjacent different-color areas. The default value is 10%.

* Using the '''Grow/shrink by''' parameter, you can control the amount of inset/outset to be applied to the created fill path. Setting a positive outset causes fill paths to be larger than the filled bitmap area (good for eliminating anti-aliasing errors), while setting a negative outset causes the path to be smaller. This works much the same as the Outset and Inset path commands, except it's done automatically after every fill.

* With the '''Close gaps''' parameter, you can make the Paint Bucket tool ignore any gaps in the area boundaries that would normally cause the fill to spill out of the desired area. There are four settings to auto gap:
** None
** Small (close gaps up to 2 pixels in size)
** Medium (4 pixels)
** Large (6 pixels)
:Note that setting this parameter to other than None may slow down noticeably the filling of large areas.

===Shortcuts===

The tool's '''shortcuts''' are:

* '''Single click''' performs filling from the click point.

* '''Shift+click''' performs filling from the click point and then unions the resulting path with the selected path. This way, if your first attempt did not fill in all of the desired area, you can Shift+click the remaining corner to fill it in separately and combine the result with the result of the previous fill.

* '''Ctrl+click''' on an object simply changes that object's fill to the current fill color of the tool, and '''Shift+Ctrl+click''' changes the stroke to the current stroke color.

* '''Click and drag''' performs filling from '''all of the points''' that you pass while dragging (you will see your path visualized by a red line). From each point, the fill spreads to the neighbors with the colors similar to that point - in other words, it's like clicking with this tool at each point of the drag path and unioning the results. This lets you easily fill an area occupied by a gradient or blur - just drag from the darkest to the lightest points in the area you want to fill.

* '''Alt+click and drag''' works similarly to simple drag, except from each point of the drag path, the fill spreads to the neighbors (if any) with the colors similar to the ''initial point'' (the point where you started the drag). This lets you fill a series of similarly-colored yet separated areas (for example, multiple cells in a cartoon) by starting the drag in one of those areas, and alt+dragging the tool through all the other areas.

==Tweak tool==

The Tweak tool is an exciting new way to edit drawings which largely blurs the
distinction between vector and raster editing. Instead of meticulously selecting some
objects and then performing an action on the selection, you can now select ''all''
objects (or all objects you are interested in) and apply the Tweak tool's brush to
smoothly and naturally change the shape or style of only those objects (or parts
thereof) ''that the brush touches''.

The area of the tool's action - its ''brush'' - is marked by an orange-colored circular
outline that moves with your mouse cursor. However, that area actually has no sharp
boundaries; the power of the tool's action falls off gradually, following a smooth
bell-shaped profile. This makes the tool act softly and smoothly.

The tool will work on any number of selected objects; for example, you can select all
(Ctrl+A) and "smear" your entire drawing by Push mode or paint it by Color Paint
mode. You can also apply it to groups of objects; it will go into groups and act on
individual objects inside groups. If you're trying to use it without anything selected,
it will remind you by a statusbar message to select some objects.

===Width===

The width of the tool's brush, in the range from 1 to 100, can be changed by the
'''Width''' control in the tool's controls bar above the canvas. You can also change
width by '''Left''' and '''Right''' arrow keys (same as in the Calligraphy tool) at any
time (including during action) as well as '''Home''' and '''End'''. Also, as in Calligraphy
tool, the visible width of the brush is independent of zoom; simply zooming in or out is
often easier than adjusting the width if you want to cover a smaller or larger area of
the drawing.

===Force===

The next control is '''Force''' which adjusts the power of the action, also in the
range from 1 to 100. You can also change width by '''Up''' and '''Down''' arrow keys at
any time (including during action).

If you have a pressure-sensitive tablet and your "Use pressure" button on the right-hand
end of the controls bar is on, then the force will also depend on how hard you actually
press your pen into your tablet, changing in the range from zero to whatever you set in
the Force control. If all you have is a mouse, then the force will be constant but still
settable by the Force control.

===Path editing modes===

The Tweak tool has a number of '''modes''', selectable by toggle buttons in the tool's
Controls bar and by keyboard shortcuts. Some of these modes change the shapes of
paths while others affect the colors of objects. All these modes share the Width and
Force controls but otherwise are quite different. Let's look at the path editing modes
first.

Unlike the Node tool, to edit paths with the Tweak tool you don't need to worry about
where the nodes of a path are and how to manipulate them. You just apply the tool's
brush to any point, and the selected paths at that point will reshape smoothly and
naturally - as if made of soft jelly - regardless of where its nodes lie. If applied to
a shape or text object, the tool converts them to paths automatically.

While not very useful for technical drawings, tweaking paths will be indispensable for
artistic uses of Inkscape - cartoons, drawings, sketches, anime, etc. This new
functionality is somewhat similar to the tools such as "Pucker" and "Bloat" in the
latest versions of Adobe Illustrator.

There are currently six path editing modes in the Tweak tool: '''Push''', '''Shrink''',
'''Grow''', '''Attract''', '''Repel''', and '''Roughen'''.

* This default mode of the tool, '''Push''', simply displaces the part of the path under the cursor in the direction of the drag. The path behaves like soft jelly, bending and bulging smoothly and naturally. It's an easy way to produce various irregular, lifelike, handmade-looking shapes starting from something as simple as an ellipse or a calligraphic stroke. For parallel-stroke hatching (engraving) done in the Calligraphy tool, pushing is an easy way to bend, pinch, or curve the entire hatching uniformly.

* The '''Shrink''' and '''Grow''' are two opposite modes that move each point of a path in a direction perpendicular to the path's surface at the point, either inwards (Shrink) or outwards (Grow). This is similar to the Inset and Outset commands, except that the Tweak tool can act on a part of a path instead of the whole path.

:For example, the visible lightness/darkness of an engraving hatching may not exactly correspond to your artistic intention. Also, the ends of Calligraphy pen strokes are often far from ideal - they may be too blunt or have unsightly bends or blobs. This is where the Tweak tool may help. Select all the strokes in a hatching pattern and apply a light Shrink action where you want the lines to become thinner (and the hatching to become lighter), up until total disappearance. If you press hard, shrinking works as an eraser, so you can easily clean the strokes' ends to make them thin, sharp, and uniform. Conversely, applying Grow makes strokes wider (i.e. the hatching becomes darker).

:Of course, shrinking and growing are useful not only for calligraphic strokes. Same as with Push, with Shrink and Grow you can '''sculpt''' any path, spawning smooth treacle-like appendages with Inflating and carving holes with Melting. Unlike the "node sculpting" mode in the Node tool, however, this does not require adding new nodes to the shape.

* The '''Attract''' and '''Repel''' modes work by moving each affected point on a path towards (Attract) or from (Repel) the cursor point. In some cases this may look similar to Shrink and Grow, but the difference is that shrinking/growing moves paths perpendicularly to the path in each point, whereas attracting/repelling moves them to or from the cursor regardless of the path shape. These modes are similar to the Pinch effect in ; you can use them for various central-symmetric distortions in parts of your paths.

* The '''Roughen''' mode does exactly this: roughens the edge of the path without changing its overall shape. Slight roughening simply makes the edge crooked and uneven; strong roughening tears and explodes the edge into random blobs and splotches. Note that this operation, especially with high Fidelity, adds a lot of nodes which increases the size of your SVG document and may slow down Inkscape considerably. In particular, pushing/melting/inflating of a roughened path becomes much slower and more difficult, so it's recommended to finalize the overall shape of a path first and roughen it, if necessary, only as the final step.

See the screenshot at [http://inkscape.org/screenshots/gallery/inkscape-0.46-tweak-path.png] for a few examples of using the path editing modes of the Tweak tool.

====Fidelity====

Any tweaking of a path slightly distorts the entire path, including even those parts
that you didn't touch. These distortions are similar to those that a Simplify command
produces. The '''Fidelity''' value (also in the range from 1 to 100, default is 50)
allows you to control the amount of these distortions. With a higher fidelity, the
distortions are less noticeable, but the path may end up having a lot of nodes which
inflates up the SVG size and slows down Inkscape.

The best value of Fidelity depends on the nature of your artwork. If you're sculpting an
amorphous blob, you can do with low fidelity of about 20. If, however, you are pushing
or inflating a text string (as a single path) and want the letters outside the distorted
area to remain crisp and clean, you will need to raise fidelity to 80 or more.

====Known problems====

Known problems with the path editing modes in Tweak tool:

# they don't work on open paths (an open path becomes closed if you tweak it);
# they are rather slow;
# they quickly eat memory; and
# they are sometimes buggy - thin calligraphic strokes may suddenly disappear or change their shape drastically as you're melting or inflating them.

For (4), it helps to increase Fidelity. Also, you can undo the bad change and try again with less pressure on the pen - if you do your thinning in several light touches instead of one heavy press, usually you will be able to get the desired result without the buggy behavior.

Also, sometimes after roughening, further tweaking of a path becomes impossible with this diagnostic:

WARNING **: Shape error in ConvertToShape: directedEulerian(a) == false

All these problems stem from the livarot library that we use for geometric manipulation of paths. Fortunately, livarot is scheduled for replacement by lib2geom, a new library now in development, so hopefully these issues will be addressed then.

===Color editing modes===

The '''Color Paint''' and '''Color Jitter''' modes, unlike the path editing modes,
change the colors of objects instead of their shapes. Yet they share enough common
features with the path editing modes to be part of the same tool: These modes also use
a circular soft-edged brush controlled by the Width and Force parameters on the Controls
bar and affected by the pen pressure (if you have a pressure-sensitive tablet).

* '''Color Paint''' applies the style of the tool to the selected objects under the brush. The style of the tool is visible in the style swatch at the rightmost end of the tool's control bar; it can be changed by clicking on the color palette or by any other style assignment command, such as Fill and Stroke dialog. ('''Note''': unlike all other tools, in Tweak tool in Color Paint mode you cannot assign style directly to selected objects; any style-setting command changes the tool's style instead.)

:The fill from the tool's style applies to the fills of the painted objects, and the stroke applies to the strokes. If the tool's style has no fill or no stroke, it won't affect fills or strokes, correspondingly. For example, if you want to color the fills of objects blue but leave their strokes untouched, assign blue fill to the tool's style (just click blue on the palette) but set its stroke to None (middle-click the Stroke swatch in the statusbar). Similarly, master opacity in the tool's style affects master opacities of the touched objects (if the O channel is on, see below).

:This mode allows you to literally paint over objects, shifting their colors towards the target style of the tool. For example, if you paint with yellow fill over a blue-filled object, the object will become greenish blue, then green, then yellowish green, and end up being exactly the yellow color you're painting with. This speed of this gradual transition depends on both Force parameter and pen pressure; also, objects touched by the periphery of the brush are less affected than those hit by the brush center. Overall, using this tool is very similar to a soft brush in a raster editor such as Gimp or Photoshop.

* '''Color Jitter''' mode does not apply any color, but instead jitters (randomizes) the colors of the objects it touches. The force of the action determines how strong is the randomization, i.e. how far the colors deviate from the original values. This mode does not use the tool's style.

Both modes work on flat fills and gradients; for gradients, the tool takes into account not only the position of the entire object with gradient, but also the position of each gradient stop relative to the brush. This means that, for example, you can change the blue color only in an object filled with blue-red gradient simply by painting over its blue end with a brush small enough to not touch the red. (Note that color tweaking does not create gradients on objects that used flat color before, but only adjusts existing gradients in the drawing.)

See the screenshot at [http://inkscape.org/screenshots/gallery/inkscape-0.46-tweak-color.png] for a few examples of using the color editing modes of the Tweak tool.

====Channels====

Color Paint and Color Jitter honor the '''Channels''' control. This control comprises
the four buttons: '''H''', '''S''', '''L''', and '''O''', which allow you to turn on and off
the tool's action on the object's hue, saturation, lightness, and opacity,
correspondingly. For example, if you want to raise the saturation of some part of your
drawing without changing the hue, select some maximum-saturation color (e.g. pure red)
and turn off all Channels buttons except S. Similarly, you can replace the hues without
affecting saturation or lightness (only H pressed), or lighten/darken all colors without
changing their hues and saturation (only L pressed). Pressing O allows you to apply the
master opacity from the tool's style to the master opacity of objects (but not fill or
stroke opacity).

====Usage notes====

Color painting with Tweak tool is similar, but not exactly analogous to bitmap
painting. Even though the tool itself works as a soft brush, it still applies its color
to vector objects, which behave as vector objects usually do. For example, if you want
to change the tint of the face in your drawing, and if a hand in the drawing is part of
the same object as the face, that hand will change its tint too even if it's located far
from the point you are painting. (We foresee a "fracture" command in one of the next
versions of Inkscape which will help you turn a monolithic object into a mosaic of small
fragments that will be then easy to paint with Tweak tool.) Still, even with this
limitation, color painting is a novel way of dealing with vector drawings which allows
you to quickly and intuitively make adjustments which would be awkward and slow with
traditional approach.

Drawings containing patterns or scatterings of small independent objects are best suited
for color painting with Tweak tool. Examples include:

* freehand drawings with Calligraphy pen, consisting of many separate strokes;

* gradient meshes imported from Adobe Illustrator files (Inkscape renders these meshes as lattices of small polygons; while there's no direct support for gradient meshes in Inkscape yet, color painting on such lattices is almost as good);

* text converted to paths and with Break Apart command applied so that each letter is a separate path;

* patterns made with the Tile Clones command; note that you need to unset the fill and/or stroke on the original object and use the Color tab to assign some initial color to the clones - this will make them paintable with the Tweak tool without unlinking.

Moreover, color tweaking can be useful for compositions with a few objects or even for
single objects. Unlike all other color selection methods, painting with the Tweak tool
implements the ''color mixing'' metaphor which is much more familiar to traditional
artists than RGB sliders or even the color wheel. For example, start with a rectagle of
pure blue color; then, pick different colors by Color Paint and apply light touches with
minimum Force and minimum pen pressure: add a little green, a little brown, a little
yellow, etc. until you have the exact hue you need. Similarly, you can whiten or blacken
any hue by admixing white or black.

You can also use color tweaking to add a tint, darken/lighten, saturate/desaturate, or
color jitter your entire drawing. Just select all in all layers, zoom out, choose a
large brush width so it covers all of the drawing, and apply a little color tweaking
(with minimum Force) that will therefore affect all visible objects.

===Keyboard shortcuts===

* '''W''', '''Shift+F2''': switch to the Tweak tool

* '''Shift+P''': switch to the Push mode

* '''Shift+S''': switch to the Shrink mode

* '''Shift+G''': switch to the Grow mode

* '''Shift+A''': switch to the Attract mode

* '''Shift+E''': switch to the Repel mode

* '''Shift+R''': switch to the Roughen mode

* '''Shift+C''': switch to the Color Paint mode

* '''Shift+J''': switch to the Color Jitter mode

* '''Left, Right, Home, End''': change width

* '''Up, Down''': change force

* '''mouse drag''': act on selected path in the current mode

* '''Ctrl+mouse drag''': temporarily switch to Shrink (while Ctrl is down)

* '''Shift+Ctrl+mouse drag''': temporarily switch to Grow (while Shift+Ctrl is down)

==3D Box tool==

Inkscape is a two-dimensional drawing tool. However, very often it is used to draw three-dimensional objects. The new '''3D box tool''' helps you create such 3D drawings by automating the most common operation: creating a three-dimensional box in a given perspective. The tool automatically ensures that all sides of the box lie on the corresponding perspective lines. We're not going to compete with Blender - but even simple things can go a long way.

Currently in the 3D box tool you can:

* draw a 3D box by dragging on canvas (use Shift+dragging without releasing the mouse button to extrude in z direction)

* adjust any of its 3 dimensions by handles

* move a 3D box "in perspective" by dragging its center; without modifiers, movement occurs within the XY-plane (press Ctrl to constrain the movement to the directions of the coordinate axes or diagonals), with Shift the box moves parallel to the Z-axis

* adjust the vanishing points of a perspective by dragging them across the canvas (see below) or toggling their states; all boxes sharing this perspective are transformed accordingly

In SVG, a 3D box is represented as a '''group''' (svg:g) with a special extension attribute (in inkscape namespace); this group contains the 6 quadrilateral '''paths''' representing the sides of the box. Only the 3D box tool treats this object as a box; for all other tools it is just a group, so you can select any of the paths by Ctrl+click, apply any style to it, delete it, etc. You can of course transform the entire box or any face in it using Selector or Node tools.

When several boxes are selected, all vanishing points of their associated perspectives are shown on the canvas. If vanishing points of different perspectives coincide, they are combined in a single "dragger". Moving this dragger moves all the vanishing points simultaneously and transforms the associated boxes accordingly. Note that some non-selected boxes may also be reshaped if their perspectives share the same vanishing point. Pressing Shift while moving the dragger can be used to only transform the selected boxes, separating their perspectives from the non-selected ones'. On the other hand, when a vanishing point being dragged comes close enough to another one, both snap together and are combined in a single dragger.

===Keyboard shortcuts===

* '''X''', '''Alt+F4''': switch to the 3D box tool

* The various kinds of parentheses, namely '''[''' ''']''', '''(''' ''')''', '''{''' '''}''', can be used to rotate infinite (i.e., parallel) perspective lines in X-, Y-, and Z-direction, respectively. Closing parentheses rotate clockwise and opening parentheses rotate counterclockwise. The angle of rotation is taken from the preferences. Pressing '''Alt''' reduces the amount of rotation to 1 screen pixel.

* '''L''': toggle visibility of perspective lines

* '''A''': when perspective lines are visible, toggle between "all lines" and "only lines connected to front corners" (this can help to avoid visual clutter)

[max]

==Gradient Tool==
===Selecting multiple stops===
'''More than one gradient stop''' can be selected at a time. Shortcuts for working with multiple stop selections are generally modeled on the Node tool.
* Add a stop to the selected stops by '''Shift+click'''.
* Press '''Ctrl+A''' to select all stops in the selected objects.
* '''Shift+drag''' around stops to add them to selection.
Multiple selected stops:
*Can be moved together by '''mouse drag''' or by '''arrow keys'''. For example, creating a linear gradient, then press Ctrl+A to select all stops and use arrow keys to move the entire gradient as a whole.
*Can be deleted at the same time by pressing '''Del'''.
An always up-to-date description of the current handle selection is provided in the statusbar in the Gradient tool, including the number of selected handles (and the type of the single selected handle), as well as the total number of handles and selected objects.

===Editing intermediate stops===
'''Intermediate stops''' in gradients can be added, deleted, and edited on canvas (previously this was only possible in the Gradient Editor dialog).
*Stops can be added by '''double clicking''' or by '''Ctrl+Alt+Click''' on the gradient line. Also, you can '''drag-and-drop''' a color from the palette onto the gradient line to create a new stop with this color. Dropping a color on an existing stop changes the color of that stop.
*When two or more adjacent stops are selected, pressing '''Ins''' adds stops in the middles of all selected stop intervals.
*Intermediate stops can be '''mousedrag'''ged or moved by '''arrow keys''' along their gradient line, within the limits of the adjacent unselected stops (or end handles).
:*Dragging with '''Ctrl''' moves the selected stops snapping them to 1/10 fractions of the available range.
:*Dragging with '''Alt''' moves the selected stops depending on how close each one is to the stop being dragged, using a smooth bell-like curve similar to the node sculpting feature in Node tool. This makes it easy to approximate different gradient profiles; for example, if you have a two-stop gradient that you want to shape according to a curve profile, select both ends of the gradient, press '''Ins''' a few times to add a number of intermediate nodes, then '''Alt+drag''' a node in the middle to smoothly profile the gradient.
*Stops can also be moved by '''arrow keys''' with all the regular modifiers ('''Shift''' for 10x movement, '''Alt''' for pixel-size movement at the current zoom, '''Shift+Alt''' for 10 pixels movement at the current zoom).
*Stops can be deleted by '''Ctrl+Alt+Click''' on a stop or by the '''Del''' key for all the selected stop(s).
:*When you delete an end stop, the nearest intermediate stop becomes the new end stop of the gradient (without moving - i.e., the gradient span becomes shorter).
:*When you delete an end stop and there are no intermediate stops, the object will be painted with a solid fill taken from the color & opacity of the remaining stop.
*Pressing '''Ctrl+L''' with some intermediate stops selected attempts to ''simplify'' the selected portion of the gradient, removing those stops that can be removed without too much change in the way the gradient looks. In particular, new stops created by double-clicking or pressing Ins initially do not change the appearance of the gradient, so if you press Ctrl+L, all redundant stops that weren't moved or repainted since creation will be deleted.

===Style of gradient stops===
*When you have one of the '''gradient handles selected''', its style (color and opacity) is reflected by the selected style indicator (left of the statusbar) and the Fill&Stroke dialog. Previously, opacity of a gradient handle was reflected as fill-opacity and stroke-opacity; now it is reflected as '''master opacity''' (the "O:" spinbutton in the selected style indicator, the "Master opacity" slider in Fill&Stroke). This makes it much easier to view and change opacity of gradient handles using only the selected style indicator in the statusbar.
:*When multiple gradient stops are selected, the selected style indicator (in the statusbar) displays and controls the averaged color and opacity of the selected stops.
*When one or more gradient stops are selected, using the Copy command ('''Ctrl+C''') copies to the clipboard the style (color and opacity) of the selected stop or the averaged style of several selected stops, not the entire object with gradient as before. This means you can now copy/paste style between stops: select the source stop(s), copy, select the destination stop(s), paste style ('''Ctrl+Shift+V'''). With several selected stops, this also allows you to easily average their colors and opacities by copying them and pasting the style back onto them. (After that, redundant gradient stops can be removed by simplification with '''Ctrl+L''').
*If the selected object(s) have gradient in fill or stroke, the '''selected style indicator''' in the bottom-left corner of the editing window now displays a '''live gradient preview''' prefixed by '''R''' or '''L''' to indicate Radial or Linear gradients (instead of displaying "L Gradient" or "R Gradient" text labels as before). Also, this and other similar widget now use italic font face to indicate <i>None</i> and bold to indicate <b>Unset</b>.

===Automatic duplication of gradients===
When copy/pasting or duplicating an object with gradient, it now automatically gets a '''copy''' of the original gradient, so modifying it does not affect the source object's gradient anymore (before, you had to press the Duplicate button on the Gradient controls bar for this). The Duplicate button is therefore removed.

However, to accommodate the needs of users who have relied on sharing the same gradient definition across objects, this behavior can be optionally suppressed. The '''Prevent sharing of gradient definitions''' checkbox on the Misc tab of Inkscape Preferences is by default checked; if you uncheck it, Inkscape does not automatically copy gradient definitions for new objects, which means that copy/pasting, duplicating, pasting style, and explicit assignment of a gradient to an object via the Gradient tool controls results in a shared gradient definition, so that changing the colors or mid-stop positions of the gradient on one object (but not changing the coordinates of the end handles) affects all other objects that share the same definition.

==Calligraphy tool: Engraver's Toolbox ==

Several new features were added to the Calligraphic pen to make
Inkscape capable of the ancient art of '''line
engraving'''. Traditional engraving is a very labour-intensive
process, and while for a long time it was the only practical way
of reproducing lifelike images in black-and-white print, about a
century ago it was almost completely displaced by automatic
halftone screens. However, line engravings have their
characteristic charm, and there's no reason not to try to
resurrect this art form with the help of Inkscape.

A brief visual guide to the new functionality can be seen on
these screenshots:

http://inkscape.org/screenshots/gallery/inkscape-0.46-engraving1.png

http://inkscape.org/screenshots/gallery/inkscape-0.46-engraving2.png

===Tracking a guide path with Ctrl===

One of the most common operations in line engraving is
'''hatching''' (or sometimes ''cross-hatching'' when several
hatching grids cross): filling a space with many parallel
straight or variously curved lines (usually of varying width to
represent a gradual shading). You could try to achieve a similar
effect with e.g. path interpolation (blending), but it is rather
cumbersome and limited; manual drawing of hatch lines, on the
other hand, is tedious and nearly impossible to do
uniformly. Now Inkscape provides "assisted hatching" by
'''tracking a guide path''', allowing you to hatch quickly and
uniformly and at the same time giving you sufficient manual
control over the process.

Here's how to do this. First, select the '''guide path''' that
you will track. It may be another calligraphic stroke, any path
or shape, or even a letter of a text object. Then switch to
Calligraphic pen, select the desired parameters (line width,
angle, fixation etc.) and, before starting to draw, press
Ctrl. You will see a gray '''track circle''' centered at your
mouse pointer and touching the closest point on the selected
guide path. (If you have no guide path selected, a statusbar
message will tell you to select it.)

Now move your mouse close to the guide path, so that the track
circle radius is equal to the desired spacing of your hatch
pattern, and start drawing along the guide path. At that moment,
the radius of the circle gets locked; now the circle slides
along the guide path - and the actual stroke is drawn by the
center of the tracking circle, ''not'' by your mouse point. As
a result, you are getting a smooth stroke going parallel to the
guide path and always at the same distance from it.

When the stroke is ready, release your mouse button (or lift
your tablet pen) but '''do not let go of the Ctrl key''' because
as long as you have it pressed, the tool remembers the hatch
spacing you set when you started drawing. Now, you have just
created a new stroke and, as usual with Inkscape tools, it gets
selected instead of what was selected before. In our case, this
means that the newly drawn stroke itself becomes the new guide
path. Next, you can draw a second stroke along the first one,
then a third one along the second, etc. Eventually you can fill
any desired space with uniform hatching.

Alternatively, if you uncheck "Select new path" in the Calligraphy tool preferences, newly created strokes will not be selected, so your original guide path will be kept selected. In this mode, Inkscape will increase the tracking distance after each created stroke so that you can create uniformly spaced hatching by tracking a single guide path.

The attachment to the guide path is not absolute. If you stray
your mouse pointer far enough from the guide path, you will be
able to tear it off (the track circle turns from green to red)
and move freely. This is intentional; this feature allows you,
for example, to continue drawing a stroke past the end of a
guide stroke, thus making your hatching cover a wider area than
the initial guide path. Special care is taken to make such
tearing off as smooth as possible and to suppress violent jerks,
but this is not always possible; the general advice is to not
try to hatch too fast. If jerking and unintended tearoffs still
bother you, try increasing the Mass parameter.

Also, special code is in place to prevent flipovers - accidental
jumps to the other side of the guide path. Brief flipovers are
suppressed, but if you intentionally go over to the other side
and stay there, eventually Inkscape will obey and your tracking
stroke will also flip over to follow you.

Tracking a guide also allows some slight feedback by gradually
changing the tracking distance in response to your drawing
behavior. Thus, if you're consistently trying to draw closer or
farther from the guide than the current tracking distance, the
distance will correspondingly decrease or increase, so you will
get a hatching that is slightly spacing in or out. (The effect
is very slight, however, so as not to become a nuisance.) Also,
note that since tracking follows the edge of the stroke, strokes
of varying width (such as those tracing background, see below)
will result in gradual bending of the hatching pattern as you
proceed.

===Tracing background by stroke width===

There is a new toggle button on the Calligraphy tool's controls
bar, '''Trace background'''. When on, the width of your pen
depends on the lightness of the background under the stroke in
each point, so that white translates into the minimum stoke
width (1) and black translates to the maximum (which is set by the
Width parameter). This can work alone or in combination with
pressure sensitivity, depending on whether the "Use pressure" button
is also toggled.

This feature allows you to not only hatch over an imported
bitmap image or any drawing, but to do so automatically
reproducing the highlights and shades of the background with
your strokes becoming lighter and heavier as needed.

===Misc features===

* For consistency with other drawing tools, drawing with '''Shift''' in Calligraphy tool automatically '''unions''' the newly created stroke with whatever paths were selected (and selects the result). Thus, you can do a series of overlapping Shift+strokes to create one unioned path object instead of separate objects as before.

* To facilitate changing the Width parameter, the Home/End keys in Calligraphy tool switch you to the minimum (1) and maximum (100) width, correspondingly. (This is in addition to the Left/Right arrow keys that change Width by 1; remember also that you can press Alt+X, type any width, and press Enter.)

==Selector==

* A new selection mode is available: '''selecting by touch'''. In this mode, you draw a freehand path across the objects; when you release mouse button, all objects that are touched by this path get selected. This mode is very convenient in situations where you need to select objects so intermingled that selecting them by the rectangular rubberband is too difficult and so numerous that click-selecting them one by one is too tedious.

:To activate selecting by touch, whenever you are drawing a rubberband rectangle, just press '''Alt''' to switch it to the touch mode. The rectangle will disappear and a red ''touch path'' will be shown instead. When dragging from an empty space, you can press '''Alt''' first and then start to drag to get the touch mode (note that your selection must be empty, otherwise Alt+dragging will move the selected objects instead). To start a touch selection from a point over an object, or to add to existing selection by touching, press '''Shift+Alt''' and then start to drag.

* Previously, the only way to switch selection from scale mode to rotate mode or back was to click on it, which was rather inconvenient when the selected object is in a group or under other objects. Now you can switch modes with keyboard as well by pressing '''Shift+S''' in Selector tool.

* Draging the '''scale handles with Alt''' now scales selection by an integer factor, i.e. up to '''2''', '''3''', '''4''', etc. times the original size or down to '''1/2'''. '''1/3''', '''1/4''', etc. of the original size (in any of the two dimensions independently). This way you can, for example, mirror any object around one of the edges of its box. (This replaces the old and rarely used "slow" scaling mode with Alt.)

* '''Horizontal/vertical flipping''': So far, flipping a selection made it flip within its bounding box, so that the latter remained fixed. In the move/scale mode of the selector tool, this behaviour remains unchanged. However, in rotate/shear mode flipping now happens about an (imaginary) vertical/horizontal axis through the rotation center. This is very handy, since the latter can be freely dragged around and snaps to all kinds of objects if desired.

* '''Objects to Marker''' was added to the objects menu, which converts the current selection to a marker, with the center point of the selection being set to the center of the marker.

==Node tool==

* If any of the nodes in the currently selected path is mouseovered, then horizontal/vertical flipping ('H' and 'V' keys), stepwise rotation ('[' and ']' keys) and scaling ('<' and '>' keys) now all use this specific node as center/axis. If there is no mouseovered node, the center of the bounding box is used instead (as is currently the case unconditionally). Nodes that are covered by one of their handles are also detected as mouseovered.

* [helper path display - johan]
** this is deactivated for normal paths now. only paths with LPE applied will show it. should there be a button to turn it on for normal paths aswell?

* As a long-requested feature, two entry fields are added to the toolbar which allow precise editing of the coordinates of selected nodes.

==Rectangle Tool==

* Ctrl+dragging now also allows the creation of rectangles with sides constrained to the golden ratio (approx. 1 : 1.618034), not only integer ratios.

==Text tool==
* [text toolbar - deadchip?]
* If text contains a tref element, the text tool's behavior may not be as expected. Please see [[#The tref Element]]

==Dropper Tool==

The shortcut 'D' is now used to <i>toggle</i> (not just switch to) the dropper tool - much like space is used to toggle the selector tool. That is, pressing 'D' a second time switches back to the tool used before.

=SVG features=

==The tref element==

Inkscape can now correctly open files with '''tref''' elements, and new tref elements can be created manually in the XML editor.

The actual character data contained in a text element can either be embedded directly, or it can be the character content of an element referenced by a '''tref'''.

While the textual content from the referenced element will be stripped of any markup before being used by the '''tref''', the '''tref''' element can itself have the same attributes as a '''tspan'''. In fact, when rendered, it is as though the '''tref''' element is replaced by a '''tspan''' with the same attributes, and the referenced character data is embedded in that '''tspan'''.

The property '''xlink:href''' is used to refer to another element whose character data will be used. Any element can be referred to except an ancestor of the '''tref'''. When any of the text contained in the referred element changes, the '''tref''' will immediately be updated to display the new data.

Existing tref elements can be converted into tspan elements with '''Edit > Clone > Unlink Clone'''. If more than one '''tref''' is contained within a selection, all '''trefs''' will be converted into '''tspans'''. All attributes applied to the '''tref''' will be retained in the new '''tspan'''.

A '''tref''' element can be mixed with any other elements allowed to be contained by a text element.

The cloned character data rendered by the '''tref''' may not be edited, but any characters surrounding it can be changed. Styles cannot be applied to a subset of the cloned characters, but if all are selected, a style can be applied to the '''tref'''.

==SVG filters==

===New filters supported===

* The '''feBlend''' filter primitive gives us image blending modes, like in many image manipulation programs. These modes are screen, multiply, darken and lighten. There's a caveat, though: when blending an object against an semi-transparent background, the background will be accumulated twice, resulting in thicker objects under the bounding box of blended object. This is a limitation of current version of SVG format, not a bug in Inkscape.

* The '''feColorMatrix''' filter primitive applies a matrix transformation to colour of each rendered pixel. This allows for effects like turning object to grayscale, modifying colour saturation and changing colour hue.

* The '''feComposite''' filter primitive composites two images using one of the [http://en.wikipedia.org/wiki/Porter-Duff Porter-Duff blending modes] (described in paper Compositing Digital Images by T. Porter and T. Duff, published in SIGGRAPH '84 Conference Proceedings, Association for Computing Machinery, Volume 18, Number 3, July 1984) or the aritmetic mode described in SVG standard. Porter-Duff blending modes are essentially logical operations between the images. For example, xor mode shows the areas, where either one of the objects is, but not the areas where both of the objects are. Arithmetic mode lets you specify coefficients k1-k4 for blending equation (result colour) = k1 * (first input colour) * (second input colour) + k2 * (first input colour) + k3 * (second input colour) + k4.

* The '''feConvolveMatrix''' lets you specify a [http://en.wikipedia.org/wiki/Convolution Convolution] to be applied on the image. Common effects created using convolution matrices are blur, sharpening, embossing and edge detection. There's a fairly good explanation and some example matrices at [http://www.gamedev.net/reference/programming/features/imageproc/page2.asp www.gamedev.net/reference/programming/features/imageproc/page2.asp]. Note that while gaussian blur can be created using this filter primitive, the special gaussian blur primitive is faster and resolution-independent.

* Filter primitives '''feDiffuseLighting''' and '''feSpecularLighting''' create lighting maps for the object in input image. SVG doesn't have concept of third dimension, so these filters use alpha channel of input image as a height map: the more opaque given point in input image is, the nearer spectator it is considered to be. There exists an example for using these in Inkscape distribution, in share/examples/lighting_effects.svg or [http://inkscape.svn.sourceforge.net/viewvc/*checkout*/inkscape/inkscape/trunk/share/examples/lighting_effects.svg?revision=15523 in SVN]

* The '''feDisplacementMap''' filter primitive displaces the pixels in the first input using the second input as a displacement map, that shows from how far the pixel should come from. Classical examples are whirl and pinch effects, that can be found in most image manipulation programs and even in some screensavers, where this kind off effect is moving around screen, twisting desktop beneath it.

* The '''feImage''' filter primitive allows using external images as part of filtering chain. For example, one could use external image as a displacement map for feDisplacementMap or as a height map for lighting effects. Note that while SVG standard allows using other parts of the SVG file in this filter primitive, the current Inkscape implementation only allows external images.

* The '''feMerge''' filter primitive composites several temporary images inside the filter primitive to a single image. It uses normal alpha compositing for this. This is equivalent to using several feBlend primitives in 'normal' mode or several feComposite primitives in 'over' -mode.

* The '''feMorphology''' filter primitive provides erode and dilate effects, that are common in image manipulation programs. With erode, darker and more transparent areas spread to lighter and more opaque areas, whereas with dilate lighter and more opaque areas spread to darker and more transparent areas. For single-colour objects, this basically means, erode makes the object thinner and dilate makes it thicker.

* The '''feOffset''' filter primitive offsets the image by an user-defined amount. For example, this is useful for drop shadows, where the shadow is in a slightly different position than the actual object.

* The '''feTurbulence''' filter primitive renders [http://en.wikipedia.org/wiki/Perlin_noise Perlin noise]. This kind of noise is useful in simulating several nature phenomena like clouds, fire and smoke and in generating complex textures like marble or granite.

See also wiki page [[Filter Effects]] for more info on filters in Inkscape in general.

===Filters UI===

* New dialog for creating and modifying filter effects ('''Object>Filter Effects...''')
* The list at the left of the dialog displays all filters currently in the document.
** New filters can be added with the '''Add''' button beneath the list
** Right-clicking a filter for the pop-up menu allows duplicating or removing a filter.
** Double-clicking a filter will apply it to all selected objects
** A black dot is placed next to whatever filter is applied to the selected objects. If more than one filter is in use by selected objects, an unfilled dot is used instead.
* The second list, at the left of the dialog, displays the '''filter primitives''' that are contained within the currently-selected filter.
** New primitives can be added by selecting the primitive type from the combo box beneath the list, and then pressing the '''Add''' button.
** Right-clicking a primitive for the pop-up menu allows duplicating or removing a primitive.
** Primitives can be rearranged by clicking and dragging any filter in the list.
** When a filter is selected, the '''Settings''' group at the bottom of the dialog will change to display the attributes available for that primitive. Changing a setting results in an immediate update to the document.
** The "in" and "in2" attributes for filters that support them are not shown in the '''Settings''' group. These input connections are displayed graphically in the list, under the '''Connections''' column.
*** Inputs for a particular filter are displayed as triangles. Depending on the primitive type, there may be one or two inputs (or more for Merge primitives.) Connections can be created by clicking on a triangle and dragging.
*** There are six standard input types that can be used for any primitive input; Source Graphic, Source Alpha, Background Image, Background Alpha, Fill Paint, and Stroke Paint. These are displayed vertically on the far right of the list. Click and drag from an input triangle to one of the standard inputs to connect them.
*** Primitives can also be connected to other primitives by clicking an input triangle and dragging upwards to another primitive. A primitive can only be connected to one higher up the list.
*** Single-clicking on an input triangle will unset it, returning it to the default. If it is on a Merge primitive, the input will be deleted.
*** Merge inputs have an empty input at the end. Dragging a connection from this input will add a new input to the primitive.

=Live Path Effects (LPE)=

'''Live path effects''' (not to be confused with extension effects or SVG filters) are a new way to <b>non-destructively modify path and shape objects</b>. Path effects affect the path data of an object but not its style. The original path is preserved and can be edited directly on-canvas, and the path effect applied to it will be updated live.

In this version, we include several path effects that are analogous to the corresponding extension effects (such as Path along Path effect and Pattern along Path that replaces the extension of the same name). The most important advantage of path effects is that they are, indeed, live - you can still edit the original path and the effect will update in real time (unlike the extension effects which were one-time one-way transformations). In the future, we plan to reimplement most if not all of path-changing extensions as live path effects.

Live path effects were developed by Johan Engelen as part of the GSoC 2007.

==Details about operation==
The following schematic tries to explain how LPE work.

original style ------------> output style
original path --> LPE --> output path
^
|
parameters

The original style and path are from the path that the effect is applied on. The output is what is visible on screen. What is very important to notice is that <b>output style equals original style</b>.

The parameters can be paths, numbers, points, text, in principle anything.

==Applying effects==
Path effects are applied through the Path Effects dialog (opened from the Path menu, or by pressing Ctrl+Shift+7. This dialog is also used for controlling the effect's parameters and for removing effects.

When a path with a path effect applied is selected, the statusbar description mentions that, for example "'''Path''' (4 nodes, path effect)".

There is a special Paste Path Effect command (Ctrl+7) that can be used to copy effects from one path to another.

==Editing effect parameters==
When switching to the node edit tool (<b>F2</b>), the <b>original path</b> can be edited. The original path is shown as a red helper path. Normal path operations, like simplify, still work.

Some parameters of effects can be edited on-canvas. For example, path parameters can be node-edited, by pressing the "edit on-canvas" button in the Path Effects dialog. <b>Press "7" to cycle through the different on-canvas editable parameters.</b> This way, one can edit the parameters without opening the Path Effects dialog. The statusbar tells the name of the parameters that is currently being shown.

==Available effects==

===Path along path===
The <b>Path along Path</b> effect can curve a path along another path. When this effect is applied to a path, it can be bend along another path (called ''bend path''). With the node edit tool, both the original path and the bend path can be changed <b>on-canvas</b> and the result is <b>updated live</b>. This provides a direct equivalent of "vector brushes" or "skeletal strokes" features in other vector editors.

In the effect's control panel in the Path Effects dialog, you can select how many copies of the original path are put along the bend path (either '''single''' or '''repeated''') and whether it is '''stretched''' to fill the bend path. In this dialog you'll also find a button to edit the bend path on-canvas and a button to '''paste''' a new bend path from clipboard. A possible workflow is this: you select and copy the new bend path to the clipboard, then select the path you want to bend, apply the Path along path effect, and paste the bend path with the paste button next to 'bend path'.

Example file: live-path-effects-pathalongpath.svg

===Pattern along path===
The <b>Pattern along Path</b> effect can curve a path along another path. When this effect is applied to path A (called ''skeleton''), another path B (called ''pattern'') can then be passed as a parameter. The result is that path B is bent along path A. With the node edit tool, path A can be changed <b>on-canvas</b> and the result is <b>updated live</b>. This provides a direct equivalent of "vector brushes" or "skeletal strokes" features in other vector editors.

In the effect's control panel in the Path Effects dialog, you can select how many copies of the pattern are attached (either '''single''' or '''repeated''') and whether the pattern is '''stretched''' to fill the skeleton path. You can also choose the pattern for the selected skeleton [either directly or] by '''pasting''' it from clipboard (that is, you select and copy to the clipboard the pattern, then select the skeleton, apply the Path along path effect, and paste the pattern). The '''Scale width''' parameter allows you to change the width of the pattern applied to the path.

Example file: live-path-effects-pathalongpath.svg

===Stitch Subcurves===
The <b>Stitch Subcurves</b> effect connects points from two subpaths of the path with straight line or curved segments, i.e. the <i>stitches</i>. It looks a lot like the Effect Lines from Expression 3. The result is also referred to as "String Art". For some examples of string art, see http://members.shaw.ca/jillbritton/string_art/jbstringart.htm.

The <b>shape</b> of the <b>connecting paths</b> can controlled by the <b>stroke path</b> parameter. This could be used to draw 'hair-shaped' connecting paths with sharp end-tips. Other controls include the <b>number of paths</b>, the variation in spacing between the connecting paths (<b>clustering</b>) and also whether the start and end points of the stitches should like exactly on the original subcurves or can <b>stray randomly</b> around them. Finally the width of the stroke path can be varied.

Note that this effect can only be applied to a path with two subpaths in it, hence '<b>sub</b>curve' in the name. Use Path > Combine to create such a path from two separate paths.

Example file: live-path-effects-curvestitch.svg

Example file showing cooperation between Stitch Subcurves and Path along Path: live-path-effects-curvestitch-hair.svg

===Gears===
The <b>Gears</b> effect is a toy effect. It generates a chain of interconnected gears from the path that has the effect applied to it. The nodes of the path define the centers of the gears. The first 3 nodes are special; the first defines the start angle of the chain, the second defines the center of the first gear and the third knot specifies the radius of the first gear. That is, to create a chain of 2 gears, you will need a path with 4 nodes; for 3 gears, 5 nodes, and so on.

Example file: live-path-effects-gears.svg

==Development of new effects==
One of the goals of the Summer of Code project was to make it easy to create new effects. There is a framework that greatly simplifies effect implementation; very little code is needed to get the effect hooked into Inkscape. This leaves valuable time for the actual effect to be implemented. See the http://wiki.inkscape.org/wiki/index.php/MakingLivePathEffects wiki page for an explanation of how to get started with your own effect!

[johan]

=Extension effects=

== Live preview ==

* '''Live preview of effects''': Using the async behavior (see below), as soon as the parameters dialog for an effect is shown, the script is executed in the background and the screen updates as soon as it's finished. This can result is seemingly faster execution if no parameters are changed. If some parameters are adjusted, the script is restarted. This allows you to see immediately the effects of any parameter change without pressing the OK button on the effect's dialog.

* '''Spawn Glib API''': Scripting extension have been moved to the Glib spawn API to ensure that parameters and variables aren't interpreted by a shell. This also means that scripting extensions are executed in a separate process asynchronously allowing the GTK main loop to continue to execute.

* '''Progress dialog''': While an extension is working on a document, a small dialog is shown allowing the user to cancel the execution.

== New and improved effects ==

* The new '''Modify Path > Edge 3D''' extension creates black, grey and white paths around a shape, then blurs and clips them for a 3D effect.

* The new '''Render > Barcode''' extension creates a [http://en.wikipedia.org/wiki/Barcode barcode]. Supported types include EAN13, EAN8, UPC-A, UPC-E, UPC-5, Code39, Code39Ext, Code93, Code128, and RM4SCC.

* The new '''Render > Gear''' extension creates a [http://en.wikipedia.org/wiki/Gear mechanical gear] given the number of teeth, the circular pitch (in px units), and the pressure angle.

* The new '''Render > [[Spirograph]]''' extension creates intricate mathematical curves akin to the classic [http://en.wikipedia.org/wiki/Spirograph mechanical Spirograph toy] (see [http://wiki.inkscape.org/wiki/images/Spirograph_Samples.svg samples]).

* A group of new effects in the '''Text''' submenu performs various case conversions on selected text objects: converting to UPPERCASE, lowercase, Sentence case, Title Case, as well as flipping case (switching uppercase to lowercase and vice versa) and rANdoMiZInG cAse. If no texts are selected, the effect works on all texts in the document.

* Another effect in the Text submenu, '''Replace text''', performs search-and-replace on the selected text objects or (if nothing is selected) on all texts in the document. Searching is case sensitive. You can use this effect to globally delete all occurrences of some text fragment by replacing it with empty string. Conversely, if you search for an empty string and replace it with some string, this string will be inserted after every character of your text; for example, you can space out a text by replacing in it an empty string with a single space.

* A new effect, '''Replace color''' in the Color submenu, simply replaces one RRGGBB-specified color to another within selection or, if there's no selection, in the entire document. As with other effects in that submenu, the replacement affects fill, stroke, and gradient colors, but not colors of bitmaps.

*The new '''Color > Randomize''' extension allows you to change the color via hue, saturation and lightness check boxes. This is useful if you want to colorize lots of shapes at the same time.

*The '''Whirl''' extension uses the center of view as the center of whirl, so you don't have to enter the center coordinates numerically.

*The '''Render > Grid''' extension has got an extended range of grid spacings, from 0.1 to 1000 px.

*The '''Render > Function Plotter''' extension can now plot using polar coordinates.

*The '''Generate Template > Perfect-Bound Cover''' extension creates templates for wraparound covers for perfect-bound books using US size and paper weight measurements. This extension will resize the document to include the width, height, spine width, and bleed measurements that are provided to the extensions, so it should be the first operation done before designing.

== XSLT effects ==

* '''XSLT''' is now supported for input, output and effect extensions. This is used to support the XAML file format (both import and export) and the Adobe Illustrator SVG import which removes Adobe's stuff from SVG.

== ImageMagick effects ==

New raster operations available through the effects drop-down menu, powered by the ImageMagick library. For any of these effects to work, you need to have an '''image object selected''' in the drawing.

* '''Adaptive Threshold''' applies adaptive thresholding to the bitmap. Average color of rectangle provided by '''width''' and '''height''' used as threshold value. Use '''offset''' to apply a different threshold than the average.

* '''Add Noise''' adds random noise of certain types to the bitmap.

* '''Blur''' blurs the bitmap, using '''radius''' as the amount of blur. Higher radius means more blur. (Note that unlike the vector Gaussian blur of objects, this bitmap blur will not extend the edges of the image, so it may appear truncated at the edges.)

* '''Channel''' extracts the specified channel from the bitmap.

* '''Charcoal''' applies a charcoal drawing style to a bitmap. Radius controls the width (or detail) of charcoal strokes. Higher '''radius''' means lower detail. '''Sigma''': the higher it is, the less defined the charcoal is.

* '''Colorize''' overlays the bitmap with a given color at a given intensity.

* '''Contrast''' lightly enhances the contrast (difference between lights and darks) of a bitmap.

* '''Cycle Colormap''' cycles the colormap of a bitmap.

* '''Despeckle''' reduce the speckle noise in a bitmap.

* '''Edge''' hilights edges in a bitmap.

* '''Emboss''' embosses a bitmap, hilighting edges with 3D effect.

* '''Enhance''' enhance a bitmap, minimizing noise.

* '''Equalize''' equalizes a bitmap. Histogram equalization.

* '''Flop''' mirrors a bitmap, reflecting each scanline in the horizontal direction.

* '''Gaussian Blur''' blurs a bitmap, more strongly than regular blur.

* '''Implode''' sucks everything towards the center of the bitmap.

* '''Level''' scales values falling between the given '''Black Point''' to '''White Point''' range to the full color range.

* '''Level Channel''' acts the same way as level but for only one channel.

* '''Median Filter''' filters a a bitmap by replacing each pixel component with the median color in a circular neighborhood

* '''Modulate''' adjusts the percent hue, saturation, and brightness of a bitmap.

* '''Negate''' takes the inverse of a bitmap.

* '''Normalize''' normalizes a bitmap, expanding color range to the full possible range of color.

* '''Oil Paint''' stylizes a bitmap so that it appears to be painted with oils.

* '''Opacity''' modifies the opacity channel of a bitmap.

* '''Raise''' alters the lightness of the edges of a bitmap to create a raised appearance, much like a frame.

* '''Reduce Noise''' reduces noise in a bitmap by using a noise peak elimination filter.

* '''Shade''' shades a bitmap by simulating a distant light source

* '''Sharpen''' sharpens a bitmap.

* '''Solarize''' solarizes a bitmap, like overexposing photographic film.

* '''Spread''' randomly spread pixels in a bitmap within the radius of '''amount'''.

* '''Swirl''' swirls the bitmap around the center point.

* '''Threshold''' thresholds a bitmap.

* '''Unsharpmask''' sharpens a bitmap using an unsharp mask algorithm.

* '''Wave''' alters a bitmap along the sine wave.

These effects are part of the Google Summer of Code 2007, coded by Christopher Brown.

== Misc ==

* All Python effects are switched from the old and unmaintained PyXML library to the new powerful [http://codespeak.net/lxml/ lxml] library.

* A new parameter, '''precision''' is added to the parameter definitions in the [[MakingAnINX|inx file format]], allowing you to set the number of digits in that parameter's spinbutton in the effect UI.

= Stock patterns =

Since a few versions ago, Inkscape supports patterns in fill and stroke. However, up to now the only way to apply a pattern was by creating it in the document using the Object(s) to Pattern command, which wasn't very convenient. Now, if you switch an object's fill or stroke to pattern using the Fill&Stroke dialog, you will get a drop-down list with a number of predefined '''stock patterns''' that you can apply simply by selecting them from the list:

*A selection of plain '''stripes''' differing by the ratio of the stripe width to gap width (for example, the "Stripes 1:2" pattern has gaps twice as wide as stripes), in the range from 4:1 to 1:64. All stripes patterns are in two versions: with black stripes and with white stripes (gaps are always transparent).

*Two '''checkerboard''' patterns with black and white odd squares (even squares are transparent)

*'''Packed circles''': a hexagonal pattern of black circles with transparent gaps.

*'''Polka dots''': a scattering of dots designed to look randomly but evenly distributed so as to mask the regularity of the repeating pattern. There are three size variants of this pattern (small, medium, and large dots) and two color variants (black and white dots).

*'''Wavy''' is a pattern of wavy lines.

*'''Camouflage''' is a green-toned protective pattern such as that used by the military.

*'''Ermine''' is the traditional heraldic pattern representing stylized stoat furs with black tails.

*Three bitmap patterns: '''sand''', '''cloth''', and '''old paint''' are based on seamless photographic tiles and allow you to add some natural texture to your drawing. All of them are grayscale, so you can make objects with these textures semitransparent and overlay them over other colored objects to "texturize" them.

After applying a stock pattern, switch to Node tool to edit the location, scale, and rotation of the pattern via on-canvas handles.

All stock patterns are stored in the file <code>patterns/patterns.svg</code> in Inkscape's <code>share</code> directory (typically <code>/usr/share/inkscape</code> on Linux, <code><i>inkscape-dir</i>/share</code> on Windows). You can add your own patterns to this file or replace it with any other SVG file containing the patterns you need.

=Color management=

== Calibrated SVG color including CMYK ==

Inkscape now supports color-managed color definitions that use a colorspace other than sRGB (for example Adobe RGB, or calibrated CMYK colors). In the SVG file, this is done using the
optional "icc-color(...)" paint components as described in section 11.2 "Specifying paint" of the SVG 1.1 specification
[http://www.w3.org/TR/SVG11/painting.html#SpecifyingPaint]. A fallback sRGB value will be used, for non color-managed workflows. This allows for the use of calibrated color spaces, including using CMYK values that are preserved across applications.

The new CMS color selector tab allows these colors to be edited.

== Display adjustment ==

In Inkscape Preferences, Color Management tab, there's are new options for enabling display adjustment; you can select any calibration profile (an ICC file) suitable for your display. Options for rendering intent can also be chosen.

=== Per-window adjustment ===
Display adjustment is enabled and disabled per each editing window. This allows for simultaneous viewing of adjusted and unadjusted views of a single document by using multiple windows. There is a toggle at the bottom-right corner of the scrollbars that allows for turning on and off display adjustment. It also will be disabled to provide visible feedback when no profile is set to be available for adjustment.

=== XICC Support ===
On X11-based systems (i.e. Unix and Mac OSX), use of [[http://www.burtonini.com/computing/x-icc-profiles-spec-latest.html ICC Profiles In X Specification]] (or XICC) can be enabled. Support for version 0.2 of this specification has been implemented. Enabling this option by choosing to retrieve profiles from the display will switch Inkscape to using profiles attached to screens at runtime. These allow display adjustment to be changed on the fly, and to be set and cleared per-monitor. This is especially helpful with more than a single monitor.

Other Open Source software such as [http://www.gimp.org/ GIMP] support XICC. This allows all aware applications to be adjusted by setting a profile only once.

=== Multi-monitor aware ===
When XICC support is enabled, windows will adjust to the proper profile as they are moved across monitors. Also, as the windows are moved onto monitors with no profile attached, the adjustment toggle will become disabled. When the windows are moved onto screens that do have profiles, the toggle will become enabled.

== Soft Proofing ==

In Inkscape Preferences, Color Management tab, there's a new option for enabling output device preview; you can select any calibration profile (an ICC file) suitable for your output device. Options for rendering intent can also be chosen, along with out of gamut warnings.

=Snapping=

* Snapping has been implemented or improved for:

:* '''Newly created shapes'''

:* '''Skewing''' of objects

:* '''Handles''' of objects, incl. '''gradients'''

:* '''Images''' and '''clones'''

:* Text boxes, which snap to '''text baselines''' again

:* Objects, for which snapping now optionally considers the '''rotation center'''

:* Objects, which now allow for '''constrained snapping'''

:* '''Guides''', which now snap while dragging them

:* '''Axonometric grids'''

:* '''Angled guide lines'''

:* '''Bounding boxes''', of which now all four corners snap

* Other snapping fixes and improvements include:

:* It is now possible to snap to '''intersections''' of e.g. gridlines with guidelines, and of line segments.

:* The '''snapping preferences dialog''' has been restyled to make it more intuitive.

:* Inkscape now has a global snapping toggle, which has been added to the view-menu and is accessible through a shortcut

:* Inkscape now allows for controlling the snapping per grid when multiple grids are being used

:* Snapping distance is now set in screen pixels and is therefore '''independent of zoom'''.

:* Snapping of objects has been made more clean, by only snapping '''bounding box corners to bounding boxes''', and '''nodes to other nodes and paths'''.

:* The time it takes to snap to objects using the selector tool has been reduced significantly.

:* The bug where "node-to-node" snapping caused jerky movement of nodes is fixed.

:* The '''aspect ratio''' is correctly preserved while scaling objects with snapping turned on.

:* Only nodes at '''non-smooth parts''' of a path now snap.

:* The confusing "Default transformations origin" option has been removed. Now Inkscape always uses the opposite edge of the object's bounding box as the '''transformation origin''' (though the bounding box itself can now be different, see next item).

:* A new preference option has been added to specify the kind of bounding box to be used for transforming objects (see Inkscape Preferences, Tools, Selector). You can choose between the '''visual bounding box''' (which takes into account the stroke width, markers, and blur margins; this is the default behavior) or '''geometric bounding box''' (which encloses only the path itself, disregarding stroke width).

=Grids=
Grids have undergone some big changes under-the-hood. These are the visible changes:
* There is a <b>new 3D/axonometric grid</b>!
* A new tab in the document properties dialog, solely meant for grids; the former grid/guide tab is now solely for guides. I envision a list of guides there in the future, for easier deletion of guides etc.
* More than one grid can be active at the same time
** Each grid can be enabled/disabled separately from the document properties dialog.
* One can make grids invisible by unchecking the "Visible" checkbox in the grid's tab in the document properties dialog. Snapping is still enabled even for invisible grids!
* Multiple views on the same document share the same grids, but the grid can be turned off for each view separately. For example: one could have an overview view without grids showing. Duplicate that window and zoom in on some detail; then grids can be shown only for that view, and snapping will only happen in those views for which grids are enabled. (sorry i am not able to explain more clearly, perhaps someone else can?)
* Grid information is now stored in SVG as a child of sodipodi:namedview. Old files will be converted to this new format automatically
* The rectangular grid now has an option to show dots on gridline intersections instead of solid lines

From developer perspective:

* Implementation of new grids is much easier now; subclassing CanvasGrid and adding an entry in the is enough. Have a peek at how the rectangular grid is implemented (CanvasXYGrid).
* Note that there is no longer "the grid", there might be several grids active now!

A side effect of removal of old gridcode: apparantly the origin of the desktop rules used to be set to the origin of the grid. I find this strange: specifying a grid origin of (2,2) would have me think the origin would be at ruler location (2,2) instead of (0,0) as it is in 0.45.1.
I have commented the grid-origin correction to the ruler range, because now there is not a single grid anymore to correct it for. Isn't there a control somewhere to define the documents origin? Now the ruler origin is set to (0,0)

--johan

=Angled guidelines=

Now, Inkscape also provides angled guidelines! Double click on a guide to set its angle.

* When dragging a guideline off the rulers close to the edge, the guideline will automatically be angled. The angle is set depending on the grid.
** For the rectangular grid, the angle is 45 degrees.
** For the axonometric grid, the angle is matched to the grid. When the Ctrl-key is pressed, the angle is perpendicular to the grid lines (useful for aligning gradients).

=Import/Export=

==PDF and AI import==

In this version, Inkscape can natively (i.e. without any additional software) import PDF files and the newer PDF-based Adobe Illustrator files (starting from AI version 9.0).

'''Implemented features''': The new import extension can import '''paths''', '''text''', '''clippaths''', '''masked or non-masked images''', and '''softmasks'''. It supports '''pattern fills''' (XStep and YStep attributes are ignored) as well as '''linear and radial gradients''' (only those using sampled or exponential functions). '''Gradient meshes''' are imported, but they get converted to groups of small tiles (flat-colored paths) that approximate the mesh; the user can adjust the precision of this approximation.

'''PDF import settings''': After opening a PDF or AI document, the PDF Import Settings dialog shows up. Here you can select:

* the '''page''' to be imported from a multipage PDF;

* the overall '''clip region''' (which can be none or set to any of the PDF boxes, e.g. the crop box, the media box, the trim box, etc.);

* the '''precision''' for the approximation of '''gradient meshes'''; note that setting this too high may result in a huge SVG file and slow performance when importing files with gradient meshes;

* a checkbox controlling whether the '''images''' should be '''embedded''' into the resulting SVG document or saved on the current path;

* a '''preview''' of the selected page (shown if poppler-cairo is present on the system or if the selected page has a thumbnail embedded into the PDF document).

'''Text editing tips''': Any text imported from PDF or AI has each letter's precise place on the page ''fixed''. While this preserves the exact appearance (e.g. justification of text blocks) of the imported document, it makes editing such text difficult: deleting text fails to contract the text line and inserting text fails to expand it, i.e. typed letters overlay the existing letters. (However, you still can replace a letter with another letter of about the same width, although you may need to kern it into place with Alt+arrows.)

To work around this, select the text object you want to edit and use '''Text > Remove manual kerns''' command. This will remove the exact positioning information, so if the text block was justified it will lose justification, but instead you will be able to edit it as usual.

Note that there is a way to select even a single line in a text block. For this, open the XML editor, expand the <svg:text> tree branch corresponding to your text, and select any of the <svg:tspan> objects under it. Now you can remove manual kerns from this line only. After you finish editing the line, you can manually justify it back, for example by adding spaces, manual kerns (Alt+arrows), or by adjusting letterspacing (select the whole line and use Alt+> or Alt+<).

The native PDF/AI importer is based on the poppler library and was implemented by Miklós Erdélyi as part of the Google Summer of Code 2007.

==PDF export==

* A new cairo-based PDF exporter has been added to Inkscape (marked as "Cairo PDF" in the export format list). Inkscape 0.46 can export shapes, strokes, transparency, gradients, patterns, text, and images correctly to cairo. While clipping paths and masks are known to be faulty or missing. Also, unlike the old PDF exporter, the cairo-based PDF export produces compressed PDF files that are reasonably compact. cairo will write a PDF with vector graphics when possible and fall back to raster graphics when needed. What can be exported as vectors and how much of the image will be rasterized when the fallback kicks in depends on your version of cairo. cairo version 1.2 with the pdf backend compiled in is the minimum requirement for any cairo-based PDF exports, but it is highly recommended to use at least '''cairo 1.5.2''' for quality PDF export.

* A new cairo-based PostScript exporter has been added (marked as "Cairo PS" in the export format list). The cairo PS backend is not as mature as the PDF backend. It rasterizes a lot of its content. Text output does not work where it works with the PDF backend.

==CDR (CorelDraw) import==

Inkscape can use [http://www.sk1project.org/modules.php?name=Products&product=uniconvertor UniConvertor] if it's installed on your system to import documents in CDR format (CorelDraw). This feature is Unix-only at this time (since UniConvertor is Unix-only) and requires that you have Python and UniConvertor installed. As of UniConvertor 1.0rc2, only versions from 7 to X3 of the CDR format are supported, and text objects are not converted.

==XAML import/export==

* Inkscape can import vector graphics portions of XAML documents, as well as export its documents to XAML.

==Adobe Illustrator SVG clean import==

* Using this new import filter, Inkscape can open an SVG document removing any elements and attributes in the namespaces that Adobe Illustrator uses for its stuff. This will clean out everything except the actual SVG content.

==Bitmap export==

* '''Batch export''': The Bitmap Export dialog (Ctrl+Shift+E) got a new checkbox, ''Batch export all selected objects''. This checkbox is available when two or more objects are selected. If it is checked, instead of exporting selection as a whole, Inkscape exports each selected object separately into its own PNG file. This uses each object's export hints (i.e. export filename and DPI) if they are remembered from a previous export; otherwise, the filename is created from the object ID and the DPI is 90 pixels per inch. '''Caution:''' Unlike regular export, batch export overwrites all existing PNG files without warning.

:This makes it possible to implement all kinds of '''image slicing''' and automated export scenarios. For example, if you are working on a web site design, you can create a separate "export" layer. In that layer, "slice" your web page image into separate areas by creating invisible rectangles with no fill and no stroke. Select each rectangle (by Tab/Shift+Tab, or by switching to Outline mode where even an invisible rectangle can be selected by clicking on its outline) and export it into the corresponding filename (which gets saved as that object's export hint). After that, if you do any changes to your graphics, it's very easy to reexport all the slices: just switch to the "export" layer, select all in that layer (Ctrl+A), and export with the ''Batch export selected objects'' checkbox on.

* '''Hide all except selected''': A new checkbox allows you to hide in the exported image everything except selected object(s).

* The Export dialog automatically appends the '''.png''' extension to the export filename you specify.

== Open Clip Art Library import and export ==

{rejon}

=Command line=

Several new command line options are added that make Inkscape even more scriptable and automatable than before.

* --verb-list will list all the Verb IDs and their names in Inkscape. This makes writing your own menus and hotkeys much easier as you can easily find out what the choices are.

* --verb followed by a verb ID allows you to specify a verb to be called on every document opened by Inkscape initially from the command line.

* --select followed by a node ID will allow you to add a node to the list of selected objects.

* --query-all produces a comma delimited listing of all objects in the document, with their x, y, height, and width values.

These options can be used, for example, for performance testing. You could do something like this:

$ time inkscape --verb=FileClose my_complex_file.svg

to measure the time it takes to load and display the file.

Of course, with the ability to select objects, it can be much more useful than
that. You can call extension effects, or any other verb, then FileSave and
FileClose to automate all kinds of operations on your drawings.

=User interface=

== [dockable dialogs - gustav] ==

Inkscape's dialog handling has been reworked in this release to allow dialogs to behave like '''dockable panels'''. The dock area that holds the user's dialogs is located right of the canvas.

Dialogs placed in the dock can easily be rearranged, resized, stacked in groups or iconified. Furthermore, a dialog can be dragged of the dock to become a floating dock in itself—this allows other dialogs to be dragged and dropped on it to form a floating group of dialogs.

The old dialog behavior (used in releases before 0.46) has been preserved as an option, and if it is preferred, one can select it under ''Windows'' > ''Dialog behavior'' in the Inkscape preferences dialog.

Known issues:

* Some of Inkscape's dialogs are yet to be adapted to allow docking, these include the "Text and Font" dialog, the "Tiled clones" dialog, the "XML editor" and the "Object properties" dialog.

* [Remembered positions of dockable floating dialogs is inexact.]

[options]

== [toolbars - [[JonCruz]]] ==

'''Main toolbar''' on the left can now optionally use '''smaller buttons'''. With the several new tools added in this version, this may help users with small screens where the toolbar otherwise may not fit vertically. The toggle is on the Misc tab of the Inkscape Preferences dialog.

[calligraphy: menus, tooltips; star; ...]

Switched to stock GTK+ toolbars.

Extra magic secret sauce added.

== [filedialogs - [[JonCruz]]] ==

== Swatches panel, color drag-and-drop ==

* Right-clicking a color swatch now opens a context menu which allows you to apply the color to the fill or stroke of selection.

* Dragging colors from the color palette has been fixed and improved:

:* Now the dropped color is applied to '''the object on which you drop it''', regardless of whether that object is selected or not. This means you can change the color of only one object from selection without having to select it separately. (If you want to assign color to the entire selection, just click on the color swatch on the palette, not drag it.)

:* If an object has stroke and you '''drop the color over stroke''', the color is applied to stroke and not fill. (Another way to always apply color to stroke is to '''Shift+drag''' it.)

:* When gradient handles are active (e.g. in Gradient or Node tools), you can '''drop a color onto the gradient line''' to create a new gradient mid stop with this color, or '''drop a color onto an existing stop''' to recolor that stop.

==Color gestures==

A new method for quick and precise adjustment of colors is added in this version: color gestures. It works on the selected objects by grabbing the '''fill or stroke color swatch''' in the '''selected style indicator''' (on the left of the statusbar) and dragging it in various directions as described below. Note that this only works when the swatch displays a '''flat color'''; it does not work for a swatch showing "None", "N/A", or displaying a gradient (although you can select one or more gradient stops in Gradient tool and color-adjust them by color gestures just as you would do for objects). Color gestures can work on '''fill''' or '''stroke''', depending on which swatch in the selected color indicator you drag.

Color gestures work in '''HSL''' color space. Dragging without any keyboard modifiers adjusts the '''hue''' channel, dragging with '''Shift''' adjusts '''saturation''', and dragging with '''Ctrl''' adjusts '''lightness'''.

The adjustment is done by '''"rotating"''' the color swatch away from the original direction which is assumed to be '''NE at 45 degrees''' (i.e. from
the swatch diagonally into the document window). Once you click and drag the color swatch, imagine a diagonal line going from the point where you clicked in the NE direction, across the entire Inkscape window. By dragging '''below or to the right''' of that line, you decrease the corresponding color channel, to the minimum at the lower edge of the window; by dragging it above or to the left, you increase it, to the maximum at the left edge of the window. If you hover your mouse exactly over the 45 degrees line, the change will be zero.

Note that you can easily vary the '''precision''' of your adjustment. If you drag close enough to the swatch, each small movement results in a big change of the color. If you need a finer adjustment, just drag farther away from the swatch, towards the center of the Inkscape window or even to its upper right corner, where minute movements will produce very small changes in the color. In fact, this method gives you more color precision than even the color wheel in the Fill and Stroke dialog, unless you expand that dialog to fill the entire screen which is rarely practical.

The mouse '''cursor''' changes when you're doing color gestures, reflecting the channel currently adjusted and indicating the directions for increasing and decreasing the value. Also, watch the '''statusbar''' which will indicate, as you drag, the channel you are adjusting, the original value of that channel, the new value, and the difference.

You can '''switch channels while you drag'''. That is, you don't need to
drag it again and again from the swatch if you want to adjust all three channels - you can do it all in one drag, by pressing and releasing Ctrl and Shift as necessary. Note that when you change the keyboard modifiers during drag, the position of the zero-change line is temporarily changed to go through the current mouse position; this is done so that there are no sudden changes in color if you are switching modifiers away from the original 45-degree line.

The '''Alt''' modifier is special. Pressing Alt means "do nothing"; this allows you to move the mouse, without releasing, to a more convenient place from where to continue tweaking the color after letting go of Alt. As with the other modifiers, releasing Alt temporarily redefines the zero-change axis to go through the point where Alt was released. For example, imagine you made your color darker by Ctrl+dragging towards the bottom edge of the window and you now need to make it less saturated. You cannot however Shift+drag it any lower because there's just not enough room for that. In that situation, without releasing the mouse, Alt+drag it upwards to a convenient spot and then Shift+drag downwards as needed. Also, you can start dragging from the swatch with Alt pressed to avoid changing the color while you take a more convenient position for adjustments.

For example, you can select a green rectangle and first turn it into greenish-blue by dragging away from the Fill swatch and slightly above the 45 degrees line; then, without releasing the mouse, press Ctrl and drag a bit to the right to darken the color; then press Shift, release Ctrl, and adjust saturation. You can press or release Ctrl and Shift as many times as necessary during a single drag; when you are finally satisfied with your color, release the mouse to commit the change.

Apart from precise adjustments, you can use color gestures to very quickly perform some common color transformations:

* Ctrl+drag the swatch to the right and down to paint all selected objects black.

* Ctrl+drag the swatch upwards and to the left to paint all selected objects white.

* Shift+drag the swatch to the right and down to desaturate the color of selected objects.

* Shift+drag the swatch upwards and to the left to maximize saturation of the color of selected objects.

Note that when several objects or gradient stops with different colors are selected, the selected style indicator shows their '''averaged''' color. If you adjust that color by gesturing, the changed color will be assigned back to all selected objects/stops, in effect eliminating any difference between them. If you want to adjust many different-colored objects preserving their relative differences, use the color modes of the Tweak tool or color adjustment extension effects.

This new technique requires some getting used to, but once you get the idea it is quite convenient, fast, and precise.

== Print dialog integration ==

* '''Print Dialog''': The GTK Unix Print Dialog has been hooked up! From the dialog, you can select any of the Postscript-capable printers known to your system and configure them as with any other GTK application.

== Saving window geometry globally ==

Previously, window geometry (size and position of document windows) could only be saved into the document (so that each document stored its own window geometry). Now, a new option is added to save the geometry of the last used window to the preferences and apply this geometry to all new windows. Thus, with the "Save geometry to preferences" option enabled, new windows will open with the shape of the most recent previous window. This mode also remembers and restores the maximized/fullscreen state (unlike geometry saved to documents).

== Preserving zoom/view of reverted documents ==

When reverting files to their previously saved state, the current zoom factor/panning is now retained (as opposed to reverted to the saved state, too, as it was the case before). This less interrupts the workflow when one is working on some detail in the drawing.

== New ways to scroll and zoom ==

* You can now enable Space+mouse drag to pan canvas, as it does in Adobe Illustrator. This mode is enabled by the '''Left mouse button pans when Space is pressed''' checkbox in the Scrolling tab of the Inksape Preferences dialog. By default it is off and pressing the spacebar key switches you to Selector and back, as it always did in Inkscape.

* By default, rotating the mouse wheel scrolls the canvas vertically and Ctrl+wheel zooms in and out. Now, if you turn on the '''Mouse wheel zooms by default''' checkbox in the Scrolling tab of the Inksape Preferences dialog, this behavior is reversed: mouse wheel zooms without Ctrl and scrolls with Ctrl. This new mode should be familiar for users of AutoCAD and CorelDraw.

* In the Zoom tool, right mouse button always zooms out instead of calling the context menu (which is rather useless in this tool anyway).

== Using other keys in place of Alt ==

* Many Linux users have found the use of '''Alt-drag''' and '''Alt+click''' in Inkscape problematical because this shortcut is often captured by window managers. In 0.46, instead of disabling of the window manager shortcut as suggested in [http://wiki.inkscape.org/wiki/index.php/FAQ#How_to_make_Alt.2Bclick_and_Alt.2Bdrag_work_on_Linux.3F the FAQ], you can change a setting in your preferences.xml file called <code>mapalt</code> in the <code>options</code> group. This numerical value ranges from 1 to 5; 1 indicates no change, any other value refers to some special key on a keyboard, such as '''Alt Gr''', the '''Windows''' key, etc. The specific mapping of these values to the keys on your keyboard can be viewed and/or editied by '''xkeycaps''', available from [http://www.jwz.org/xkeycaps www.jwz.org]. The value associated with a particular key is shown in that program at the top of the screen beside the word "Modifiers" when the mouse is held over a key on the main display.

== GTK theme on OS X ==

A GTK theme is now included in Inkscape.app bundle on OS X. If the user does not have any personal customization (e.g. in a .gtkrc-2.0 file) this theme is used. It reflects the OS X settings for "Appearance" and "Highlight Color" set in System Preferences > Appearance.

=Other changes and improvements=

* '''Gnome VFS Improvements''': Gnome VFS Non-Local files are now usable through all of our file choosers in Open, Save and Export. This compile-time option allowed people to open any Gnome-VFS-based URI from the command-line in the past, but not non-local resources (WebDAV, SFTP, etc) and this now allows for all the lovely possibilities Gnome-VFS provides.

* In previous versions, Inkscape didn't allow you to '''group a single object.''' Yet in some cases, this operation is useful (for example, to blur the clipped edged of an object, or apply more than one clippath/mask to an object). Now this limitation is removed; just select any single object and group it to get a single-object group.

* The somewhat cryptic "F:" and "S:" labels in the selected style indicator (at the left end of the statusbar) and in tool's style swatches are now spelled out as '''Fill:''' and '''Stroke:'''. We believe this makes the interface, even if less space-efficient, a bit more friendly for newbies.

* The '''style swatches''' at the right end of object-creating tools' control bars now open the Preferences page of the corresponding tool when clicked. Also, now these swatches display a tooltip explaining its purpose (e.g. "Style of new rectangles", "Style of new calligraphic strokes", etc.)

* On the '''Scale''' tab of the '''Transform dialog''', the numbers now show the current size of selection, not size increment as before. Correspondingly, with the % unit chosen, you see 100% displayed, and to scale it up twice, you enter 200%, not 100% as before. This is a more intuitive behavior and it's more consistent with how the W/H controls work in the Selector tool.

* After dragging a curve segment in Node tool, Inkscape no longer selects the two adjacent nodes if they were not selected before.

* The '''Tile Clones''' dialog now uses the object's defined '''rotation axis''' (which can be freely moved by Selector tool and which is saved separately for each object) for all rotations (including both symmetry rotations and the Rotation tab rotations), scales, and flips. This renders unnecessary the previous workarounds where you had to group an object with another transparent object to affect how it's rotated by the clone tiler.

* The '''Shift''' tab of the '''Tile Clones''' dialog has two new options: '''Cumulate''': when checked, each tile is shifted by the normal amount plus the cumulative shifts of all previous tiles. This is useful when placing tiles that are being scaled by a uniform amount. '''Exlude tile''': when checked, the tile width or height is not automatically included in calculating the tile's shift. This is useful when using the dialog to place clones on a circle or spiral (rather than using a shift of -100%). It is also useful when positioning tiles using the '''Exponent''' parameter.

* The '''Scale''' tab of the '''Tile Clones''' dialog has a new parameter: '''Base''' that allows placing tiles along a logarithmic spiral (as often found in nature). If the value is '''0''', the parameter is not used. Use a value less than one for a converging spiral and a value of greater than one for a diverging spiral. The actual scale is calculated as '''base''' raised to the nominal '''scale''' power.

* In '''Pencil''' and '''Calligraphic''' tools, pressing '''Esc''' or '''Ctrl+Z''' while drawing cancels the currently drawn path or stroke. When not drawing, these keys work as before (Esc deselects, Ctrl+Z undoes last action). (This is the same behavior as in the Pen tool where it was introduced in a previous version.)

* A set of new verbs has been added to allow the user to easily '''unlock all locked objects''' or '''unhide all hidden objects'''. There are two variants one that operates on the current layer and its children and one that operates globally. While searching for hidden or locked object descendants of locked layers are ignored.

* Several more '''rotation snapping increments''' are available in the Steps tab of the Inkscape Preferences dialog: 36, 22.5, 18, 12, and 0.5 degrees.

* The list of folder shortcuts in the '''Open''' dialog includes the folder with Inkscape's SVG '''examples''' for easy access. Similarly, the '''Save''' dialog has a shortcut for the user's own '''templates''' dialog making it easy to save the current document as a template (if saved as <code>default.svg</code>, it will be loaded every time you run Inkscape or create new document with Ctrl+N; with any other name, it will be added to the File > New submenu).

* For time-intensive operations such as Paint Bucket and Simplify, the system's busy wait cursor is displayed to indicate to the user that Inkscape is actively working, and not frozen.

* Several improvements in '''inkview''': busy cursor is shown while loading file, the button window stays on top and responds to keyboard shortcuts; several memleaks stopped and bugs fixed. The "slideshow mode" of the main inkscape application (-s or --slideshow command line option) is removed; use inkview instead.

* In Document Metadata dialog, updated '''Creative Commons Licenses''' to version '''3.0'''.

* Preferences have been added for setting the default metadata and licenses, so this information can be automatically filled in with new documents.

* The built-in '''Potrace''' tracing engine is upgraded to version '''1.8''' with some minor bugs fixed.

* File dialog windows (open/save) now have an '''Enable preview''' checkbox which allows you to disable the preview pane.

* In the Calligraphic pen controls, the toggle button to enable tablet pressure sensitivity is moved to the Width control, and the button for tilt sensitivity is moved to Angle, to better reflect what parameters these toggles affect.

* In Node and Gradient tools, using '''Tab/Shift+Tab''' to select next/previous node or gradient handle scrolls the canvas if necessary to show the selection.

* The option '''Import bitmap as <image>''' is removed; it was added several versions ago to allow optionally importing images as rectangles with image pattern, to make clipping the images easier. Now that you can easily use clipping paths, as well as convert any image to rectangle with pattern with Alt+I, this option is not really necessary and removed to reduce confusion. Bitmaps are always imported into SVG as an <image> element.

* Support has been added for stock patterns, in the same way that stock markers were already supported. Adding patterns to share/patterns/patterns.svg, and giving them a inkscape-stockid attribute as found on the examples already there will make them available in all Inkscape sessions from the patterns tab of the fill & stroke dialog.

* New '''fontforge_glyph.svg''' template is added for font designers who draw glyphs in Inkscape and import them into FontFoge. It is 1000x1000px large and has a horizontal guide at 200px to mark border for descenders.

* Save dialogs have been modified to clarify that they '''Save as SVG''', so people using Inkscape to edit PDF, EPS, and other file formats will be less confused at the default behavior when saving files.

* Add some new '''UML markers''', including filled and hollow diamonds and triangles.

* Inkscape application bundle on '''Mac OS X''' now has the possibility to contain '''pre-compiled python modules''' (e.g. lxml, numpy, etc.) and to use them without requiring any work from the user. Since Python itself is shipped with Mac OS X, the user only has to drag and drop Inkscape on its hard-drive and all the extensions will be '''functional immediately'''.

=Notable bugfixes=

These are bugfixes compared to 0.45.1; for a list of fixes in 0.45.1 compared to 0.45, see [[ReleaseNotes045|0.45.1 release notes]].

* The '''sodipodi:docbase''' attribute is no longer added to the root <svg> element. This attribute used to keep the latest directory that the document was saved to, and thus represented a mild privacy violation (i.e., by sharing your Inkscape SVG files you allowed others to have a peek into your directory structure). Note, however, that Inkscape does not remove this attribute from old documents it opens; if you want you can remove it yourself. Inkscape just no longer creates this attribute in new documents.

* A fix in the blur rendering code made '''exporting blurred objects to bitmap''' much faster and fixed the disappearing of blurred objects in exported bitmaps which happened for large objects in 0.45. The same fix got rid of the rendering artefacts that sometimes appeared on blurred objects during scrolling.

* Inkscape now properly quotes <code>font-family</code> values and therefore can use '''fonts''' with various '''nonalphanumeric characters''' in their names, which previously failed.

* If you have saved documents with a previous version of Inkscape which used '''right-to-left text''' (e.g. Arabic, Hebrew) then the paragraph alignment of non-flowed text has been reversed in this release. This is due to a bug in previous versions - the new behaviour is compliant with the SVG specification and compatible with other editors and viewers. To correct your images, simply reverse the paragraph alignment by selecting the text and clicking the appropriate button on the toolbar.

* A large family of bugs was exterminated where an object's style could only refer other objects (such as gradients, patterns, and filters) that come after it in the document. Now any objects can be referenced from a style regardless of their place in the document. This fixed the '''disappearance of gradients/patterns/filters''' after you undo an effect, as well as lots of assorted crashes and misrenderings (mostly on non-Inkscape SVG files).

* On Windows, '''file opening/saving dialogs''' can no longer sink under the main editor window (they now have the inkscape window set correctly as their parent window).

* '''Stock markers''' now appear in the "recently used markers" section of the marker selector dropdowns in the Fill & Stroke dialog. Before, any markers with stock id's (including markers modified by the user) were hidden, making it difficult to work with modified stock markers.

* A regression in 0.45 caused crashes when '''undo or redo''' was attempted before the previous action could complete (e.g. pressing ctrl+z while you are still drawing a rectangle). This is now fixed.

* Previously, if there was a single '''invalid property''' in a <code>style</code> attribute, the entire attribute was discarded, i.e. the object lost all styling. Now Inkscape's behavior is more compliant to the CSS specification: it ignores only the invalid property but reads in all the rest.

* Several bugs are fixed in '''searching for linked images'''. Now moving SVG documents with their associated images to a different place or a different machine should work more reliably.

* Master opacity did not apply to stroke '''markers''' as it should; fixed.

* '''Creative Commons Public Domain Declaration URI''' points to the right location now.

* Text objects didn't display the '''pattern editing handles'''; fixed.

* On Windows, the Inkscape uninstaller deleted all files under the install directory. This could lead to removing user-created files, or even other program files not related to inkscape if the install directory was C:\Program Files. The new uninstaller '''tracks all installed files and asks for confirmation before deleting any other files'''. However, installation and uninstallation process is now slower.

* Clones were wrongly unlinked when their original was moved to another layer; fixed.

* Previous versions had a problem on '''Windows Vista''' where selected menu item was invisible. Now our Windows builds use a newer version of GTK library which fixes this problem.

* Duplicating empty text objects that have just been created no longer crashes. Also, the XML editor crash related to empty text objects is fixed. A downside is that the SVG will become cluttered with empty text objects as they are no longer automatically removed. A better fix for the problem is planned.

* In Tile Clones dialog, the PMG symmetry group was created incorrectly, which is now fixed.

= Previous releases =

* [[ReleaseNotes045]]
* [[ReleaseNotes044]]
* [[ReleaseNotes043]]
* [[ReleaseNotes042]]
* [[ReleaseNotes041]]
* [[ReleaseNotes040]]
* [[ReleaseNotes039]]
* [[ReleaseNotes038]]
* [[ReleaseNotes037]]
* [[ReleaseNotes036]]
* [[ReleaseNotes035]]

[[Category:Marketing]]

Release notes/0.46

2008-01-11T15:21:06Z

Jiho: /* Other changes and improvements */ Add note about bundled python modules on OS X

=Inkscape 0.46=
'''(not released yet)'''

Highlights in this release:

* Paintbucket tool

* Tweak tool

* 3D Box tool

* Live path effects

* Color management

* New SVG filters and UI

* Native PDF and AI import

* XAML import/export

* Open Clip Art Library integration (import/export)

* Stock patterns

* Bitmap editing extension effects

* Full on-canvas gradient editing

* Engraver's Toolbox in the Calligraphic tool

* Touch selection

* Dockable dialogs

* Command-line access to verbs

* Snapping made usable

* "3D" / axonometric grid

* Angled guidelines

* Significant speed and interactivity improvements

* Hundreds of smaller features and bugfixes

=Speed and interactivity=

* In this version, Inkscape starts using the [http://www.cairographics.org cairo] library for rendering. It is now used for '''outline mode''' display which, thanks to using cairo and other optimizations, redraws '''faster by about 25%'''. More impressive are memory savings: thanks to cairo, in outline mode Inkscape now takes only about '''50% of the memory''' used by 0.45 for the same file.

* '''Smart redraw directionality:''' With complex images and/or on slow computers, you may have noticed that Inkscape redraws the screen image in horizontal strips, and these strips are painted in order from top to bottom. Now the redraw always starts '''at your mouse cursor location''' and proceed upwards and downwards from it, so that the area near the cursor is always redrawn first. This significantly improves program's responsiveness in some situations. For example, when you are node-editing part of a complex path, the entire path needs to be redrawn on each change, but now this redraw starts from the point you're working on. Moreover, the redraw is interruptible, so each mouse movement starts new redraw from the mouse cursor area. As a result, during such operations those parts that you're working on redraw often and feel snappy and responsive, while areas further away may lag behind more.

* '''Faster blur''' for exporting and high quality on-screen rendering: Inkscape now uses an IIR (Infinite Impulse Response) filter for blurring with large radius. This greatly improves the speed of blur redraw at high zooms or in high-resolution export (or simply with very large blur radius). On the other hand, the results are an approximation to a true Gaussian blur, so a drawing may look slightly different from the mathematically precise blur (usually the differences are far from visible, though). This code is mainly based on: ''Recursive Gaussian Derivative Filters'' by L.J. van Vliet, I.T. Young and P.W. Verbeek (see the source code for more detailed references).

:'''Exporting drawings with blur''' was particularly slow in 0.45; some files could take hours to export. Now this is fixed, in part by the faster algorithm mentioned above and in part by a bugfix in the export code. Now even the quite complex files with large blurs export at high resolution in at most a few minutes.

* Minor improvements have been made to gradient rendering performance.

* '''Dragging handles and nodes''' as well as '''dragging and transforming objects''' by mouse became more responsive, so that working in complex drawings and especially editing complex paths is noticeably easier. In particular, this fixes the annoying latency issue where a node or a handle could follow mouse cursor even after you release mouse button after a drag.

* '''Moving objects, nodes, and gradient handles by cursor keys''' as well as '''scaling and rotating objects from keyboard''' and '''zooming by keys''' are much more responsive when working with complex slow-rendering objects. Now, if you press and hold a key, your selection/zoom level will quickly jump to the final position instead of going through all the intermediate steps as before.

* '''Moving the cursor around''' in a file with large and complex paths has become much snappier and more responsive. Previously, in extreme cases Inkscape could freeze for seconds while catching up with the mouse cursor; such delays are now eliminated.

* Several improvements make '''canvas panning and scrolling''' smoother and more interactive in complex slow-rendering documents:

:* When panning by the middle mouse button, Inkscape no longer attempts to redraw the canvas while your mouse button is pressed. Any redrawing only happens after you release the mouse. As a result, the newly revealed parts of the canvas are somewhat more "dirty" but the '''panning is smoother than before''', with few if any "hiccups".

:* '''Redrawing the newly exposed parts of the canvas''' after scrolling, especially diagonal scrolling, is now faster because only the exposed areas are redrawn; before, this often resulted in the entire screen being redrawn which was much slower.

:* Previously, if you started panning with middle button while Inkscape is still redrawing screen in a complex drawing, panning sometimes completely failed or moved canvas just a little step. Now it is '''guaranteed to pan the canvas all the way''' from mouse-press point to mouse-release point in any case, even if sometimes it fails to show the intermediate positions.

:* When pressing and holding Ctrl+arrows to scroll canvas, Inkscape normally accelerates scrolling so that each next scrolling step is bigger than the previous. Previously, in complex drawings this acceleration sometimes got interrupted, which made scrolling annoyingly bumpy and slow. Now this is fixed so that '''scrolling is smoothly accelerated''' even in a slow-rendering document.

:* The default '''starting speed and acceleration''' of Ctrl+arrows scrolling are slightly increased. (They are both settable in Preferences.)

* Better responsiveness and more visual feedback in user interface:

:*When you zoom, the '''zoom control''' on the right end of the statusbar now updates immediately, not after screen redraw as before.

:*Many potentially slow commands (Save, Simplify, Combine, Break Apart and others) now display a '''busy cursor''' and flash a message in the statusbar (e.g. "Saving document...") while they work.

:*The '''statusbar messages''' displayed while you're drawing a shape or a path in Pen tool do not lag behind the mouse movements.

* '''Combine''' and '''Convert to paths''' commands are now orders of magnitude faster when applied to a selection with hundreds or thousands of objects.

* The time it takes to '''snap to objects''' using the selector tool has been reduced dramatically, which is most noticeable for snapping to complex paths.

=Tools=

==Paint Bucket tool==

The new Paint Bucket tool works exactly as you would expect: click in any area bounded on all sides and it will '''fill it with color'''. Being a vector tool, however, Inkscape's Paint Bucket just creates a new ''path'' that "fills in" the area in which you clicked.

===How it works===

It is important to note that the tool is '''perceptual''', not geometric. That is, when looking for the boundaries around the point you clicked, it takes for such boundaries any ''visible'' color changes. This means that filling will stop at gradients, blurs, and even the color boundaries in imported bitmaps, but will ignore any paths or other objects that are fully (or almost) transparent or for any other reason do not stand out from the background. In short, it will work exactly as if you were filling a rasterized version of your image in a bitmap editor like Photoshop or GIMP - but will give you a vector object to work with.

For example, now you can scan a pencil sketch, import the bitmap into Inkscape, and quickly fill all its cells with colors even without tracing the bitmap first. This is a very convenient and interactive way of digitizing your paper drawings, making the '''traditional bitmap tracing unnecessary''' in many cases.

Internally, the tool works by performing a bitmap-based flood fill on a rendered version of the visible canvas, then tracing the resulting fill using [[potrace]] and placing the traced path into the document.

It places the rendered path onto the current layer, so you can have a layer on top (for example, "Inks") and select the layer below ("Colors") and do the fills so that they always appear below the Inks.

The '''resolution''' of the bitmap image used to perform the trace is dependent upon your '''current zoom level''' -- the more zoomed in to an area that you are, the higher the resolution of the bitmap-based flood fill. So, if you are got a fill that is too imprecise, has rough corners, or don't go into small nooks and appendices where it is supposed to go, just undo, zoom in closer and repeat filling from the same point. Conversely, if the fill leaks out through a small gap, zoom out to make the gap less visible and fill again (or use the auto gap closing parameter, see below).

===Style===

Like all object-creating tools, the Paint Bucket may use the '''last-set style''' for the objects it creates (this is the default), or it can use its own '''fixed style'''. You can switch between these modes on this tool's page in Inkscape Preferences (Ctrl+Shift+P). As in all other tools, the '''style swatch''' on the far right of the Controls bar shows the style that will be used for the next fill object you create.

===Controls===

In the tool's '''Controls bar''':

* Paint Bucket's perceptual fill can use either all visible colors or specific color channels. Using the '''Fill by''' drop-down list, you can restrict the fill algorithm to one the following channels:
** Red
** Green
** Blue
** Hue
** Saturation
** Lightness
** Alpha

* The '''Threshold''' (in per cent units) controls how large must be color difference at a point (compared to the initial click point) to stop the fill. Zero tolerance means only the area of strictly the same color will be filled; the larger the tolerance, the easier it will be for the fill to leak into adjacent different-color areas. The default value is 10%.

* Using the '''Grow/shrink by''' parameter, you can control the amount of inset/outset to be applied to the created fill path. Setting a positive outset causes fill paths to be larger than the filled bitmap area (good for eliminating anti-aliasing errors), while setting a negative outset causes the path to be smaller. This works much the same as the Outset and Inset path commands, except it's done automatically after every fill.

* With the '''Close gaps''' parameter, you can make the Paint Bucket tool ignore any gaps in the area boundaries that would normally cause the fill to spill out of the desired area. There are four settings to auto gap:
** None
** Small (close gaps up to 2 pixels in size)
** Medium (4 pixels)
** Large (6 pixels)
:Note that setting this parameter to other than None may slow down noticeably the filling of large areas.

===Shortcuts===

The tool's '''shortcuts''' are:

* '''Single click''' performs filling from the click point.

* '''Shift+click''' performs filling from the click point and then unions the resulting path with the selected path. This way, if your first attempt did not fill in all of the desired area, you can Shift+click the remaining corner to fill it in separately and combine the result with the result of the previous fill.

* '''Ctrl+click''' on an object simply changes that object's fill to the current fill color of the tool, and '''Shift+Ctrl+click''' changes the stroke to the current stroke color.

* '''Click and drag''' performs filling from '''all of the points''' that you pass while dragging (you will see your path visualized by a red line). From each point, the fill spreads to the neighbors with the colors similar to that point - in other words, it's like clicking with this tool at each point of the drag path and unioning the results. This lets you easily fill an area occupied by a gradient or blur - just drag from the darkest to the lightest points in the area you want to fill.

* '''Alt+click and drag''' works similarly to simple drag, except from each point of the drag path, the fill spreads to the neighbors (if any) with the colors similar to the ''initial point'' (the point where you started the drag). This lets you fill a series of similarly-colored yet separated areas (for example, multiple cells in a cartoon) by starting the drag in one of those areas, and alt+dragging the tool through all the other areas.

==Tweak tool==

The Tweak tool is an exciting new way to edit drawings which largely blurs the
distinction between vector and raster editing. Instead of meticulously selecting some
objects and then performing an action on the selection, you can now select ''all''
objects (or all objects you are interested in) and apply the Tweak tool's brush to
smoothly and naturally change the shape or style of only those objects (or parts
thereof) ''that the brush touches''.

The area of the tool's action - its ''brush'' - is marked by an orange-colored circular
outline that moves with your mouse cursor. However, that area actually has no sharp
boundaries; the power of the tool's action falls off gradually, following a smooth
bell-shaped profile. This makes the tool act softly and smoothly.

The tool will work on any number of selected objects; for example, you can select all
(Ctrl+A) and "smear" your entire drawing by Push mode or paint it by Color Paint
mode. You can also apply it to groups of objects; it will go into groups and act on
individual objects inside groups. If you're trying to use it without anything selected,
it will remind you by a statusbar message to select some objects.

===Width===

The width of the tool's brush, in the range from 1 to 100, can be changed by the
'''Width''' control in the tool's controls bar above the canvas. You can also change
width by '''Left''' and '''Right''' arrow keys (same as in the Calligraphy tool) at any
time (including during action) as well as '''Home''' and '''End'''. Also, as in Calligraphy
tool, the visible width of the brush is independent of zoom; simply zooming in or out is
often easier than adjusting the width if you want to cover a smaller or larger area of
the drawing.

===Force===

The next control is '''Force''' which adjusts the power of the action, also in the
range from 1 to 100. You can also change width by '''Up''' and '''Down''' arrow keys at
any time (including during action).

If you have a pressure-sensitive tablet and your "Use pressure" button on the right-hand
end of the controls bar is on, then the force will also depend on how hard you actually
press your pen into your tablet, changing in the range from zero to whatever you set in
the Force control. If all you have is a mouse, then the force will be constant but still
settable by the Force control.

===Path editing modes===

The Tweak tool has a number of '''modes''', selectable by toggle buttons in the tool's
Controls bar and by keyboard shortcuts. Some of these modes change the shapes of
paths while others affect the colors of objects. All these modes share the Width and
Force controls but otherwise are quite different. Let's look at the path editing modes
first.

Unlike the Node tool, to edit paths with the Tweak tool you don't need to worry about
where the nodes of a path are and how to manipulate them. You just apply the tool's
brush to any point, and the selected paths at that point will reshape smoothly and
naturally - as if made of soft jelly - regardless of where its nodes lie. If applied to
a shape or text object, the tool converts them to paths automatically.

While not very useful for technical drawings, tweaking paths will be indispensable for
artistic uses of Inkscape - cartoons, drawings, sketches, anime, etc. This new
functionality is somewhat similar to the tools such as "Pucker" and "Bloat" in the
latest versions of Adobe Illustrator.

There are currently six path editing modes in the Tweak tool: '''Push''', '''Shrink''',
'''Grow''', '''Attract''', '''Repel''', and '''Roughen'''.

* This default mode of the tool, '''Push''', simply displaces the part of the path under the cursor in the direction of the drag. The path behaves like soft jelly, bending and bulging smoothly and naturally. It's an easy way to produce various irregular, lifelike, handmade-looking shapes starting from something as simple as an ellipse or a calligraphic stroke. For parallel-stroke hatching (engraving) done in the Calligraphy tool, pushing is an easy way to bend, pinch, or curve the entire hatching uniformly.

* The '''Shrink''' and '''Grow''' are two opposite modes that move each point of a path in a direction perpendicular to the path's surface at the point, either inwards (Shrink) or outwards (Grow). This is similar to the Inset and Outset commands, except that the Tweak tool can act on a part of a path instead of the whole path.

:For example, the visible lightness/darkness of an engraving hatching may not exactly correspond to your artistic intention. Also, the ends of Calligraphy pen strokes are often far from ideal - they may be too blunt or have unsightly bends or blobs. This is where the Tweak tool may help. Select all the strokes in a hatching pattern and apply a light Shrink action where you want the lines to become thinner (and the hatching to become lighter), up until total disappearance. If you press hard, shrinking works as an eraser, so you can easily clean the strokes' ends to make them thin, sharp, and uniform. Conversely, applying Grow makes strokes wider (i.e. the hatching becomes darker).

:Of course, shrinking and growing are useful not only for calligraphic strokes. Same as with Push, with Shrink and Grow you can '''sculpt''' any path, spawning smooth treacle-like appendages with Inflating and carving holes with Melting. Unlike the "node sculpting" mode in the Node tool, however, this does not require adding new nodes to the shape.

* The '''Attract''' and '''Repel''' modes work by moving each affected point on a path towards (Attract) or from (Repel) the cursor point. In some cases this may look similar to Shrink and Grow, but the difference is that shrinking/growing moves paths perpendicularly to the path in each point, whereas attracting/repelling moves them to or from the cursor regardless of the path shape. These modes are similar to the Pinch effect in ; you can use them for various central-symmetric distortions in parts of your paths.

* The '''Roughen''' mode does exactly this: roughens the edge of the path without changing its overall shape. Slight roughening simply makes the edge crooked and uneven; strong roughening tears and explodes the edge into random blobs and splotches. Note that this operation, especially with high Fidelity, adds a lot of nodes which increases the size of your SVG document and may slow down Inkscape considerably. In particular, pushing/melting/inflating of a roughened path becomes much slower and more difficult, so it's recommended to finalize the overall shape of a path first and roughen it, if necessary, only as the final step.

See the screenshot at [http://inkscape.org/screenshots/gallery/inkscape-0.46-tweak-path.png] for a few examples of using the path editing modes of the Tweak tool.

====Fidelity====

Any tweaking of a path slightly distorts the entire path, including even those parts
that you didn't touch. These distortions are similar to those that a Simplify command
produces. The '''Fidelity''' value (also in the range from 1 to 100, default is 50)
allows you to control the amount of these distortions. With a higher fidelity, the
distortions are less noticeable, but the path may end up having a lot of nodes which
inflates up the SVG size and slows down Inkscape.

The best value of Fidelity depends on the nature of your artwork. If you're sculpting an
amorphous blob, you can do with low fidelity of about 20. If, however, you are pushing
or inflating a text string (as a single path) and want the letters outside the distorted
area to remain crisp and clean, you will need to raise fidelity to 80 or more.

====Known problems====

Known problems with the path editing modes in Tweak tool:

# they don't work on open paths (an open path becomes closed if you tweak it);
# they are rather slow;
# they quickly eat memory; and
# they are sometimes buggy - thin calligraphic strokes may suddenly disappear or change their shape drastically as you're melting or inflating them.

For (4), it helps to increase Fidelity. Also, you can undo the bad change and try again with less pressure on the pen - if you do your thinning in several light touches instead of one heavy press, usually you will be able to get the desired result without the buggy behavior.

Also, sometimes after roughening, further tweaking of a path becomes impossible with this diagnostic:

WARNING **: Shape error in ConvertToShape: directedEulerian(a) == false

All these problems stem from the livarot library that we use for geometric manipulation of paths. Fortunately, livarot is scheduled for replacement by lib2geom, a new library now in development, so hopefully these issues will be addressed then.

===Color editing modes===

The '''Color Paint''' and '''Color Jitter''' modes, unlike the path editing modes,
change the colors of objects instead of their shapes. Yet they share enough common
features with the path editing modes to be part of the same tool: These modes also use
a circular soft-edged brush controlled by the Width and Force parameters on the Controls
bar and affected by the pen pressure (if you have a pressure-sensitive tablet).

* '''Color Paint''' applies the style of the tool to the selected objects under the brush. The style of the tool is visible in the style swatch at the rightmost end of the tool's control bar; it can be changed by clicking on the color palette or by any other style assignment command, such as Fill and Stroke dialog. ('''Note''': unlike all other tools, in Tweak tool in Color Paint mode you cannot assign style directly to selected objects; any style-setting command changes the tool's style instead.)

:The fill from the tool's style applies to the fills of the painted objects, and the stroke applies to the strokes. If the tool's style has no fill or no stroke, it won't affect fills or strokes, correspondingly. For example, if you want to color the fills of objects blue but leave their strokes untouched, assign blue fill to the tool's style (just click blue on the palette) but set its stroke to None (middle-click the Stroke swatch in the statusbar). Similarly, master opacity in the tool's style affects master opacities of the touched objects (if the O channel is on, see below).

:This mode allows you to literally paint over objects, shifting their colors towards the target style of the tool. For example, if you paint with yellow fill over a blue-filled object, the object will become greenish blue, then green, then yellowish green, and end up being exactly the yellow color you're painting with. This speed of this gradual transition depends on both Force parameter and pen pressure; also, objects touched by the periphery of the brush are less affected than those hit by the brush center. Overall, using this tool is very similar to a soft brush in a raster editor such as Gimp or Photoshop.

* '''Color Jitter''' mode does not apply any color, but instead jitters (randomizes) the colors of the objects it touches. The force of the action determines how strong is the randomization, i.e. how far the colors deviate from the original values. This mode does not use the tool's style.

Both modes work on flat fills and gradients; for gradients, the tool takes into account not only the position of the entire object with gradient, but also the position of each gradient stop relative to the brush. This means that, for example, you can change the blue color only in an object filled with blue-red gradient simply by painting over its blue end with a brush small enough to not touch the red. (Note that color tweaking does not create gradients on objects that used flat color before, but only adjusts existing gradients in the drawing.)

See the screenshot at [http://inkscape.org/screenshots/gallery/inkscape-0.46-tweak-color.png] for a few examples of using the color editing modes of the Tweak tool.

====Channels====

Color Paint and Color Jitter honor the '''Channels''' control. This control comprises
the four buttons: '''H''', '''S''', '''L''', and '''O''', which allow you to turn on and off
the tool's action on the object's hue, saturation, lightness, and opacity,
correspondingly. For example, if you want to raise the saturation of some part of your
drawing without changing the hue, select some maximum-saturation color (e.g. pure red)
and turn off all Channels buttons except S. Similarly, you can replace the hues without
affecting saturation or lightness (only H pressed), or lighten/darken all colors without
changing their hues and saturation (only L pressed). Pressing O allows you to apply the
master opacity from the tool's style to the master opacity of objects (but not fill or
stroke opacity).

====Usage notes====

Color painting with Tweak tool is similar, but not exactly analogous to bitmap
painting. Even though the tool itself works as a soft brush, it still applies its color
to vector objects, which behave as vector objects usually do. For example, if you want
to change the tint of the face in your drawing, and if a hand in the drawing is part of
the same object as the face, that hand will change its tint too even if it's located far
from the point you are painting. (We foresee a "fracture" command in one of the next
versions of Inkscape which will help you turn a monolithic object into a mosaic of small
fragments that will be then easy to paint with Tweak tool.) Still, even with this
limitation, color painting is a novel way of dealing with vector drawings which allows
you to quickly and intuitively make adjustments which would be awkward and slow with
traditional approach.

Drawings containing patterns or scatterings of small independent objects are best suited
for color painting with Tweak tool. Examples include:

* freehand drawings with Calligraphy pen, consisting of many separate strokes;

* gradient meshes imported from Adobe Illustrator files (Inkscape renders these meshes as lattices of small polygons; while there's no direct support for gradient meshes in Inkscape yet, color painting on such lattices is almost as good);

* text converted to paths and with Break Apart command applied so that each letter is a separate path;

* patterns made with the Tile Clones command; note that you need to unset the fill and/or stroke on the original object and use the Color tab to assign some initial color to the clones - this will make them paintable with the Tweak tool without unlinking.

Moreover, color tweaking can be useful for compositions with a few objects or even for
single objects. Unlike all other color selection methods, painting with the Tweak tool
implements the ''color mixing'' metaphor which is much more familiar to traditional
artists than RGB sliders or even the color wheel. For example, start with a rectagle of
pure blue color; then, pick different colors by Color Paint and apply light touches with
minimum Force and minimum pen pressure: add a little green, a little brown, a little
yellow, etc. until you have the exact hue you need. Similarly, you can whiten or blacken
any hue by admixing white or black.

You can also use color tweaking to add a tint, darken/lighten, saturate/desaturate, or
color jitter your entire drawing. Just select all in all layers, zoom out, choose a
large brush width so it covers all of the drawing, and apply a little color tweaking
(with minimum Force) that will therefore affect all visible objects.

===Keyboard shortcuts===

* '''W''', '''Shift+F2''': switch to the Tweak tool

* '''Shift+P''': switch to the Push mode

* '''Shift+S''': switch to the Shrink mode

* '''Shift+G''': switch to the Grow mode

* '''Shift+A''': switch to the Attract mode

* '''Shift+E''': switch to the Repel mode

* '''Shift+R''': switch to the Roughen mode

* '''Shift+C''': switch to the Color Paint mode

* '''Shift+J''': switch to the Color Jitter mode

* '''Left, Right, Home, End''': change width

* '''Up, Down''': change force

* '''mouse drag''': act on selected path in the current mode

* '''Ctrl+mouse drag''': temporarily switch to Shrink (while Ctrl is down)

* '''Shift+Ctrl+mouse drag''': temporarily switch to Grow (while Shift+Ctrl is down)

==3D Box tool==

Inkscape is a two-dimensional drawing tool. However, very often it is used to draw three-dimensional objects. The new '''3D box tool''' helps you create such 3D drawings by automating the most common operation: creating a three-dimensional box in a given perspective. The tool automatically ensures that all sides of the box lie on the corresponding perspective lines. We're not going to compete with Blender - but even simple things can go a long way.

Currently in the 3D box tool you can:

* draw a 3D box by dragging on canvas (use Shift+dragging without releasing the mouse button to extrude in z direction)

* adjust any of its 3 dimensions by handles

* move a 3D box "in perspective" by dragging its center; without modifiers, movement occurs within the XY-plane (press Ctrl to constrain the movement to the directions of the coordinate axes or diagonals), with Shift the box moves parallel to the Z-axis

* adjust the vanishing points of a perspective by dragging them across the canvas (see below) or toggling their states; all boxes sharing this perspective are transformed accordingly

In SVG, a 3D box is represented as a '''group''' (svg:g) with a special extension attribute (in inkscape namespace); this group contains the 6 quadrilateral '''paths''' representing the sides of the box. Only the 3D box tool treats this object as a box; for all other tools it is just a group, so you can select any of the paths by Ctrl+click, apply any style to it, delete it, etc. You can of course transform the entire box or any face in it using Selector or Node tools.

When several boxes are selected, all vanishing points of their associated perspectives are shown on the canvas. If vanishing points of different perspectives coincide, they are combined in a single "dragger". Moving this dragger moves all the vanishing points simultaneously and transforms the associated boxes accordingly. Note that some non-selected boxes may also be reshaped if their perspectives share the same vanishing point. Pressing Shift while moving the dragger can be used to only transform the selected boxes, separating their perspectives from the non-selected ones'. On the other hand, when a vanishing point being dragged comes close enough to another one, both snap together and are combined in a single dragger.

===Keyboard shortcuts===

* '''X''', '''Alt+F4''': switch to the 3D box tool

* The various kinds of parentheses, namely '''[''' ''']''', '''(''' ''')''', '''{''' '''}''', can be used to rotate infinite (i.e., parallel) perspective lines in X-, Y-, and Z-direction, respectively. Closing parentheses rotate clockwise and opening parentheses rotate counterclockwise. The angle of rotation is taken from the preferences. Pressing '''Alt''' reduces the amount of rotation to 1 screen pixel.

* '''L''': toggle visibility of perspective lines

* '''A''': when perspective lines are visible, toggle between "all lines" and "only lines connected to front corners" (this can help to avoid visual clutter)

[max]

==Gradient Tool==
===Selecting multiple stops===
'''More than one gradient stop''' can be selected at a time. Shortcuts for working with multiple stop selections are generally modeled on the Node tool.
* Add a stop to the selected stops by '''Shift+click'''.
* Press '''Ctrl+A''' to select all stops in the selected objects.
* '''Shift+drag''' around stops to add them to selection.
Multiple selected stops:
*Can be moved together by '''mouse drag''' or by '''arrow keys'''. For example, creating a linear gradient, then press Ctrl+A to select all stops and use arrow keys to move the entire gradient as a whole.
*Can be deleted at the same time by pressing '''Del'''.
An always up-to-date description of the current handle selection is provided in the statusbar in the Gradient tool, including the number of selected handles (and the type of the single selected handle), as well as the total number of handles and selected objects.

===Editing intermediate stops===
'''Intermediate stops''' in gradients can be added, deleted, and edited on canvas (previously this was only possible in the Gradient Editor dialog).
*Stops can be added by '''double clicking''' or by '''Ctrl+Alt+Click''' on the gradient line. Also, you can '''drag-and-drop''' a color from the palette onto the gradient line to create a new stop with this color. Dropping a color on an existing stop changes the color of that stop.
*When two or more adjacent stops are selected, pressing '''Ins''' adds stops in the middles of all selected stop intervals.
*Intermediate stops can be '''mousedrag'''ged or moved by '''arrow keys''' along their gradient line, within the limits of the adjacent unselected stops (or end handles).
:*Dragging with '''Ctrl''' moves the selected stops snapping them to 1/10 fractions of the available range.
:*Dragging with '''Alt''' moves the selected stops depending on how close each one is to the stop being dragged, using a smooth bell-like curve similar to the node sculpting feature in Node tool. This makes it easy to approximate different gradient profiles; for example, if you have a two-stop gradient that you want to shape according to a curve profile, select both ends of the gradient, press '''Ins''' a few times to add a number of intermediate nodes, then '''Alt+drag''' a node in the middle to smoothly profile the gradient.
*Stops can also be moved by '''arrow keys''' with all the regular modifiers ('''Shift''' for 10x movement, '''Alt''' for pixel-size movement at the current zoom, '''Shift+Alt''' for 10 pixels movement at the current zoom).
*Stops can be deleted by '''Ctrl+Alt+Click''' on a stop or by the '''Del''' key for all the selected stop(s).
:*When you delete an end stop, the nearest intermediate stop becomes the new end stop of the gradient (without moving - i.e., the gradient span becomes shorter).
:*When you delete an end stop and there are no intermediate stops, the object will be painted with a solid fill taken from the color & opacity of the remaining stop.
*Pressing '''Ctrl+L''' with some intermediate stops selected attempts to ''simplify'' the selected portion of the gradient, removing those stops that can be removed without too much change in the way the gradient looks. In particular, new stops created by double-clicking or pressing Ins initially do not change the appearance of the gradient, so if you press Ctrl+L, all redundant stops that weren't moved or repainted since creation will be deleted.

===Style of gradient stops===
*When you have one of the '''gradient handles selected''', its style (color and opacity) is reflected by the selected style indicator (left of the statusbar) and the Fill&Stroke dialog. Previously, opacity of a gradient handle was reflected as fill-opacity and stroke-opacity; now it is reflected as '''master opacity''' (the "O:" spinbutton in the selected style indicator, the "Master opacity" slider in Fill&Stroke). This makes it much easier to view and change opacity of gradient handles using only the selected style indicator in the statusbar.
:*When multiple gradient stops are selected, the selected style indicator (in the statusbar) displays and controls the averaged color and opacity of the selected stops.
*When one or more gradient stops are selected, using the Copy command ('''Ctrl+C''') copies to the clipboard the style (color and opacity) of the selected stop or the averaged style of several selected stops, not the entire object with gradient as before. This means you can now copy/paste style between stops: select the source stop(s), copy, select the destination stop(s), paste style ('''Ctrl+Shift+V'''). With several selected stops, this also allows you to easily average their colors and opacities by copying them and pasting the style back onto them. (After that, redundant gradient stops can be removed by simplification with '''Ctrl+L''').
*If the selected object(s) have gradient in fill or stroke, the '''selected style indicator''' in the bottom-left corner of the editing window now displays a '''live gradient preview''' prefixed by '''R''' or '''L''' to indicate Radial or Linear gradients (instead of displaying "L Gradient" or "R Gradient" text labels as before). Also, this and other similar widget now use italic font face to indicate <i>None</i> and bold to indicate <b>Unset</b>.

===Automatic duplication of gradients===
When copy/pasting or duplicating an object with gradient, it now automatically gets a '''copy''' of the original gradient, so modifying it does not affect the source object's gradient anymore (before, you had to press the Duplicate button on the Gradient controls bar for this). The Duplicate button is therefore removed.

However, to accommodate the needs of users who have relied on sharing the same gradient definition across objects, this behavior can be optionally suppressed. The '''Prevent sharing of gradient definitions''' checkbox on the Misc tab of Inkscape Preferences is by default checked; if you uncheck it, Inkscape does not automatically copy gradient definitions for new objects, which means that copy/pasting, duplicating, pasting style, and explicit assignment of a gradient to an object via the Gradient tool controls results in a shared gradient definition, so that changing the colors or mid-stop positions of the gradient on one object (but not changing the coordinates of the end handles) affects all other objects that share the same definition.

==Calligraphy tool: Engraver's Toolbox ==

Several new features were added to the Calligraphic pen to make
Inkscape capable of the ancient art of '''line
engraving'''. Traditional engraving is a very labour-intensive
process, and while for a long time it was the only practical way
of reproducing lifelike images in black-and-white print, about a
century ago it was almost completely displaced by automatic
halftone screens. However, line engravings have their
characteristic charm, and there's no reason not to try to
resurrect this art form with the help of Inkscape.

A brief visual guide to the new functionality can be seen on
these screenshots:

http://inkscape.org/screenshots/gallery/inkscape-0.46-engraving1.png

http://inkscape.org/screenshots/gallery/inkscape-0.46-engraving2.png

===Tracking a guide path with Ctrl===

One of the most common operations in line engraving is
'''hatching''' (or sometimes ''cross-hatching'' when several
hatching grids cross): filling a space with many parallel
straight or variously curved lines (usually of varying width to
represent a gradual shading). You could try to achieve a similar
effect with e.g. path interpolation (blending), but it is rather
cumbersome and limited; manual drawing of hatch lines, on the
other hand, is tedious and nearly impossible to do
uniformly. Now Inkscape provides "assisted hatching" by
'''tracking a guide path''', allowing you to hatch quickly and
uniformly and at the same time giving you sufficient manual
control over the process.

Here's how to do this. First, select the '''guide path''' that
you will track. It may be another calligraphic stroke, any path
or shape, or even a letter of a text object. Then switch to
Calligraphic pen, select the desired parameters (line width,
angle, fixation etc.) and, before starting to draw, press
Ctrl. You will see a gray '''track circle''' centered at your
mouse pointer and touching the closest point on the selected
guide path. (If you have no guide path selected, a statusbar
message will tell you to select it.)

Now move your mouse close to the guide path, so that the track
circle radius is equal to the desired spacing of your hatch
pattern, and start drawing along the guide path. At that moment,
the radius of the circle gets locked; now the circle slides
along the guide path - and the actual stroke is drawn by the
center of the tracking circle, ''not'' by your mouse point. As
a result, you are getting a smooth stroke going parallel to the
guide path and always at the same distance from it.

When the stroke is ready, release your mouse button (or lift
your tablet pen) but '''do not let go of the Ctrl key''' because
as long as you have it pressed, the tool remembers the hatch
spacing you set when you started drawing. Now, you have just
created a new stroke and, as usual with Inkscape tools, it gets
selected instead of what was selected before. In our case, this
means that the newly drawn stroke itself becomes the new guide
path. Next, you can draw a second stroke along the first one,
then a third one along the second, etc. Eventually you can fill
any desired space with uniform hatching.

Alternatively, if you uncheck "Select new path" in the Calligraphy tool preferences, newly created strokes will not be selected, so your original guide path will be kept selected. In this mode, Inkscape will increase the tracking distance after each created stroke so that you can create uniformly spaced hatching by tracking a single guide path.

The attachment to the guide path is not absolute. If you stray
your mouse pointer far enough from the guide path, you will be
able to tear it off (the track circle turns from green to red)
and move freely. This is intentional; this feature allows you,
for example, to continue drawing a stroke past the end of a
guide stroke, thus making your hatching cover a wider area than
the initial guide path. Special care is taken to make such
tearing off as smooth as possible and to suppress violent jerks,
but this is not always possible; the general advice is to not
try to hatch too fast. If jerking and unintended tearoffs still
bother you, try increasing the Mass parameter.

Also, special code is in place to prevent flipovers - accidental
jumps to the other side of the guide path. Brief flipovers are
suppressed, but if you intentionally go over to the other side
and stay there, eventually Inkscape will obey and your tracking
stroke will also flip over to follow you.

Tracking a guide also allows some slight feedback by gradually
changing the tracking distance in response to your drawing
behavior. Thus, if you're consistently trying to draw closer or
farther from the guide than the current tracking distance, the
distance will correspondingly decrease or increase, so you will
get a hatching that is slightly spacing in or out. (The effect
is very slight, however, so as not to become a nuisance.) Also,
note that since tracking follows the edge of the stroke, strokes
of varying width (such as those tracing background, see below)
will result in gradual bending of the hatching pattern as you
proceed.

===Tracing background by stroke width===

There is a new toggle button on the Calligraphy tool's controls
bar, '''Trace background'''. When on, the width of your pen
depends on the lightness of the background under the stroke in
each point, so that white translates into the minimum stoke
width (1) and black translates to the maximum (which is set by the
Width parameter). This can work alone or in combination with
pressure sensitivity, depending on whether the "Use pressure" button
is also toggled.

This feature allows you to not only hatch over an imported
bitmap image or any drawing, but to do so automatically
reproducing the highlights and shades of the background with
your strokes becoming lighter and heavier as needed.

===Misc features===

* For consistency with other drawing tools, drawing with '''Shift''' in Calligraphy tool automatically '''unions''' the newly created stroke with whatever paths were selected (and selects the result). Thus, you can do a series of overlapping Shift+strokes to create one unioned path object instead of separate objects as before.

* To facilitate changing the Width parameter, the Home/End keys in Calligraphy tool switch you to the minimum (1) and maximum (100) width, correspondingly. (This is in addition to the Left/Right arrow keys that change Width by 1; remember also that you can press Alt+X, type any width, and press Enter.)

==Selector==

* A new selection mode is available: '''selecting by touch'''. In this mode, you draw a freehand path across the objects; when you release mouse button, all objects that are touched by this path get selected. This mode is very convenient in situations where you need to select objects so intermingled that selecting them by the rectangular rubberband is too difficult and so numerous that click-selecting them one by one is too tedious.

:To activate selecting by touch, whenever you are drawing a rubberband rectangle, just press '''Alt''' to switch it to the touch mode. The rectangle will disappear and a red ''touch path'' will be shown instead. When dragging from an empty space, you can press '''Alt''' first and then start to drag to get the touch mode (note that your selection must be empty, otherwise Alt+dragging will move the selected objects instead). To start a touch selection from a point over an object, or to add to existing selection by touching, press '''Shift+Alt''' and then start to drag.

* Previously, the only way to switch selection from scale mode to rotate mode or back was to click on it, which was rather inconvenient when the selected object is in a group or under other objects. Now you can switch modes with keyboard as well by pressing '''Shift+S''' in Selector tool.

* Draging the '''scale handles with Alt''' now scales selection by an integer factor, i.e. up to '''2''', '''3''', '''4''', etc. times the original size or down to '''1/2'''. '''1/3''', '''1/4''', etc. of the original size (in any of the two dimensions independently). This way you can, for example, mirror any object around one of the edges of its box. (This replaces the old and rarely used "slow" scaling mode with Alt.)

* '''Horizontal/vertical flipping''': So far, flipping a selection made it flip within its bounding box, so that the latter remained fixed. In the move/scale mode of the selector tool, this behaviour remains unchanged. However, in rotate/shear mode flipping now happens about an (imaginary) vertical/horizontal axis through the rotation center. This is very handy, since the latter can be freely dragged around and snaps to all kinds of objects if desired.

* '''Objects to Marker''' was added to the objects menu, which converts the current selection to a marker, with the center point of the selection being set to the center of the marker.

==Node tool==

* If any of the nodes in the currently selected path is mouseovered, then horizontal/vertical flipping ('H' and 'V' keys), stepwise rotation ('[' and ']' keys) and scaling ('<' and '>' keys) now all use this specific node as center/axis. If there is no mouseovered node, the center of the bounding box is used instead (as is currently the case unconditionally). Nodes that are covered by one of their handles are also detected as mouseovered.

* [helper path display - johan]
** this is deactivated for normal paths now. only paths with LPE applied will show it. should there be a button to turn it on for normal paths aswell?

* As a long-requested feature, two entry fields are added to the toolbar which allow precise editing of the coordinates of selected nodes.

==Rectangle Tool==

* Ctrl+dragging now also allows the creation of rectangles with sides constrained to the golden ratio (approx. 1 : 1.618034), not only integer ratios.

==Text tool==
* [text toolbar - deadchip?]
* If text contains a tref element, the text tool's behavior may not be as expected. Please see [[#The tref Element]]

==Dropper Tool==

The shortcut 'D' is now used to <i>toggle</i> (not just switch to) the dropper tool - much like space is used to toggle the selector tool. That is, pressing 'D' a second time switches back to the tool used before.

=SVG features=

==The tref element==

Inkscape can now correctly open files with '''tref''' elements, and new tref elements can be created manually in the XML editor.

The actual character data contained in a text element can either be embedded directly, or it can be the character content of an element referenced by a '''tref'''.

While the textual content from the referenced element will be stripped of any markup before being used by the '''tref''', the '''tref''' element can itself have the same attributes as a '''tspan'''. In fact, when rendered, it is as though the '''tref''' element is replaced by a '''tspan''' with the same attributes, and the referenced character data is embedded in that '''tspan'''.

The property '''xlink:href''' is used to refer to another element whose character data will be used. Any element can be referred to except an ancestor of the '''tref'''. When any of the text contained in the referred element changes, the '''tref''' will immediately be updated to display the new data.

Existing tref elements can be converted into tspan elements with '''Edit > Clone > Unlink Clone'''. If more than one '''tref''' is contained within a selection, all '''trefs''' will be converted into '''tspans'''. All attributes applied to the '''tref''' will be retained in the new '''tspan'''.

A '''tref''' element can be mixed with any other elements allowed to be contained by a text element.

The cloned character data rendered by the '''tref''' may not be edited, but any characters surrounding it can be changed. Styles cannot be applied to a subset of the cloned characters, but if all are selected, a style can be applied to the '''tref'''.

==SVG filters==

===New filters supported===

* The '''feBlend''' filter primitive gives us image blending modes, like in many image manipulation programs. These modes are screen, multiply, darken and lighten. There's a caveat, though: when blending an object against an semi-transparent background, the background will be accumulated twice, resulting in thicker objects under the bounding box of blended object. This is a limitation of current version of SVG format, not a bug in Inkscape.

* The '''feColorMatrix''' filter primitive applies a matrix transformation to colour of each rendered pixel. This allows for effects like turning object to grayscale, modifying colour saturation and changing colour hue.

* The '''feComposite''' filter primitive composites two images using one of the [http://en.wikipedia.org/wiki/Porter-Duff Porter-Duff blending modes] (described in paper Compositing Digital Images by T. Porter and T. Duff, published in SIGGRAPH '84 Conference Proceedings, Association for Computing Machinery, Volume 18, Number 3, July 1984) or the aritmetic mode described in SVG standard. Porter-Duff blending modes are essentially logical operations between the images. For example, xor mode shows the areas, where either one of the objects is, but not the areas where both of the objects are. Arithmetic mode lets you specify coefficients k1-k4 for blending equation (result colour) = k1 * (first input colour) * (second input colour) + k2 * (first input colour) + k3 * (second input colour) + k4.

* The '''feConvolveMatrix''' lets you specify a [http://en.wikipedia.org/wiki/Convolution Convolution] to be applied on the image. Common effects created using convolution matrices are blur, sharpening, embossing and edge detection. There's a fairly good explanation and some example matrices at [http://www.gamedev.net/reference/programming/features/imageproc/page2.asp www.gamedev.net/reference/programming/features/imageproc/page2.asp]. Note that while gaussian blur can be created using this filter primitive, the special gaussian blur primitive is faster and resolution-independent.

* Filter primitives '''feDiffuseLighting''' and '''feSpecularLighting''' create lighting maps for the object in input image. SVG doesn't have concept of third dimension, so these filters use alpha channel of input image as a height map: the more opaque given point in input image is, the nearer spectator it is considered to be. There exists an example for using these in Inkscape distribution, in share/examples/lighting_effects.svg or [http://inkscape.svn.sourceforge.net/viewvc/*checkout*/inkscape/inkscape/trunk/share/examples/lighting_effects.svg?revision=15523 in SVN]

* The '''feDisplacementMap''' filter primitive displaces the pixels in the first input using the second input as a displacement map, that shows from how far the pixel should come from. Classical examples are whirl and pinch effects, that can be found in most image manipulation programs and even in some screensavers, where this kind off effect is moving around screen, twisting desktop beneath it.

* The '''feImage''' filter primitive allows using external images as part of filtering chain. For example, one could use external image as a displacement map for feDisplacementMap or as a height map for lighting effects. Note that while SVG standard allows using other parts of the SVG file in this filter primitive, the current Inkscape implementation only allows external images.

* The '''feMerge''' filter primitive composites several temporary images inside the filter primitive to a single image. It uses normal alpha compositing for this. This is equivalent to using several feBlend primitives in 'normal' mode or several feComposite primitives in 'over' -mode.

* The '''feMorphology''' filter primitive provides erode and dilate effects, that are common in image manipulation programs. With erode, darker and more transparent areas spread to lighter and more opaque areas, whereas with dilate lighter and more opaque areas spread to darker and more transparent areas. For single-colour objects, this basically means, erode makes the object thinner and dilate makes it thicker.

* The '''feOffset''' filter primitive offsets the image by an user-defined amount. For example, this is useful for drop shadows, where the shadow is in a slightly different position than the actual object.

* The '''feTurbulence''' filter primitive renders [http://en.wikipedia.org/wiki/Perlin_noise Perlin noise]. This kind of noise is useful in simulating several nature phenomena like clouds, fire and smoke and in generating complex textures like marble or granite.

See also wiki page [[Filter Effects]] for more info on filters in Inkscape in general.

===Filters UI===

* New dialog for creating and modifying filter effects ('''Object>Filter Effects...''')
* The list at the left of the dialog displays all filters currently in the document.
** New filters can be added with the '''Add''' button beneath the list
** Right-clicking a filter for the pop-up menu allows duplicating or removing a filter.
** Double-clicking a filter will apply it to all selected objects
** A black dot is placed next to whatever filter is applied to the selected objects. If more than one filter is in use by selected objects, an unfilled dot is used instead.
* The second list, at the left of the dialog, displays the '''filter primitives''' that are contained within the currently-selected filter.
** New primitives can be added by selecting the primitive type from the combo box beneath the list, and then pressing the '''Add''' button.
** Right-clicking a primitive for the pop-up menu allows duplicating or removing a primitive.
** Primitives can be rearranged by clicking and dragging any filter in the list.
** When a filter is selected, the '''Settings''' group at the bottom of the dialog will change to display the attributes available for that primitive. Changing a setting results in an immediate update to the document.
** The "in" and "in2" attributes for filters that support them are not shown in the '''Settings''' group. These input connections are displayed graphically in the list, under the '''Connections''' column.
*** Inputs for a particular filter are displayed as triangles. Depending on the primitive type, there may be one or two inputs (or more for Merge primitives.) Connections can be created by clicking on a triangle and dragging.
*** There are six standard input types that can be used for any primitive input; Source Graphic, Source Alpha, Background Image, Background Alpha, Fill Paint, and Stroke Paint. These are displayed vertically on the far right of the list. Click and drag from an input triangle to one of the standard inputs to connect them.
*** Primitives can also be connected to other primitives by clicking an input triangle and dragging upwards to another primitive. A primitive can only be connected to one higher up the list.
*** Single-clicking on an input triangle will unset it, returning it to the default. If it is on a Merge primitive, the input will be deleted.
*** Merge inputs have an empty input at the end. Dragging a connection from this input will add a new input to the primitive.

=Live Path Effects (LPE)=

'''Live path effects''' (not to be confused with extension effects or SVG filters) are a new way to <b>non-destructively modify path and shape objects</b>. Path effects affect the path data of an object but not its style. The original path is preserved and can be edited directly on-canvas, and the path effect applied to it will be updated live.

In this version, we include several path effects that are analogous to the corresponding extension effects (such as Path along Path effect and Pattern along Path that replaces the extension of the same name). The most important advantage of path effects is that they are, indeed, live - you can still edit the original path and the effect will update in real time (unlike the extension effects which were one-time one-way transformations). In the future, we plan to reimplement most if not all of path-changing extensions as live path effects.

Live path effects were developed by Johan Engelen as part of the GSoC 2007.

==Details about operation==
The following schematic tries to explain how LPE work.

original style ------------> output style
original path --> LPE --> output path
^
|
parameters

The original style and path are from the path that the effect is applied on. The output is what is visible on screen. What is very important to notice is that <b>output style equals original style</b>.

The parameters can be paths, numbers, points, text, in principle anything.

==Applying effects==
Path effects are applied through the Path Effects dialog (opened from the Path menu, or by pressing Ctrl+Shift+7. This dialog is also used for controlling the effect's parameters and for removing effects.

When a path with a path effect applied is selected, the statusbar description mentions that, for example "'''Path''' (4 nodes, path effect)".

There is a special Paste Path Effect command (Ctrl+7) that can be used to copy effects from one path to another.

==Editing effect parameters==
When switching to the node edit tool (<b>F2</b>), the <b>original path</b> can be edited. The original path is shown as a red helper path. Normal path operations, like simplify, still work.

Some parameters of effects can be edited on-canvas. For example, path parameters can be node-edited, by pressing the "edit on-canvas" button in the Path Effects dialog. <b>Press "7" to cycle through the different on-canvas editable parameters.</b> This way, one can edit the parameters without opening the Path Effects dialog. The statusbar tells the name of the parameters that is currently being shown.

==Available effects==

===Path along path===
The <b>Path along Path</b> effect can curve a path along another path. When this effect is applied to a path, it can be bend along another path (called ''bend path''). With the node edit tool, both the original path and the bend path can be changed <b>on-canvas</b> and the result is <b>updated live</b>. This provides a direct equivalent of "vector brushes" or "skeletal strokes" features in other vector editors.

In the effect's control panel in the Path Effects dialog, you can select how many copies of the original path are put along the bend path (either '''single''' or '''repeated''') and whether it is '''stretched''' to fill the bend path. In this dialog you'll also find a button to edit the bend path on-canvas and a button to '''paste''' a new bend path from clipboard. A possible workflow is this: you select and copy the new bend path to the clipboard, then select the path you want to bend, apply the Path along path effect, and paste the bend path with the paste button next to 'bend path'.

Example file: live-path-effects-pathalongpath.svg

===Pattern along path===
The <b>Pattern along Path</b> effect can curve a path along another path. When this effect is applied to path A (called ''skeleton''), another path B (called ''pattern'') can then be passed as a parameter. The result is that path B is bent along path A. With the node edit tool, path A can be changed <b>on-canvas</b> and the result is <b>updated live</b>. This provides a direct equivalent of "vector brushes" or "skeletal strokes" features in other vector editors.

In the effect's control panel in the Path Effects dialog, you can select how many copies of the pattern are attached (either '''single''' or '''repeated''') and whether the pattern is '''stretched''' to fill the skeleton path. You can also choose the pattern for the selected skeleton [either directly or] by '''pasting''' it from clipboard (that is, you select and copy to the clipboard the pattern, then select the skeleton, apply the Path along path effect, and paste the pattern). The '''Scale width''' parameter allows you to change the width of the pattern applied to the path.

Example file: live-path-effects-pathalongpath.svg

===Stitch Subcurves===
The <b>Stitch Subcurves</b> effect connects points from two subpaths of the path with straight line or curved segments, i.e. the <i>stitches</i>. It looks a lot like the Effect Lines from Expression 3. The result is also referred to as "String Art". For some examples of string art, see http://members.shaw.ca/jillbritton/string_art/jbstringart.htm.

The <b>shape</b> of the <b>connecting paths</b> can controlled by the <b>stroke path</b> parameter. This could be used to draw 'hair-shaped' connecting paths with sharp end-tips. Other controls include the <b>number of paths</b>, the variation in spacing between the connecting paths (<b>clustering</b>) and also whether the start and end points of the stitches should like exactly on the original subcurves or can <b>stray randomly</b> around them. Finally the width of the stroke path can be varied.

Note that this effect can only be applied to a path with two subpaths in it, hence '<b>sub</b>curve' in the name. Use Path > Combine to create such a path from two separate paths.

Example file: live-path-effects-curvestitch.svg

Example file showing cooperation between Stitch Subcurves and Path along Path: live-path-effects-curvestitch-hair.svg

===Gears===
The <b>Gears</b> effect is a toy effect. It generates a chain of interconnected gears from the path that has the effect applied to it. The nodes of the path define the centers of the gears. The first 3 nodes are special; the first defines the start angle of the chain, the second defines the center of the first gear and the third knot specifies the radius of the first gear. That is, to create a chain of 2 gears, you will need a path with 4 nodes; for 3 gears, 5 nodes, and so on.

Example file: live-path-effects-gears.svg

==Development of new effects==
One of the goals of the Summer of Code project was to make it easy to create new effects. There is a framework that greatly simplifies effect implementation; very little code is needed to get the effect hooked into Inkscape. This leaves valuable time for the actual effect to be implemented. See the http://wiki.inkscape.org/wiki/index.php/MakingLivePathEffects wiki page for an explanation of how to get started with your own effect!

[johan]

=Extension effects=

== Live preview ==

* '''Live preview of effects''': Using the async behavior (see below), as soon as the parameters dialog for an effect is shown, the script is executed in the background and the screen updates as soon as it's finished. This can result is seemingly faster execution if no parameters are changed. If some parameters are adjusted, the script is restarted. This allows you to see immediately the effects of any parameter change without pressing the OK button on the effect's dialog.

* '''Spawn Glib API''': Scripting extension have been moved to the Glib spawn API to ensure that parameters and variables aren't interpreted by a shell. This also means that scripting extensions are executed in a separate process asynchronously allowing the GTK main loop to continue to execute.

* '''Progress dialog''': While an extension is working on a document, a small dialog is shown allowing the user to cancel the execution.

== New and improved effects ==

* The new '''Modify Path > Edge 3D''' extension creates black, grey and white paths around a shape, then blurs and clips them for a 3D effect.

* The new '''Render > Barcode''' extension creates a [http://en.wikipedia.org/wiki/Barcode barcode]. Supported types include EAN13, EAN8, UPC-A, UPC-E, UPC-5, Code39, Code39Ext, Code93, Code128, and RM4SCC.

* The new '''Render > Gear''' extension creates a [http://en.wikipedia.org/wiki/Gear mechanical gear] given the number of teeth, the circular pitch (in px units), and the pressure angle.

* The new '''Render > [[Spirograph]]''' extension creates intricate mathematical curves akin to the classic [http://en.wikipedia.org/wiki/Spirograph mechanical Spirograph toy] (see [http://wiki.inkscape.org/wiki/images/Spirograph_Samples.svg samples]).

* A group of new effects in the '''Text''' submenu performs various case conversions on selected text objects: converting to UPPERCASE, lowercase, Sentence case, Title Case, as well as flipping case (switching uppercase to lowercase and vice versa) and rANdoMiZInG cAse. If no texts are selected, the effect works on all texts in the document.

* Another effect in the Text submenu, '''Replace text''', performs search-and-replace on the selected text objects or (if nothing is selected) on all texts in the document. Searching is case sensitive. You can use this effect to globally delete all occurrences of some text fragment by replacing it with empty string. Conversely, if you search for an empty string and replace it with some string, this string will be inserted after every character of your text; for example, you can space out a text by replacing in it an empty string with a single space.

* A new effect, '''Replace color''' in the Color submenu, simply replaces one RRGGBB-specified color to another within selection or, if there's no selection, in the entire document. As with other effects in that submenu, the replacement affects fill, stroke, and gradient colors, but not colors of bitmaps.

*The new '''Color > Randomize''' extension allows you to change the color via hue, saturation and lightness check boxes. This is useful if you want to colorize lots of shapes at the same time.

*The '''Whirl''' extension uses the center of view as the center of whirl, so you don't have to enter the center coordinates numerically.

*The '''Render > Grid''' extension has got an extended range of grid spacings, from 0.1 to 1000 px.

*The '''Render > Function Plotter''' extension can now plot using polar coordinates.

*The '''Generate Template > Perfect-Bound Cover''' extension creates templates for wraparound covers for perfect-bound books using US size and paper weight measurements. This extension will resize the document to include the width, height, spine width, and bleed measurements that are provided to the extensions, so it should be the first operation done before designing.

== XSLT effects ==

* '''XSLT''' is now supported for input, output and effect extensions. This is used to support the XAML file format (both import and export) and the Adobe Illustrator SVG import which removes Adobe's stuff from SVG.

== ImageMagick effects ==

New raster operations available through the effects drop-down menu, powered by the ImageMagick library. For any of these effects to work, you need to have an '''image object selected''' in the drawing.

* '''Adaptive Threshold''' applies adaptive thresholding to the bitmap. Average color of rectangle provided by '''width''' and '''height''' used as threshold value. Use '''offset''' to apply a different threshold than the average.

* '''Add Noise''' adds random noise of certain types to the bitmap.

* '''Blur''' blurs the bitmap, using '''radius''' as the amount of blur. Higher radius means more blur. (Note that unlike the vector Gaussian blur of objects, this bitmap blur will not extend the edges of the image, so it may appear truncated at the edges.)

* '''Channel''' extracts the specified channel from the bitmap.

* '''Charcoal''' applies a charcoal drawing style to a bitmap. Radius controls the width (or detail) of charcoal strokes. Higher '''radius''' means lower detail. '''Sigma''': the higher it is, the less defined the charcoal is.

* '''Colorize''' overlays the bitmap with a given color at a given intensity.

* '''Contrast''' lightly enhances the contrast (difference between lights and darks) of a bitmap.

* '''Cycle Colormap''' cycles the colormap of a bitmap.

* '''Despeckle''' reduce the speckle noise in a bitmap.

* '''Edge''' hilights edges in a bitmap.

* '''Emboss''' embosses a bitmap, hilighting edges with 3D effect.

* '''Enhance''' enhance a bitmap, minimizing noise.

* '''Equalize''' equalizes a bitmap. Histogram equalization.

* '''Flop''' mirrors a bitmap, reflecting each scanline in the horizontal direction.

* '''Gaussian Blur''' blurs a bitmap, more strongly than regular blur.

* '''Implode''' sucks everything towards the center of the bitmap.

* '''Level''' scales values falling between the given '''Black Point''' to '''White Point''' range to the full color range.

* '''Level Channel''' acts the same way as level but for only one channel.

* '''Median Filter''' filters a a bitmap by replacing each pixel component with the median color in a circular neighborhood

* '''Modulate''' adjusts the percent hue, saturation, and brightness of a bitmap.

* '''Negate''' takes the inverse of a bitmap.

* '''Normalize''' normalizes a bitmap, expanding color range to the full possible range of color.

* '''Oil Paint''' stylizes a bitmap so that it appears to be painted with oils.

* '''Opacity''' modifies the opacity channel of a bitmap.

* '''Raise''' alters the lightness of the edges of a bitmap to create a raised appearance, much like a frame.

* '''Reduce Noise''' reduces noise in a bitmap by using a noise peak elimination filter.

* '''Shade''' shades a bitmap by simulating a distant light source

* '''Sharpen''' sharpens a bitmap.

* '''Solarize''' solarizes a bitmap, like overexposing photographic film.

* '''Spread''' randomly spread pixels in a bitmap within the radius of '''amount'''.

* '''Swirl''' swirls the bitmap around the center point.

* '''Threshold''' thresholds a bitmap.

* '''Unsharpmask''' sharpens a bitmap using an unsharp mask algorithm.

* '''Wave''' alters a bitmap along the sine wave.

These effects are part of the Google Summer of Code 2007, coded by Christopher Brown.

== Misc ==

* All Python effects are switched from the old and unmaintained PyXML library to the new powerful [http://codespeak.net/lxml/ lxml] library.

* A new parameter, '''precision''' is added to the parameter definitions in the [[MakingAnINX|inx file format]], allowing you to set the number of digits in that parameter's spinbutton in the effect UI.

= Stock patterns =

Since a few versions ago, Inkscape supports patterns in fill and stroke. However, up to now the only way to apply a pattern was by creating it in the document using the Object(s) to Pattern command, which wasn't very convenient. Now, if you switch an object's fill or stroke to pattern using the Fill&Stroke dialog, you will get a drop-down list with a number of predefined '''stock patterns''' that you can apply simply by selecting them from the list:

*A selection of plain '''stripes''' differing by the ratio of the stripe width to gap width (for example, the "Stripes 1:2" pattern has gaps twice as wide as stripes), in the range from 4:1 to 1:64. All stripes patterns are in two versions: with black stripes and with white stripes (gaps are always transparent).

*Two '''checkerboard''' patterns with black and white odd squares (even squares are transparent)

*'''Packed circles''': a hexagonal pattern of black circles with transparent gaps.

*'''Polka dots''': a scattering of dots designed to look randomly but evenly distributed so as to mask the regularity of the repeating pattern. There are three size variants of this pattern (small, medium, and large dots) and two color variants (black and white dots).

*'''Wavy''' is a pattern of wavy lines.

*'''Camouflage''' is a green-toned protective pattern such as that used by the military.

*'''Ermine''' is the traditional heraldic pattern representing stylized stoat furs with black tails.

*Three bitmap patterns: '''sand''', '''cloth''', and '''old paint''' are based on seamless photographic tiles and allow you to add some natural texture to your drawing. All of them are grayscale, so you can make objects with these textures semitransparent and overlay them over other colored objects to "texturize" them.

After applying a stock pattern, switch to Node tool to edit the location, scale, and rotation of the pattern via on-canvas handles.

All stock patterns are stored in the file <code>patterns/patterns.svg</code> in Inkscape's <code>share</code> directory (typically <code>/usr/share/inkscape</code> on Linux, <code><i>inkscape-dir</i>/share</code> on Windows). You can add your own patterns to this file or replace it with any other SVG file containing the patterns you need.

=Color management=

== Calibrated SVG color including CMYK ==

Inkscape now supports color-managed color definitions that use a colorspace other than sRGB (for example Adobe RGB, or calibrated CMYK colors). In the SVG file, this is done using the
optional "icc-color(...)" paint components as described in section 11.2 "Specifying paint" of the SVG 1.1 specification
[http://www.w3.org/TR/SVG11/painting.html#SpecifyingPaint]. A fallback sRGB value will be used, for non color-managed workflows. This allows for the use of calibrated color spaces, including using CMYK values that are preserved across applications.

The new CMS color selector tab allows these colors to be edited.

== Display adjustment ==

In Inkscape Preferences, Color Management tab, there's are new options for enabling display adjustment; you can select any calibration profile (an ICC file) suitable for your display. Options for rendering intent can also be chosen.

=== Per-window adjustment ===
Display adjustment is enabled and disabled per each editing window. This allows for simultaneous viewing of adjusted and unadjusted views of a single document by using multiple windows. There is a toggle at the bottom-right corner of the scrollbars that allows for turning on and off display adjustment. It also will be disabled to provide visible feedback when no profile is set to be available for adjustment.

=== XICC Support ===
On X11-based systems (i.e. Unix and Mac OSX), use of [[http://www.burtonini.com/computing/x-icc-profiles-spec-latest.html ICC Profiles In X Specification]] (or XICC) can be enabled. Support for version 0.2 of this specification has been implemented. Enabling this option by choosing to retrieve profiles from the display will switch Inkscape to using profiles attached to screens at runtime. These allow display adjustment to be changed on the fly, and to be set and cleared per-monitor. This is especially helpful with more than a single monitor.

Other Open Source software such as [http://www.gimp.org/ GIMP] support XICC. This allows all aware applications to be adjusted by setting a profile only once.

=== Multi-monitor aware ===
When XICC support is enabled, windows will adjust to the proper profile as they are moved across monitors. Also, as the windows are moved onto monitors with no profile attached, the adjustment toggle will become disabled. When the windows are moved onto screens that do have profiles, the toggle will become enabled.

== Soft Proofing ==

In Inkscape Preferences, Color Management tab, there's a new option for enabling output device preview; you can select any calibration profile (an ICC file) suitable for your output device. Options for rendering intent can also be chosen, along with out of gamut warnings.

=Snapping=

* Snapping has been implemented or improved for:

:* '''Newly created shapes'''

:* '''Skewing''' of objects

:* '''Handles''' of objects, incl. '''gradients'''

:* '''Images''' and '''clones'''

:* Text boxes, which snap to '''text baselines''' again

:* Objects, for which snapping now optionally considers the '''rotation center'''

:* Objects, which now allow for '''constrained snapping'''

:* '''Guides''', which now snap while dragging them

:* '''Axonometric grids'''

:* '''Angled guide lines'''

:* '''Bounding boxes''', of which now all four corners snap

* Other snapping fixes and improvements include:

:* It is now possible to snap to '''intersections''' of e.g. gridlines with guidelines, and of line segments.

:* The '''snapping preferences dialog''' has been restyled to make it more intuitive.

:* Inkscape now has a global snapping toggle, which has been added to the view-menu and is accessible through a shortcut

:* Inkscape now allows for controlling the snapping per grid when multiple grids are being used

:* Snapping distance is now set in screen pixels and is therefore '''independent of zoom'''.

:* Snapping of objects has been made more clean, by only snapping '''bounding box corners to bounding boxes''', and '''nodes to other nodes and paths'''.

:* The time it takes to snap to objects using the selector tool has been reduced significantly.

:* The bug where "node-to-node" snapping caused jerky movement of nodes is fixed.

:* The '''aspect ratio''' is correctly preserved while scaling objects with snapping turned on.

:* Only nodes at '''non-smooth parts''' of a path now snap.

:* The confusing "Default transformations origin" option has been removed. Now Inkscape always uses the opposite edge of the object's bounding box as the '''transformation origin''' (though the bounding box itself can now be different, see next item).

:* A new preference option has been added to specify the kind of bounding box to be used for transforming objects (see Inkscape Preferences, Tools, Selector). You can choose between the '''visual bounding box''' (which takes into account the stroke width, markers, and blur margins; this is the default behavior) or '''geometric bounding box''' (which encloses only the path itself, disregarding stroke width).

=Grids=
Grids have undergone some big changes under-the-hood. These are the visible changes:
* There is a <b>new 3D/axonometric grid</b>!
* A new tab in the document properties dialog, solely meant for grids; the former grid/guide tab is now solely for guides. I envision a list of guides there in the future, for easier deletion of guides etc.
* More than one grid can be active at the same time
** Each grid can be enabled/disabled separately from the document properties dialog.
* One can make grids invisible by unchecking the "Visible" checkbox in the grid's tab in the document properties dialog. Snapping is still enabled even for invisible grids!
* Multiple views on the same document share the same grids, but the grid can be turned off for each view separately. For example: one could have an overview view without grids showing. Duplicate that window and zoom in on some detail; then grids can be shown only for that view, and snapping will only happen in those views for which grids are enabled. (sorry i am not able to explain more clearly, perhaps someone else can?)
* Grid information is now stored in SVG as a child of sodipodi:namedview. Old files will be converted to this new format automatically
* The rectangular grid now has an option to show dots on gridline intersections instead of solid lines

From developer perspective:

* Implementation of new grids is much easier now; subclassing CanvasGrid and adding an entry in the is enough. Have a peek at how the rectangular grid is implemented (CanvasXYGrid).
* Note that there is no longer "the grid", there might be several grids active now!

A side effect of removal of old gridcode: apparantly the origin of the desktop rules used to be set to the origin of the grid. I find this strange: specifying a grid origin of (2,2) would have me think the origin would be at ruler location (2,2) instead of (0,0) as it is in 0.45.1.
I have commented the grid-origin correction to the ruler range, because now there is not a single grid anymore to correct it for. Isn't there a control somewhere to define the documents origin? Now the ruler origin is set to (0,0)

--johan

=Angled guidelines=

Now, Inkscape also provides angled guidelines! Double click on a guide to set its angle.

* When dragging a guideline off the rulers close to the edge, the guideline will automatically be angled. The angle is set depending on the grid.
** For the rectangular grid, the angle is 45 degrees.
** For the axonometric grid, the angle is matched to the grid. When the Ctrl-key is pressed, the angle is perpendicular to the grid lines (useful for aligning gradients).

=Import/Export=

==PDF and AI import==

In this version, Inkscape can natively (i.e. without any additional software) import PDF files and the newer PDF-based Adobe Illustrator files (starting from AI version 9.0).

'''Implemented features''': The new import extension can import '''paths''', '''text''', '''clippaths''', '''masked or non-masked images''', and '''softmasks'''. It supports '''pattern fills''' (XStep and YStep attributes are ignored) as well as '''linear and radial gradients''' (only those using sampled or exponential functions). '''Gradient meshes''' are imported, but they get converted to groups of small tiles (flat-colored paths) that approximate the mesh; the user can adjust the precision of this approximation.

'''PDF import settings''': After opening a PDF or AI document, the PDF Import Settings dialog shows up. Here you can select:

* the '''page''' to be imported from a multipage PDF;

* the overall '''clip region''' (which can be none or set to any of the PDF boxes, e.g. the crop box, the media box, the trim box, etc.);

* the '''precision''' for the approximation of '''gradient meshes'''; note that setting this too high may result in a huge SVG file and slow performance when importing files with gradient meshes;

* a checkbox controlling whether the '''images''' should be '''embedded''' into the resulting SVG document or saved on the current path;

* a '''preview''' of the selected page (shown if poppler-cairo is present on the system or if the selected page has a thumbnail embedded into the PDF document).

'''Text editing tips''': Any text imported from PDF or AI has each letter's precise place on the page ''fixed''. While this preserves the exact appearance (e.g. justification of text blocks) of the imported document, it makes editing such text difficult: deleting text fails to contract the text line and inserting text fails to expand it, i.e. typed letters overlay the existing letters. (However, you still can replace a letter with another letter of about the same width, although you may need to kern it into place with Alt+arrows.)

To work around this, select the text object you want to edit and use '''Text > Remove manual kerns''' command. This will remove the exact positioning information, so if the text block was justified it will lose justification, but instead you will be able to edit it as usual.

Note that there is a way to select even a single line in a text block. For this, open the XML editor, expand the <svg:text> tree branch corresponding to your text, and select any of the <svg:tspan> objects under it. Now you can remove manual kerns from this line only. After you finish editing the line, you can manually justify it back, for example by adding spaces, manual kerns (Alt+arrows), or by adjusting letterspacing (select the whole line and use Alt+> or Alt+<).

The native PDF/AI importer is based on the poppler library and was implemented by Miklós Erdélyi as part of the Google Summer of Code 2007.

==PDF export==

* A new cairo-based PDF exporter has been added to Inkscape (marked as "Cairo PDF" in the export format list). Inkscape 0.46 can export shapes, strokes, transparency, gradients, patterns, text, and images correctly to cairo. While clipping paths and masks are known to be faulty or missing. Also, unlike the old PDF exporter, the cairo-based PDF export produces compressed PDF files that are reasonably compact. cairo will write a PDF with vector graphics when possible and fall back to raster graphics when needed. What can be exported as vectors and how much of the image will be rasterized when the fallback kicks in depends on your version of cairo. cairo version 1.2 with the pdf backend compiled in is the minimum requirement for any cairo-based PDF exports, but it is highly recommended to use at least '''cairo 1.5.2''' for quality PDF export.

* A new cairo-based PostScript exporter has been added (marked as "Cairo PS" in the export format list). The cairo PS backend is not as mature as the PDF backend. It rasterizes a lot of its content. Text output does not work where it works with the PDF backend.

==CDR (CorelDraw) import==

Inkscape can use [http://www.sk1project.org/modules.php?name=Products&product=uniconvertor UniConvertor] if it's installed on your system to import documents in CDR format (CorelDraw). This feature is Unix-only at this time (since UniConvertor is Unix-only) and requires that you have Python and UniConvertor installed. As of UniConvertor 1.0rc2, only versions from 7 to X3 of the CDR format are supported, and text objects are not converted.

==XAML import/export==

* Inkscape can import vector graphics portions of XAML documents, as well as export its documents to XAML.

==Adobe Illustrator SVG clean import==

* Using this new import filter, Inkscape can open an SVG document removing any elements and attributes in the namespaces that Adobe Illustrator uses for its stuff. This will clean out everything except the actual SVG content.

==Bitmap export==

* '''Batch export''': The Bitmap Export dialog (Ctrl+Shift+E) got a new checkbox, ''Batch export all selected objects''. This checkbox is available when two or more objects are selected. If it is checked, instead of exporting selection as a whole, Inkscape exports each selected object separately into its own PNG file. This uses each object's export hints (i.e. export filename and DPI) if they are remembered from a previous export; otherwise, the filename is created from the object ID and the DPI is 90 pixels per inch. '''Caution:''' Unlike regular export, batch export overwrites all existing PNG files without warning.

:This makes it possible to implement all kinds of '''image slicing''' and automated export scenarios. For example, if you are working on a web site design, you can create a separate "export" layer. In that layer, "slice" your web page image into separate areas by creating invisible rectangles with no fill and no stroke. Select each rectangle (by Tab/Shift+Tab, or by switching to Outline mode where even an invisible rectangle can be selected by clicking on its outline) and export it into the corresponding filename (which gets saved as that object's export hint). After that, if you do any changes to your graphics, it's very easy to reexport all the slices: just switch to the "export" layer, select all in that layer (Ctrl+A), and export with the ''Batch export selected objects'' checkbox on.

* '''Hide all except selected''': A new checkbox allows you to hide in the exported image everything except selected object(s).

* The Export dialog automatically appends the '''.png''' extension to the export filename you specify.

== Open Clip Art Library import and export ==

{rejon}

=Command line=

Several new command line options are added that make Inkscape even more scriptable and automatable than before.

* --verb-list will list all the Verb IDs and their names in Inkscape. This makes writing your own menus and hotkeys much easier as you can easily find out what the choices are.

* --verb followed by a verb ID allows you to specify a verb to be called on every document opened by Inkscape initially from the command line.

* --select followed by a node ID will allow you to add a node to the list of selected objects.

* --query-all produces a comma delimited listing of all objects in the document, with their x, y, height, and width values.

These options can be used, for example, for performance testing. You could do something like this:

$ time inkscape --verb=FileClose my_complex_file.svg

to measure the time it takes to load and display the file.

Of course, with the ability to select objects, it can be much more useful than
that. You can call extension effects, or any other verb, then FileSave and
FileClose to automate all kinds of operations on your drawings.

=User interface=

== [dockable dialogs - gustav] ==

Inkscape's dialog handling has been reworked in this release to allow dialogs to behave like '''dockable panels'''. The dock area that holds the user's dialogs is located right of the canvas.

Dialogs placed in the dock can easily be rearranged, resized, stacked in groups or iconified. Furthermore, a dialog can be dragged of the dock to become a floating dock in itself—this allows other dialogs to be dragged and dropped on it to form a floating group of dialogs.

The old dialog behavior (used in releases before 0.46) has been preserved as an option, and if it is preferred, one can select it under ''Windows'' > ''Dialog behavior'' in the Inkscape preferences dialog.

Known issues:

* Some of Inkscape's dialogs are yet to be adapted to allow docking, these include the "Text and Font" dialog, the "Tiled clones" dialog, the "XML editor" and the "Object properties" dialog.

* [Remembered positions of dockable floating dialogs is inexact.]

[options]

== [toolbars - [[JonCruz]]] ==

'''Main toolbar''' on the left can now optionally use '''smaller buttons'''. With the several new tools added in this version, this may help users with small screens where the toolbar otherwise may not fit vertically. The toggle is on the Misc tab of the Inkscape Preferences dialog.

[calligraphy: menus, tooltips; star; ...]

Switched to stock GTK+ toolbars.

Extra magic secret sauce added.

== [filedialogs - [[JonCruz]]] ==

== Swatches panel, color drag-and-drop ==

* Right-clicking a color swatch now opens a context menu which allows you to apply the color to the fill or stroke of selection.

* Dragging colors from the color palette has been fixed and improved:

:* Now the dropped color is applied to '''the object on which you drop it''', regardless of whether that object is selected or not. This means you can change the color of only one object from selection without having to select it separately. (If you want to assign color to the entire selection, just click on the color swatch on the palette, not drag it.)

:* If an object has stroke and you '''drop the color over stroke''', the color is applied to stroke and not fill. (Another way to always apply color to stroke is to '''Shift+drag''' it.)

:* When gradient handles are active (e.g. in Gradient or Node tools), you can '''drop a color onto the gradient line''' to create a new gradient mid stop with this color, or '''drop a color onto an existing stop''' to recolor that stop.

==Color gestures==

A new method for quick and precise adjustment of colors is added in this version: color gestures. It works on the selected objects by grabbing the '''fill or stroke color swatch''' in the '''selected style indicator''' (on the left of the statusbar) and dragging it in various directions as described below. Note that this only works when the swatch displays a '''flat color'''; it does not work for a swatch showing "None", "N/A", or displaying a gradient (although you can select one or more gradient stops in Gradient tool and color-adjust them by color gestures just as you would do for objects). Color gestures can work on '''fill''' or '''stroke''', depending on which swatch in the selected color indicator you drag.

Color gestures work in '''HSL''' color space. Dragging without any keyboard modifiers adjusts the '''hue''' channel, dragging with '''Shift''' adjusts '''saturation''', and dragging with '''Ctrl''' adjusts '''lightness'''.

The adjustment is done by '''"rotating"''' the color swatch away from the original direction which is assumed to be '''NE at 45 degrees''' (i.e. from
the swatch diagonally into the document window). Once you click and drag the color swatch, imagine a diagonal line going from the point where you clicked in the NE direction, across the entire Inkscape window. By dragging '''below or to the right''' of that line, you decrease the corresponding color channel, to the minimum at the lower edge of the window; by dragging it above or to the left, you increase it, to the maximum at the left edge of the window. If you hover your mouse exactly over the 45 degrees line, the change will be zero.

Note that you can easily vary the '''precision''' of your adjustment. If you drag close enough to the swatch, each small movement results in a big change of the color. If you need a finer adjustment, just drag farther away from the swatch, towards the center of the Inkscape window or even to its upper right corner, where minute movements will produce very small changes in the color. In fact, this method gives you more color precision than even the color wheel in the Fill and Stroke dialog, unless you expand that dialog to fill the entire screen which is rarely practical.

The mouse '''cursor''' changes when you're doing color gestures, reflecting the channel currently adjusted and indicating the directions for increasing and decreasing the value. Also, watch the '''statusbar''' which will indicate, as you drag, the channel you are adjusting, the original value of that channel, the new value, and the difference.

You can '''switch channels while you drag'''. That is, you don't need to
drag it again and again from the swatch if you want to adjust all three channels - you can do it all in one drag, by pressing and releasing Ctrl and Shift as necessary. Note that when you change the keyboard modifiers during drag, the position of the zero-change line is temporarily changed to go through the current mouse position; this is done so that there are no sudden changes in color if you are switching modifiers away from the original 45-degree line.

The '''Alt''' modifier is special. Pressing Alt means "do nothing"; this allows you to move the mouse, without releasing, to a more convenient place from where to continue tweaking the color after letting go of Alt. As with the other modifiers, releasing Alt temporarily redefines the zero-change axis to go through the point where Alt was released. For example, imagine you made your color darker by Ctrl+dragging towards the bottom edge of the window and you now need to make it less saturated. You cannot however Shift+drag it any lower because there's just not enough room for that. In that situation, without releasing the mouse, Alt+drag it upwards to a convenient spot and then Shift+drag downwards as needed. Also, you can start dragging from the swatch with Alt pressed to avoid changing the color while you take a more convenient position for adjustments.

For example, you can select a green rectangle and first turn it into greenish-blue by dragging away from the Fill swatch and slightly above the 45 degrees line; then, without releasing the mouse, press Ctrl and drag a bit to the right to darken the color; then press Shift, release Ctrl, and adjust saturation. You can press or release Ctrl and Shift as many times as necessary during a single drag; when you are finally satisfied with your color, release the mouse to commit the change.

Apart from precise adjustments, you can use color gestures to very quickly perform some common color transformations:

* Ctrl+drag the swatch to the right and down to paint all selected objects black.

* Ctrl+drag the swatch upwards and to the left to paint all selected objects white.

* Shift+drag the swatch to the right and down to desaturate the color of selected objects.

* Shift+drag the swatch upwards and to the left to maximize saturation of the color of selected objects.

Note that when several objects or gradient stops with different colors are selected, the selected style indicator shows their '''averaged''' color. If you adjust that color by gesturing, the changed color will be assigned back to all selected objects/stops, in effect eliminating any difference between them. If you want to adjust many different-colored objects preserving their relative differences, use the color modes of the Tweak tool or color adjustment extension effects.

This new technique requires some getting used to, but once you get the idea it is quite convenient, fast, and precise.

== Print dialog integration ==

* '''Print Dialog''': The GTK Unix Print Dialog has been hooked up! From the dialog, you can select any of the Postscript-capable printers known to your system and configure them as with any other GTK application.

== Saving window geometry globally ==

Previously, window geometry (size and position of document windows) could only be saved into the document (so that each document stored its own window geometry). Now, a new option is added to save the geometry of the last used window to the preferences and apply this geometry to all new windows. Thus, with the "Save geometry to preferences" option enabled, new windows will open with the shape of the most recent previous window. This mode also remembers and restores the maximized/fullscreen state (unlike geometry saved to documents).

== Preserving zoom/view of reverted documents ==

When reverting files to their previously saved state, the current zoom factor/panning is now retained (as opposed to reverted to the saved state, too, as it was the case before). This less interrupts the workflow when one is working on some detail in the drawing.

== New ways to scroll and zoom ==

* You can now enable Space+mouse drag to pan canvas, as it does in Adobe Illustrator. This mode is enabled by the '''Left mouse button pans when Space is pressed''' checkbox in the Scrolling tab of the Inksape Preferences dialog. By default it is off and pressing the spacebar key switches you to Selector and back, as it always did in Inkscape.

* By default, rotating the mouse wheel scrolls the canvas vertically and Ctrl+wheel zooms in and out. Now, if you turn on the '''Mouse wheel zooms by default''' checkbox in the Scrolling tab of the Inksape Preferences dialog, this behavior is reversed: mouse wheel zooms without Ctrl and scrolls with Ctrl. This new mode should be familiar for users of AutoCAD and CorelDraw.

* In the Zoom tool, right mouse button always zooms out instead of calling the context menu (which is rather useless in this tool anyway).

== Using other keys in place of Alt ==

* Many Linux users have found the use of '''Alt-drag''' and '''Alt+click''' in Inkscape problematical because this shortcut is often captured by window managers. In 0.46, instead of disabling of the window manager shortcut as suggested in [http://wiki.inkscape.org/wiki/index.php/FAQ#How_to_make_Alt.2Bclick_and_Alt.2Bdrag_work_on_Linux.3F the FAQ], you can change a setting in your preferences.xml file called <code>mapalt</code> in the <code>options</code> group. This numerical value ranges from 1 to 5; 1 indicates no change, any other value refers to some special key on a keyboard, such as '''Alt Gr''', the '''Windows''' key, etc. The specific mapping of these values to the keys on your keyboard can be viewed and/or editied by '''xkeycaps''', available from [http://www.jwz.org/xkeycaps www.jwz.org]. The value associated with a particular key is shown in that program at the top of the screen beside the word "Modifiers" when the mouse is held over a key on the main display.

== GTK theme on OS X ==

A GTK theme is now included in Inkscape.app bundle on OS X. If the user does not have any personal customization (e.g. in a .gtkrc-2.0 file) this theme is used. It reflects the OS X settings for "Appearance" and "Highlight Color" set in System Preferences > Appearance.

=Other changes and improvements=

* '''Gnome VFS Improvements''': Gnome VFS Non-Local files are now usable through all of our file choosers in Open, Save and Export. This compile-time option allowed people to open any Gnome-VFS-based URI from the command-line in the past, but not non-local resources (WebDAV, SFTP, etc) and this now allows for all the lovely possibilities Gnome-VFS provides.

* In previous versions, Inkscape didn't allow you to '''group a single object.''' Yet in some cases, this operation is useful (for example, to blur the clipped edged of an object, or apply more than one clippath/mask to an object). Now this limitation is removed; just select any single object and group it to get a single-object group.

* The somewhat cryptic "F:" and "S:" labels in the selected style indicator (at the left end of the statusbar) and in tool's style swatches are now spelled out as '''Fill:''' and '''Stroke:'''. We believe this makes the interface, even if less space-efficient, a bit more friendly for newbies.

* The '''style swatches''' at the right end of object-creating tools' control bars now open the Preferences page of the corresponding tool when clicked. Also, now these swatches display a tooltip explaining its purpose (e.g. "Style of new rectangles", "Style of new calligraphic strokes", etc.)

* On the '''Scale''' tab of the '''Transform dialog''', the numbers now show the current size of selection, not size increment as before. Correspondingly, with the % unit chosen, you see 100% displayed, and to scale it up twice, you enter 200%, not 100% as before. This is a more intuitive behavior and it's more consistent with how the W/H controls work in the Selector tool.

* After dragging a curve segment in Node tool, Inkscape no longer selects the two adjacent nodes if they were not selected before.

* The '''Tile Clones''' dialog now uses the object's defined '''rotation axis''' (which can be freely moved by Selector tool and which is saved separately for each object) for all rotations (including both symmetry rotations and the Rotation tab rotations), scales, and flips. This renders unnecessary the previous workarounds where you had to group an object with another transparent object to affect how it's rotated by the clone tiler.

* The '''Shift''' tab of the '''Tile Clones''' dialog has two new options: '''Cumulate''': when checked, each tile is shifted by the normal amount plus the cumulative shifts of all previous tiles. This is useful when placing tiles that are being scaled by a uniform amount. '''Exlude tile''': when checked, the tile width or height is not automatically included in calculating the tile's shift. This is useful when using the dialog to place clones on a circle or spiral (rather than using a shift of -100%). It is also useful when positioning tiles using the '''Exponent''' parameter.

* The '''Scale''' tab of the '''Tile Clones''' dialog has a new parameter: '''Base''' that allows placing tiles along a logarithmic spiral (as often found in nature). If the value is '''0''', the parameter is not used. Use a value less than one for a converging spiral and a value of greater than one for a diverging spiral. The actual scale is calculated as '''base''' raised to the nominal '''scale''' power.

* In '''Pencil''' and '''Calligraphic''' tools, pressing '''Esc''' or '''Ctrl+Z''' while drawing cancels the currently drawn path or stroke. When not drawing, these keys work as before (Esc deselects, Ctrl+Z undoes last action). (This is the same behavior as in the Pen tool where it was introduced in a previous version.)

* A set of new verbs has been added to allow the user to easily '''unlock all locked objects''' or '''unhide all hidden objects'''. There are two variants one that operates on the current layer and its children and one that operates globally. While searching for hidden or locked object descendants of locked layers are ignored.

* Several more '''rotation snapping increments''' are available in the Steps tab of the Inkscape Preferences dialog: 36, 22.5, 18, 12, and 0.5 degrees.

* The list of folder shortcuts in the '''Open''' dialog includes the folder with Inkscape's SVG '''examples''' for easy access. Similarly, the '''Save''' dialog has a shortcut for the user's own '''templates''' dialog making it easy to save the current document as a template (if saved as <code>default.svg</code>, it will be loaded every time you run Inkscape or create new document with Ctrl+N; with any other name, it will be added to the File > New submenu).

* For time-intensive operations such as Paint Bucket and Simplify, the system's busy wait cursor is displayed to indicate to the user that Inkscape is actively working, and not frozen.

* Several improvements in '''inkview''': busy cursor is shown while loading file, the button window stays on top and responds to keyboard shortcuts; several memleaks stopped and bugs fixed. The "slideshow mode" of the main inkscape application (-s or --slideshow command line option) is removed; use inkview instead.

* In Document Metadata dialog, updated '''Creative Commons Licenses''' to version '''3.0'''.

* Preferences have been added for setting the default metadata and licenses, so this information can be automatically filled in with new documents.

* The built-in '''Potrace''' tracing engine is upgraded to version '''1.8''' with some minor bugs fixed.

* File dialog windows (open/save) now have an '''Enable preview''' checkbox which allows you to disable the preview pane.

* In the Calligraphic pen controls, the toggle button to enable tablet pressure sensitivity is moved to the Width control, and the button for tilt sensitivity is moved to Angle, to better reflect what parameters these toggles affect.

* In Node and Gradient tools, using '''Tab/Shift+Tab''' to select next/previous node or gradient handle scrolls the canvas if necessary to show the selection.

* The option '''Import bitmap as <image>''' is removed; it was added several versions ago to allow optionally importing images as rectangles with image pattern, to make clipping the images easier. Now that you can easily use clipping paths, as well as convert any image to rectangle with pattern with Alt+I, this option is not really necessary and removed to reduce confusion. Bitmaps are always imported into SVG as an <image> element.

* Support has been added for stock patterns, in the same way that stock markers were already supported. Adding patterns to share/patterns/patterns.svg, and giving them a inkscape-stockid attribute as found on the examples already there will make them available in all Inkscape sessions from the patterns tab of the fill & stroke dialog.

* New '''fontforge_glyph.svg''' template is added for font designers who draw glyphs in Inkscape and import them into FontFoge. It is 1000x1000px large and has a horizontal guide at 200px to mark border for descenders.

* Save dialogs have been modified to clarify that they '''Save as SVG''', so people using Inkscape to edit PDF, EPS, and other file formats will be less confused at the default behavior when saving files.

* Add some new '''UML markers''', including filled and hollow diamonds and triangles.

* Inkscape application bundle on OS X now has the possibility to contain pre-compiled python modules (e.g. lxml, numpy, etc.) and to use them without requiring any work from the user. Since Python itself is shipped with Mac OS X, the user only has to drag and drop Inkscape on its hard-drive and all the extensions will be functional immediately.

=Notable bugfixes=

These are bugfixes compared to 0.45.1; for a list of fixes in 0.45.1 compared to 0.45, see [[ReleaseNotes045|0.45.1 release notes]].

* The '''sodipodi:docbase''' attribute is no longer added to the root <svg> element. This attribute used to keep the latest directory that the document was saved to, and thus represented a mild privacy violation (i.e., by sharing your Inkscape SVG files you allowed others to have a peek into your directory structure). Note, however, that Inkscape does not remove this attribute from old documents it opens; if you want you can remove it yourself. Inkscape just no longer creates this attribute in new documents.

* A fix in the blur rendering code made '''exporting blurred objects to bitmap''' much faster and fixed the disappearing of blurred objects in exported bitmaps which happened for large objects in 0.45. The same fix got rid of the rendering artefacts that sometimes appeared on blurred objects during scrolling.

* Inkscape now properly quotes <code>font-family</code> values and therefore can use '''fonts''' with various '''nonalphanumeric characters''' in their names, which previously failed.

* If you have saved documents with a previous version of Inkscape which used '''right-to-left text''' (e.g. Arabic, Hebrew) then the paragraph alignment of non-flowed text has been reversed in this release. This is due to a bug in previous versions - the new behaviour is compliant with the SVG specification and compatible with other editors and viewers. To correct your images, simply reverse the paragraph alignment by selecting the text and clicking the appropriate button on the toolbar.

* A large family of bugs was exterminated where an object's style could only refer other objects (such as gradients, patterns, and filters) that come after it in the document. Now any objects can be referenced from a style regardless of their place in the document. This fixed the '''disappearance of gradients/patterns/filters''' after you undo an effect, as well as lots of assorted crashes and misrenderings (mostly on non-Inkscape SVG files).

* On Windows, '''file opening/saving dialogs''' can no longer sink under the main editor window (they now have the inkscape window set correctly as their parent window).

* '''Stock markers''' now appear in the "recently used markers" section of the marker selector dropdowns in the Fill & Stroke dialog. Before, any markers with stock id's (including markers modified by the user) were hidden, making it difficult to work with modified stock markers.

* A regression in 0.45 caused crashes when '''undo or redo''' was attempted before the previous action could complete (e.g. pressing ctrl+z while you are still drawing a rectangle). This is now fixed.

* Previously, if there was a single '''invalid property''' in a <code>style</code> attribute, the entire attribute was discarded, i.e. the object lost all styling. Now Inkscape's behavior is more compliant to the CSS specification: it ignores only the invalid property but reads in all the rest.

* Several bugs are fixed in '''searching for linked images'''. Now moving SVG documents with their associated images to a different place or a different machine should work more reliably.

* Master opacity did not apply to stroke '''markers''' as it should; fixed.

* '''Creative Commons Public Domain Declaration URI''' points to the right location now.

* Text objects didn't display the '''pattern editing handles'''; fixed.

* On Windows, the Inkscape uninstaller deleted all files under the install directory. This could lead to removing user-created files, or even other program files not related to inkscape if the install directory was C:\Program Files. The new uninstaller '''tracks all installed files and asks for confirmation before deleting any other files'''. However, installation and uninstallation process is now slower.

* Clones were wrongly unlinked when their original was moved to another layer; fixed.

* Previous versions had a problem on '''Windows Vista''' where selected menu item was invisible. Now our Windows builds use a newer version of GTK library which fixes this problem.

* Duplicating empty text objects that have just been created no longer crashes. Also, the XML editor crash related to empty text objects is fixed. A downside is that the SVG will become cluttered with empty text objects as they are no longer automatically removed. A better fix for the problem is planned.

* In Tile Clones dialog, the PMG symmetry group was created incorrectly, which is now fixed.

= Previous releases =

* [[ReleaseNotes045]]
* [[ReleaseNotes044]]
* [[ReleaseNotes043]]
* [[ReleaseNotes042]]
* [[ReleaseNotes041]]
* [[ReleaseNotes040]]
* [[ReleaseNotes039]]
* [[ReleaseNotes038]]
* [[ReleaseNotes037]]
* [[ReleaseNotes036]]
* [[ReleaseNotes035]]

[[Category:Marketing]]

CompilingMacOsX

2007-12-21T10:04:12Z

Jiho: /* For the impatient */

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo +pdf boehmgc gtkmm intltool libxslt lcms popt poppler boost gnome-vfs \
libgnomeprintui automake autoconf subversion</pre>
Grab a cup of cofee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. [http://www.finkproject.org/ Fink] was used in the past but there is no information about wether it meets Inkscape needs currently. Alternatively you could use Inkscape all-in-one universal build script to install them (see below).

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All these steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to known how to use it just type:
<pre>./osx-build.sh help</pre>

= Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script [untested]=

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

== Packaging ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

Extension requirements

2007-12-18T08:17:36Z

Jiho: /* on Mac OS X */

== Setting Up Effects in Inkscape ==
<i>For effects to work you need to be using inkscape .42 or later.</i><br>
<i>For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]</i><br>
<i>See also [[GettingExtensionsWorking]].</i><br>

=== Unhide the Effects menu ===
(Only necessary in some versions of Inkscape. Between .41 and .45)

On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects" (0.41+CVS onwards only)

Close and reopen Inkscape

== Python Effects ==
=== on Debian GNU / Linux ===
apt-get install python python-xml

=== on Microsoft Windows ===
[[GettingEffectsWorking/Windows]] Tutorial on Getting Effects to work on Windows

=== on Mac OS X ===

Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed in version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]. In version 0.46, Inkscape will ship with everything that's needed right into the app bundle.

==== Binary packages ====
On OS X Panther or Tiger, you can install a binary version compiled by us with Python 2.3, downloadable with the development builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
You need to copy the folders for numpy (numpy) and lxml (*lxml*.egg or lxml) to System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).

==== Compiling from source ====
If you prefer, you can install them from source, it is really easy.

# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file <pre>tar -xzf numpy***.tar.gz lxml***.tar.gz</pre>
# for each one <code>cd<code> into the newly created directory
# build C extensions and install (the install is system wide so you need administrator priviledges)<pre>sudo python setup.py install</pre>and type your password.

The packages are installed in the <code>site-packages</code> directory of your Python install. This is <code>/Library/Python/2.*/site-packages/<code> for the stock install of Python on Mac OS X.

== Perl Effects ==
=== on Debian GNU / Linux ===
apt-get install perl libxml-xql-perl

=== on Gentoo GNU / Linux ===
emerge -a XML-XQL

=== on Microsoft Windows ===
install [http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl [[ActivePerl]]]
install XML::XQL::DOM (perhaps like this?)
1: install prereqs with ppm:
install xml-dom
install parse-yapp
install datemanip
2: download xml-xql from:
http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
3: open command prompt and locate perl"s lib directory with:
perl -e "print qq(@INC)" (mine was C:[[/Perl/site/lib]])
4: unpack xml-xql archive
5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

== Plugin Effects ==
I have absolutely no idea. Please record your success here. :)

== What if it doesn't work? ==
Run Inkscape from the console

Use the error messges printed to the console to diagnose the problem (very often missing dependencies)

On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

[[Category:Extensions]]

Extension requirements

2007-12-18T08:16:33Z

Jiho: /* Binary packages */

== Setting Up Effects in Inkscape ==
<i>For effects to work you need to be using inkscape .42 or later.</i><br>
<i>For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]</i><br>
<i>See also [[GettingExtensionsWorking]].</i><br>

=== Unhide the Effects menu ===
(Only necessary in some versions of Inkscape. Between .41 and .45)

On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects" (0.41+CVS onwards only)

Close and reopen Inkscape

== Python Effects ==
=== on Debian GNU / Linux ===
apt-get install python python-xml

=== on Microsoft Windows ===
[[GettingEffectsWorking/Windows]] Tutorial on Getting Effects to work on Windows

=== on Mac OS X ===

Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed in version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]

==== Binary packages ====
On OS X Panther or Tiger, you can install a binary version compiled by us with Python 2.3, downloadable with the development builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
You need to copy the folders for numpy (numpy) and lxml (*lxml*.egg or lxml) to System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).

==== Compiling from source ====
If you prefer, you can install them from source, it is really easy.

# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file <pre>tar -xzf numpy***.tar.gz lxml***.tar.gz</pre>
# for each one <code>cd<code> into the newly created directory
# build C extensions and install (the install is system wide so you need administrator priviledges)<pre>sudo python setup.py install</pre>and type your password.

The packages are installed in the <code>site-packages</code> directory of your Python install. This is <code>/Library/Python/2.*/site-packages/<code> for the stock install of Python on Mac OS X.

== Perl Effects ==
=== on Debian GNU / Linux ===
apt-get install perl libxml-xql-perl

=== on Gentoo GNU / Linux ===
emerge -a XML-XQL

=== on Microsoft Windows ===
install [http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl [[ActivePerl]]]
install XML::XQL::DOM (perhaps like this?)
1: install prereqs with ppm:
install xml-dom
install parse-yapp
install datemanip
2: download xml-xql from:
http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
3: open command prompt and locate perl"s lib directory with:
perl -e "print qq(@INC)" (mine was C:[[/Perl/site/lib]])
4: unpack xml-xql archive
5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

== Plugin Effects ==
I have absolutely no idea. Please record your success here. :)

== What if it doesn't work? ==
Run Inkscape from the console

Use the error messges printed to the console to diagnose the problem (very often missing dependencies)

On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

[[Category:Extensions]]

Extension requirements

2007-12-18T08:14:31Z

Jiho: /* Compiling from source */ suppresses pyXML

== Setting Up Effects in Inkscape ==
<i>For effects to work you need to be using inkscape .42 or later.</i><br>
<i>For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]</i><br>
<i>See also [[GettingExtensionsWorking]].</i><br>

=== Unhide the Effects menu ===
(Only necessary in some versions of Inkscape. Between .41 and .45)

On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects" (0.41+CVS onwards only)

Close and reopen Inkscape

== Python Effects ==
=== on Debian GNU / Linux ===
apt-get install python python-xml

=== on Microsoft Windows ===
[[GettingEffectsWorking/Windows]] Tutorial on Getting Effects to work on Windows

=== on Mac OS X ===

Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed in version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]

==== Binary packages ====
You can install a binary version compiled by us, downloadable with the development builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
You need to copy the folders for pyXML (_xmlplus), numpy (numpy) and lxml (*lxml*.egg or lxml) to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).

==== Compiling from source ====
If you prefer, you can install them from source, it is really easy.

# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file <pre>tar -xzf numpy***.tar.gz lxml***.tar.gz</pre>
# for each one <code>cd<code> into the newly created directory
# build C extensions and install (the install is system wide so you need administrator priviledges)<pre>sudo python setup.py install</pre>and type your password.

The packages are installed in the <code>site-packages</code> directory of your Python install. This is <code>/Library/Python/2.*/site-packages/<code> for the stock install of Python on Mac OS X.

== Perl Effects ==
=== on Debian GNU / Linux ===
apt-get install perl libxml-xql-perl

=== on Gentoo GNU / Linux ===
emerge -a XML-XQL

=== on Microsoft Windows ===
install [http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl [[ActivePerl]]]
install XML::XQL::DOM (perhaps like this?)
1: install prereqs with ppm:
install xml-dom
install parse-yapp
install datemanip
2: download xml-xql from:
http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
3: open command prompt and locate perl"s lib directory with:
perl -e "print qq(@INC)" (mine was C:[[/Perl/site/lib]])
4: unpack xml-xql archive
5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

== Plugin Effects ==
I have absolutely no idea. Please record your success here. :)

== What if it doesn't work? ==
Run Inkscape from the console

Use the error messges printed to the console to diagnose the problem (very often missing dependencies)

On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

[[Category:Extensions]]

CompilingMacOsX

2007-12-16T23:29:13Z

Jiho: Overall review, updated according to progress on MacPorts side

= For the impatient =

1. Install [http://developer.apple.com/tools/xcode/ XCode tools] from your OS X installation DVD

2. Download and install [http://www.macports.org/ MacPorts]

3. In Terminal (Applications>Utilities>Terminal) type
<pre>sudo port sync
sudo port selfupdate
sudo port install cairo +pdf boehmgc gtkmm intltool libxslt lcms popt poppler boost gnome-vfs \
libgnomeprintui automake autoconf subversion</pre>
Grab a cup of cofee

4. In Terminal, get and build Inkscape
<pre>
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/inkscape/trunk inkscape
cd inkscape/packaging/macosx/
./osx-build.sh a c b i -s p</pre>

''Et voilà''. If you want to understand what you've just did, read on.

= Requirements =
To compile Inkscape from source you need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD, in the optional installs, or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download an [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion]. Subversion comes pre-installed on Leopard. On previous system, subversion can be installed by package management systems (see point below) or with an OS X installer [http://homepage.mac.com/martinott/ package]
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehmgc... We recommend the use of [http://www.macports.org/ MacPorts] right now. [http://www.finkproject.org/ Fink] was used in the past but there is no information about wether it meets Inkscape needs currently. Alternatively you could use Inkscape all-in-one universal build script to install them (see below).

= Compiling Inkscape with X11, using MacPorts [Recommended method]=

== Installing dependencies ==
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
* <code>cairo +pdf</code> (cairo with the pdf variant) : better pdf export
* <code>poppler</code> : better pdf import
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth cairo +pdf poppler</pre>
NB: Cairo was already installed at previous step as a GTK dependency. You need to either deactivate the old version and install this one, or directly write it on the command line above.

In addition, Inkscape requires versions of the autotools more recent thant those that ship with OS X. Install them:
<pre>sudo port install autoconf automake</pre>

== Setting the build environment ==
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

== Configuring ==
If you compile Inkscape for the first time from an svn checkout you need to generate the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

== Building and Installing ==
Just run:
<pre>make
make install</pre>

== Creating an .app bundle ==
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

== Creating a disk image to distribute Inkscape ==
Inkscape.app created at the previous step is completely independent from the original location of MacPorts libraries and can therefore be distributed. It will only work on your platform though (PPC or Intel) and incompatibilities are known between X11 versions on different major versions of OS X (Panther, Tiger and Leopard). The general rule is that versions are not backward compatible.

The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background and all, using the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Automated build script ==
All these steps are automated by a build script: <code>osx-build.sh</code>. It has built-in help so to known how to use it just type:
<pre>./osx-build.sh help</pre>

= Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script [untested]=

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Compiling Inkscape with native GTK using MacPorts [experimental] =
This process is very similar to compiling an X11 version of Inkscape except for the building of dependencies: need to build native versions of Inkscape dependencies. At the moment (2007-12-17) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

== Native version of Inkscape dependencies ==
Thanks to the power of port "variants" and port "deactivation" you can install native versions of gtk, cairo, pango and such, alongside the regular X11 ones. To know which ports have a <code>quartz</code> or <code>no_x11</code> variant, use the command:
<pre>port list variant:quartz variant:no_x11</pre>
This will give you an idea of what need to be replaced.

Assuming your MacPorts tree has been already used to build regular versions of Inkscape, you first need to deactivate (suppress from the tree without really uninstalling) the X11 versions of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm pango</pre>

Then install native variants:
<pre>sudo port install cairo +quartz+pdf+no_x11 cairomm +quartz pango +no_x11 poppler +quartz gtk2 +quartz</pre>

== Install the rest ==
Eventually, follow the regular install procedure for the rest:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
If your MacPorts tree was already ready to compile Inkscape, you should not need to reinstall anything, with the possible exception of gtkmm, which may need to be rebuilt against the native version of gtk rather than against the X11 one (please someone confirm this).

Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit <code>osx-build.sh</code> to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>

NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme or recompile it with the new native GTK.

= Compiling Inkscape with native GTK using the all in one build script [experimental] =

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
<pre>export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape
</pre>

= Enabling python effects =
moved to [[GettingEffectsWorking]]. They should work out of the box in the new versions anyway.

= Links =

== Apple Documentation ==
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

== Packaging ==

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-12-15T15:37:12Z

Jiho: /* Requirements */

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X > 10.3
*XCode Tools. They are on your installation DVD in the optional installs or can be download from [http://developer.apple.com/tools/xcode/ Apple Developer Connection]. You can customize the install to make it smaller (avoir documentation and example software for example). You need at least: gcc, XCode, X11SDK.
*Inkscape's source code. You can download the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D development snapshot] or checkout a copy of the current state of the [http://www.inkscape.org/svn.php?lang=en SVN repository] using [http://subversion.tigris.org/ subversion].
*A means of getting Inkscape's numerous dependencies: glibmm, gtkmm, lmcs, boehm gc... We recommend the use of [http://www.macports.org/ MacPorts] right now. [http://www.finkproject.org/ Fink] was used in the past but there is no information about wether it meets Inkscape needs currently. Alternatively you could use Inkscape all-in-one universal build script to install them.

== Compiling Inkscape with X11, using MacPorts ==

=== Installing dependencies ===
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has built-in help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to update from svn, generate the configure script, configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh update autogen configure build install -s package</pre>
or more simply
<pre>./osx-build.sh u a c b i -s p</pre>
or even more simply
<pre>./osx-build.sh all -s</pre>

=== Step by step instructions ===
If you want to know what you are doing or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

You can also add pre-compiled python modules to the app, which other users can take advantage of. See the built in help for the syntax:
<pre>./osx-app.sh -h</pre>

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independent from the original location of the libraries and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script ==

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape with native GTK using MacPorts [experimental] ==
This process will be very similar to compiling a X11 version of Inkscape except for the building of dependencies: you will need to build native versions of GTK and Cairo.
At the moment (2007-09-31) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

=== Native version of GTK and Cairo ===
In theory you should be able to install a second MacPorts tree independent from your usual one (in /opt/local-native/ for example) but I did not manage to have the two cohabit so I would advise doing everything in your regular MacPorts tree. However, this should not be too much of a problem thanks to the power of port "variants" and port "deactivation".

You need to deactivate (suppress from the tree without really uninstalling) current version of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm</pre>
Then install native variants:
<pre>sudo port install cairo +quartz cairomm +quartz gtk2 +quartz</pre>
There is currently an incompatibility with gtk and cairo native ports. It is reported in this ticket at MacPorts [http://trac.macports.org/projects/macports/ticket/11745]
(Note 22/10/07 : with my freshly installed MacPorts I did not get any compile errors and skipped the patch, the ticket is still open though)
You need to edit the Portfile for gtk2 according to the Portfile patch:
<pre>sudo port edit gtk2</pre>
and add the patch to the <code>files</code> directory next to the Portfile. If you edit your file in a Cocoa editor just Command+click on the filename in the window title bar and this will bring a menu with the file hierarchy down to the Portfile. Go one step up and you're there. Otherwise the path is <pre>/opt/localquartz/var/macports/sources/rsync.macports.org/release/ports/x11/gtk2</pre>

=== Pango without X requirements ===

(Note 22/10/07 : with my freshly installed MacPorts this variant was already there)

Then you need to prevent Pango to try using Xft or X to render fonts. To do this kind of cleanly we'll create a new variant for Pango, called <code>no_x</code>. So:
<pre>sudo port edit pango</pre>
and, after configure.arg add:
<pre>variant no_x description {Remove X and Xft rendering} {
configure.args-append --with-x=no
depends_lib-delete lib:libX11.6:XFree86 \
port:Xft2
}</pre>
The deactivate pango and install the new variant:
<pre>sudo port deactivate pango
sudo port install pango +no_x</pre>

=== Install the rest ===
Eventually, follow the regular install procedure:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit osx-build.sh to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>
NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme.

== Compiling Inkscapewith native GTK using the all in one build script [experimental] ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
moved to [[GettingEffectsWorking]]

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-11-03T23:27:55Z

Jiho: /* Creating a disk image to distribute Inkscape */

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X > 10.3
*XCode Tools (with gcc)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies: glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape with X11, using MacPorts ==

=== Installing dependencies ===
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has built-in help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to update from svn, generate the configure script, configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh update autogen configure build install -s package</pre>
or more simply
<pre>./osx-build.sh u a c b i -s p</pre>
or even more simply
<pre>./osx-build.sh all -s</pre>

=== Step by step instructions ===
If you want to know what you are doing or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

You can also add pre-compiled python modules to the app, which other users can take advantage of. See the built in help for the syntax:
<pre>./osx-app.sh -h</pre>

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independent from the original location of the libraries and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh -p Inkscape.app</pre>
in the packaging directory for Mac OS X (where your app bundle should be, otherwise modify the path to Inkscape.app).

== Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script ==

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape with native GTK using MacPorts [experimental] ==
This process will be very similar to compiling a X11 version of Inkscape except for the building of dependencies: you will need to build native versions of GTK and Cairo.
At the moment (2007-09-31) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

=== Native version of GTK and Cairo ===
In theory you should be able to install a second MacPorts tree independent from your usual one (in /opt/local-native/ for example) but I did not manage to have the two cohabit so I would advise doing everything in your regular MacPorts tree. However, this should not be too much of a problem thanks to the power of port "variants" and port "deactivation".

You need to deactivate (suppress from the tree without really uninstalling) current version of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm</pre>
Then install native variants:
<pre>sudo port install cairo +quartz cairomm +quartz gtk2 +quartz</pre>
There is currently an incompatibility with gtk and cairo native ports. It is reported in this ticket at MacPorts [http://trac.macports.org/projects/macports/ticket/11745]
(Note 22/10/07 : with my freshly installed MacPorts I did not get any compile errors and skipped the patch, the ticket is still open though)
You need to edit the Portfile for gtk2 according to the Portfile patch:
<pre>sudo port edit gtk2</pre>
and add the patch to the <code>files</code> directory next to the Portfile. If you edit your file in a Cocoa editor just Command+click on the filename in the window title bar and this will bring a menu with the file hierarchy down to the Portfile. Go one step up and you're there. Otherwise the path is <pre>/opt/localquartz/var/macports/sources/rsync.macports.org/release/ports/x11/gtk2</pre>

=== Pango without X requirements ===

(Note 22/10/07 : with my freshly installed MacPorts this variant was already there)

Then you need to prevent Pango to try using Xft or X to render fonts. To do this kind of cleanly we'll create a new variant for Pango, called <code>no_x</code>. So:
<pre>sudo port edit pango</pre>
and, after configure.arg add:
<pre>variant no_x description {Remove X and Xft rendering} {
configure.args-append --with-x=no
depends_lib-delete lib:libX11.6:XFree86 \
port:Xft2
}</pre>
The deactivate pango and install the new variant:
<pre>sudo port deactivate pango
sudo port install pango +no_x</pre>

=== Install the rest ===
Eventually, follow the regular install procedure:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit osx-build.sh to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>
NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme.

== Compiling Inkscapewith native GTK using the all in one build script [experimental] ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
moved to [[GettingEffectsWorking]]

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-11-03T23:26:15Z

Jiho: /* Creating an .app bundle */ add a note about python packages

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X > 10.3
*XCode Tools (with gcc)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies: glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape with X11, using MacPorts ==

=== Installing dependencies ===
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has built-in help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to update from svn, generate the configure script, configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh update autogen configure build install -s package</pre>
or more simply
<pre>./osx-build.sh u a c b i -s p</pre>
or even more simply
<pre>./osx-build.sh all -s</pre>

=== Step by step instructions ===
If you want to know what you are doing or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s -b /path/to/install/prefix/bin/inkscape -p ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

You can also add pre-compiled python modules to the app, which other users can take advantage of. See the built in help for the syntax:
<pre>./osx-app.sh -h</pre>

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independent from the original location of the libraries and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script ==

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape with native GTK using MacPorts [experimental] ==
This process will be very similar to compiling a X11 version of Inkscape except for the building of dependencies: you will need to build native versions of GTK and Cairo.
At the moment (2007-09-31) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

=== Native version of GTK and Cairo ===
In theory you should be able to install a second MacPorts tree independent from your usual one (in /opt/local-native/ for example) but I did not manage to have the two cohabit so I would advise doing everything in your regular MacPorts tree. However, this should not be too much of a problem thanks to the power of port "variants" and port "deactivation".

You need to deactivate (suppress from the tree without really uninstalling) current version of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm</pre>
Then install native variants:
<pre>sudo port install cairo +quartz cairomm +quartz gtk2 +quartz</pre>
There is currently an incompatibility with gtk and cairo native ports. It is reported in this ticket at MacPorts [http://trac.macports.org/projects/macports/ticket/11745]
(Note 22/10/07 : with my freshly installed MacPorts I did not get any compile errors and skipped the patch, the ticket is still open though)
You need to edit the Portfile for gtk2 according to the Portfile patch:
<pre>sudo port edit gtk2</pre>
and add the patch to the <code>files</code> directory next to the Portfile. If you edit your file in a Cocoa editor just Command+click on the filename in the window title bar and this will bring a menu with the file hierarchy down to the Portfile. Go one step up and you're there. Otherwise the path is <pre>/opt/localquartz/var/macports/sources/rsync.macports.org/release/ports/x11/gtk2</pre>

=== Pango without X requirements ===

(Note 22/10/07 : with my freshly installed MacPorts this variant was already there)

Then you need to prevent Pango to try using Xft or X to render fonts. To do this kind of cleanly we'll create a new variant for Pango, called <code>no_x</code>. So:
<pre>sudo port edit pango</pre>
and, after configure.arg add:
<pre>variant no_x description {Remove X and Xft rendering} {
configure.args-append --with-x=no
depends_lib-delete lib:libX11.6:XFree86 \
port:Xft2
}</pre>
The deactivate pango and install the new variant:
<pre>sudo port deactivate pango
sudo port install pango +no_x</pre>

=== Install the rest ===
Eventually, follow the regular install procedure:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit osx-build.sh to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>
NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme.

== Compiling Inkscapewith native GTK using the all in one build script [experimental] ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
moved to [[GettingEffectsWorking]]

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

TangoifiedIcons

2007-10-30T01:06:57Z

Jiho: Expanded the introductory text

== The reasoning ==

Many GTK applications (including the whole Gnome desktop) are using Tango icons. These icons are designed to look nice in many environments (on all kinds of backgrounds and in many different OSes). So both for unification purposes on Linux and for cross-platform reasons, it would be nice to have a complete Tangoified Inkscape Icon Set for a future release (hopefully sooner rather than later).

The Tangoified set [http://gnomelook.org/content/show.php/Tangofied+inkscape+icons+set?content=48140 here] is lacking many icons. It is based on the [http://tango.freedesktop.org/ArtLibreSet Tango ArtLibre Icon Set], which Gimp also uses.

This page is a place to list all the icons Inkscape needs, the corresponding icons (whether they exists already or not) in the [http://tango.freedesktop.org/ArtLibreSet ArtLibre Set] and the proposed Tangoified icon for Inkscape. This would be the ArtLibre icon directly or an improved version, made to fit withing Inkscape more properly.

== Standard naming and loading ==

We should try to get Inkscape loading those from standard calls and naming so that users can switch icons externally. The [http://tango.freedesktop.org/Tango_Icon_Library#Download Tango naming utilities] and following the [http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html Icon Naming Specification] might help.

To get things going well, we also would probably need to get Inkscape to hook itself in a standard GTK+ icon source. (So Inkscape would ask GTK+ to get an icon for it, and GTK+ would turn around and ask Inkscape to provide that icon).

Furthermore, and icon set switcher would be nice to void fidling with SVG files in .inkscape/icons/

== The Icons ==

There are 246 unique inkscape icons. All of them are listed in the following tables. Each of which is structured as follows: an image of current Inkscape icon, the name of this icon in Inkscape, the size at which the SVG should be designed (in pixels) to look crisp in standard GTK themes, a short description of the tool, the corresponding ArtLibre icon and ArtLibre icon name (NA if it does not exists), an image of the proposed replacement icon.

All image need to be manually uploaded. If you wish to help upload a few to this wiki, you can download a ZIP file of all icons already named from [http://www.microugly.com/orig-inkscape-icons.zip]

=== Drawing tools ===

<table>
<tr>
<th scope="row">Icon</th>

<th scope="row">Icon name</th>

<th scope="row">px Size</th>

<th scope="row">Description</th>

<th scope="row">Tango Icon</th>

<th scope="row">Tango Name</th>

<th scope="row">Proposed Icon</th>
</tr>

<tr>
<td>[[Image:orig_draw_select.png]]</td>

<td>draw_select</td>

<td>24</td>

<td>Pointer tool</td>

<td> </td>

<td>tool-pointer</td>

<td>[[Image:tool-pointer.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_node.png]]</td>

<td>draw_node</td>

<td>24</td>

<td>Node selection tool</td>

<td>NA</td>

<td>NA</td>

<td>[[Image:tool-node.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_tweak.png]]</td>

<td>draw_tweak</td>

<td>24</td>

<td></td>
<td>NA</td>

<td>NA</td>

<td>NA</td>
</tr>

<tr>
<td>[[Image:orig_draw_zoom.png]]</td>

<td>draw_zoom</td>

<td>24</td>

<td>Page Magnifier tool</td>

<td></td>

<td>page-magnifier</td>

<td>[[Image:page-magnifier.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_rect.png]]</td>

<td>draw_rect</td>

<td>24</td>

<td></td>

<td></td>

<td>draw-rectangle</td>

<td>[[Image:draw-rectangle.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_arc.png]]</td>

<td>draw_arc</td>

<td>24</td>

<td></td>

<td></td>
<td>draw-ellipse</td>

<td>[[Image:draw-arc.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_star.png]]</td>

<td>draw_star</td>

<td>24</td>

<td></td>
<td></td>

<td>draw-star</td>

<td>[[Image:draw-star.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_spiral.png]]</td>

<td>draw_spiral</td>

<td>24</td>

<td></td>

<td>NA</td>
<td>NA</td>

<td>[[Image:draw-spiral.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_freehand.png]]</td>

<td>draw freehand</td>

<td>24</td>

<td></td>
<td></td>

<td>draw-freehand</td>

<td>[[Image:draw-freehand.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_pen.png]]</td>

<td>draw pen</td>

<td>24</td>

<td></td>

<td></td>
<td></td>

<td>[[Image:draw-pen.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_calligraphic.png]]</td>

<td>draw calligraphic</td>

<td>24</td>

<td></td>
<td></td>

<td> </td>

<td>[[Image:draw-calligraphic.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_paintbucket.png]]</td>

<td>draw paintbucket</td>

<td>24</td>

<td></td>
<td></td>

<td> </td>

<td>[[Image:draw-fill.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_text.png]]</td>

<td>draw text</td>

<td>24</td>

<td></td>
<td></td>

<td> </td>

<td>[[Image:draw-text.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_connector.png]]</td>

<td>draw connector</td>

<td>24</td>

<td></td>

<td></td>
<td></td>

<td>[[Image:draw-connector.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_gradient.png]]</td>

<td>draw gradient</td>

<td>24</td>

<td></td>
<td></td>

<td> </td>

<td>[[Image:draw-gradient.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_dropper.png]]</td>

<td>draw dropper</td>

<td>24</td>

<td></td>
<td></td>

<td> </td>

<td>[[Image:draw-dropper.png]]</td>
</tr>
</table>

=== Tool Controls ===
==== Select Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_object_flip_hor.png]]</td> <td>object flip hor</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_flip_ver.png]]</td> <td>object flip ver</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_rotate_90_CCW.png]]</td> <td>object rotate 90 CCW</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_rotate_90_CW.png]]</td> <td>object rotate 90 CW</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr>
<td>[[Image:orig_selection_up.png]]</td>
<td>selection up</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr> <td>[[Image:orig_selection_bot.png]]</td> <td>selection bot</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr>
<td>[[Image:orig_selection_down.png]]</td>
<td>selection down</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_top.png]]</td>
<td>selection top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr> <td>[[Image:orig_selection_deselect.png]]</td> <td>selection deselect</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_selection_select_all.png]]</td> <td>selection select all</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_selection_select_all_in_all_layers.png]]</td> <td>selection select all in all layers</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_corners.png]]</td> <td>transform corners</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_gradient.png]]</td> <td>transform gradient</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_pattern.png]]</td> <td>transform pattern</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_stroke.png]]</td> <td>transform stroke</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Node Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_nodes_show_handles.png]]</td> <td>nodes show handles</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_break.png]]</td> <td>node break</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_curve.png]]</td> <td>node curve</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_cusp.png]]</td> <td>node cusp</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_delete.png]]</td> <td>node delete</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_delete_segment.png]]</td> <td>node delete segment</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_insert.png]]</td> <td>node insert</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_join.png]]</td> <td>node join</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_join_segment.png]]</td> <td>node join segment</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_line.png]]</td> <td>node line</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_smooth.png]]</td> <td>node smooth</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_symmetric.png]]</td> <td>node symmetric</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_stroke_tocurve.png]]</td> <td>stroke tocurve</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_tocurve.png]]</td> <td>object tocurve</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Tweak Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_tweak_attract_mode.png]]</td> <td>tweak attract mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_colorjitter_mode.png]]</td> <td>tweak colorjitter mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_colorpaint_mode.png]]</td> <td>tweak colorpaint mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_grow_mode.png]]</td> <td>tweak grow mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_push_mode.png]]</td> <td>tweak push mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_repel_mode.png]]</td> <td>tweak repel mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_roughen_mode.png]]</td> <td>tweak roughen mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_shrink_mode.png]]</td> <td>tweak shrink mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_guse_pressure.png]]</td> <td>guse pressure</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Zoom Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr>
<td>[[Image:orig_zoom_1_to_1.png]]</td>
<td>zoom 1 to 1</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-original.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_1_to_2.png]]</td>
<td>zoom 1 to 2</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-1-to-2.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_2_to_1.png]]</td>
<td>zoom 2 to 1</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-2-to-1.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_draw.png]]</td>
<td>zoom draw</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-drawing.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_in.png]]</td>
<td>zoom in</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-in.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_next.png]]</td>
<td>zoom next</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-next.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_out.png]]</td>
<td>zoom out</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-out.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_page.png]]</td>
<td>zoom page</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-page.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_pagewidth.png]]</td>
<td>zoom pagewidth</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-page-width.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_previous.png]]</td>
<td>zoom previous</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-previous.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_select.png]]</td>
<td>zoom select</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-selection.png]]</td>
</tr>
</table>

==== Rectangle Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_squared_corner.png]]</td> <td>squared corner</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Arc Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_circle_closed_arc.png]]</td> <td>circle closed arc</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_circle_open_arc.png]]</td> <td>circle open arc</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_reset_circle.png]]</td>
<td>reset circle</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Star Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_star_angled.png]]</td>
<td>star angled</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_star_flat.png]]</td>
<td>star flat</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Calligraphic Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_trace_background.png]]</td>
<td>trace background</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_guse_tilt.png]]</td>
<td>guse tilt</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_guse_pressure.png]]</td>
<td>guse pressure</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Text Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_writing_mode_lr.png]]</td>
<td>writing mode lr</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_writing_mode_tb.png]]</td>
<td>writing mode tb</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Connector Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_connector_avoid.png]]</td>
<td>connector avoid</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_connector_ignore.png]]</td>
<td>connector ignore</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_directed_graph.png]]</td>
<td>directed graph</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_overlaps.png]]</td>
<td>remove overlaps</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Gradient Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_fill_radial.png]]</td>
<td>fill radial</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_controls_fill.png]]</td>
<td>controls fill</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_controls_stroke.png]]</td>
<td>controls stroke</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_gradient.png]]</td>
<td>fill gradient</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Dropper Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_color_alpha_get.png]]</td>
<td>color alpha get</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_color_alpha_set.png]]</td>
<td>color alpha set</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
=== Palettes ===
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_object_font.png]]</td>
<td>object font</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_xml_editor.png]]</td>
<td>xml editor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_align.png]]</td>
<td>object align</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_trans.png]]</td>
<td>object trans</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_and_stroke.png]]</td>
<td>fill and stroke</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_grid_arrange.png]]</td>
<td>grid arrange</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_layers.png]]</td>
<td>layers</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td> </td>
<td> </td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Fill and Stroke ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_properties_fill.png]]</td>
<td>properties fill</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_properties_stroke_paint.png]]</td>
<td>properties stroke paint</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_properties_stroke.png]]</td>
<td>properties stroke</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_none.png]]</td>
<td>fill none</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_gradient.png]]</td>
<td>fill gradient</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_radial.png]]</td>
<td>fill radial</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_pattern.png]]</td>
<td>fill pattern</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_solid.png]]</td>
<td>fill solid</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_unset.png]]</td>
<td>fill unset</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fillrule_evenodd.png]]</td>
<td>fillrule evenodd</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fillrule_nonzero.png]]</td>
<td>fillrule nonzero</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cap_butt.png]]</td>
<td>cap butt</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cap_round.png]]</td>
<td>cap round</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cap_square.png]]</td>
<td>cap square</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_join_bevel.png]]</td>
<td>join bevel</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_join_miter.png]]</td>
<td>join miter</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_join_round.png]]</td>
<td>join round</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Transform ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_arrows_hor.png]]</td>
<td>arrows hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_arrows_ver.png]]</td>
<td>arrows ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_rotate.png]]</td>
<td>transform rotate</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scale_hor.png]]</td>
<td>transform scale hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scale_ver.png]]</td>
<td>transform scale ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scew_hor.png]]</td>
<td>transform scew hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scew_ver.png]]</td>
<td>transform scew ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Align and Distribute ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_al_baselines_hor.png]]</td>
<td>al baselines hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_baselines_vert.png]]</td>
<td>al baselines vert</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_bottom_in.png]]</td>
<td>al bottom in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_bottom_out.png]]</td>
<td>al bottom out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_center_hor.png]]</td>
<td>al center hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_center_ver.png]]</td>
<td>al center ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_left_in.png]]</td>
<td>al left in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_left_out.png]]</td>
<td>al left out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_right_in.png]]</td>
<td>al right in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_right_out.png]]</td>
<td>al right out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_top_in.png]]</td>
<td>al top in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_top_out.png]]</td>
<td>al top out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_baselines_hor.png]]</td>
<td>distribute baselines hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_baselines_vert.png]]</td>
<td>distribute baselines vert</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_bottom.png]]</td>
<td>distribute bottom</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_hcentre.png]]</td>
<td>distribute hcentre</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_hdist.png]]</td>
<td>distribute hdist</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_left.png]]</td>
<td>distribute left</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_randomize.png]]</td>
<td>distribute randomize</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_right.png]]</td>
<td>distribute right</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_top.png]]</td>
<td>distribute top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_vcentre.png]]</td>
<td>distribute vcentre</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_vdist.png]]</td>
<td>distribute vdist</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_unclump.png]]</td>
<td>unclump</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_graph_layout.png]]</td>
<td>graph layout</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_overlaps.png]]</td>
<td>remove overlaps</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_halign.png]]</td>
<td>node halign</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_hdistribute.png]]</td>
<td>node hdistribute</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_valign.png]]</td>
<td>node valign</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_vdistribute.png]]</td>
<td>node vdistribute</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Grid Arrange ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row.png]]</td>
<td>clonetiler per row</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column.png]]</td>
<td>clonetiler per column</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Text ====
<p>Text icons are not currently used.</p>
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_text_horz_kern.png]]</td>
<td>text horz kern</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_letter_spacing.png]]</td>
<td>text letter spacing</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_line_spacing.png]]</td>
<td>text line spacing</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_remove_kerns.png]]</td>
<td>text remove kerns</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_vert_kern.png]]</td>
<td>text vert kern</td>
<td> </td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_rotation.png]]</td>
<td>text_rotation</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Clone ====
<p>Clone icons are not currently used.</p>
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_color.png]]</td>
<td>clonetiler per column color</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_opacity.png]]</td>
<td>clonetiler per column opacity</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_rotation.png]]</td>
<td>clonetiler per column rotation</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_scale.png]]</td>
<td>clonetiler per column scale</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_shift.png]]</td>
<td>clonetiler per column shift</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_color.png]]</td>
<td>clonetiler per row color</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_opacity.png]]</td>
<td>clonetiler per row opacity</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_rotation.png]]</td>
<td>clonetiler per row rotation</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_scale.png]]</td>
<td>clonetiler per row scale</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_shift.png]]</td>
<td>clonetiler per row shift</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== XML Editor ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_add_xml_element_node.png]]</td>
<td>add xml element node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_add_xml_text_node.png]]</td>
<td>add xml text node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_duplicate_xml_node.png]]</td>
<td>duplicate xml node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_delete_xml_node.png]]</td>
<td>delete xml node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_delete_xml_attribute.png]]</td>
<td>delete xml attribute</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Layers ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_visible.png]]</td>
<td>visible</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_width_height_lock.png]]</td>
<td>width height lock</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_hidden.png]]</td>
<td>hidden</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_lock_unlocked.png]]</td>
<td>lock unlocked</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
=== Menus ===
==== File ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_file_export.png]]</td>
<td>file export</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_file_import.png]]</td>
<td>file import</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_file_vacuum.png]]</td>
<td>file vacuum</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_document_metadata.png]]</td>
<td>document metadata</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_input_devices.png]]</td>
<td>input devices</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_ocal_export.png]]</td>
<td>ocal export</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_ocal_import.png]]</td>
<td>ocal import</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Edit ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_edit_undo_history.png]]</td>
<td>edit undo history</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_paste_in_place.png]]</td>
<td>selection paste in place</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_paste_style.png]]</td>
<td>selection paste style</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_clone.png]]</td>
<td>edit clone</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_create_tiled_clones.png]]</td>
<td>edit create tiled clones</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_duplicate.png]]</td>
<td>edit duplicate</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_select_original.png]]</td>
<td>edit select original</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_unlink_clone.png]]</td>
<td>edit unlink clone</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_bitmap.png]]</td>
<td>selection bitmap</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_invert.png]]</td>
<td>selection invert</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_deselect.png]]</td>
<td>selection deselect</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== View ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_zoom_1_to_1.png]]</td>
<td>zoom 1 to 1</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_1_to_2.png]]</td>
<td>zoom 1 to 2</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_2_to_1.png]]</td>
<td>zoom 2 to 1</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_draw.png]]</td>
<td>zoom draw</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_in.png]]</td>
<td>zoom in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_next.png]]</td>
<td>zoom next</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_out.png]]</td>
<td>zoom out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_page.png]]</td>
<td>zoom page</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_pagewidth.png]]</td>
<td>zoom pagewidth</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_previous.png]]</td>
<td>zoom previous</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_select.png]]</td>
<td>zoom select</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_grid.png]]</td>
<td>grid</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_guides.png]]</td>
<td>guides</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_dialog_toggle.png]]</td>
<td>dialog toggle</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_swatches.png]]</td>
<td>swatches</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_messages.png]]</td>
<td>messages</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_scripts.png]]</td>
<td>scripts</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_window_next.png]]</td>
<td>window next</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_window_previous.png]]</td>
<td>window previous</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_view_icon_preview.png]]</td>
<td>view icon preview</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_view_new.png]]</td>
<td>view new</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fullscreen.png]]</td>
<td>fullscreen</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Layer ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_new_layer.png]]</td>
<td>new layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_rename_layer.png]]</td>
<td>rename layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_switch_to_layer_above.png]]</td>
<td>switch to layer above</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_switch_to_layer_below.png]]</td>
<td>switch to layer below</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_move_selection_above.png]]</td>
<td>move selection above</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_move_selection_below.png]]</td>
<td>move selection below</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_layer_to_bottom.png]]</td>
<td>layer to bottom</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_layer_to_top.png]]</td>
<td>layer to top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_raise_layer.png]]</td>
<td>raise layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_lower_layer.png]]</td>
<td>lower layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_delete_layer.png]]</td>
<td>delete layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Object ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_selection_group.png]]</td>
<td>selection group</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_ungroup.png]]</td>
<td>selection ungroup</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_up.png]]</td>
<td>selection up</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_bot.png]]</td>
<td>selection bot</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_down.png]]</td>
<td>selection down</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_top.png]]</td>
<td>selection top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_flip_hor.png]]</td>
<td>object flip hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_flip_ver.png]]</td>
<td>object flip ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_rotate_90_CCW.png]]</td>
<td>object rotate 90 CCW</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_rotate_90_CW.png]]</td>
<td>object rotate 90 CW</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Path ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_stroke_tocurve.png]]</td>
<td>stroke tocurve</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_tocurve.png]]</td>
<td>object tocurve</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_trace.png]]</td>
<td>selection trace</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_union.png]]</td>
<td>union</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_difference.png]]</td>
<td>difference</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_division.png]]</td>
<td>division</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_exclusion.png]]</td>
<td>exclusion</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_break.png]]</td>
<td>selection break</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_combine.png]]</td>
<td>selection combine</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_linked_offset.png]]</td>
<td>linked offset</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_dynamic_offset.png]]</td>
<td>dynamic offset</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_outset_path.png]]</td>
<td>outset path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_inset_path.png]]</td>
<td>inset path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_intersection.png]]</td>
<td>intersection</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cut_path.png]]</td>
<td>cut path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_simplify.png]]</td>
<td>simplify</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_reverse.png]]</td>
<td>selection reverse</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Text ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_put_on_path.png]]</td>
<td>put on path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_from_path.png]]</td>
<td>remove from path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_flow_into_frame.png]]</td>
<td>flow into frame</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_unflow.png]]</td>
<td>unflow</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_convert_to_text.png]]</td>
<td>convert to text</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_manual_kerns.png]]</td>
<td>remove manual kerns</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Help ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_about_memory.png]]</td>
<td>about memory</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_inkscape_options.png]]</td>
<td>inkscape options</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Extras ====
<p>These icons may need classification or may be unused.</p>
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_3dbox_four_handles.png]]</td> <td>3dbox four handles</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_3dbox_three_handles.png]]</td> <td>3dbox three handles</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_dialog_item_properties.png]]</td> <td>dialog item properties</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_draw_3dbox.png]]</td> <td>draw 3dbox</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_file_open_recent.png]]</td> <td>file open recent</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_help_keys.png]]</td> <td>help keys</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_help_tutorials.png]]</td> <td>help tutorials</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_inkscape.file.png]]</td> <td>inkscape.file</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_sticky_zoom.png]]</td> <td>sticky zoom</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_toggle_vp_x.png]]</td> <td>toggle vp x</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_toggle_vp_y.png]]</td> <td>toggle vp y</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_toggle_vp_z.png]]</td> <td>toggle vp z</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

TangoifiedIcons

2007-10-28T12:08:04Z

Jiho: /* Drawing tools */ Changed column headers, added tango name, added NAs where Tango does not exist. To be continued tomorrow

It would be nice to have a complete Tangoified Inkscape Icon Set for a future release (hopefully sooner rather than later).

The current set [http://gnomelook.org/content/show.php/Tangofied+inkscape+icons+set?content=48140 here] is lacking many icons. It is based on the [http://tango.freedesktop.org/ArtLibreSet Tango ArtLibre Icon Set], which also Gimp is using.

Maybe this would be a good place to list all the icons Inkscape needs and the corresponding icon places (whether filled or not) in the [http://tango.freedesktop.org/ArtLibreSet ArtLibre Set].

== Standard naming and loading ==

We should try to get Inkscape loading those from standard calls and naming so that users can switch icons externally. The [http://tango.freedesktop.org/Tango_Icon_Library#Download Tango naming utilities] and following the [http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html Icon Naming Specification] might help.

To get things going well, we also would probably need to get Inkscape to hook itself in as a standard GTK+ icon source. (So Inkscape would ask GTK+ to get an icon for it, and GTK+ would turn around and ask Inkscape to provide that icon).

== The Icons ==
<p>There are 246 unique inkscape icons. If you would like to help upload a few to this wiki, you can download a ZIP file of all icons already named from [http://www.microugly.com/orig-inkscape-icons.zip]
=== Drawing tools ===

<table>
<tr>
<th scope="row">Icon</th>

<th scope="row">Icon name</th>

<th scope="row">px Size</th>

<th scope="row">Description</th>

<th scope="row">Tango Icon</th>

<th scope="row">Tango Name</th>

<th scope="row">Proposed Icon</th>
</tr>

<tr>
<td>[[Image:orig_draw_select.png]]</td>

<td>draw_select</td>

<td>24</td>

<td>Pointer tool</td>

<td> </td>

<td>tool-pointer</td>

<td>[[Image:tool-pointer.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_node.png]]</td>

<td>draw_node</td>

<td>24</td>

<td>Node selection tool</td>

<td>NA</td>

<td>NA</td>

<td>[[Image:tool-node.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_tweak.png]]</td>

<td>draw_tweak</td>

<td>24</td>

<td></td>
<td>NA</td>

<td>NA</td>

<td>NA</td>
</tr>

<tr>
<td>[[Image:orig_draw_zoom.png]]</td>

<td>draw_zoom</td>

<td>24</td>

<td>Page Magnifier tool</td>

<td></td>

<td>page-magnifier</td>

<td>[[Image:page-magnifier.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_rect.png]]</td>

<td>draw_rect</td>

<td>24</td>

<td></td>

<td></td>

<td>draw-rectangle</td>

<td>[[Image:draw-rectangle.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_arc.png]]</td>

<td>draw_arc</td>

<td>24</td>

<td></td>

<td></td>
<td>draw-ellipse</td>

<td>[[Image:draw-arc.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_star.png]]</td>

<td>draw_star</td>

<td>24</td>

<td></td>
<td></td>

<td>draw-star</td>

<td>[[Image:draw-star.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_spiral.png]]</td>

<td>draw_spiral</td>

<td>24</td>

<td></td>

<td>NA</td>
<td>NA</td>

<td>[[Image:draw-spiral.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_freehand.png]]</td>

<td>draw freehand</td>

<td>24</td>

<td></td>
<td></td>

<td>draw-freehand</td>

<td>[[Image:draw-freehand.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_pen.png]]</td>

<td>draw pen</td>

<td>24</td>

<td></td>

<td></td>
<td></td>

<td>[[Image:draw-pen.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_calligraphic.png]]</td>

<td>draw calligraphic</td>

<td>24</td>

<td></td>
<td></td>

<td> </td>

<td>[[Image:draw-calligraphic.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_paintbucket.png]]</td>

<td>draw paintbucket</td>

<td>24</td>

<td></td>
<td></td>

<td> </td>

<td>[[Image:draw-fill.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_text.png]]</td>

<td>draw text</td>

<td>24</td>

<td></td>
<td></td>

<td> </td>

<td>[[Image:draw-text.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_connector.png]]</td>

<td>draw connector</td>

<td>24</td>

<td></td>

<td></td>
<td></td>

<td>[[Image:draw-connector.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_gradient.png]]</td>

<td>draw gradient</td>

<td>24</td>

<td></td>
<td></td>

<td> </td>

<td>[[Image:draw-gradient.png]]</td>
</tr>

<tr>
<td>[[Image:orig_draw_dropper.png]]</td>

<td>draw dropper</td>

<td>24</td>

<td></td>
<td></td>

<td> </td>

<td>[[Image:draw-dropper.png]]</td>
</tr>
</table>

=== Tool Controls ===
==== Select Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_object_flip_hor.png]]</td> <td>object flip hor</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_flip_ver.png]]</td> <td>object flip ver</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_rotate_90_CCW.png]]</td> <td>object rotate 90 CCW</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_rotate_90_CW.png]]</td> <td>object rotate 90 CW</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr>
<td>[[Image:orig_selection_up.png]]</td>
<td>selection up</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr> <td>[[Image:orig_selection_bot.png]]</td> <td>selection bot</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr>
<td>[[Image:orig_selection_down.png]]</td>
<td>selection down</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_top.png]]</td>
<td>selection top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr> <td>[[Image:orig_selection_deselect.png]]</td> <td>selection deselect</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_selection_select_all.png]]</td> <td>selection select all</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_selection_select_all_in_all_layers.png]]</td> <td>selection select all in all layers</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_corners.png]]</td> <td>transform corners</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_gradient.png]]</td> <td>transform gradient</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_pattern.png]]</td> <td>transform pattern</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_stroke.png]]</td> <td>transform stroke</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Node Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_nodes_show_handles.png]]</td> <td>nodes show handles</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_break.png]]</td> <td>node break</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_curve.png]]</td> <td>node curve</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_cusp.png]]</td> <td>node cusp</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_delete.png]]</td> <td>node delete</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_delete_segment.png]]</td> <td>node delete segment</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_insert.png]]</td> <td>node insert</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_join.png]]</td> <td>node join</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_join_segment.png]]</td> <td>node join segment</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_line.png]]</td> <td>node line</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_smooth.png]]</td> <td>node smooth</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_symmetric.png]]</td> <td>node symmetric</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_stroke_tocurve.png]]</td> <td>stroke tocurve</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_tocurve.png]]</td> <td>object tocurve</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Tweak Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_tweak_attract_mode.png]]</td> <td>tweak attract mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_colorjitter_mode.png]]</td> <td>tweak colorjitter mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_colorpaint_mode.png]]</td> <td>tweak colorpaint mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_grow_mode.png]]</td> <td>tweak grow mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_push_mode.png]]</td> <td>tweak push mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_repel_mode.png]]</td> <td>tweak repel mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_roughen_mode.png]]</td> <td>tweak roughen mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_shrink_mode.png]]</td> <td>tweak shrink mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_guse_pressure.png]]</td> <td>guse pressure</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Zoom Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr>
<td>[[Image:orig_zoom_1_to_1.png]]</td>
<td>zoom 1 to 1</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-original.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_1_to_2.png]]</td>
<td>zoom 1 to 2</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-1-to-2.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_2_to_1.png]]</td>
<td>zoom 2 to 1</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-2-to-1.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_draw.png]]</td>
<td>zoom draw</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-drawing.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_in.png]]</td>
<td>zoom in</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-in.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_next.png]]</td>
<td>zoom next</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-next.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_out.png]]</td>
<td>zoom out</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-out.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_page.png]]</td>
<td>zoom page</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-page.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_pagewidth.png]]</td>
<td>zoom pagewidth</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-page-width.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_previous.png]]</td>
<td>zoom previous</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-previous.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_select.png]]</td>
<td>zoom select</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-selection.png]]</td>
</tr>
</table>

==== Rectangle Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_squared_corner.png]]</td> <td>squared corner</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Arc Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_circle_closed_arc.png]]</td> <td>circle closed arc</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_circle_open_arc.png]]</td> <td>circle open arc</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_reset_circle.png]]</td>
<td>reset circle</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Star Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_star_angled.png]]</td>
<td>star angled</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_star_flat.png]]</td>
<td>star flat</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Calligraphic Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_trace_background.png]]</td>
<td>trace background</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_guse_tilt.png]]</td>
<td>guse tilt</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_guse_pressure.png]]</td>
<td>guse pressure</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Text Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_writing_mode_lr.png]]</td>
<td>writing mode lr</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_writing_mode_tb.png]]</td>
<td>writing mode tb</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Connector Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_connector_avoid.png]]</td>
<td>connector avoid</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_connector_ignore.png]]</td>
<td>connector ignore</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_directed_graph.png]]</td>
<td>directed graph</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_overlaps.png]]</td>
<td>remove overlaps</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Gradient Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_fill_radial.png]]</td>
<td>fill radial</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_controls_fill.png]]</td>
<td>controls fill</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_controls_stroke.png]]</td>
<td>controls stroke</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_gradient.png]]</td>
<td>fill gradient</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Dropper Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_color_alpha_get.png]]</td>
<td>color alpha get</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_color_alpha_set.png]]</td>
<td>color alpha set</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
=== Palettes ===
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_object_font.png]]</td>
<td>object font</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_xml_editor.png]]</td>
<td>xml editor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_align.png]]</td>
<td>object align</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_trans.png]]</td>
<td>object trans</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_and_stroke.png]]</td>
<td>fill and stroke</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_grid_arrange.png]]</td>
<td>grid arrange</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_layers.png]]</td>
<td>layers</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td> </td>
<td> </td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Fill and Stroke ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_properties_fill.png]]</td>
<td>properties fill</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_properties_stroke_paint.png]]</td>
<td>properties stroke paint</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_properties_stroke.png]]</td>
<td>properties stroke</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_none.png]]</td>
<td>fill none</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_gradient.png]]</td>
<td>fill gradient</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_radial.png]]</td>
<td>fill radial</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_pattern.png]]</td>
<td>fill pattern</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_solid.png]]</td>
<td>fill solid</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_unset.png]]</td>
<td>fill unset</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fillrule_evenodd.png]]</td>
<td>fillrule evenodd</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fillrule_nonzero.png]]</td>
<td>fillrule nonzero</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cap_butt.png]]</td>
<td>cap butt</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cap_round.png]]</td>
<td>cap round</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cap_square.png]]</td>
<td>cap square</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_join_bevel.png]]</td>
<td>join bevel</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_join_miter.png]]</td>
<td>join miter</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_join_round.png]]</td>
<td>join round</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Transform ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_arrows_hor.png]]</td>
<td>arrows hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_arrows_ver.png]]</td>
<td>arrows ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_rotate.png]]</td>
<td>transform rotate</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scale_hor.png]]</td>
<td>transform scale hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scale_ver.png]]</td>
<td>transform scale ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scew_hor.png]]</td>
<td>transform scew hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scew_ver.png]]</td>
<td>transform scew ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Align and Distribute ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_al_baselines_hor.png]]</td>
<td>al baselines hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_baselines_vert.png]]</td>
<td>al baselines vert</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_bottom_in.png]]</td>
<td>al bottom in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_bottom_out.png]]</td>
<td>al bottom out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_center_hor.png]]</td>
<td>al center hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_center_ver.png]]</td>
<td>al center ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_left_in.png]]</td>
<td>al left in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_left_out.png]]</td>
<td>al left out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_right_in.png]]</td>
<td>al right in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_right_out.png]]</td>
<td>al right out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_top_in.png]]</td>
<td>al top in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_top_out.png]]</td>
<td>al top out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_baselines_hor.png]]</td>
<td>distribute baselines hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_baselines_vert.png]]</td>
<td>distribute baselines vert</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_bottom.png]]</td>
<td>distribute bottom</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_hcentre.png]]</td>
<td>distribute hcentre</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_hdist.png]]</td>
<td>distribute hdist</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_left.png]]</td>
<td>distribute left</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_randomize.png]]</td>
<td>distribute randomize</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_right.png]]</td>
<td>distribute right</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_top.png]]</td>
<td>distribute top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_vcentre.png]]</td>
<td>distribute vcentre</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_vdist.png]]</td>
<td>distribute vdist</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_unclump.png]]</td>
<td>unclump</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_graph_layout.png]]</td>
<td>graph layout</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_overlaps.png]]</td>
<td>remove overlaps</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_halign.png]]</td>
<td>node halign</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_hdistribute.png]]</td>
<td>node hdistribute</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_valign.png]]</td>
<td>node valign</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_vdistribute.png]]</td>
<td>node vdistribute</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Grid Arrange ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row.png]]</td>
<td>clonetiler per row</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column.png]]</td>
<td>clonetiler per column</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Text ====
<p>Text icons are not currently used.</p>
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_text_horz_kern.png]]</td>
<td>text horz kern</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_letter_spacing.png]]</td>
<td>text letter spacing</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_line_spacing.png]]</td>
<td>text line spacing</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_remove_kerns.png]]</td>
<td>text remove kerns</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_vert_kern.png]]</td>
<td>text vert kern</td>
<td> </td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_rotation.png]]</td>
<td>text_rotation</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Clone ====
<p>Clone icons are not currently used.</p>
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_color.png]]</td>
<td>clonetiler per column color</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_opacity.png]]</td>
<td>clonetiler per column opacity</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_rotation.png]]</td>
<td>clonetiler per column rotation</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_scale.png]]</td>
<td>clonetiler per column scale</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_shift.png]]</td>
<td>clonetiler per column shift</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_color.png]]</td>
<td>clonetiler per row color</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_opacity.png]]</td>
<td>clonetiler per row opacity</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_rotation.png]]</td>
<td>clonetiler per row rotation</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_scale.png]]</td>
<td>clonetiler per row scale</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_shift.png]]</td>
<td>clonetiler per row shift</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== XML Editor ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_add_xml_element_node.png]]</td>
<td>add xml element node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_add_xml_text_node.png]]</td>
<td>add xml text node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_duplicate_xml_node.png]]</td>
<td>duplicate xml node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_delete_xml_node.png]]</td>
<td>delete xml node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_delete_xml_attribute.png]]</td>
<td>delete xml attribute</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Layers ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_visible.png]]</td>
<td>visible</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_width_height_lock.png]]</td>
<td>width height lock</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_hidden.png]]</td>
<td>hidden</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_lock_unlocked.png]]</td>
<td>lock unlocked</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
=== Menus ===
==== File ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_file_export.png]]</td>
<td>file export</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_file_import.png]]</td>
<td>file import</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_file_vacuum.png]]</td>
<td>file vacuum</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_document_metadata.png]]</td>
<td>document metadata</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_input_devices.png]]</td>
<td>input devices</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_ocal_export.png]]</td>
<td>ocal export</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_ocal_import.png]]</td>
<td>ocal import</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Edit ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_edit_undo_history.png]]</td>
<td>edit undo history</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_paste_in_place.png]]</td>
<td>selection paste in place</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_paste_style.png]]</td>
<td>selection paste style</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_clone.png]]</td>
<td>edit clone</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_create_tiled_clones.png]]</td>
<td>edit create tiled clones</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_duplicate.png]]</td>
<td>edit duplicate</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_select_original.png]]</td>
<td>edit select original</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_unlink_clone.png]]</td>
<td>edit unlink clone</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_bitmap.png]]</td>
<td>selection bitmap</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_invert.png]]</td>
<td>selection invert</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_deselect.png]]</td>
<td>selection deselect</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== View ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_zoom_1_to_1.png]]</td>
<td>zoom 1 to 1</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_1_to_2.png]]</td>
<td>zoom 1 to 2</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_2_to_1.png]]</td>
<td>zoom 2 to 1</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_draw.png]]</td>
<td>zoom draw</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_in.png]]</td>
<td>zoom in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_next.png]]</td>
<td>zoom next</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_out.png]]</td>
<td>zoom out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_page.png]]</td>
<td>zoom page</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_pagewidth.png]]</td>
<td>zoom pagewidth</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_previous.png]]</td>
<td>zoom previous</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_select.png]]</td>
<td>zoom select</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_grid.png]]</td>
<td>grid</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_guides.png]]</td>
<td>guides</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_dialog_toggle.png]]</td>
<td>dialog toggle</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_swatches.png]]</td>
<td>swatches</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_messages.png]]</td>
<td>messages</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_scripts.png]]</td>
<td>scripts</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_window_next.png]]</td>
<td>window next</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_window_previous.png]]</td>
<td>window previous</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_view_icon_preview.png]]</td>
<td>view icon preview</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_view_new.png]]</td>
<td>view new</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fullscreen.png]]</td>
<td>fullscreen</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Layer ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_new_layer.png]]</td>
<td>new layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_rename_layer.png]]</td>
<td>rename layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_switch_to_layer_above.png]]</td>
<td>switch to layer above</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_switch_to_layer_below.png]]</td>
<td>switch to layer below</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_move_selection_above.png]]</td>
<td>move selection above</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_move_selection_below.png]]</td>
<td>move selection below</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_layer_to_bottom.png]]</td>
<td>layer to bottom</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_layer_to_top.png]]</td>
<td>layer to top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_raise_layer.png]]</td>
<td>raise layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_lower_layer.png]]</td>
<td>lower layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_delete_layer.png]]</td>
<td>delete layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Object ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_selection_group.png]]</td>
<td>selection group</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_ungroup.png]]</td>
<td>selection ungroup</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_up.png]]</td>
<td>selection up</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_bot.png]]</td>
<td>selection bot</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_down.png]]</td>
<td>selection down</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_top.png]]</td>
<td>selection top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_flip_hor.png]]</td>
<td>object flip hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_flip_ver.png]]</td>
<td>object flip ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_rotate_90_CCW.png]]</td>
<td>object rotate 90 CCW</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_rotate_90_CW.png]]</td>
<td>object rotate 90 CW</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Path ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_stroke_tocurve.png]]</td>
<td>stroke tocurve</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_tocurve.png]]</td>
<td>object tocurve</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_trace.png]]</td>
<td>selection trace</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_union.png]]</td>
<td>union</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_difference.png]]</td>
<td>difference</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_division.png]]</td>
<td>division</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_exclusion.png]]</td>
<td>exclusion</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_break.png]]</td>
<td>selection break</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_combine.png]]</td>
<td>selection combine</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_linked_offset.png]]</td>
<td>linked offset</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_dynamic_offset.png]]</td>
<td>dynamic offset</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_outset_path.png]]</td>
<td>outset path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_inset_path.png]]</td>
<td>inset path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_intersection.png]]</td>
<td>intersection</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cut_path.png]]</td>
<td>cut path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_simplify.png]]</td>
<td>simplify</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_reverse.png]]</td>
<td>selection reverse</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Text ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_put_on_path.png]]</td>
<td>put on path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_from_path.png]]</td>
<td>remove from path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_flow_into_frame.png]]</td>
<td>flow into frame</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_unflow.png]]</td>
<td>unflow</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_convert_to_text.png]]</td>
<td>convert to text</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_manual_kerns.png]]</td>
<td>remove manual kerns</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Help ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_about_memory.png]]</td>
<td>about memory</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_inkscape_options.png]]</td>
<td>inkscape options</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Extras ====
<p>These icons may need classification or may be unused.</p>
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_3dbox_four_handles.png]]</td> <td>3dbox four handles</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_3dbox_three_handles.png]]</td> <td>3dbox three handles</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_dialog_item_properties.png]]</td> <td>dialog item properties</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_draw_3dbox.png]]</td> <td>draw 3dbox</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_file_open_recent.png]]</td> <td>file open recent</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_help_keys.png]]</td> <td>help keys</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_help_tutorials.png]]</td> <td>help tutorials</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_inkscape.file.png]]</td> <td>inkscape.file</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_sticky_zoom.png]]</td> <td>sticky zoom</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_toggle_vp_x.png]]</td> <td>toggle vp x</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_toggle_vp_y.png]]</td> <td>toggle vp y</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_toggle_vp_z.png]]</td> <td>toggle vp z</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

TangoifiedIcons

2007-10-28T10:46:38Z

Jiho: /* The Icons */ added some sizes

It would be nice to have a complete Tangoified Inkscape Icon Set for a future release (hopefully sooner rather than later).

The current set [http://gnomelook.org/content/show.php/Tangofied+inkscape+icons+set?content=48140 here] is lacking many icons. It is based on the [http://tango.freedesktop.org/ArtLibreSet Tango ArtLibre Icon Set], which also Gimp is using.

Maybe this would be a good place to list all the icons Inkscape needs and the corresponding icon places (whether filled or not) in the [http://tango.freedesktop.org/ArtLibreSet ArtLibre Set].

== Standard naming and loading ==

We should try to get Inkscape loading those from standard calls and naming so that users can switch icons externally. The [http://tango.freedesktop.org/Tango_Icon_Library#Download Tango naming utilities] and following the [http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html Icon Naming Specification] might help.

To get things going well, we also would probably need to get Inkscape to hook itself in as a standard GTK+ icon source. (So Inkscape would ask GTK+ to get an icon for it, and GTK+ would turn around and ask Inkscape to provide that icon).

== The Icons ==
<p>There are 246 unique inkscape icons. If you would like to help upload a few to this wiki, you can download a ZIP file of all icons already named from [http://www.microugly.com/orig-inkscape-icons.zip]
=== Drawing tools ===
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_draw_select.png]]</td> <td>draw select</td> <td>24</td> <td>Pointer tool</td> <td></td> <td>[[Image:tool-pointer.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_node.png]]</td> <td>draw node</td> <td>24</td> <td>Node selection tool</td> <td></td> <td>[[Image:tool-node.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_tweak.png]]</td> <td>draw tweak</td> <td>24</td> <td></td> <td> </td>
<td>24</td> </tr>
<tr> <td>[[Image:orig_draw_zoom.png]]</td> <td>draw zoom</td> <td>24</td> <td>Page Magnifier tool</td> <td></td>
<td>[[Image:page-magnifier.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_rect.png]]</td> <td>draw rect</td> <td>24</td> <td></td> <td> </td>
<td>[[Image:draw-rectangle.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_arc.png]]</td> <td>draw arc</td> <td>24</td> <td></td> <td> </td>
<td>[[Image:draw-arc.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_star.png]]</td> <td>draw star</td> <td>24</td> <td></td> <td> </td>
<td>[[Image:draw-star.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_spiral.png]]</td> <td>draw spiral</td> <td>24</td> <td></td> <td></td> <td>[[Image:draw-spiral.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_freehand.png]]</td> <td>draw freehand</td> <td>24</td> <td></td> <td> </td>
<td>[[Image:draw-freehand.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_pen.png]]</td> <td>draw pen</td> <td>24</td> <td></td> <td> </td>
<td>[[Image:draw-pen.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_calligraphic.png]]</td> <td>draw calligraphic</td> <td>24</td> <td></td> <td> </td>
<td>[[Image:draw-calligraphic.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_paintbucket.png]]</td> <td>draw paintbucket</td> <td>24</td> <td></td> <td> </td>
<td>[[Image:draw-fill.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_text.png]]</td> <td>draw text</td> <td>24</td> <td></td> <td> </td>
<td>[[Image:draw-text.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_connector.png]]</td> <td>draw connector</td> <td>24</td> <td></td> <td></td> <td>[[Image:draw-connector.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_gradient.png]]</td> <td>draw gradient</td> <td>24</td> <td></td> <td> </td>
<td>[[Image:draw-gradient.png]]</td> </tr>
<tr> <td>[[Image:orig_draw_dropper.png]]</td> <td>draw dropper</td> <td>24</td> <td></td> <td> </td>
<td>[[Image:draw-dropper.png]]</td> </tr>
</table>

=== Tool Controls ===
==== Select Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_object_flip_hor.png]]</td> <td>object flip hor</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_flip_ver.png]]</td> <td>object flip ver</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_rotate_90_CCW.png]]</td> <td>object rotate 90 CCW</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_rotate_90_CW.png]]</td> <td>object rotate 90 CW</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr>
<td>[[Image:orig_selection_up.png]]</td>
<td>selection up</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr> <td>[[Image:orig_selection_bot.png]]</td> <td>selection bot</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr>
<td>[[Image:orig_selection_down.png]]</td>
<td>selection down</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_top.png]]</td>
<td>selection top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr> <td>[[Image:orig_selection_deselect.png]]</td> <td>selection deselect</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_selection_select_all.png]]</td> <td>selection select all</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_selection_select_all_in_all_layers.png]]</td> <td>selection select all in all layers</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_corners.png]]</td> <td>transform corners</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_gradient.png]]</td> <td>transform gradient</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_pattern.png]]</td> <td>transform pattern</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_transform_stroke.png]]</td> <td>transform stroke</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Node Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_nodes_show_handles.png]]</td> <td>nodes show handles</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_break.png]]</td> <td>node break</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_curve.png]]</td> <td>node curve</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_cusp.png]]</td> <td>node cusp</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_delete.png]]</td> <td>node delete</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_delete_segment.png]]</td> <td>node delete segment</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_insert.png]]</td> <td>node insert</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_join.png]]</td> <td>node join</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_join_segment.png]]</td> <td>node join segment</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_line.png]]</td> <td>node line</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_smooth.png]]</td> <td>node smooth</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_node_symmetric.png]]</td> <td>node symmetric</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_stroke_tocurve.png]]</td> <td>stroke tocurve</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_object_tocurve.png]]</td> <td>object tocurve</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Tweak Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_tweak_attract_mode.png]]</td> <td>tweak attract mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_colorjitter_mode.png]]</td> <td>tweak colorjitter mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_colorpaint_mode.png]]</td> <td>tweak colorpaint mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_grow_mode.png]]</td> <td>tweak grow mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_push_mode.png]]</td> <td>tweak push mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_repel_mode.png]]</td> <td>tweak repel mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_roughen_mode.png]]</td> <td>tweak roughen mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_tweak_shrink_mode.png]]</td> <td>tweak shrink mode</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_guse_pressure.png]]</td> <td>guse pressure</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Zoom Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr>
<td>[[Image:orig_zoom_1_to_1.png]]</td>
<td>zoom 1 to 1</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-original.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_1_to_2.png]]</td>
<td>zoom 1 to 2</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-1-to-2.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_2_to_1.png]]</td>
<td>zoom 2 to 1</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-2-to-1.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_draw.png]]</td>
<td>zoom draw</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-drawing.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_in.png]]</td>
<td>zoom in</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-in.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_next.png]]</td>
<td>zoom next</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-next.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_out.png]]</td>
<td>zoom out</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-out.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_page.png]]</td>
<td>zoom page</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-page.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_pagewidth.png]]</td>
<td>zoom pagewidth</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-page-width.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_previous.png]]</td>
<td>zoom previous</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-previous.png]]</td>
</tr>
<tr>
<td>[[Image:orig_zoom_select.png]]</td>
<td>zoom select</td>
<td></td>
<td></td>
<td></td>
<td>[[Image:zoom-selection.png]]</td>
</tr>
</table>

==== Rectangle Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_squared_corner.png]]</td> <td>squared corner</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Arc Controls ====
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_circle_closed_arc.png]]</td> <td>circle closed arc</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_circle_open_arc.png]]</td> <td>circle open arc</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_reset_circle.png]]</td>
<td>reset circle</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

==== Star Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_star_angled.png]]</td>
<td>star angled</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_star_flat.png]]</td>
<td>star flat</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Calligraphic Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_trace_background.png]]</td>
<td>trace background</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_guse_tilt.png]]</td>
<td>guse tilt</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_guse_pressure.png]]</td>
<td>guse pressure</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Text Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_writing_mode_lr.png]]</td>
<td>writing mode lr</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_writing_mode_tb.png]]</td>
<td>writing mode tb</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Connector Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_connector_avoid.png]]</td>
<td>connector avoid</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_connector_ignore.png]]</td>
<td>connector ignore</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_directed_graph.png]]</td>
<td>directed graph</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_overlaps.png]]</td>
<td>remove overlaps</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Gradient Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_fill_radial.png]]</td>
<td>fill radial</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_controls_fill.png]]</td>
<td>controls fill</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_controls_stroke.png]]</td>
<td>controls stroke</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_gradient.png]]</td>
<td>fill gradient</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Dropper Controls ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_color_alpha_get.png]]</td>
<td>color alpha get</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_color_alpha_set.png]]</td>
<td>color alpha set</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
=== Palettes ===
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_object_font.png]]</td>
<td>object font</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_xml_editor.png]]</td>
<td>xml editor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_align.png]]</td>
<td>object align</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_trans.png]]</td>
<td>object trans</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_and_stroke.png]]</td>
<td>fill and stroke</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_grid_arrange.png]]</td>
<td>grid arrange</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_layers.png]]</td>
<td>layers</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td> </td>
<td> </td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Fill and Stroke ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_properties_fill.png]]</td>
<td>properties fill</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_properties_stroke_paint.png]]</td>
<td>properties stroke paint</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_properties_stroke.png]]</td>
<td>properties stroke</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_none.png]]</td>
<td>fill none</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_gradient.png]]</td>
<td>fill gradient</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_radial.png]]</td>
<td>fill radial</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_pattern.png]]</td>
<td>fill pattern</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_solid.png]]</td>
<td>fill solid</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fill_unset.png]]</td>
<td>fill unset</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fillrule_evenodd.png]]</td>
<td>fillrule evenodd</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fillrule_nonzero.png]]</td>
<td>fillrule nonzero</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cap_butt.png]]</td>
<td>cap butt</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cap_round.png]]</td>
<td>cap round</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cap_square.png]]</td>
<td>cap square</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_join_bevel.png]]</td>
<td>join bevel</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_join_miter.png]]</td>
<td>join miter</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_join_round.png]]</td>
<td>join round</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Transform ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_arrows_hor.png]]</td>
<td>arrows hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_arrows_ver.png]]</td>
<td>arrows ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_rotate.png]]</td>
<td>transform rotate</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scale_hor.png]]</td>
<td>transform scale hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scale_ver.png]]</td>
<td>transform scale ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scew_hor.png]]</td>
<td>transform scew hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_transform_scew_ver.png]]</td>
<td>transform scew ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Align and Distribute ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_al_baselines_hor.png]]</td>
<td>al baselines hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_baselines_vert.png]]</td>
<td>al baselines vert</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_bottom_in.png]]</td>
<td>al bottom in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_bottom_out.png]]</td>
<td>al bottom out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_center_hor.png]]</td>
<td>al center hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_center_ver.png]]</td>
<td>al center ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_left_in.png]]</td>
<td>al left in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_left_out.png]]</td>
<td>al left out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_right_in.png]]</td>
<td>al right in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_right_out.png]]</td>
<td>al right out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_top_in.png]]</td>
<td>al top in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_al_top_out.png]]</td>
<td>al top out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_baselines_hor.png]]</td>
<td>distribute baselines hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_baselines_vert.png]]</td>
<td>distribute baselines vert</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_bottom.png]]</td>
<td>distribute bottom</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_hcentre.png]]</td>
<td>distribute hcentre</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_hdist.png]]</td>
<td>distribute hdist</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_left.png]]</td>
<td>distribute left</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_randomize.png]]</td>
<td>distribute randomize</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_right.png]]</td>
<td>distribute right</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_top.png]]</td>
<td>distribute top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_vcentre.png]]</td>
<td>distribute vcentre</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_distribute_vdist.png]]</td>
<td>distribute vdist</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_unclump.png]]</td>
<td>unclump</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_graph_layout.png]]</td>
<td>graph layout</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_overlaps.png]]</td>
<td>remove overlaps</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_halign.png]]</td>
<td>node halign</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_hdistribute.png]]</td>
<td>node hdistribute</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_valign.png]]</td>
<td>node valign</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_node_vdistribute.png]]</td>
<td>node vdistribute</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Grid Arrange ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row.png]]</td>
<td>clonetiler per row</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column.png]]</td>
<td>clonetiler per column</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Text ====
<p>Text icons are not currently used.</p>
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_text_horz_kern.png]]</td>
<td>text horz kern</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_letter_spacing.png]]</td>
<td>text letter spacing</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_line_spacing.png]]</td>
<td>text line spacing</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_remove_kerns.png]]</td>
<td>text remove kerns</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_vert_kern.png]]</td>
<td>text vert kern</td>
<td> </td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_text_rotation.png]]</td>
<td>text_rotation</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Clone ====
<p>Clone icons are not currently used.</p>
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_color.png]]</td>
<td>clonetiler per column color</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_opacity.png]]</td>
<td>clonetiler per column opacity</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_rotation.png]]</td>
<td>clonetiler per column rotation</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_scale.png]]</td>
<td>clonetiler per column scale</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_column_shift.png]]</td>
<td>clonetiler per column shift</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_color.png]]</td>
<td>clonetiler per row color</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_opacity.png]]</td>
<td>clonetiler per row opacity</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_rotation.png]]</td>
<td>clonetiler per row rotation</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_scale.png]]</td>
<td>clonetiler per row scale</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_clonetiler_per_row_shift.png]]</td>
<td>clonetiler per row shift</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== XML Editor ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_add_xml_element_node.png]]</td>
<td>add xml element node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_add_xml_text_node.png]]</td>
<td>add xml text node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_duplicate_xml_node.png]]</td>
<td>duplicate xml node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_delete_xml_node.png]]</td>
<td>delete xml node</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_delete_xml_attribute.png]]</td>
<td>delete xml attribute</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Layers ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_visible.png]]</td>
<td>visible</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_width_height_lock.png]]</td>
<td>width height lock</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_hidden.png]]</td>
<td>hidden</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_lock_unlocked.png]]</td>
<td>lock unlocked</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
=== Menus ===
==== File ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_file_export.png]]</td>
<td>file export</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_file_import.png]]</td>
<td>file import</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_file_vacuum.png]]</td>
<td>file vacuum</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_document_metadata.png]]</td>
<td>document metadata</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_input_devices.png]]</td>
<td>input devices</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_ocal_export.png]]</td>
<td>ocal export</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_ocal_import.png]]</td>
<td>ocal import</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Edit ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_edit_undo_history.png]]</td>
<td>edit undo history</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_paste_in_place.png]]</td>
<td>selection paste in place</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_paste_style.png]]</td>
<td>selection paste style</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_clone.png]]</td>
<td>edit clone</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_create_tiled_clones.png]]</td>
<td>edit create tiled clones</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_duplicate.png]]</td>
<td>edit duplicate</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_select_original.png]]</td>
<td>edit select original</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_edit_unlink_clone.png]]</td>
<td>edit unlink clone</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_bitmap.png]]</td>
<td>selection bitmap</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_invert.png]]</td>
<td>selection invert</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_deselect.png]]</td>
<td>selection deselect</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== View ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_zoom_1_to_1.png]]</td>
<td>zoom 1 to 1</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_1_to_2.png]]</td>
<td>zoom 1 to 2</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_2_to_1.png]]</td>
<td>zoom 2 to 1</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_draw.png]]</td>
<td>zoom draw</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_in.png]]</td>
<td>zoom in</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_next.png]]</td>
<td>zoom next</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_out.png]]</td>
<td>zoom out</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_page.png]]</td>
<td>zoom page</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_pagewidth.png]]</td>
<td>zoom pagewidth</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_previous.png]]</td>
<td>zoom previous</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_zoom_select.png]]</td>
<td>zoom select</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_grid.png]]</td>
<td>grid</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_guides.png]]</td>
<td>guides</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_dialog_toggle.png]]</td>
<td>dialog toggle</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_swatches.png]]</td>
<td>swatches</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_messages.png]]</td>
<td>messages</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_scripts.png]]</td>
<td>scripts</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_window_next.png]]</td>
<td>window next</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_window_previous.png]]</td>
<td>window previous</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_view_icon_preview.png]]</td>
<td>view icon preview</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_view_new.png]]</td>
<td>view new</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_fullscreen.png]]</td>
<td>fullscreen</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Layer ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_new_layer.png]]</td>
<td>new layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_rename_layer.png]]</td>
<td>rename layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_switch_to_layer_above.png]]</td>
<td>switch to layer above</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_switch_to_layer_below.png]]</td>
<td>switch to layer below</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_move_selection_above.png]]</td>
<td>move selection above</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_move_selection_below.png]]</td>
<td>move selection below</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_layer_to_bottom.png]]</td>
<td>layer to bottom</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_layer_to_top.png]]</td>
<td>layer to top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_raise_layer.png]]</td>
<td>raise layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_lower_layer.png]]</td>
<td>lower layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_delete_layer.png]]</td>
<td>delete layer</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Object ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_selection_group.png]]</td>
<td>selection group</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_ungroup.png]]</td>
<td>selection ungroup</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_up.png]]</td>
<td>selection up</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_bot.png]]</td>
<td>selection bot</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_down.png]]</td>
<td>selection down</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_top.png]]</td>
<td>selection top</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_flip_hor.png]]</td>
<td>object flip hor</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_flip_ver.png]]</td>
<td>object flip ver</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_rotate_90_CCW.png]]</td>
<td>object rotate 90 CCW</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_rotate_90_CW.png]]</td>
<td>object rotate 90 CW</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Path ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_stroke_tocurve.png]]</td>
<td>stroke tocurve</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_object_tocurve.png]]</td>
<td>object tocurve</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_trace.png]]</td>
<td>selection trace</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_union.png]]</td>
<td>union</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_difference.png]]</td>
<td>difference</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_division.png]]</td>
<td>division</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_exclusion.png]]</td>
<td>exclusion</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_break.png]]</td>
<td>selection break</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_combine.png]]</td>
<td>selection combine</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_linked_offset.png]]</td>
<td>linked offset</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_dynamic_offset.png]]</td>
<td>dynamic offset</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_outset_path.png]]</td>
<td>outset path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_inset_path.png]]</td>
<td>inset path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_intersection.png]]</td>
<td>intersection</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_cut_path.png]]</td>
<td>cut path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_simplify.png]]</td>
<td>simplify</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_selection_reverse.png]]</td>
<td>selection reverse</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Text ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_put_on_path.png]]</td>
<td>put on path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_from_path.png]]</td>
<td>remove from path</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_flow_into_frame.png]]</td>
<td>flow into frame</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_unflow.png]]</td>
<td>unflow</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_convert_to_text.png]]</td>
<td>convert to text</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_remove_manual_kerns.png]]</td>
<td>remove manual kerns</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Help ====
<table>
<tr>
<th scope="row">Icon</th>
<th scope="row">Icon name</th>
<th scope="row">Req. Pixel Size</th>
<th scope="row">Description</th>
<th scope="row">Current Tango ArtLibreSet</th>
<th scope="row">Proposed Icon</th>
</tr>
<tr>
<td>[[Image:orig_about_memory.png]]</td>
<td>about memory</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td>[[Image:orig_inkscape_options.png]]</td>
<td>inkscape options</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
==== Extras ====
<p>These icons may need classification or may be unused.</p>
<table>
<tr> <th scope="row">Icon</th> <th scope="row">Icon name</th> <th scope="row">Req. Pixel Size</th> <th scope="row">Description</th> <th scope="row">Current Tango ArtLibreSet</th> <th scope="row">Proposed Icon</th> </tr>
<tr> <td>[[Image:orig_3dbox_four_handles.png]]</td> <td>3dbox four handles</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_3dbox_three_handles.png]]</td> <td>3dbox three handles</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_dialog_item_properties.png]]</td> <td>dialog item properties</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_draw_3dbox.png]]</td> <td>draw 3dbox</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_file_open_recent.png]]</td> <td>file open recent</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_help_keys.png]]</td> <td>help keys</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_help_tutorials.png]]</td> <td>help tutorials</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_inkscape.file.png]]</td> <td>inkscape.file</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_sticky_zoom.png]]</td> <td>sticky zoom</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_toggle_vp_x.png]]</td> <td>toggle vp x</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_toggle_vp_y.png]]</td> <td>toggle vp y</td> <td></td> <td></td> <td></td> <td></td> </tr>
<tr> <td>[[Image:orig_toggle_vp_z.png]]</td> <td>toggle vp z</td> <td></td> <td></td> <td></td> <td></td> </tr>
</table>

Release notes/0.46

2007-09-05T20:36:18Z

Jiho: /* UI */ added OS X theme improvements

=Inkscape 0.46=
'''(not released yet)'''

Highlights in this release:

* Paintbucket tool

* Tweak tool

* 3D box tool

* LPEs

* new SVG filters and UI

* native PDF and AI import

* Open Clip Art Library integration

* full on-canvas gradient editing

* engraver's toolbox

* touch selection

* dockable dialogs

* command line access to verbs

* snapping made usable

* significant speed and interactivity improvements

* hundreds of smaller features and bugfixes

=Speed and interactivity=

* In this version, Inkscape starts using the [http://www.cairographics.org cairo] library for rendering. It is now used for '''outline mode''' display which, thanks to using cairo and other optimizations, redraws '''faster by about 25%'''. More impressive are memory savings: thanks to cairo, in outline mode Inkscape now takes only about '''50% of the memory''' used by 0.45 for the same file.

* '''Smart redraw directionality:''' With complex images and/or on slow computers, you may have noticed that Inkscape redraws the screen image in horizontal strips, and these strips are painted in order from top to bottom. Now the redraw always starts '''at your mouse cursor location''' and proceed upwards and downwards from it, so that the area near the cursor is always redrawn first. This significantly improves program's responsiveness in some situations. For example, when you are node-editing part of a complex path, the entire path needs to be redrawn on each change, but now this redraw starts from the point you're working on. Moreover, the redraw is interruptible, so each mouse movement starts new redraw from the mouse cursor area. As a result, during such operations those parts that you're working on redraw often and feel snappy and responsive, while areas further away may lag behind more.

* '''Faster blur''' for exporting and high quality on-screen rendering: Inkscape now uses an IIR (Infinite Impulse Response) filter for blurring with large radius. This greatly improves the speed of blur redraw at high zooms or in high-resolution export (or simply with very large blur radius). On the other hand, the results are an approximation to a true Gaussian blur, so a drawing may look slightly different from the mathematically precise blur (usually the differences are far from visible, though). This code is mainly based on: ''Recursive Gaussian Derivative Filters'' by L.J. van Vliet, I.T. Young and P.W. Verbeek (see the source code for more detailed references).

:'''Exporting drawings with blur''' was particularly slow in 0.45; some files could take hours to export. Now this is fixed, in part by the faster algorithm mentioned above and in part by a bugfix in the export code. Now even the quite complex files with large blurs export at high resolution in at most a few minutes.

* [faster gradients - mental]

* '''Dragging handles and nodes''' as well as '''dragging and transforming objects''' by mouse became more responsive, so that working in complex drawings and especially editing complex paths is noticeably easier. In particular, this fixes the annoying latency issue where a node or a handle could follow mouse cursor even after you release mouse button after a drag.

* '''Moving the cursor around''' in a file with large and complex paths has become much snappier and more responsive. Previously, in extreme cases Inkscape could freeze for seconds while catching up with the mouse cursor; such delays are now eliminated.

* Several improvements make '''canvas panning and scrolling''' smoother and more interactive in complex slow-rendering documents:

:* When panning by the middle mouse button, Inkscape no longer attempts to redraw the canvas while your mouse button is pressed. Any redrawing only happens after you release the mouse. As a result, the newly revealed parts of the canvas are somewhat more "dirty" but the '''panning is smoother than before''', with few if any "hiccups".

:* '''Redrawing the newly exposed parts of the canvas''' after scrolling, especially diagonal scrolling, is now faster because only the exposed areas are redrawn; before, this often resulted in the entire screen being redrawn which was much slower.

:* Previously, if you started panning with middle button while Inkscape is still redrawing screen in a complex drawing, panning sometimes completely failed or moved canvas just a little step. Now it is '''guaranteed to pan the canvas all the way''' from mouse-press point to mouse-release point in any case, even if sometimes it fails to show the intermediate positions.

:* When pressing and holding Ctrl+arrows to scroll canvas, Inkscape normally accelerates scrolling so that each next scrolling step is bigger than the previous. Previously, in complex drawings this acceleration sometimes got interrupted, which made scrolling annoyingly bumpy and slow. Now this is fixed so that '''scrolling is smoothly accelerated''' even in a slow-rendering document.

:* The default '''starting speed and acceleration''' of Ctrl+arrows scrolling are slightly increased. (They are both settable in Preferences.)

* More responsive UI: When you zoom, the '''zoom control''' on the right end of the statusbar now updates immediately, not after screen redraw as before. Also, the '''statusbar messages''' displayed while you're drawing a shape or a path in Pen tool do not lag behind the mouse movements.

=Tools=

==Paint Bucket tool==

The new Paint Bucket tool works exactly as you would expect: click in any area bounded on all sides and it will '''fill it with color'''. Being a vector tool, however, Inkscape's Paint Bucket just creates a new ''path'' that "fills in" the area in which you clicked.

===How it works===

It is important to note that the tool is '''perceptual''', not geometric. That is, when looking for the boundaries around the point you clicked, it takes for such boundaries any ''visible'' color changes. This means that filling will stop at gradients, blurs, and even the color boundaries in imported bitmaps, but will ignore any paths or other objects that are fully (or almost) transparent or for any other reason do not stand out from the background. In short, it will work exactly as if you were filling a rasterized version of your image in a bitmap editor like Photoshop or GIMP - but will give you a vector object to work with.

For example, now you can scan a pencil sketch, import the bitmap into Inkscape, and quickly fill all its cells with colors even without tracing the bitmap first. This is a very convenient and interactive way of digitizing your paper drawings, making the '''traditional bitmap tracing unnecessary''' in many cases.

Internally, the tool works by performing a bitmap-based flood fill on a rendered version of the visible canvas, then tracing the resulting fill using [[potrace]] and placing the traced path into the document.

It places the rendered path onto the current layer, so you can have a layer on top (for example, "Inks") and select the layer below ("Colors") and do the fills so that they always appear below the Inks.

The '''resolution''' of the bitmap image used to perform the trace is dependent upon your '''current zoom level''' -- the more zoomed in to an area that you are, the higher the resolution of the bitmap-based flood fill. So, if you are got a fill that is too imprecise, has rough corners, or don't go into small nooks and appendices where it is supposed to go, just undo, zoom in closer and repeat filling from the same point. Conversely, if the fill leaks out through a small gap, zoom out to make the gap less visible and fill again (or use the auto gap closing parameter, see below).

===Style===

Like all object-creating tools, the Paint Bucket may use the '''last-set style''' for the objects it creates (this is the default), or it can use its own '''fixed style'''. You can switch between these modes on this tool's page in Inkscape Preferences (Ctrl+Shift+P).

===Controls===

In the tool's '''Controls bar''':

* '''Tolerance''' (set in per cent units) controls how large must be color difference at a point (compared to the initial click point) to stop the fill. Zero tolerance means only the area of strictly the same color will be filled; the larger the tolerance, the easier it will be for the fill to leak into adjacent different-color areas. The default value is 10%.

* You can control the amount of '''inset/outset''' to be applied to the created fill path. Setting a positive outset causes fill paths to be larger than the filled bitmap area (good for eliminating anti-aliasing errors), while setting a negative outset causes the path to be smaller. This works the same as the Outset and Inset path commands.

* Paint Bucket's perceptual fill can use either all visible colors or specific color '''channels'''. You can restrict the fill algorithm to the following channels:
** Red
** Green
** Blue
** Hue
** Saturation
** Lightness
** Alpha

* An '''auto gap''' setting. When enabled, Paint Bucket will try to close any gaps in the area boundaries that would normally cause the fill to spill out of the desired area. There are four settings to auto gap:
** None
** Small (fill gaps up to 2 pixels in size)
** Medium (4 pixels)
** Large (6 pixels)

* A '''style swatch''' on the far right of the bar shows the style that will be used for the next fill object you create.

===Shortcuts===

The tool's '''shortcuts''' are:

* '''Single click''' performs filling from the click point.

* '''Shift+click''' performs filling from the click point and then unions the resulting path with the selected path. This way, if your first attempt did not fill in all of the desired area, you can Shift+click the remaining corner to fill it in separately and combine the result with the result of the previous fill.

* '''Ctrl+click''' on an object simply changes that object's fill to the current fill color of the tool, and '''Shift+Ctrl+click''' changes the stroke to the current stroke color.

* '''Click and drag''' performs filling from '''all of the points''' that you pass while dragging (you will see your path visualized by a red line). From each point, the fill spreads to the neighbors with the colors similar to that point - in other words, it's like clicking with this tool at each point of the drag path and unioning the results. This lets you easily fill an area occupied by a gradient or blur - just drag from the darkest to the lightest points in the area you want to fill.

* '''Alt+click and drag''' works similarly to simple drag, except from each point of the drag path, the fill spreads to the neighbors (if any) with the colors similar to the ''initial point'' (the point where you started the drag). This lets you fill a series of similarly-colored yet separated areas (for example, multiple cells in a cartoon) by starting the drag in one of those areas, and alt+dragging the tool through all the other areas.

==Tweak tool==

The Tweak tool is an exciting new way to edit drawings which largely blurs the
distinction between vector and raster editing. Instead of meticulously selecting some
objects and then performing an action on the selection, you can now select ''all''
objects (or all objects you are interested in) and apply the Tweak tool's brush to
smoothly and naturally change the shape or style of only those objects (or parts
thereof) ''that the brush touches''.

The area of the tool's action - its ''brush'' - is marked by an orange-colored circular
outline that moves with your mouse cursor. However, that area actually has no sharp
boundaries; the power of the tool's action falls off gradually, following a smooth
bell-shaped profile. This makes the tool act softly and smoothly.

The tool will work on any number of selected objects; for example, you can select all
(Ctrl+A) and "smear" your entire drawing by Push mode or paint it by Color Paint
mode. You can also apply it to groups of objects; it will go into groups and act on
individual objects inside groups. If you're trying to use it without anything selected,
it will remind you by a statusbar message to select some objects.

===Width===

The width of the tool's brush, in the range from 1 to 100, can be changed by the
'''Width''' control in the tool's controls bar above the canvas. You can also change
width by '''Left''' and '''Right''' arrow keys (same as in the Calligraphy tool) at any
time (including during action) as well as '''Home''' and '''End'''. Also, as in Calligraphy
tool, the visible width of the brush is independent of zoom; simply zooming in or out is
often easier than adjusting the width if you want to cover a smaller or larger area of
the drawing.

===Force===

The next control is '''Force''' which adjusts the power of the action, also in the
range from 1 to 100. You can also change width by '''Up''' and '''Down''' arrow keys at
any time (including during action).

If you have a pressure-sensitive tablet and your "Use pressure" button on the right-hand
end of the controls bar is on, then the force will also depend on how hard you actually
press your pen into your tablet, changing in the range from zero to whatever you set in
the Force control. If all you have is a mouse, then the force will be constant but still
settable by the Force control.

===Path editing modes===

The Tweak tool has a number of '''modes''', selectable by toggle buttons in the tool's
Controls bar and by keyboard shortcuts. Some of these modes change the shapes of
paths while others affect the colors of objects. All these modes share the Width and
Force controls but otherwise are quite different. Let's look at the path editing modes
first.

Unlike the Node tool, to edit paths with the Tweak tool you don't need to worry about
where the nodes of a path are and how to manipulate them. You just apply the tool's
brush to any point, and the selected paths at that point will reshape smoothly and
naturally - as if made of soft jelly - regardless of where its nodes lie. If applied to
a shape or text object, the tool converts them to paths automatically.

While not very useful for technical drawings, tweaking paths will be indispensable for
artistic uses of Inkscape - cartoons, drawings, sketches, anime, etc. This new
functionality is somewhat similar to the tools such as "Pucker" and "Bloat" in the
latest versions of Adobe Illustrator.

There are currently six path editing modes in the Tweak tool: '''Push''', '''Shrink''',
'''Grow''', '''Attract''', '''Repel''', and '''Roughen'''.

* This default mode of the tool, '''Push''', simply displaces the part of the path under the cursor in the direction of the drag. The path behaves like soft jelly, bending and bulging smoothly and naturally. It's an easy way to produce various irregular, lifelike, handmade-looking shapes starting from something as simple as an ellipse or a calligraphic stroke. For parallel-stroke hatching (engraving) done in the Calligraphy tool, pushing is an easy way to bend, pinch, or curve the entire hatching uniformly.

* The '''Shrink''' and '''Grow''' are two opposite modes that move each point of a path in a direction perpendicular to the path's surface at the point, either inwards (Shrink) or outwards (Grow). This is similar to the Inset and Outset commands, except that the Tweak tool can act on a part of a path instead of the whole path.

:For example, the visible lightness/darkness of an engraving hatching may not exactly correspond to your artistic intention. Also, the ends of Calligraphy pen strokes are often far from ideal - they may be too blunt or have unsightly bends or blobs. This is where the Tweak tool may help. Select all the strokes in a hatching pattern and apply a light Shrink action where you want the lines to become thinner (and the hatching to become lighter), up until total disappearance. If you press hard, shrinking works as an eraser, so you can easily clean the strokes' ends to make them thin, sharp, and uniform. Conversely, applying Grow makes strokes wider (i.e. the hatching becomes darker).

:Of course, shrinking and growing are useful not only for calligraphic strokes. Same as with Push, with Shrink and Grow you can '''sculpt''' any path, spawning smooth treacle-like appendages with Inflating and carving holes with Melting. Unlike the "node sculpting" mode in the Node tool, however, this does not require adding new nodes to the shape.

* The '''Attract''' and '''Repel''' modes work by moving each affected point on a path towards (Attract) or from (Repel) the cursor point. In some cases this may look similar to Shrink and Grow, but the difference is that shrinking/growing moves paths perpendicularly to the path in each point, whereas attracting/repelling moves them to or from the cursor regardless of the path shape. These modes are similar to the Pinch effect in ; you can use them for various central-symmetric distortions in parts of your paths.

* The '''Roughen''' mode does exactly this: roughens the edge of the path without changing its overall shape. Slight roughening simply makes the edge crooked and uneven; strong roughening tears and explodes the edge into random blobs and splotches. Note that this operation, especially with high Fidelity, adds a lot of nodes which increases the size of your SVG document and may slow down Inkscape considerably. In particular, pushing/melting/inflating of a roughened path becomes much slower and more difficult, so it's recommended to finalize the overall shape of a path first and roughen it, if necessary, only as the final step.

====Fidelity====

Any tweaking of a path slightly distorts the entire path, including even those parts
that you didn't touch. These distortions are similar to those that a Simplify command
produces. The '''Fidelity''' value (also in the range from 1 to 100, default is 50)
allows you to control the amount of these distortions. With a higher fidelity, the
distortions are less noticeable, but the path may end up having a lot of nodes which
inflates up the SVG size and slows down Inkscape.

The best value of Fidelity depends on the nature of your artwork. If you're sculpting an
amorphous blob, you can do with low fidelity of about 20. If, however, you are pushing
or inflating a text string (as a single path) and want the letters outside the distorted
area to remain crisp and clean, you will need to raise fidelity to 80 or more.

====Known problems====

Known problems with the path editing modes in Tweak tool:

# they don't work on open paths (an open path becomes closed if you tweak it);
# they are rather slow;
# they quickly eat memory; and
# they are sometimes buggy - thin calligraphic strokes may suddenly disappear or change their shape drastically as you're melting or inflating them.

For (4), it helps to increase Fidelity. Also, you can undo the bad change and try again with less pressure on the pen - if you do your thinning in several light touches instead of one heavy press, usually you will be able to get the desired result without the buggy behavior.

Also, sometimes after roughening, further tweaking of a path becomes impossible with this diagnostic:

WARNING **: Shape error in ConvertToShape: directedEulerian(a) == false

All these problems stem from the livarot library that we use for geometric manipulation of paths. Fortunately, livarot is scheduled for replacement by lib2geom, a new library now in development, so hopefully these issues will be addressed then.

===Color-changing modes===

The '''Color Paint''' and '''Color Jitter''' modes, unlike the path editing modes,
change the colors of objects instead of their shapes. Yet they share enough common
features with the path-changing modes to be part of the same tool: These modes also use
a circular soft-edged brush controlled by the Width and Force parameters on the Controls
bar and affected by the pen pressure (if you have a pressure-sensitive tablet).

* '''Color Paint''' applies the style of the tool to the selected objects under the brush. The style of the tool is visible in the style swatch at the rightmost end of the tool's control bar; it can be changed by clicking on the color palette or by any other style assignment command, such as Fill and Stroke dialog. ('''Note''': unlike all other tools, in Tweak tool in Color Paint mode you cannot assign style directly to selected objects; any style-setting command changes the tool's style instead.)

:The fill from the tool's style applies to the fills of the painted objects, and the stroke applies to the strokes. If the tool's style has no fill or no stroke, it won't affect fills or strokes, correspondingly. For example, if you want to color the fills of objects blue but leave their strokes untouched, assign blue fill to the tool's style (just click blue on the palette) but set its stroke to None (middle-click the Stroke swatch in the statusbar). Similarly, master opacity in the tool's style affects master opacities of the touched objects (if the O channel is on, see below).

:This mode allows you to literally paint over objects, shifting their colors towards the target style of the tool. For example, if you paint with yellow fill over a blue-filled object, the object will become greenish blue, then green, then yellowish green, and end up being exactly the yellow color you're painting with. This speed of this gradual transition depends on both Force parameter and pen pressure; also, objects touched by the periphery of the brush are less affected than those hit by the brush center. Overall, using this tool is very similar to a soft brush in a raster editor such as Gimp or Photoshop.

* '''Color Jitter''' mode does not apply any color, but instead jitters (randomizes) the colors of the objects it touches. The force of the action determines how strong is the randomization, i.e. how far the colors deviate from the original values. This mode does not use the tool's style.

Both modes work on flat fills and gradients; for gradients, the tool takes into account not only the position of the entire object with gradient, but also the position of each gradient stop relative to the brush. This means that, for example, you can change the blue color only in an object filled with blue-red gradient simply by painting over its blue end with a brush small enough to not touch the red. (Note that color tweaking does not create gradients on objects that used flat color before, but only adjusts existing gradients in the drawing.)

====Channels====

Color Paint and Color Jitter honor the '''Channels''' control. This control comprises
the four buttons: '''H''', '''S''', '''L''', and '''O''', which allow you to turn on and off
the tool's action on the object's hue, saturation, lightness, and opacity,
correspondingly. For example, if you want to raise the saturation of some part of your
drawing without changing the hue, select some maximum-saturation color (e.g. pure red)
and turn off all Channels buttons except S. Similarly, you can replace the hues without
affecting saturation or lightness (only H pressed), or lighten/darken all colors without
changing their hues and saturation (only L pressed). Pressing O allows you to apply the
master opacity from the tool's style to the master opacity of objects (but not fill or
stroke opacity).

====Usage notes====

Color painting with Tweak tool is similar, but not exactly analogous to bitmap
painting. Even though the tool itself works as a soft brush, it still applies its color
to vector objects, which behave as vector objects usually do. For example, if you want
to change the tint of the face in your drawing, and if a hand in the drawing is part of
the same object as the face, that hand will change its tint too even if it's located far
from the point you are painting. (We foresee a "fracture" command in one of the next
versions of Inkscape which will help you turn a monolithic object into a mosaic of small
fragments that will be then easy to paint with Tweak tool.) Still, even with this
limitation, color painting is a novel way of dealing with vector drawings which allows
you to quickly and intuitively make adjustments which would be awkward and slow with
traditional approach.

Drawings containing patterns or scatterings of small independent objects are best suited
for color painting with Tweak tool. Examples include:

* freehand drawings with Calligraphy pen, consisting of many separate strokes;

* gradient meshes imported from Adobe Illustrator files (Inkscape renders these meshes as lattices of small polygons; while there's no direct support for gradient meshes in Inkscape yet, color painting on such lattices is almost as good);

* text converted to paths and with Break Apart command applied so that each letter is a separate path;

* patterns made with the Tile Clones command; note that you need to unset the fill and/or stroke on the original object and use the Color tab to assign some initial color to the clones - this will make them paintable with the Tweak tool without unlinking.

Moreover, color tweaking can be useful for compositions with a few objects or even for
single objects. Unlike all other color selection methods, painting with the Tweak tool
implements the ''color mixing'' metaphor which is much more familiar to traditional
artists than RGB sliders or even the color wheel. For example, start with a rectagle of
pure blue color; then, pick different colors by Color Paint and apply light touches with
minimum Force and minimum pen pressure: add a little green, a little brown, a little
yellow, etc. until you have the exact hue you need. Similarly, you can whiten or blacken
any hue by admixing white or black.

You can also use color tweaking to add a tint, darken/lighten, saturate/desaturate, or
color jitter your entire drawing. Just select all in all layers, zoom out, choose a
large brush width so it covers all of the drawing, and apply a little color tweaking
(with minimum Force) that will therefore affect all visible objects.

===Keyboard shortcuts===

* '''W''', '''Shift+F2''': switch to the Tweak tool

* '''Shift+P''': switch to the Push mode

* '''Shift+S''': switch to the Shrink mode

* '''Shift+G''': switch to the Grow mode

* '''Shift+A''': switch to the Attract mode

* '''Shift+E''': switch to the Repel mode

* '''Shift+R''': switch to the Roughen mode

* '''Shift+C''': switch to the Color Paint mode

* '''Shift+J''': switch to the Color Jitter mode

* '''Left, Right, Home, End''': change width

* '''Up, Down''': change force

* '''mouse drag''': act on selected path in the current mode

* '''Ctrl+mouse drag''': temporarily switch to Shrink (while Ctrl is down)

* '''Shift+Ctrl+mouse drag''': temporarily switch to Grow (while Shift+Ctrl is down)

==3D Box tool==

Inkscape is a two-dimensional drawing tool. However, very often it is used to draw three-dimensional objects. The new '''3D box tool''' helps you create such 3D drawings by automating the most common operation: creating a three-dimensional box in a given perspective. The tool automatically ensures that all sides of the box lie on the corresponding perspective lines. We're not going to compete with Blender - but even simple things can go a long way.

Currently in the 3D box tool you can:

* draw a 3D box by dragging on canvas (use Shift+dragging without releasing the mouse button to extrude in z direction)

* adjust any of its 3 dimensions by handles

* move a 3D box "in perspective" by dragging its center; without modifiers, movement occurs within the XY-plane (press Ctrl to constrain the movement to the directions of the coordinate axes or diagonals), with Shift the box moves parallel to the Z-axis

* adjust the vanishing points of a perspective by dragging them across the canvas (see below) or toggling their states; all boxes sharing this perspective are transformed accordingly

In SVG, a 3D box is represented as a '''group''' (svg:g) with a special extension attribute (in inkscape namespace); this group contains the 6 quadrilateral '''paths''' representing the sides of the box. Only the 3D box tool treats this object as a box; for all other tools it is just a group, so you can select any of the paths by Ctrl+click, apply any style to it, delete it, etc. You can of course transform the entire box or any face in it using Selector or Node tools.

When several boxes are selected, all vanishing points of their associated perspectives are shown on the canvas. If vanishing points of different perspectives coincide, they are combined in a single "dragger". Moving this dragger moves all the vanishing points simultaneously and transforms the associated boxes accordingly. Note that some non-selected boxes may also be reshaped if their perspectives share the same vanishing point. Pressing Shift while moving the dragger can be used to only transform the selected boxes, separating their perspectives from the non-selected ones'. On the other hand, when a vanishing point being dragged comes close enough to another one, both snap together and are combined in a single dragger.

===Keyboard shortcuts===

* '''X''', '''Alt+F4''': switch to the 3D box tool

* '''L''': toggle visibility of perspective lines

* '''A''': when perspective lines are visible, toggle between "all lines" and "only lines connected to front corners" (this can help to avoid visual clutter)

[max]

==Gradient Tool==
Stops in gradients can be added, deleted, and edited on-canvas now.
*Stops can be added by '''double clicking''' or by '''Ctrl+Alt+Click''' on the gradient line.
*Stops can be deleted by '''Ctrl+Alt+Click''' on a stop or by the '''Del''' key for all the selected stop(s).
:*When you delete an end stop, the nearest intermediate stop becomes the new end stop of the gradient (without moving - i.e., the gradient span becomes shorter).
:*When you delete an end stop and there are no intermediate stops, the object will be painted with a solid fill taken from the color & opacity of the remaining stop.
*More than one stop can be selected at a time by '''Shift+click'''.
:*Can be moved together if next to each other.
:*Can be deleted at the same time.
:*When you have one of the '''gradient handles selected''', its style (color and opacity) is reflected by the selected style indicator (left of the statusbar) and the Fill&Stroke dialog. Previously, opacity of a gradient handle was reflected as fill-opacity and stroke-opacity; now it is reflected as '''master opacity''' (the "O:" spinbutton in the selected style indicator, the "Master opacity" slider in Fill&Stroke). This makes it much easier to view and change opacity of gradient handles using only the selected style indicator in the statusbar.
:*When multiple gradient stops are selected, the selected style indicator (in the statusbar) displays and controls the averaged color and opacity of the selected stops.
*If the selected object(s) have gradient in fill or stroke, the '''selected style indicator''' in the bottom-left corner of the editing window now displays a '''live gradient preview''' prefixed by '''R''' or '''L''' to indicate Radial or Linear gradients (instead of displaying "L Gradient" or "R Gradient" text labels as before). Also, this and other similar widget now use italic font face to indicate <i>None</i> and bold to indicate <b>Unset</b>.
* When copy/pasting or duplicating an object with gradient, it now automatically gets a '''copy''' of the original gradient, so modifying it does not affect the source object's gradient anymore (before, you had to press the Duplicate button on the Gradient controls bar for this).

==Calligraphy tool: Engraver's Toolbox ==

Several new features were added to the Calligraphic pen to make
Inkscape capable of the ancient art of '''line
engraving'''. Traditional engraving is a very labour-intensive
process, and while for a long time it was the only practical way
of reproducing lifelike images in black-and-white print, about a
century ago it was almost completely displaced by automatic
halftone screens. However, line engravings have their
characteristic charm, and there's no reason not to try to
resurrect this art form with the help of Inkscape.

A brief visual guide to the new functionality can be seen on
these screenshots:

http://inkscape.org/screenshots/gallery/inkscape-0.46-engraving1.png

http://inkscape.org/screenshots/gallery/inkscape-0.46-engraving2.png

===Tracking a guide path with Ctrl===

One of the most common operations in line engraving is
'''hatching''' (or sometimes ''cross-hatching'' when several
hatching grids cross): filling a space with many parallel
straight or variously curved lines (usually of varying width to
represent a gradual shading). You could try to achieve a similar
effect with e.g. path interpolation (blending), but it is rather
cumbersome and limited; manual drawing of hatch lines, on the
other hand, is tedious and nearly impossible to do
uniformly. Now Inkscape provides "assisted hatching" by
'''tracking a guide path''', allowing you to hatch quickly and
uniformly and at the same time giving you sufficient manual
control over the process.

Here's how to do this. First, select the '''guide path''' that
you will track. It may be another calligraphic stroke, any path
or shape, or even a letter of a text object. Then switch to
Calligraphic pen, select the desired parameters (line width,
angle, fixation etc.) and, before starting to draw, press
Ctrl. You will see a gray '''track circle''' centered at your
mouse pointer and touching the closest point on the selected
guide path. (If you have no guide path selected, a statusbar
message will tell you to select it.)

Now move your mouse close to the guide path, so that the track
circle radius is equal to the desired spacing of your hatch
pattern, and start drawing along the guide path. At that moment,
the radius of the circle gets locked; now the circle slides
along the guide path - and the actual stroke is drawn by the
center of the tracking circle, ''not'' by your mouse point. As
a result, you are getting a smooth stroke going parallel to the
guide path and always at the same distance from it.

When the stroke is ready, release your mouse button (or lift
your tablet pen) but '''do not let go of the Ctrl key''' because
as long as you have it pressed, the tool remembers the hatch
spacing you set when you started drawing. Now, you have just
created a new stroke and, as usual with Inkscape tools, it gets
selected instead of what was selected before. In our case, this
means that the newly drawn stroke itself becomes the new guide
path. Next, you can draw a second stroke along the first one,
then a third one along the second, etc. Eventually you can fill
any desired space with uniform hatching.

Alternatively, if you uncheck "Select new path" in the Calligraphy tool preferences, newly created strokes will not be selected, so your original guide path will be kept selected. In this mode, Inkscape will increase the tracking distance after each created stroke so that you can create uniformly spaced hatching by tracking a single guide path.

The attachment to the guide path is not absolute. If you stray
your mouse pointer far enough from the guide path, you will be
able to tear it off (the track circle turns from green to red)
and move freely. This is intentional; this feature allows you,
for example, to continue drawing a stroke past the end of a
guide stroke, thus making your hatching cover a wider area than
the initial guide path. Special care is taken to make such
tearing off as smooth as possible and to suppress violent jerks,
but this is not always possible; the general advice is to not
try to hatch too fast. If jerking and unintended tearoffs still
bother you, try increasing the Mass parameter.

Also, special code is in place to prevent flipovers - accidental
jumps to the other side of the guide path. Brief flipovers are
suppressed, but if you intentionally go over to the other side
and stay there, eventually Inkscape will obey and your tracking
stroke will also flip over to follow you.

Tracking a guide also allows some slight feedback by gradually
changing the tracking distance in response to your drawing
behavior. Thus, if you're consistently trying to draw closer or
farther from the guide than the current tracking distance, the
distance will correspondingly decrease or increase, so you will
get a hatching that is slightly spacing in or out. (The effect
is very slight, however, so as not to become a nuisance.) Also,
note that since tracking follows the edge of the stroke, strokes
of varying width (such as those tracing background, see below)
will result in gradual bending of the hatching pattern as you
proceed.

===Tracing background by stroke width===

There is a new toggle button on the Calligraphy tool's controls
bar, '''Trace background'''. When on, the width of your pen
depends on the lightness of the background under the stroke in
each point, so that white translates into the minimum stoke
width (1) and black translates to the maximum (which is set by the
Width parameter). This can work alone or in combination with
pressure sensitivity, depending on whether the "Use pressure" button
is also toggled.

This feature allows you to not only hatch over an imported
bitmap image or any drawing, but to do so automatically
reproducing the highlights and shades of the background with
your strokes becoming lighter and heavier as needed.

===Misc features===

* For consistency with other drawing tools, drawing with '''Shift''' in Calligraphy tool automatically '''unions''' the newly created stroke with whatever paths were selected (and selects the result). Thus, you can do a series of overlapping Shift+strokes to create one unioned path object instead of separate objects as before.

* To facilitate changing the Width parameter, the Home/End keys in Calligraphy tool switch you to the minimum (1) and maximum (100) width, correspondingly. (This is in addition to the Left/Right arrow keys that change Width by 1; remember also that you can press Alt+X, type any width, and press Enter.)

==Selector==

* A new selection mode is available: '''selecting by touch'''. In this mode, you draw a freehand path across the objects; when you release mouse button, all objects that are touched by this path get selected. This mode is very convenient in situations where you need to select objects so intermingled that selecting them by the rectangular rubberband is too difficult and so numerous that click-selecting them one by one is too tedious.

:To activate selecting by touch, whenever you are drawing a rubberband rectangle, just press '''Alt''' to switch it to the touch mode. The rectangle will disappear and a red ''touch path'' will be shown instead. When dragging from an empty space, you can press '''Alt''' first and then start to drag to get the touch mode (note that your selection must be empty, otherwise Alt+dragging will move the selected objects instead). To start a touch selection from a point over an object, or to add to existing selection by touching, press '''Shift+Alt''' and then start to drag.

* Previously, the only way to switch selection from scale mode to rotate mode or back was to click on it, which was rather inconvenient when the selected object is in a group or under other objects. Now you can switch modes with keyboard as well by pressing '''Shift+S''' in Selector tool.

* Draging the '''scale handles with Alt''' now scales selection by an integer factor, i.e. up to '''2''', '''3''', '''4''', etc. times the original size or down to '''1/2'''. '''1/3''', '''1/4''', etc. of the original size (in any of the two dimensions independently). This way you can, for example, mirror any object around one of the edges of its box. (This replaces the old and rarely used "slow" scaling mode with Alt.)

* '''Horizontal/vertical flipping''': So far, flipping a selection made it flip within its bounding box, so that the latter remained fixed. In the move/scale mode of the selector tool, this behaviour remains unchanged. However, in rotate/shear mode flipping now happens about an (imaginary) vertical/horizontal axis through the rotation center. This is very handy, since the latter can be freely dragged around and snaps to all kinds of objects if desired.

==Node tool==
[sculpt profiles - bbyak]

* If any of the nodes in the currently selected path is mouseovered, then horizontal/vertical flipping ('H' and 'V' keys), stepwise rotation ('[' and ']' keys) and scaling ('<' and '>' keys) now all use this specific node as center/axis. If there is no mouseovered node, the center of the bounding box is used instead (as is currently the case unconditionally). Nodes that are covered by one of their handles are also detected as mouseovered.

* [helper path display - johan]

==Text tool==
* [text toolbar - deadchip?]
* If text contains a tref element, the text tool's behavior may not be as expected. Please see [[#The tref Element]]

=SVG=

==The tref Element==

Inkscape can now correctly open files with '''tref''' elements, and new tref elements can be created manually in the XML editor.

The actual character data contained in a text element can either be embedded directly, or it can be the character content of an element referenced by a '''tref'''.

While the textual content from the referenced element will be stripped of any markup before being used by the '''tref''', the '''tref''' element can itself have the same attributes as a '''tspan'''. In fact, when rendered, it is as though the '''tref''' element is replaced by a '''tspan''' with the same attributes, and the referenced character data is embedded in that '''tspan'''.

The property '''xlink:href''' is used to refer to another element whose character data will be used. Any element can be referred to except an ancestor of the '''tref'''. When any of the text contained in the referred element changes, the '''tref''' will immediately be updated to display the new data.

Existing tref elements can be converted into tspan elements with '''Edit > Clone > Unlink Clone'''. If more than one '''tref''' is contained within a selection, all '''trefs''' will be converted into '''tspans'''. All attributes applied to the '''tref''' will be retained in the new '''tspan'''.

A '''tref''' element can be mixed with any other elements allowed to be contained by a text element.

The cloned character data rendered by the '''tref''' may not be edited, but any characters surrounding it can be changed. Styles cannot be applied to a subset of the cloned characters, but if all are selected, a style can be applied to the '''tref'''.

=Filters=

==New filters supported==

* The '''feBlend''' filter primitive gives us image blending modes, like in many image manipulation programs. These modes are screen, multiply, darken and lighten. There's a caveat, though: when blending an object against an semi-transparent background, the background will be accumulated twice, resulting in thicker objects under the bounding box of blended object. This is a limitation of current version of SVG format, not a bug in Inkscape.

* The '''feOffset''' filter primitive offsets the image by an user-defined amount. For example, this is useful for drop shadows, as the shadow has to be in a slightly different position than the actual object.

[[Filter Effects]]

==Filters UI==

* New dialog for creating and modifying filter effects ('''Object>Filter Effects...''')
* The list at the left of the dialog displays all filters currently in the document.
** New filters can be added with the '''Add''' button beneath the list
** Right-clicking a filter for the pop-up menu allows duplicating or removing a filter.
** Double-clicking a filter will apply it to all selected objects
** A black dot is placed next to whatever filter is applied to the selected objects. If more than one filter is in use by selected objects, an unfilled dot is used instead.
* The second list, at the left of the dialog, displays the '''filter primitives''' that are contained within the currently-selected filter.
** New primitives can be added by selecting the primitive type from the combo box beneath the list, and then pressing the '''Add''' button.
** Right-clicking a primitive for the pop-up menu allows duplicating or removing a primitive.
** Primitives can be rearranged by clicking and dragging any filter in the list.
** When a filter is selected, the '''Settings''' group at the bottom of the dialog will change to display the attributes available for that primitive. Changing a setting results in an immediate update to the document.
** The "in" and "in2" attributes for filters that support them are not shown in the '''Settings''' group. These input connections are displayed graphically in the list, under the '''Connections''' column.
*** Inputs for a particular filter are displayed as triangles. Depending on the primitive type, there may be one or two inputs (or more for Merge primitives.) Connections can be created by clicking on a triangle and dragging.
*** There are six standard input types that can be used for any primitive input; Source Graphic, Source Alpha, Background Image, Background Alpha, Fill Paint, and Stroke Paint. These are displayed vertically on the far right of the list. Click and drag from an input triangle to one of the standard inputs to connect them.
*** Primitives can also be connected to other primitives by clicking an input triangle and dragging upwards to another primitive. A primitive can only be connected to one higher up the list.
*** Single-clicking on an input triangle will unset it, returning it to the default. If it is on a Merge primitive, the input will be deleted.
*** Merge inputs have an empty input at the end. Dragging a connection from this input will add a new input to the primitive.

=Live path effects=

'''Live path effects''' (not to be confused with extension effects or SVG filters) are a new way to non-destructively modify path and shape objects. LPEs only affect the path of an object and not its style. The original path is preserved and can be edited directly, and the LPEs applied to it will be updated.

[Path Effects dialog, Ctrl+Shift+7]

[Paste Path Effect command, Ctrl+7]

Live path effects were developed as part of the GSoC 2007.

==Path along path==
The <b>Path along Path</b> effect can curve a path along another path. When this effect is applied to path A, another path B can then be passed as a parameter. The result is that path B is bent along path A. With the node edit tool, path A can be changed <b>on-canvas</b> and the result is <b>updated live</b>.

Example file: live-path-effects-pathalongpath.svg

==Curve Stitching==
The <b>Curve Stitching</b> effect connects points from two paths with straight line segments. The result is also referred to as "String Art". For some examples of what can be made with this method: http://members.shaw.ca/jillbritton/string_art/jbstringart.htm

Example file: live-path-effects-curvestitch.svg

==Gears==
The <b>Gears</b> effect is a toy effect. It generates a chain of gears from the path that has the effect applied to it. The knots of the path define the centers of the gears. The first 3 knots are special; the first defines the start angle of the chain, the second defines the center of the first gear and the third knot specifies the radius of the first gear.

Example file: live-path-effects-gears.svg

==Development of new effects==
One of the goals of the Summer of Code project was to make it easy to create new effects. There is a framework that greatly simplifies effect implementation; very little code is needed to get the effect hooked into Inkscape. This leaves valuable time for the actual effect to be implemented. See the http://wiki.inkscape.org/wiki/index.php/MakingLivePathEffects wiki page for an explanation of how to get started with your own effect!

[johan]

=Extension effects=

== Live preview ==

* '''Live preview of effects''': Using the async behavior (see below), as soon as the parameters dialog for an effect is shown, the script is executed in the background and the screen updates as soon as it's finished. This can result is seemingly faster execution if no parameters are changed. If some parameters are adjusted, the script is restarted. This allows you to see immediately the effects of any parameter change without pressing the OK button on the effect's dialog.

* '''Spawn Glib API''': Scripting extension have been moved to the Glib spawn API to ensure that parameters and variables aren't interpreted by a shell. This also means that scripting extensions are executed in a separate process asynchronously allowing the GTK main loop to continue to execute.

* '''Progress dialog''': While an extension is working on a document, a small dialog is shown allowing the user to cancel the execution.

== New and improved effects ==

* The new '''Render > Barcode''' extension creates a [http://en.wikipedia.org/wiki/Barcode barcode]. Supported types include EAN13, EAN8, UPC-A, UPC-E, UPC-5, Code39, Code39Ext, Code93, Code128, and RM4SCC.

* The new '''Render > Gear''' extension creates a [http://en.wikipedia.org/wiki/Gear mechanical gear] given the number of teeth, the circular pitch (in px units), and the pressure angle.

* The new '''Render > [[Spirograph]]''' extension creates intricate mathematical curves akin to the classic [http://en.wikipedia.org/wiki/Spirograph mechanical Spirograph toy] (see [http://wiki.inkscape.org/wiki/images/Spirograph_Samples.svg samples]).

* A group of new effects in the '''Text''' submenu performs various case conversions on selected text objects: converting to UPPERCASE, lowercase, Sentence case, Title Case, as well as flipping case (switching uppercase to lowercase and vice versa) and rANdoMiZInG cAse. If no texts are selected, the effect works on all texts in the document.

* Another effect in the Text submenu, '''Replace text''', performs search-and-replace on the selected text objects or (if nothing is selected) on all texts in the document. Searching is case sensitive. You can use this effect to globally delete all occurrences of some text fragment by replacing it with empty string. Conversely, if you search for an empty string and replace it with some string, this string will be inserted after every character of your text; for example, you can space out a text by replacing in it an empty string with a single space.

* A new effect, '''Replace color''' in the Color submenu, simply replaces one RRGGBB-specified color to another within selection or, if there's no selection, in the entire document. As with other effects in that submenu, the replacement affects fill, stroke, and gradient colors, but not colors of bitmaps.

*The '''Whirl''' extension uses the center of view as the center of whirl, so you don't have to enter the center coordinates numerically.

*The '''Render > Grid''' extension has got an extended range of grid spacings, from 0.1 to 1000 px.

*The '''Render > Function Plotter''' extension can now plot using polar coordinates.

*[color randomize]

== ImageMagick effects ==

New raster operations available through the effects drop-down menu, powered by the ImageMagick library. For any of these effects to work, you need to have an '''image object selected''' in the drawing.

* '''Adaptive Threshold''' applies adaptive thresholding to the bitmap. Average color of rectangle provided by '''width''' and '''height''' used as threshold value. Use '''offset''' to apply a different threshold than the average.

* '''Add Noise''' adds random noise of certain types to the bitmap.

* '''Blur''' blurs the bitmap, using '''radius''' as the amount of blur. Higher radius means more blur. (Note that unlike the vector Gaussian blur of objects, this bitmap blur will not extend the edges of the image, so it may appear truncated at the edges.)

* '''Channel''' extracts the specified channel from the bitmap.

* '''Charcoal''' applies a charcoal drawing style to a bitmap. Radius controls the width (or detail) of charcoal strokes. Higher '''radius''' means lower detail. '''Sigma''': the higher it is, the less defined the charcoal is.

* '''Colorize''' overlays the bitmap with a given color at a given intensity.

* '''Contrast''' lightly enhances the contrast (difference between lights and darks) of a bitmap.

* '''Cycle Colormap''' cycles the colormap of a bitmap.

* '''Despeckle''' reduce the speckle noise in a bitmap.

* '''Edge''' hilights edges in a bitmap.

* '''Emboss''' embosses a bitmap, hilighting edges with 3D effect.

* '''Enhance''' enhance a bitmap, minimizing noise.

* '''Equalize''' equalizes a bitmap. Histogram equalization.

* '''Flop''' mirrors a bitmap, reflecting each scanline in the horizontal direction.

* '''Gaussian Blur''' blurs a bitmap, more strongly than regular blur.

* '''Implode''' sucks everything towards the center of the bitmap.

* '''Level''' scales values falling between the given '''Black Point''' to '''White Point''' range to the full color range.

* '''Level Channel''' acts the same way as level but for only one channel.

* '''Median Filter''' filters a a bitmap by replacing each pixel component with the median color in a circular neighborhood

* '''Modulate''' adjusts the percent hue, saturation, and brightness of a bitmap.

* '''Negate''' takes the inverse of a bitmap.

* '''Normalize''' normalizes a bitmap, expanding color range to the full possible range of color.

* '''Oil Paint''' stylizes a bitmap so that it appears to be painted with oils.

* '''Opacity''' modifies the opacity channel of a bitmap.

* '''Raise''' alters the lightness of the edges of a bitmap to create a raised appearance, much like a frame.

* '''Reduce Noise''' reduces noise in a bitmap by using a noise peak elimination filter.

* '''Shade''' shades a bitmap by simulating a distant light source

* '''Sharpen''' sharpens a bitmap.

* '''Solarize''' solarizes a bitmap, like overexposing photographic film.

* '''Spread''' randomly spread pixels in a bitmap within the radius of '''amount'''.

* '''Swirl''' swirls the bitmap around the center point.

* '''Threshold''' thresholds a bitmap.

* '''Unsharpmask''' sharpens a bitmap using an unsharp mask algorithm.

* '''Wave''' alters a bitmap along the sine wave.

These effects are part of the Google Summer of Code 2007, coded by Christopher Brown.

== New Python XML library ==

* All Python effects are switched from the old and unmaintained PyXML library to the new powerful [http://codespeak.net/lxml/ lxml] library.

=Snapping=

* In addition to all other snapping modes and techniques, snapping has been implemented or improved in many tools and contexts:

:* Drawing of new '''shapes''' (such as rectangles or ellipses) snaps to grid/guides/objects.

:* '''Handles''' of existing objects and gradient handles snap.

:* '''Skewing''' objects in Selector snaps.

:* Snapping to objects works for '''images''' and '''clones''' (not only paths/shapes as before).

:* Snapping of '''text baselines''' works again.

:* When moved in Selector, an object optionally snaps with its '''rotation axis''' (which is by default in the geometric center of its bounding box, but can be arbitrarily moved and its position is remembered for every object). It is also possible to snap to a rotation axis with another object.

:* While dragging a '''guide''', it now snaps to object nodes

:Other snapping fixes and improvements include:

:* The snapping preferences dialog has been restyled to make it more intuitive

:* Snapping distance is now set in screen pixels and is therefore independent of zoom.

:* Snapping to bounding boxes has been added

:* Snapping of objects has been made more clean, by only snapping bounding box corners to bounding boxes, and nodes to other nodes and paths.

:* The bug where "node-to-node" snapping caused jerky movement of nodes is fixed.

:* The aspect ratio is correctly preserved while scaling objects with snapping turned on.

:* All four bounding box corners now snap instead of only the lower-left and upper-right as before.

:* Snapping while uniformly scaling has been improved.

* The confusing "Default transformations origin" option is removed. Now Inkscape always uses the opposite edge of the object's bounding box as the transformation origin (though the bounding box itself can now be different, see next item).

* A new preference option has been added to specify the kind of '''bounding box''' to be used for transforming objects (see Inkscape Preferences, Tools, Selector). You can choose between the '''visual bounding box''' (which takes into account the stroke width, markers, and blur margins; this is the default behavior) or '''geometric bounding box''' (which encloses only the path itself, disregarding stroke width).

=Grids=

* a new tab in the document properties dialog, solely meant for grids; the former grid/guide tab is now solely for guides. I envision a list of guides there in the future, for easier deletion of guides etc.
* more than one grid can be active at the same time, although i am having trouble in finding a usefull case for this
* multiple views on the same document share the same grids, but the grid can be turned off for each view separately. For example: one could have an overview view without grid enabled. Duplicate that window and zoom in on some detail; then grids can be shown only for that view, and snapping will only happen in those views for which grids are enabled. (sorry i am not able to explain more clearly)
* grid information is now stored in SVG as a child of sodipodi:namedview. Can someone please make an extension that converts an old grid definition to the new format?
* axonometric grid (not yet snapping)
* dots instead of lines

From developer perspective:

* implementation of new grids is much easier now; subclassing CanvasGrid and adding an entry in the is enough. Have a peek at how the rectangular grid is implemented (CanvasXYGrid).
* note that there is no longer "the grid", there might be several grids active now!

[Future plans (i will not be working on this soon, due to GSoC Live effects!):
** possibility of enabling not all but a selection of grids for a view. Eg. when there are 4 grids defined in the document, only enable grid2 for a certain view.
** new grids!
** better snapping mechanism to enable snapping to intersections of guides&grids and grids&grids.

A side effect of removal of old gridcode: apparantly the origin of the desktop rules used to be set to the origin of the grid. I find this strange: specifying a grid origin of (2,2) would have me think the origin would be at ruler location (2,2) instead of (0,0) as it is in 0.45.1.
I have commented the grid-origin correction to the ruler range, because now there is not a single grid anymore to correct it for. Isn't there a control somewhere to define the documents origin? Now the ruler origin is set to (0,0) -- johan]

=Bitmap export=

* '''Batch export''': The Bitmap Export dialog (Ctrl+Shift+E) got a new checkbox, ''Batch export all selected objects''. This checkbox is available when two or more objects are selected. If it is checked, instead of exporting selection as a whole, Inkscape exports each selected object separately into its own PNG file. This uses each object's export hints (i.e. export filename and DPI) if they are remembered from a previous export; otherwise, the filename is created from the object ID and the DPI is 90 pixels per inch. '''Caution:''' Unlike regular export, batch export overwrites all existing PNG files without warning.

:This makes it possible to implement all kinds of '''image slicing''' and automated export scenarios. For example, if you are working on a web site design, you can create a separate "export" layer. In that layer, "slice" your web page image into separate areas by creating invisible rectangles with no fill and no stroke. Select each rectangle (by Tab/Shift+Tab, or by switching to Outline mode where even an invisible rectangle can be selected by clicking on its outline) and export it into the corresponding filename (which gets saved as that object's export hint). After that, if you do any changes to your graphics, it's very easy to reexport all the slices: just switch to the "export" layer, select all in that layer (Ctrl+A), and export with the ''Batch export selected objects'' checkbox on.

* '''Hide all except selected''': A new checkbox allows you to hide in the exported image everything except selected object(s).

* The Export dialog automatically appends the '''.png''' extension to the export filename you specify.

=Import/Export=

==PDF and AI import==

In this version, Inkscape can natively (i.e. without any additional software) import PDF files and the newer PDF-based Adobe Illustrator files (starting from AI version 9.0).

'''Implemented features''': The new import extension can import '''paths''', '''text''', '''clippaths''', '''masked or non-masked images''', and '''softmasks'''. It supports '''pattern fills''' (XStep and YStep attributes are ignored) as well as '''linear and radial gradients''' (only those using sampled or exponential functions). '''Gradient meshes''' are imported, but they get converted to groups of small tiles (flat-colored paths) that approximate the mesh; the user can adjust the precision of this approximation.

'''PDF import settings''': After opening a PDF or AI document, the PDF Import Settings dialog shows up. Here you can select:

* the '''page''' to be imported from a multipage PDF;

* the overall '''clip region''' (which can be none or set to any of the PDF boxes, e.g. the crop box, the media box, the trim box, etc.);

* the '''precision''' for the approximation of '''gradient meshes'''; note that setting this too high may result in a huge SVG file and slow performance when importing files with gradient meshes;

* a checkbox controlling whether the '''images''' should be '''embedded''' into the resulting SVG document or saved on the current path;

* a '''preview''' of the selected page (shown if poppler-cairo is present on the system or if the selected page has a thumbnail embedded into the PDF document).

'''Text editing tips''': Any text imported from PDF or AI has each letter's precise place on the page ''fixed''. While this preserves the exact appearance (e.g. justification of text blocks) of the imported document, it makes editing such text difficult: deleting text fails to contract the text line and inserting text fails to expand it, i.e. typed letters overlay the existing letters. (However, you still can replace a letter with another letter of about the same width, although you may need to kern it into place with Alt+arrows.)

To work around this, select the text object you want to edit and use '''Text > Remove manual kerns''' command. This will remove the exact positioning information, so if the text block was justified it will lose justification, but instead you will be able to edit it as usual.

Note that there is a way to select even a single line in a text block. For this, open the XML editor, expand the <svg:text> tree branch corresponding to your text, and select any of the <svg:tspan> objects under it. Now you can remove manual kerns from this line only. After you finish editing the line, you can manually justify it back, for example by adding spaces, manual kerns (Alt+arrows), or by adjusting letterspacing (select the whole line and use Alt+> or Alt+<).

The native PDF/AI importer is based on the poppler library and was implemented by Miklós Erdélyi as part of the Google Summer of Code 2007.

==PDF export==

* '''[if enabled! - mental]''' A new cairo-based PDF exporter has been added to Inkscape. Inkscape 0.46 can export shapes, strokes, transparency, gradients, patterns, text, and images correctly to cairo. While clipping paths and masks are known to be faulty or missing. cairo will write a PDF with vector graphics when possible and fall back to raster graphics when needed. What can be exported as vectors and how much of the image will be rasterized when the fallback kicks in depends on your version of cairo. cairo version 1.2 with the pdf backend compiled in is the minimum requirement for any cairo-based PDF exports.

* [cairo ps export - adib]

* [new wpg lib - ted gould]

=Command line=

Several new command line options are added that make Inkscape even more scriptable and automatable than before.

* --verb-list will list all the Verb IDs and their names in Inkscape. This makes writing your own menus and hotkeys much easier as you can easily find out what the choices are.

* --verb followed by a verb ID allows you to specify a verb to be called on every document opened by Inkscape initially from the command line.

* --select followed by a node ID will allow you to add a node to the list of selected objects.

These options can be used, for example, for performance testing. You could do something like this:

$ time inkscape --verb=FileClose my_complex_file.svg

to measure the time it takes to load and display the file.

Of course, with the ability to select objects, it can be much more useful than
that. You can call extension effects, or any other verb, then FileSave and
FileClose to automate all kinds of operations on your drawings.

=UI=

== [docked dialogs - gustav] ==

== [toolbars - [[JonCruz]]] ==

[calligraphy: menus, tooltips; star; ...]

Switched to stock GTK+ toolbars.

Extra magic secret sauce added.

== [filedialogs - [[JonCruz]]] ==

== Print dialog integration ==

* '''Print Dialog''': The GTK Unix Print Dialog has been hooked up! From the dialog, you can select any of the Postscript-capable printers known to your system and configure them as with any other GTK application.

== Saving window geometry globally ==

Previously, window geometry (size and position of document windows) could only be saved into the document (so that each document stored its own window geometry). Now, a new option is added to save the geometry of the last used window to the preferences and apply this geometry to all new windows. Thus, with the "Save geometry to preferences" option enabled, new windows will open with the shape of the most recent previous window. This mode also remembers and restores the maximized/fullscreen state (unlike geometry saved to documents).

== New ways to scroll and zoom ==

* You can now enable Space+mouse drag to pan canvas, as it does in Adobe Illustrator. This mode is enabled by the '''Left mouse button pans when Space is pressed''' checkbox in the Scrolling tab of the Inksape Preferences dialog. By default it is off and pressing the spacebar key switches you to Selector and back, as it always did in Inkscape.

* By default, rotating the mouse wheel scrolls the canvas vertically and Ctrl+wheel zooms in and out. Now, if you turn on the '''Mouse wheel zooms by default''' checkbox in the Scrolling tab of the Inksape Preferences dialog, this behavior is reversed: mouse wheel zooms without Ctrl and scrolls with Ctrl. This new mode should be familiar for users of AutoCAD and CorelDraw.

* In the Zoom tool, right mouse button always zooms out instead of calling the context menu (which is rather useless in this tool anyway).

== GTK theme on OS X ==

A GTK theme is now included in Inkscape.app bundle on OS X. If the user does not have any personal customization (e.g. in a .gtkrc-2.0 file) this theme is used. It reflects the OS X settings for "Appearance" and "Highlight Color" set in System Preferences > Appearance.

=Even more improvements=

* '''Gnome VFS Improvements''': Gnome VFS Non-Local files are now usable through all of our file choosers in Open, Save and Export. This compile-time option allowed people to open any Gnome-VFS-based URI from the command-line in the past, but not non-local resources (WebDAV, SFTP, etc) and this now allows for all the lovely possibilities Gnome-VFS provides.

* In previous versions, Inkscape didn't allow you to '''group a single object.''' Yet in some cases, this operation is useful (for example, to blur the clipped edged of an object, or apply more than one clippath/mask to an object). Now this limitation is removed; just select any single object and group it to get a single-object group.

* The somewhat cryptic "F:" and "S:" labels in the selected style indicator (at the left end of the statusbar) and in tool's style swatches are now spelled out as '''Fill:''' and '''Stroke:'''. We believe this makes the interface, even if less space-efficient, a bit more friendly for newbies.

* The '''style swatches''' at the right end of object-creating tools' control bars now open the Preferences page of the corresponding tool when clicked. Also, now these swatches display a tooltip explaining its purpose (e.g. "Style of new rectangles", "Style of new calligraphic strokes", etc.)

* After dragging a curve segment in Node tool, Inkscape no longer selects the two adjacent nodes if they were not selected before.

* The '''Tile Clones''' dialog now uses the object's defined '''rotation axis''' (which can be freely moved by Selector tool and which is saved separately for each object) for all rotations (including both symmetry rotations and the Rotation tab rotations), scales, and flips. This renders unnecessary the previous workarounds where you had to group an object with another transparent object to affect how it's rotated by the clone tiler.

* In '''Pencil''' and '''Calligraphic''' tools, pressing '''Esc''' or '''Ctrl+Z''' while drawing cancels the currently drawn path or stroke. When not drawing, these keys work as before (Esc deselects, Ctrl+Z undoes last action). (This is the same behavior as in the Pen tool where it was introduced in a previous version.)

* A set of new verbs has been added to allow the user to easily '''unlock all locked objects''' or '''unhide all hidden objects'''. There are two variants one that operates on the current layer and its children and one that operates globally. While searching for hidden or locked object descendants of locked layers are ignored.

* Several more '''rotation snapping increments''' are available in the Steps tab of the Inkscape Preferences dialog: 36, 22.5, 18, 12, and 0.5 degrees.

* The list of folder shortcuts in the '''Open''' dialog includes the folder with Inkscape's SVG '''examples''' for easy access. Similarly, the '''Save''' dialog has a shortcut for the user's own '''templates''' dialog making it easy to save the current document as a template (if saved as <code>default.svg</code>, it will be loaded every time you run Inkscape or create new document with Ctrl+N; with any other name, it will be added to the File > New submenu).

* For time-intensive operations such as Paint Bucket and Simplify, the system's busy wait cursor is displayed to indicate to the user that Inkscape is actively working, and not frozen.

* [statusbar updates: save, ...]

* Several improvements in '''inkview''': busy cursor is shown while loading file, the button window stays on top and responds to keyboard shortcuts; several memleaks stopped and bugs fixed. The "slideshow mode" of the main inkscape application (-s or --slideshow command line option) is removed; use inkview instead.

* In Document Metadata dialog, updated Creative Commons Licenses to version 3.0.

* In addition to Shift+click, right clicking on a colour swatch now also sets the stroke colour.

* File dialog windows (open/save) now have a "Enable preview" checkbox which allows you to disable the preview pane.

=Notable bugfixes=

These are bugfixes compared to 0.45.1; for a list of fixes in 0.45.1 compared to 0.45, see [[ReleaseNotes045|0.45.1 release notes]]

* The '''sodipodi:docbase''' attribute is no longer added to the root <svg> element. This attribute used to keep the latest directory that the document was saved to, and thus represented a mild privacy violation (i.e., by sharing your Inkscape SVG files you allowed others to have a peek into your directory structure). Note, however, that Inkscape does not remove this attribute from old documents it opens; if you want you can remove it yourself. Inkscape just no longer creates this attribute in new documents.

* A fix in the blur rendering code made '''exporting blurred objects to bitmap''' much faster and fixed the disappearing of blurred objects in exported bitmaps which happened for large objects in 0.45. The same fix got rid of the rendering artefacts that sometimes appeared on blurred objects during scrolling.

* Inkscape now properly quotes <code>font-family</code> values and therefore can use '''fonts''' with various '''nonalphanumeric characters''' in their names, which previously failed.

* If you have saved documents with a previous version of Inkscape which used '''right-to-left text''' (e.g. Arabic, Hebrew) then the paragraph alignment of non-flowed text has been reversed in this release. This is due to a bug in previous versions - the new behaviour is compliant with the SVG specification and compatible with other editors and viewers. To correct your images, simply reverse the paragraph alignment by selecting the text and clicking the appropriate button on the toolbar.

* A large family of bugs was exterminated where an object's style could only refer other objects (such as gradients, patterns, and filters) that come after it in the document. Now any objects can be referenced from a style regardless of their place in the document. This fixed the '''disappearance of gradients/patterns/filters''' after you undo an effect, as well as lots of assorted crashes and misrenderings (mostly on non-Inkscape SVG files).

* On Windows, '''file opening/saving dialogs''' can no longer sink under the main editor window (they now have the inkscape window set correctly as their parent window).

* '''Stock markers''' now appear in the "recently used markers" section of the marker selector dropdowns in the Fill & Stroke dialog. Before, any markers with stock id's (including markers modified by the user) were hidden, making it difficult to work with modified stock markers.

* A regression in 0.45 caused crashes when '''undo or redo''' was attempted before the previous action could complete (e.g. pressing ctrl+z while you are still drawing a rectangle). This is now fixed.

* Previously, if there was a single '''invalid property''' in a <code>style</code> attribute, the entire attribute was discarded, i.e. the object lost all styling. Now Inkscape's behavior is more compliant to the CSS specification: it ignores only the invalid property but reads in all the rest.

* Several bugs are fixed in '''searching for linked images'''. Now moving SVG documents with their associated images to a different place or a different machine should work more reliably.

* Master opacity did not apply to stroke '''markers''' as it should; fixed.

* '''Creative Commons Public Domain Declaration URI''' points to the right location now.

* Text objects didn't display the '''pattern editing handles'''; fixed.

= Previous releases =

* [[ReleaseNotes045]]
* [[ReleaseNotes044]]
* [[ReleaseNotes043]]
* [[ReleaseNotes042]]
* [[ReleaseNotes041]]
* [[ReleaseNotes040]]
* [[ReleaseNotes039]]
* [[ReleaseNotes038]]
* [[ReleaseNotes037]]
* [[ReleaseNotes036]]
* [[ReleaseNotes035]]

[[Category:Marketing]]

CompilingMacOsX

2007-09-01T11:41:58Z

Jiho: /* Enabling python effects */ moved to GettingEffects Working where it belongs more

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X > 10.3
*XCode Tools (with gcc)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies: glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape with X11, using MacPorts ==

=== Installing dependencies ===
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has built-in help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to update from svn, generate the configure script, configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh update autogen configure build install -s package</pre>
or more simply
<pre>./osx-build.sh u a c b i -s p</pre>
or even more simply
<pre>./osx-build.sh all -s</pre>

=== Step by step instructions ===
If you want to know what you are doing or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independent from the original location of the libraries and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script ==

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape with native GTK using MacPorts [experimental] ==
This process will be very similar to compiling a X11 version of Inkscape except for the building of dependencies: you will need to build native versions of GTK and Cairo.
At the moment (2007-09-31) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

=== Native version of GTK and Cairo ===
In theory you should be able to install a second MacPorts tree independent from your usual one (in /opt/local-native/ for example) but I did not manage to have the two cohabit so I would advise doing everything in your regular MacPorts tree. However, this should not be too much of a problem thanks to the power of port "variants" and port "deactivation".

You need to deactivate (suppress from the tree without really uninstalling) current version of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm</pre>
Then install native variants:
<pre>sudo port install cairo +quartz cairomm +quartz gtk2 +quartz</pre>
There is currently an incompatibility with gtk and cairo native ports. It is reported in this ticket at MacPorts [http://trac.macports.org/projects/macports/ticket/11745]
You need to edit the Portfile for gtk2 according to the Portfile patch:
<pre>sudo port edit gtk2</pre>
and add the patch to the <code>files</code> directory next to the Portfile. If you edit your file in a Cocoa editor just Command+click on the filename in the window title bar and this will bring a menu with the file hierarchy down to the Portfile. Go one step up and you're there. Otherwise the path is <pre>/opt/localquartz/var/macports/sources/rsync.macports.org/release/ports/x11/gtk2</pre>

=== Pango without X requirements ===
Then you need to prevent Pango to try using Xft or X to render fonts. To do this kind of cleanly we'll create a new variant for Pango, called <code>no_x</code>. So:
<pre>sudo edit pango</pre>
and, after configure.arg add:
<pre>variant no_x description {Remove X and Xft rendering} {
configure.args-append --with-x=no
depends_lib-delete lib:libX11.6:XFree86 \
port:Xft2
}</pre>
The deactivate pango and install the new variant:
<pre>sudo port deactivate pango
sudo port install pango +no_x</pre>

=== Install the rest ===
Eventually, follow the regular install procedure:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit osx-build.sh to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>
NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme.

== Compiling Inkscapewith native GTK using the all in one build script [experimental] ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
moved to [[GettingEffectsWorking]]

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

Extension requirements

2007-09-01T11:41:03Z

Jiho: Reformated the page to have headers and moved mac os x info to here

== Setting Up Effects in Inkscape ==
<i>For effects to work you need to be using inkscape .42 or later.</i><br>
<i>For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]</i><br>
<i>See also [[GettingExtensionsWorking]].</i><br>

=== Unhide the Effects menu ===
(Only necessary in some versions of Inkscape. Between .41 and .45)

On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects" (0.41+CVS onwards only)

Close and reopen Inkscape

== Python Effects ==
=== on Debian GNU / Linux ===
apt-get install python python-xml

=== on Microsoft Windows ===
[[GettingEffectsWorking/Windows]] Tutorial on Getting Effects to work on Windows

=== on Mac OS X ===

Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed in version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]

==== Binary packages ====
You can install a binary version compiled by us, downloadable with the development builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
You need to copy the folders for pyXML (_xmlplus), numpy (numpy) and lxml (*lxml*.egg or lxml) to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).

==== Compiling from source ====
If you prefer, you can install them from source, it is really easy.

'''pyXML'''
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

'''numpy and lxml'''
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Perl Effects ==
=== on Debian GNU / Linux ===
apt-get install perl libxml-xql-perl

=== on Gentoo GNU / Linux ===
emerge -a XML-XQL

=== on Microsoft Windows ===
install [http://www.activestate.com/Products/Download/Download.plex?id=ActivePerl [[ActivePerl]]]
install XML::XQL::DOM (perhaps like this?)
1: install prereqs with ppm:
install xml-dom
install parse-yapp
install datemanip
2: download xml-xql from:
http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
3: open command prompt and locate perl"s lib directory with:
perl -e "print qq(@INC)" (mine was C:[[/Perl/site/lib]])
4: unpack xml-xql archive
5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

== Plugin Effects ==
I have absolutely no idea. Please record your success here. :)

== What if it doesn't work? ==
Run Inkscape from the console

Use the error messges printed to the console to diagnose the problem (very often missing dependencies)

On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

[[Category:Extensions]]

CompilingMacOsX

2007-09-01T11:31:32Z

Jiho: /* Compiling Inkscape as a native application (no X11) */

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X > 10.3
*XCode Tools (with gcc)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies: glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape with X11, using MacPorts ==

=== Installing dependencies ===
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has built-in help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to update from svn, generate the configure script, configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh update autogen configure build install -s package</pre>
or more simply
<pre>./osx-build.sh u a c b i -s p</pre>
or even more simply
<pre>./osx-build.sh all -s</pre>

=== Step by step instructions ===
If you want to know what you are doing or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independent from the original location of the libraries and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script ==

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape with native GTK using MacPorts [experimental] ==
This process will be very similar to compiling a X11 version of Inkscape except for the building of dependencies: you will need to build native versions of GTK and Cairo.
At the moment (2007-09-31) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

=== Native version of GTK and Cairo ===
In theory you should be able to install a second MacPorts tree independent from your usual one (in /opt/local-native/ for example) but I did not manage to have the two cohabit so I would advise doing everything in your regular MacPorts tree. However, this should not be too much of a problem thanks to the power of port "variants" and port "deactivation".

You need to deactivate (suppress from the tree without really uninstalling) current version of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm</pre>
Then install native variants:
<pre>sudo port install cairo +quartz cairomm +quartz gtk2 +quartz</pre>
There is currently an incompatibility with gtk and cairo native ports. It is reported in this ticket at MacPorts [http://trac.macports.org/projects/macports/ticket/11745]
You need to edit the Portfile for gtk2 according to the Portfile patch:
<pre>sudo port edit gtk2</pre>
and add the patch to the <code>files</code> directory next to the Portfile. If you edit your file in a Cocoa editor just Command+click on the filename in the window title bar and this will bring a menu with the file hierarchy down to the Portfile. Go one step up and you're there. Otherwise the path is <pre>/opt/localquartz/var/macports/sources/rsync.macports.org/release/ports/x11/gtk2</pre>

=== Pango without X requirements ===
Then you need to prevent Pango to try using Xft or X to render fonts. To do this kind of cleanly we'll create a new variant for Pango, called <code>no_x</code>. So:
<pre>sudo edit pango</pre>
and, after configure.arg add:
<pre>variant no_x description {Remove X and Xft rendering} {
configure.args-append --with-x=no
depends_lib-delete lib:libX11.6:XFree86 \
port:Xft2
}</pre>
The deactivate pango and install the new variant:
<pre>sudo port deactivate pango
sudo port install pango +no_x</pre>

=== Install the rest ===
Eventually, follow the regular install procedure:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit osx-build.sh to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>
NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme.

== Compiling Inkscapewith native GTK using the all in one build script [experimental] ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed as of version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]

=== Binary packages ===
You can install a binary version compiled by us, downloadable with the development builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44.PPC or later (their name contains "+python").
You need to copy the folders for pyXML (_xmlplus), numpy (numpy) and lxml (*lxml*.egg) to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).

=== Compiling from source ===
If you prefer, you can install them from source, it is really easy.

==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

==== numpy and lxml====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-09-01T11:30:31Z

Jiho: /* Native version of GTK and Cairo */ finished the instructions to build inkscape natively with MP

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X > 10.3
*XCode Tools (with gcc)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies: glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape with X11, using MacPorts ==

=== Installing dependencies ===
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has built-in help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to update from svn, generate the configure script, configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh update autogen configure build install -s package</pre>
or more simply
<pre>./osx-build.sh u a c b i -s p</pre>
or even more simply
<pre>./osx-build.sh all -s</pre>

=== Step by step instructions ===
If you want to know what you are doing or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independent from the original location of the libraries and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script ==

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape with native GTK using MacPorts [experimental] ==
This process will be very similar to compiling a X11 version of Inkscape except for the building of dependencies: you will need to build native versions of GTK and Cairo.
At the moment (2007-09-31) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

=== Native version of GTK and Cairo ===
In theory you should be able to install a second MacPorts tree independent from your usual one (in /opt/local-native/ for example) but I did not manage to have the two cohabit so I would advise doing everything in your regular MacPorts tree. However, this should not be too much of a problem thanks to the power of port "variants" and port "deactivation".

You need to deactivate (suppress from the tree without really uninstalling) current version of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm</pre>
Then install native variants:
<pre>sudo port install cairo +quartz cairomm +quartz gtk2 +quartz</pre>
There is currently an incompatibility with gtk and cairo native ports. It is reported in this ticket at MacPorts [http://trac.macports.org/projects/macports/ticket/11745]
You need to edit the Portfile for gtk2 according to the Portfile patch:
<pre>sudo port edit gtk2</pre>
and add the patch to the <code>files</code> directory next to the Portfile. If you edit your file in a Cocoa editor just Command+click on the filename in the window title bar and this will bring a menu with the file hierarchy down to the Portfile. Go one step up and you're there. Otherwise the path is <pre>/opt/localquartz/var/macports/sources/rsync.macports.org/release/ports/x11/gtk2</pre>

=== Pango without X requirements ===
Then you need to prevent Pango to try using Xft or X to render fonts. To do this kind of cleanly we'll create a new variant for Pango, called <code>no_x</code>. So:
<pre>sudo edit pango</pre>
and, after configure.arg add:
<pre>variant no_x description {Remove X and Xft rendering} {
configure.args-append --with-x=no
depends_lib-delete lib:libX11.6:XFree86 \
port:Xft2
}</pre>
The deactivate pango and install the new variant:
<pre>sudo port deactivate pango
sudo port install pango +no_x</pre>

=== Install the rest ===
Eventually, follow the regular install procedure:
<pre>sudo port install libxslt boost boehmgc gtkmm lcms intltool popt</pre>
Get inkscape source code and go in the mac OS X specific packaging directory
<pre>cd packaging/macosx</pre>
There edit osx-build.sh to remove the configure option <code>--enable-osxapp</code> because it puts inkscape in a .app bundle where it is started together with X11, which would defeat the purpose of this native compilation. You can also specify an alternative install prefix if you want. Then
<pre>./osx-build.sh u a c b i</pre>
and a native version of Inkscape is installed in the prefix you specified or in the <code>Build/bin</code> directory of Inkscape's source code. You can test it by
<pre> cd ../../Build/bin/
./inkscape</pre>
NB: if you compiled a GTK theme engine against your old GTK install (i.e. the one with X11) and try to use it with the new install, it will complain, so edit <code>~/.gtkrc-2.0</code> to remove the offending theme.

== Compiling Inkscape as a native application (no X11) ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed as of version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]

=== Binary packages ===
You can install a binary version compiled by us, downloadable with the development builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44.PPC or later (their name contains "+python").
You need to copy the folders for pyXML (_xmlplus), numpy (numpy) and lxml (*lxml*.egg) to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).

=== Compiling from source ===
If you prefer, you can install them from source, it is really easy.

==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

==== numpy and lxml====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-09-01T10:35:18Z

Jiho: /* Compiling Inkscape using MacPorts [with X11] */

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X > 10.3
*XCode Tools (with gcc)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies: glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape with X11, using MacPorts ==

=== Installing dependencies ===
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has built-in help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to update from svn, generate the configure script, configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh update autogen configure build install -s package</pre>
or more simply
<pre>./osx-build.sh u a c b i -s p</pre>
or even more simply
<pre>./osx-build.sh all -s</pre>

=== Step by step instructions ===
If you want to know what you are doing or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independent from the original location of the libraries and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script ==

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape with native GTK using MacPorts [experimental] ==
This process will be very similar to compiling a X11 version of Inkscape except for the building of dependencies: you will need to build native versions of GTK and Cairo.
At the moment (2007-09-31) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

=== Native version of GTK and Cairo ==
In theory you should be able to install a second MacPorts tree independent from your usual one (in /opt/local-native/ for example) but I did not manage to have the two cohabit so I would advise doing everything in your regular MacPorts tree. However, this should not be too much of a problem thanks to the power of "variants" and port deactivation.
You need to deactivate (suppress from the tree without really uninstalling) current version of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm</pre>
Then install native variants:
<pre>sudo port install cairo +quartz cairomm +quartz gtk2 +quartz</pre>
There is currently an incompatibility with gtk and cairo native ports. It is reported in this ticket
You need to edit the Portfile for gtk according to the Portfile patch:
<pre>sudo port edit gtk2</pre>
and add the patch to the <code>files</code> directory next to the Portfile. If you edit your file in a Cocoa editor just Command+click on the filename in the window title bar and this will bring a menu with the file hierarchy down to the Portfile. Go one step up and you're there. Otherwise the path is <pre>/opt/localquartz/var/macports/sources/rsync.macports.org/release/ports/x11/gtk2</pre>

to be continued...

== Compiling Inkscape as a native application (no X11) ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed as of version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]

=== Binary packages ===
You can install a binary version compiled by us, downloadable with the development builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44.PPC or later (their name contains "+python").
You need to copy the folders for pyXML (_xmlplus), numpy (numpy) and lxml (*lxml*.egg) to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).

=== Compiling from source ===
If you prefer, you can install them from source, it is really easy.

==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

==== numpy and lxml====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-09-01T10:34:41Z

Jiho: /* Requirements */

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X > 10.3
*XCode Tools (with gcc)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies: glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape using MacPorts [with X11]==

=== Installing dependencies ===
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has built-in help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to update from svn, generate the configure script, configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh update autogen configure build install -s package</pre>
or more simply
<pre>./osx-build.sh u a c b i -s p</pre>
or even more simply
<pre>./osx-build.sh all -s</pre>

=== Step by step instructions ===
If you want to know what you are doing or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independent from the original location of the libraries and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script ==

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape with native GTK using MacPorts [experimental] ==
This process will be very similar to compiling a X11 version of Inkscape except for the building of dependencies: you will need to build native versions of GTK and Cairo.
At the moment (2007-09-31) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

=== Native version of GTK and Cairo ==
In theory you should be able to install a second MacPorts tree independent from your usual one (in /opt/local-native/ for example) but I did not manage to have the two cohabit so I would advise doing everything in your regular MacPorts tree. However, this should not be too much of a problem thanks to the power of "variants" and port deactivation.
You need to deactivate (suppress from the tree without really uninstalling) current version of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm</pre>
Then install native variants:
<pre>sudo port install cairo +quartz cairomm +quartz gtk2 +quartz</pre>
There is currently an incompatibility with gtk and cairo native ports. It is reported in this ticket
You need to edit the Portfile for gtk according to the Portfile patch:
<pre>sudo port edit gtk2</pre>
and add the patch to the <code>files</code> directory next to the Portfile. If you edit your file in a Cocoa editor just Command+click on the filename in the window title bar and this will bring a menu with the file hierarchy down to the Portfile. Go one step up and you're there. Otherwise the path is <pre>/opt/localquartz/var/macports/sources/rsync.macports.org/release/ports/x11/gtk2</pre>

to be continued...

== Compiling Inkscape as a native application (no X11) ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed as of version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]

=== Binary packages ===
You can install a binary version compiled by us, downloadable with the development builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44.PPC or later (their name contains "+python").
You need to copy the folders for pyXML (_xmlplus), numpy (numpy) and lxml (*lxml*.egg) to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).

=== Compiling from source ===
If you prefer, you can install them from source, it is really easy.

==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

==== numpy and lxml====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-08-31T22:26:05Z

Jiho: added the begining of explanations to compile inkscape native with macports

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X 10.4 (10.3 support is on the way, you are welcome to help if you still have a machine running 10.3)
*XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies, for example glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape using MacPorts [with X11]==

=== Installing dependencies ===
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has built-in help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to update from svn, generate the configure script, configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh update autogen configure build install -s package</pre>
or more simply
<pre>./osx-build.sh u a c b i -s p</pre>
or even more simply
<pre>./osx-build.sh all -s</pre>

=== Step by step instructions ===
If you want to know what you are doing or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independent from the original location of the libraries and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a Universal Binary of Inkscape with X11, using the all-in-one build script ==

To build a Universal Binary of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape with native GTK using MacPorts [experimental] ==
This process will be very similar to compiling a X11 version of Inkscape except for the building of dependencies: you will need to build native versions of GTK and Cairo.
At the moment (2007-09-31) this process does not produce a usable version of Inkscape but the more people try to use it, the quicker the bugs will be ironed out!

=== Native version of GTK and Cairo ==
In theory you should be able to install a second MacPorts tree independent from your usual one (in /opt/local-native/ for example) but I did not manage to have the two cohabit so I would advise doing everything in your regular MacPorts tree. However, this should not be too much of a problem thanks to the power of "variants" and port deactivation.
You need to deactivate (suppress from the tree without really uninstalling) current version of gtk, cairo, cairomm and pango:
<pre>sudo port deactivate gtk2 cairo cairomm</pre>
Then install native variants:
<pre>sudo port install cairo +quartz cairomm +quartz gtk2 +quartz</pre>
There is currently an incompatibility with gtk and cairo native ports. It is reported in this ticket
You need to edit the Portfile for gtk according to the Portfile patch:
<pre>sudo port edit gtk2</pre>
and add the patch to the <code>files</code> directory next to the Portfile. If you edit your file in a Cocoa editor just Command+click on the filename in the window title bar and this will bring a menu with the file hierarchy down to the Portfile. Go one step up and you're there. Otherwise the path is <pre>/opt/localquartz/var/macports/sources/rsync.macports.org/release/ports/x11/gtk2</pre>

to be continued...

== Compiling Inkscape as a native application (no X11) ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed as of version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]

=== Binary packages ===
You can install a binary version compiled by us, downloadable with the development builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44.PPC or later (their name contains "+python").
You need to copy the folders for pyXML (_xmlplus), numpy (numpy) and lxml (*lxml*.egg) to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).

=== Compiling from source ===
If you prefer, you can install them from source, it is really easy.

==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

==== numpy and lxml====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-08-31T21:25:00Z

Jiho: /* Compiling Inkscape using MacPorts */ updated the list of dependencies

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X 10.4 (10.3 support is on the way, you are welcome to help if you still have a machine running 10.3)
*XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies, for example glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape using MacPorts [with X11]==

=== Installing dependencies ===
You can use MacPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>gnome-vfs</code> : access to remote servers, in particular import from Open Clipart Library
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install gnome-vfs aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has built-in help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to update from svn, generate the configure script, configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh update autogen configure build install -s package</pre>
or more simply
<pre>./osx-build.sh u a c b i -s p</pre>
or even more simply
<pre>./osx-build.sh all -s</pre>

=== Step by step instructions ===
If you want to know what you are doing or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
MacPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independent from the original location of the libraries and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a universal binary of Inkscape using the all-in-one build script ==

To build a universal build of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape as a native application (no X11) ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed as of version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]

=== Binary packages ===
You can install a binary version compiled by us, downloadable with the development builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44.PPC or later (their name contains "+python").
You need to copy the folders for pyXML (_xmlplus), numpy (numpy) and lxml (*lxml*.egg) to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).

=== Compiling from source ===
If you prefer, you can install them from source, it is really easy.

==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

==== numpy and lxml====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-08-20T07:34:18Z

Jiho: /* Enabling python effects */ modified to include info about lxml

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X 10.4 (10.3 support is on the way, you are welcome to help if you still have a machine running 10.3)
*XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies, for example glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape using Mac/DarwinPorts ==

=== Installing dependencies ===
You can use DarwinPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gnome-vfs intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has builtin help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh conf build install -s package</pre>
or more simply
<pre>./osx-build.sh c b i -s p</pre>

=== Step by step instructions ===
If you want to know what you do or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
DarwinPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independant from the original location of the librairies and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a universal binary of Inkscape using the all-in-one build script ==

To build a universal build of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape as a native application (no X11) ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed as of version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]

=== Binary packages ===
You can install a binary version compiled by us, downloadable with the development builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44.PPC or later (their name contains "+python").
You need to copy the folders for pyXML (_xmlplus), numpy (numpy) and lxml (*lxml*.egg) to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).

=== Compiling from source ===
If you prefer, you can install them from source, it is really easy.

==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

==== numpy and lxml====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-08-20T07:28:16Z

Jiho: /* Installing dependencies */ placed boost as a mandatory dependency

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X 10.4 (10.3 support is on the way, you are welcome to help if you still have a machine running 10.3)
*XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies, for example glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape using Mac/DarwinPorts ==

=== Installing dependencies ===
You can use DarwinPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gnome-vfs intltool libxslt lcms popt boost</pre>

Others provide additional functionality to Inkscape:
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install aspell libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has builtin help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh conf build install -s package</pre>
or more simply
<pre>./osx-build.sh c b i -s p</pre>

=== Step by step instructions ===
If you want to know what you do or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
DarwinPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independant from the original location of the librairies and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a universal binary of Inkscape using the all-in-one build script ==

To build a universal build of Inkscape you also need to build Universal versions of all its dependencies (i.e., gtk+, cairo, pango, etc). You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/).

This process is relatively untested, as it is only being used by Michael Wybrow for official Inkscape release builds. If you have any troubles using this process then please report them to Michael (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
export UNIVERSAL_BUILD=Yes
./build-gtk bootstrap
./build-gtk build inkscape

== Compiling Inkscape as a native application (no X11) ==

To build a native-GTK build of Inkscape, GTK and some of its dependencies must be built with special options. You can do this using the build-gtk.sh script from the Inkscape repository (it's in packaging/macosx/native-gtk/). This is a modified version of the Imendio native build script, found with instructions on this page:
http://developer.imendio.com/projects/gtk-macosx/build-instructions

This process is relatively untested. If you have any troubles using this process then please report them to Michael Wybrow (mjwybrow on sourceforge).

The process is:
export PREFIX=/your/install/prefix
./build-gtk bootstrap
./build-gtk build inkscape

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] and [http://numpy.scipy.org/ numpy].

=== Binary packages ===
You can install a binary version compiled by us (thanks to krolco for the Intel version) downloadable with the developement builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44.PPC or later (their name contains "+python").
You need to copy the folders for pyXML (_xmlplus) and numpy (numpy) to /Library/Python/2.3/site-packages/ (there is a link in the dmg on which the folders can be droped).

On OS X 10.3, the _xmlplus and numpy folders should be copied to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages. This is a symlink back to /Library/Python/2.3 (note lack of "site-packages"!).

=== Compiling from source ===
If you prefer or if you are on an Intel machine, you can install them from source, it is really easy.

==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

==== numpy ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-04-17T16:24:49Z

Jiho: /* Binary packages for PPC users */ modified to take in account that we have Intel version now

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X 10.4 (10.3 support is on the way, you are welcome to help if you still have a machine running 10.3)
*XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies, for example glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape using Mac/DarwinPorts ==

=== Installing dependencies ===
You can use DarwinPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gnome-vfs intltool libxslt lcms popt</pre>

Others provide additional functionality to Inkscape:
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>boost</code> : auto-organisation of connectors [Note: is boost still needed?]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install aspell boost libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has builtin help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh conf build install -s package</pre>
or more simply
<pre>./osx-build.sh c b i -s p</pre>

=== Step by step instructions ===
If you want to know what you do or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
DarwinPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independant from the original location of the librairies and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a universal binary of Inkscape using the all-in-one build script ==
Michael's text to go here

== Compiling Inkscape as a native application (no X11) ==
Derek Hinchliffe's text to go here

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] and [http://numpy.scipy.org/ numpy].

=== Binary packages ===
You can install a binary version compiled by us (thanks to krolco for the Intel version) downloadable with the developement builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44.PPC or later (their name contains "+python").
You need to copy the folders for pyXML (_xmlplus) and numpy (numpy) to /Library/Python/2.3/site-packages/ (there is a link in the dmg on which the folders can be droped).

=== Compiling from source ===
If you prefer or if you are on an Intel machine, you can install them from source, it is really easy.

==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

==== numpy ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-03-23T22:48:08Z

Jiho: /* numpy */

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X 10.4 (10.3 support is on the way, you are welcome to help if you still have a machine running 10.3)
*XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies, for example glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape using Mac/DarwinPorts ==

=== Installing dependencies ===
You can use DarwinPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gnome-vfs intltool libxslt lcms popt</pre>

Others provide additional functionality to Inkscape:
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>boost</code> : auto-organisation of connectors [Note: is boost still needed?]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install aspell boost libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has builtin help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh conf build install -s package</pre>
or more simply
<pre>./osx-build.sh c b i -s p</pre>

=== Step by step instructions ===
If you want to know what you do or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
DarwinPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independant from the original location of the librairies and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a universal binary of Inkscape using the all-in-one build script ==
Michael's text to go here

== Compiling Inkscape as a native application (no X11) ==
Derek Hinchliffe's text to go here

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] and [http://numpy.scipy.org/ numpy].

=== Binary packages for PPC users ===
[Note: could someone do this for Intel users as well? you need to set your environment to use Python 2.3 from Apple]
If you are on a PPC machine, you can install a binary version downloadable with the developement builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44 or later (their name contains "+python"). You need to copy them to /Library/Python/2.3/site-packages/ (there is usually a direct link in the dmg on which the folders can be droped).

=== Compiling from source ===
If you prefer or if you are on an Intel machine, you can install them from source, it is really easy.

==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

==== numpy ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]

CompilingMacOsX

2007-03-23T22:46:30Z

Jiho: /* Creating an .app bundle */

== Requirements ==
To compile Inkscape from source you will need:
*Mac OS X 10.4 (10.3 support is on the way, you are welcome to help if you still have a machine running 10.3)
*XCode 2.3 on OS X 10.4 (i.e. with gcc 4.0.1)
*Inkscape's source code. You can get the [http://www.inkscape.org/download.php official release source code], a [http://inkscape.modevia.com/svn-snap/?M=D SVN snapshot] or a copy of the [http://www.inkscape.org/svn.php?lang=en SVN repository].
*Inkscape's dependencies, for example glibmm, gtkmm, lmcs, boehm gc... You can use a package distribution system ([http://www.finkproject.org/ Fink] or [http://www.macports.org/ MacPorts], formerly known as [http://darwinports.opendarwin.org/ DarwinPorts]) or Inkscape all-in-one universal build script to install them. Inkscape requires a recent version of gtk, hence only MacPorts can be used at the moment. Once Fink updates gtk it should not be a problem to use it.

== Compiling Inkscape using Mac/DarwinPorts ==

=== Installing dependencies ===
You can use DarwinPorts to list Inkscape dependencies:
<pre>port deps inkscape</pre>

Some are mandatory and you can install them with the command:
<pre>sudo port install boehmgc gtkmm gnome-vfs intltool libxslt lcms popt</pre>

Others provide additional functionality to Inkscape:
* <code>aspell</code> : check spelling of text elements [Note: I have never seen it working on OS X]
* <code>boost</code> : auto-organisation of connectors [Note: is boost still needed?]
* <code>libgnomeprintui</code>
* <code>loudmouth</code> : jabber library used by InkBoard
<pre>sudo port install aspell boost libgnomeprintui loudmouth</pre>

=== For the impatient ===
There is an automated build script for Mac OS X included with Inkscape source code, in the directory packaging/macosx. It has builtin help:
<pre> cd packaging/macosx/
./osx-build.sh help</pre>

Basically to configure, build, install and package Inkscape into a double clickable app bundle you just need to issue the command
<pre>./osx-build.sh conf build install -s package</pre>
or more simply
<pre>./osx-build.sh c b i -s p</pre>

=== Step by step instructions ===
If you want to know what you do or to understand how the build script works, please read the following paragraphs.

==== Setting the build environment ====
DarwinPorts's hierarchy (/opt/local/) is not searched for libraries by default. Therefore, before the configuration starts, some environment variables need to be set. The environment variables are presented in bash syntax here.
<pre>export LIBPREFIX="/opt/local"
# automake seach path
export CPATH="$LIBPREFIX/include"
# configure search path
export CPPFLAGS="-I$LIBPREFIX/include"
export LDFLAGS="-L$LIBPREFIX/lib"
# compiler arguments
export CFLAGS="-O3 -Wall"
export CXXFLAGS="$CFLAGS"
</pre>

You can also use <code>[http://en.wikipedia.org/wiki/Ccache ccache]</code> (<code>sudo port install ccache</code>) to speed up the compilation a bit. To do so, add compiler variables:
<pre>export CC="ccache gcc"
export CXX="ccache g++"</pre>

==== Configuring ====
If you compile Inkscape for the first time from an svn checkout you probably need to build the configure script. Navigate to Inkscape's source directory and run:
<pre>./autogen.sh</pre>

Then run configure with the options <code>--disable-static --enable-shared</code> and <code>--prefix</code> which sets the directory where the build products are placed. It must be somewhere you have write access to.
<pre>./configure --disable-static --enable-shared --prefix=/path/to/build/products/</pre>

I you want to package Inkscape into a double-clickable <code>.app</code> bundle in order to access it like a regular OS X application (you probably want to do it), you need to add the option <code>--enable-osxapp</code>:
<pre>./configure {...} --enable-osxapp</pre>

If you have loudmouth installed and you want to enable whiteboard functionality in Inkscape, add <code>--enable-inkboard</code>.

Other configuration options can be set, check the list of options by issuing:
<pre>./configure --help</pre>

==== Building and Installing ====
Just run:
<pre>make
make install</pre>

==== Creating an .app bundle ====
Assuming that you have used the <code>--enable-osxapp</code> option during <code>configure</code>, navigate to Mac OS X packaging directory in Inkscape source code and use the automated script:
<pre>cd packaging/macosx
./osx-app.sh -s /path/to/install/prefix/bin/inkscape ../Info.plist macosx</pre>
The script copies Inkscape binary and all its dependencies into the app bundle. The <code>-s</code> options strips libraries from debugging information (the bundle is therefore smaller). Omit this option if you want to keep debugging info.

==== Creating a disk image to distribute Inkscape ====
Inkscape.app created at the previous step is completely independant from the original location of the librairies and can therefore be distributed. It will only work on one platform though (PPC or Intel): the one you built it on.
The most widespread way of distributing applications on Mac OS X is via .dmg images. You can created a dmg image of Inkscape, with a nice background, with the script:
<pre>./osx-dmg.sh</pre>
in the packaging directory for Mac OS X.

== Compiling a universal binary of Inkscape using the all-in-one build script ==
Michael's text to go here

== Compiling Inkscape as a native application (no X11) ==
Derek Hinchliffe's text to go here

== Enabling python effects ==
Many "effects" in the Effect menu of Inkscape use python as a scripting language. Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] and [http://numpy.scipy.org/ numpy].

=== Binary packages for PPC users ===
[Note: could someone do this for Intel users as well? you need to set your environment to use Python 2.3 from Apple]
If you are on a PPC machine, you can install a binary version downloadable with the developement builds of Inkscape:
:http://inkscape.modevia.com/macosx-snap/?M=D
or in an official stable package for 0.44 or later (their name contains "+python"). You need to copy them to /Library/Python/2.3/site-packages/ (there is usually a direct link in the dmg on which the folders can be droped).

=== Compiling from source ===
If you prefer or if you are on an Intel machine, you can install them from source, it is really easy.

==== pyXML ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

==== numpy ====
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.

== Links ==

=== Apple Documentation ===
* [http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/BPRuntimeConfig.html Introduction to Runtime Configuration] Covers the Info.plist files, Preferences, Environment variables and has a list of the most important Properties that the Property List should contain.

=== Packaging ===

* [http://www.sveinbjorn.org/platypus Sveinbjorn Thordarson's Website] The author of Platypus, the Script Exec wrapper that launches the Inkscape binary.
* [http://freespace.ausgamers.com/2005/02/creating-os-x-application-bundles-step.html Creating OS X application bundles step by step] Covers the bundle concepts, copying libraries into the bundle, editing libraries with the install_name_tool, the Info.plist file and adding an icon.
* [http://java.sun.com/developer/technicalArticles/JavaLP/JavaToMac3/ Bringing your Java Application to Mac OS X] I would regard this a little dated, and the detail is (unsurprisingly) Java-related, but it is a gentle introduction to the role of the .app bundle and give a most clear account of how to create one.
* The [http://gimp-app.sourceforge.net/gimp.app.howto.txt Gimp .app Howto] This is a very bare document, and would be of little help to you if you were new to making packages. Note that it seems to refer to a more mature Clipboard technique and Online help than we currently have; and we ought to move to parity in these areas.

[[Category:Developer Documentation]]