Inkscape Wiki - User contributions [en]

Installing Inkscape

2025-10-26T17:44:00Z

PBS: Update dev version download instructions after GitLab changes

This page explains how to install Inkscape, either the stable or the development version. For instructions on how to compile Inkscape from the source code, see [[Compiling Inkscape]].

The latest stable version can always be found on the [https://inkscape.org/release/ Download page]. The latest development versions are available from [https://gitlab.com/inkscape/inkscape/-/commits/master GitLab].
== Installing the stable version ==
=== '''macOS''' ===
DMG files can be downloaded from the [https://inkscape.org/release/ Download page]. Click the box labelled macOS and choose Intel or arm64 architecture. Once the download is complete, installation is the same as for any other DMG.

See also the [https://inkscape.org/learn/faq/#mac-os-x-specific-issues section dedicated to macOS in our FAQ], and the [https://inkscape-manuals.readthedocs.io/en/latest/installing-on-mac.html readthedocs] page for installation on macOS.
=== '''Linux''' ===

On most Linux systems, you can use the software installer provided with your system (look for "software" in your start menu) to install Inkscape.

Visit the [https://inkscape.org/release/ Download page] to see a list of other available options and installation methods for each available version.

==== Ubuntu or Debian ====
Probably the easiest way to install on Debian/Ubuntu is to use the <code>apt</code> command.

Open a terminal and type:
sudo apt-get update
sudo apt-get install inkscape

If your Ubuntu version does not have the most recent Inkscape version in its repositories (yet), the next section describes how to use the [https://launchpad.net/~inkscape.dev/+archive/ubuntu/stable stable PPA] to get it.

==== Ubuntu (new stable versions) ====

The most recent version (slightly newer than what is available directly from Ubuntu) is available from our [https://launchpad.net/~inkscape.dev/+archive/ubuntu/stable/ stable PPA] for Ubuntu and derivative Linux distributions:

<pre>
sudo add-apt-repository universe
sudo add-apt-repository ppa:inkscape.dev/stable
sudo apt-get update
sudo apt install inkscape
</pre>

==== openSUSE ====

openSUSE includes Inkscape in the Gnome repositories. The newest version of Inkscape is in Gnome:Apps.
=== '''Windows''' ===
You can find the installer on the [http://www.inkscape.org/release/ Download page]. Normally you want to choose "64-bit architecture" and "Windows Installer Package (msi)". Installing should be an easy step-by-step (next-next-finish) process.

== Installing the development version ==
First be warned. Unstable and development mean you likely will encounter crashes, usability problems and sometimes lose data. Ctrl+S will become your friend. If you cannot take this risk, please use the stable version instead.

If you are still reading, you are probably one of the brave ones who wants to be on the bleeding edge. If so, follow the steps below.

'''Don't forget:''' Please help Inkscape by reporting bugs, encouraging developers or fixing bugs yourself. If you find bugs, make sure to include the debug information which can be found in <code>Help > About</code>.

'''Tip:''' If you're looking for a beta release, those can be downloaded from the [https://inkscape.org/release/ Download page]. Find the "Next version preview" option in the Download tab, and proceed like you would with a stable release.

=== '''macOS''' ===
See [[Installing Inkscape#Finding development versions on GitLab|Finding development versions on GitLab]] below for instructions to download the development version, then install it in the same way as the stable version.

=== '''Linux''' ===
You can run an [https://appimage.org/ AppImage] of the latest development version on any Linux distribution. See [[Installing Inkscape#Finding development versions on GitLab|Finding development versions on GitLab]] below for instructions on how to download. To run, extract the zip and run the executable inside.

'''Tip:''' If you don't want to trust our executable, you can run it with sandboxing using [https://wiki.archlinux.org/title/Firejail firejail]: <code>firejail --appimage ...</code>.

==== Ubuntu ====
Development versions (inkscape-trunk) are also available from our [https://launchpad.net/~inkscape.dev/+archive/ubuntu/trunk trunk PPA] for Ubuntu and derivative Linux distributions. Follow the commands at https://inkscape.org/release/inkscape-dev/gnulinux/ubuntu/ppa/dl/ .

=== '''Windows''' ===

=== 1. Download the latest build ===
Follow the instructions on [https://inkscape.org/release/inkscape-dev/windows/ the inkscape-dev Download page] to download a 7zip file of the latest development build. Save the file (<code>inkscape-....7z</code>) to your Downloads folder.

==== 2. Extract the .7z archive ====
Extract the archive using the [http://www.7-zip.org/ 7zip unpacker]: Open the Downloads folder in Explorer, right-click on the 7zip file and choose 7-Zip → Extract to "inkscape-....".

You will get a directory which contains several files including <code>inkscape.exe</code>.

==== 3. Run inkscape ====
Run the <code>inkscape.exe</code> file by double clicking it. That's it. You can also drag files to <code>inkscape.exe</code> to have these opened.

==== Multiple versions for testing ====
For testing purposes it is good to be able to test multiple versions of Inkscape to find when and where some problem first appeared. For this reason you are able to store and use as many parallel versions of Inkscape as your disk has room for.
== Finding development versions on GitLab ==
Recent development builds can be found using the GitLab CI infrastructure. They do however require clicking through several pages to find:

# Visit https://gitlab.com/inkscape/inkscape/-/commits/master.
# There, look for the topmost (most recent) commit with a ✓ mark, and click on that ✓ mark.
#On the next page, find a ✓ mark which when clicked on, shows a menu with "appimage:linux", "inkscape:macos" and "inkscape:windows:7z" in it. Within this menu, click on the item you want to download.
#On the next page, click the Download button.

In a similar way, you download a build of any earlier commit, allowing bugs to be pinpointed to the commit that introduced them.

[[File:Gitlab-download-instructions-1.png|alt=Click the green tick with alt text "Pipeline: passed/failed"|none|thumb|Step 2]]
[[File:Gitlab-download-instructions-2.png|alt=Click the leftmost green tick under "stages" with alt text "build passed:failed"|none|thumb|Step 3]]
[[File:Gitlab-download-instructions-3.png|alt=Click the download button|none||thumb|Step 4]]
[[Category:User Documentation]]

C++20

2025-09-21T21:16:42Z

PBS: Mark as usable std::make_unique_for_overwrite, ranges and heterogenous lookup

See also [[C++11]], [[C++17]], [[C++23]].

Some things that will be interesting to use once C++20 is common:

{| class="wikitable"
|-
! Feature !! Since !! Can use? !! GCC !! Apple Clang !! Comment
|-
| <code>std::span</code> || C++20 || style="background: lightgreen;" | from 1.4 || 10 || 11.0.3 || Handle buffers like standard library containers without risk of overflow.
|-
| <code>std::format</code> || C++20 || style="background: lightgreen;" | from 1.5 || 13 || 15.3 || Better and more efficient formatting of strings. [https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p0645r10.html Text Formatting]
|-
| <code>std::lerp</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9 || 11.0.3 || Linear interpolation. (ui/tools/pencil-tool.cpp)
|-
| <code>std::bit_floor</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9/10 || 11.0.3/13.0.0 || Compute <code>floor(log2(x))</code>. (helper/mathfns.h)
|-
| Concepts || C++20 || style="background: lightgreen;" | from 1.5 || 6/10 || 12.0.0 Partial || Safer templating. (ui/controller.h)
|-
| Coroutines || C++20 || style="background: lightgreen;" | from 1.5 || 10 || 10.0.1 Partial, 15.3 Full || Simpler asynchronous code. (trace/trace.cpp)
|-
| <code>std::make_unique_for_overwrite</code>
|| C++20 || style="background: lightgreen;" | from 1.5 || 11 || 15.0.0 || Don't zero arrays allocated using std::make_unique. (util/pool.cpp)
|-
| Ranges || C++20 || style="background: lightgreen;" | from 1.5 || || ? || (ui/dialog/swatches.cpp)
|-
| [https://stackoverflow.com/a/60244416/5075760 Structural templates]
|| C++20 || from 1.4? || || Partial || Allow instances of arbitrary literal classes as template parameters. (display/drawing.cpp)
|-
| Mathematical Constants || C++20 || || 10 || 12.0.5 || Constants like <code>std::numbers::pi</code>.
|-
| Heterogenous lookup in <code>std::unordered_map</code>
|| C++20 || style="background: lightgreen;" | from 1.5 || || || Faster lookup, use of smart pointers as keys.
|-
|<code>consteval static</code> member functions
|C++20
| style="background: pink;" | not yet
|
|
|Guaranteed compile time evaluation of member functions (stronger than <code>constexpr</code>)
|}

References:

* General: https://en.cppreference.com/w/Template:cpp/compiler_support/20
* Apple Clang: https://developer.apple.com/documentation/xcode-release-notes

As of 21 September 2025, the CI runners for the various supported platforms are
* Linux: GCC 13.3.0 (on Ubuntu 24.04)
* Windows: GCC 15.1.0
* macOS: Apple Clang 17.0.0
* Android: Clang 19.0.0 (on Ubuntu 24.04)

We support the latest Debian stable and latest Ubuntu LTS.
{| class="wikitable"
|-
! Distro || gcc || clang || glib || glibmm || gtk4 || gtkmm4
|-
| Debian 13 (Trixie) || 14.2.0 || 19.0 || 2.84.4 || 2.84.0 || 4.18.6 || 4.18.0
|-
| Ubuntu 24.04 (Noble) || 13.3.0 || 18.1.3 || 2.80.0 || 2.78.1 || 4.14.2 || style="background: wheat;" | 4.10.1
|}

The build requires glibmm >= 2.78.1 and gtkmm4 >= 4.14, however Inkscape will compile its own gtkmm4 if the system version is too old, so building on Ubuntu 24.04 still works out of the box.

Deprecated items that we still use:
* warning: implicit capture of ‘this’ via ‘[=]’ is deprecated in C++20 [-Wdeprecated] https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2018/p0806r2.html
* warning: bitwise operation between different enumeration types ‘Box3D::Axis’ and ‘Box3D::FrontOrRear’ is deprecated [-Wdeprecated-enum-enum-conversion]

C++20

2025-09-21T20:22:15Z

PBS: Mark as usable std::format, concepts, and coroutines

See also [[C++11]], [[C++17]], [[C++23]].

Some things that will be interesting to use once C++20 is common:

{| class="wikitable"
|-
! Feature !! Since !! Can use? !! GCC !! Apple Clang !! Comment
|-
| <code>std::span</code> || C++20 || style="background: lightgreen;" | from 1.4 || 10 || 11.0.3 || Handle buffers like standard library containers without risk of overflow.
|-
| <code>std::format</code> || C++20 || style="background: lightgreen;" | from 1.5 || 13 || 15.3 || Better and more efficient formatting of strings. [https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p0645r10.html Text Formatting]
|-
| <code>std::lerp</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9 || 11.0.3 || Linear interpolation. (ui/tools/pencil-tool.cpp)
|-
| <code>std::bit_floor</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9/10 || 11.0.3/13.0.0 || Compute <code>floor(log2(x))</code>. (helper/mathfns.h)
|-
| Concepts || C++20 || style="background: lightgreen;" | from 1.5 || 6/10 || 12.0.0 Partial || Safer templating. (ui/controller.h)
|-
| Coroutines || C++20 || style="background: lightgreen;" | from 1.5 || 10 || 10.0.1 Partial, 15.3 Full || Simpler asynchronous code. (trace/trace.cpp)
|-
| <code>std::make_unique_for_overwrite</code>
|| C++20 || style="background: pink;" | not yet || 11 || 15.0.0 || Don't zero arrays allocated using std::make_unique. (util/pool.cpp)
|-
| Ranges || C++20 || style="background: pink;" | not yet || || ? || (ui/dialog/swatches.cpp)
|-
| [https://stackoverflow.com/a/60244416/5075760 Structural templates]
|| C++20 || from 1.4? || || Partial || Allow instances of arbitrary literal classes as template parameters. (display/drawing.cpp)
|-
| Mathematical Constants || C++20 || || 10 || 12.0.5 || Constants like <code>std::numbers::pi</code>.
|-
| Heterogenous lookup in <code>std::unordered_map</code>
|| C++20 || style="background: pink;" | not yet || || || Faster lookup, use of smart pointers as keys.
|-
|<code>consteval static</code> member functions
|C++20
| style="background: pink;" | not yet
|
|
|Guaranteed compile time evaluation of member functions (stronger than <code>constexpr</code>)
|}

References:

* General: https://en.cppreference.com/w/Template:cpp/compiler_support/20
* Apple Clang: https://developer.apple.com/documentation/xcode-release-notes

As of 21 September 2025, the CI runners for the various supported platforms are
* Linux: GCC 13.3.0 (on Ubuntu 24.04)
* Windows: GCC 15.1.0
* macOS: Apple Clang 17.0.0
* Android: Clang 19.0.0 (on Ubuntu 24.04)

We support the latest Debian stable and latest Ubuntu LTS.
{| class="wikitable"
|-
! Distro || gcc || clang || glib || glibmm || gtk4 || gtkmm4
|-
| Debian 13 (Trixie) || 14.2.0 || 19.0 || 2.84.4 || 2.84.0 || 4.18.6 || 4.18.0
|-
| Ubuntu 24.04 (Noble) || 13.3.0 || 18.1.3 || 2.80.0 || 2.78.1 || 4.14.2 || style="background: wheat;" | 4.10.1
|}

The build requires glibmm >= 2.78.1 and gtkmm4 >= 4.14, however Inkscape will compile its own gtkmm4 if the system version is too old, so building on Ubuntu 24.04 still works out of the box.

Deprecated items that we still use:
* warning: implicit capture of ‘this’ via ‘[=]’ is deprecated in C++20 [-Wdeprecated] https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2018/p0806r2.html
* warning: bitwise operation between different enumeration types ‘Box3D::Axis’ and ‘Box3D::FrontOrRear’ is deprecated [-Wdeprecated-enum-enum-conversion]

C++20

2025-09-21T18:54:47Z

PBS: Update compiler versions used by CI

See also [[C++11]], [[C++17]], [[C++23]].

Some things that will be interesting to use once C++20 is common:

{| class="wikitable"
|-
! Feature !! Since !! Can use? !! GCC !! Apple Clang !! Comment
|-
| <code>std::span</code> || C++20 || style="background: lightgreen;" | from 1.4 || 10 || 11.0.3 || Handle buffers like standard library containers without risk of overflow.
|-
| <code>std::format</code> || C++20 || style="background: pink;" | not yet || 13 || 15.3 || Better and more efficient formatting of strings. [https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p0645r10.html Text Formatting]
|-
| <code>std::lerp</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9 || 11.0.3 || Linear interpolation. (ui/tools/pencil-tool.cpp)
|-
| <code>std::bit_floor</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9/10 || 11.0.3/13.0.0 || Compute <code>floor(log2(x))</code>. (helper/mathfns.h)
|-
| Concepts || C++20 || from 1.4? || 6/10 || 12.0.0 Partial || Safer templating. (ui/controller.h)
|-
| Coroutines || C++20 || style="background: pink;" | not yet || 10 || 10.0.1 Partial, 15.3 Full || Simpler asynchronous code. (trace/trace.cpp)
|-
| <code>std::make_unique_for_overwrite</code>
|| C++20 || style="background: pink;" | not yet || 11 || 15.0.0 || Don't zero arrays allocated using std::make_unique. (util/pool.cpp)
|-
| Ranges || C++20 || style="background: pink;" | not yet || || ? || (ui/dialog/swatches.cpp)
|-
| [https://stackoverflow.com/a/60244416/5075760 Structural templates]
|| C++20 || from 1.4? || || Partial || Allow instances of arbitrary literal classes as template parameters. (display/drawing.cpp)
|-
| Mathematical Constants || C++20 || || 10 || 12.0.5 || Constants like <code>std::numbers::pi</code>.
|-
| Heterogenous lookup in <code>std::unordered_map</code>
|| C++20 || style="background: pink;" | not yet || || || Faster lookup, use of smart pointers as keys.
|-
|<code>consteval static</code> member functions
|C++20
| style="background: pink;" | not yet
|
|
|Guaranteed compile time evaluation of member functions (stronger than <code>constexpr</code>)
|}

References:

* General: https://en.cppreference.com/w/Template:cpp/compiler_support/20
* Apple Clang: https://developer.apple.com/documentation/xcode-release-notes

As of 21 September 2025, the CI runners for the various supported platforms are
* Linux: GCC 13.3.0 (on Ubuntu 24.04)
* Windows: GCC 15.1.0
* macOS: Apple Clang 17.0.0
* Android: Clang 19.0.0 (on Ubuntu 24.04)

We support the latest Debian stable and latest Ubuntu LTS.
{| class="wikitable"
|-
! Distro || gcc || clang || glib || glibmm || gtk4 || gtkmm4
|-
| Debian 13 (Trixie) || 14.2.0 || 19.0 || 2.84.4 || 2.84.0 || 4.18.6 || 4.18.0
|-
| Ubuntu 24.04 (Noble) || 13.3.0 || 18.1.3 || 2.80.0 || 2.78.1 || 4.14.2 || style="background: wheat;" | 4.10.1
|}

The build requires glibmm >= 2.78.1 and gtkmm4 >= 4.14, however Inkscape will compile its own gtkmm4 if the system version is too old, so building on Ubuntu 24.04 still works out of the box.

Deprecated items that we still use:
* warning: implicit capture of ‘this’ via ‘[=]’ is deprecated in C++20 [-Wdeprecated] https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2018/p0806r2.html
* warning: bitwise operation between different enumeration types ‘Box3D::Axis’ and ‘Box3D::FrontOrRear’ is deprecated [-Wdeprecated-enum-enum-conversion]

Inkscape

2025-08-10T20:26:55Z

PBS: Move 2025 hackfest from upcoming to past

This is a freeform area for Inkscape development and discussion. Curious about [[wiki syntax]]?

{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 33%; background: #EEE; padding: 1em;" |
== Project Info ==
* [http://www.inkscape.org/ Inkscape Homepage]
* [[About Inkscape]]
* [[FAQ]] — Frequently Asked Questions
* [[Tools]] — Supporting Tools and Applications
* [[Galleries]]
* [[Inkscape coverage|Coverage]] — Awards, articles, presentations, books about Inkscape
* [[Inkscape popularity|Popularity]]
* [[Inkscape invariants|Inkscape's Mission]]
* [https://inkscape.org/en/community/ Communication] — How to reach us
* [[Announcement to Sodipodi]] — This started it all
* [[Branding]]
* [[Travel Reimbursement Policy]]
* [[Funded Project System Development]]
* [[:Category:Hackfest|Hackfests]]
** upcoming/proposed events:
** past events:
*** [[Inkscape Summit 2025 Nuremberg|2025 Nuremberg]]
*** [[Hackfest2023_Bensberg|2023 Bensberg]]
*** [[Hackfest2019 SCALE|2019 Pasadena (SCALE)]], [[Hackfest2019 Saarbrücken|2019 Saarbrücken (LGM)]]
*** [[Hackfest2018|2018 Boston]], [[Hackfest2018 LGM|2018 Seville (LGM)]], [[Hackfest2018 Kiel|2018 Kiel]]
*** [[Hackfest2017|2017 Paris]]
*** [[Hackfest2016|2016 Leeds (LGM)]]
*** [[Hackfest2015|2015 Toronto (LGM)]]

| style="width: 33%; padding: 1em;" |

== User Documentation ==
* [[Installing Inkscape|Installation]]
* [[International and Local Communities]]
* [[Inkscape glossary]]
* [[User manual information]] — Inkscape manual and how to contribute
* [http://inkscape.org/en/learn/tutorials/ Tutorials]
* [[Inkscape SVG vs. plain SVG]]
* [[Output format requirements]]
* [[Extension requirements]] — (slightly outdated)
* [[Extension reference]] — What each extension does (slightly outdated)
* [[Installing fonts]]
* [[Emergency save]] — Recovery in case Inkscape crashed
* [[Release notes]]
** ''[[Release notes/1.5|Inkscape 1.5]] — development branch''
** '''[[Release notes/1.4|Inkscape 1.4]]''' — ''current stable release branch''
***[[Release notes/1.4.1|Inkscape 1.4.1]] — ''bug fix release branch''
***'''[[Release notes/1.4.2|Inkscape 1.4.2]]''' — future ''bug fix release branch''
* [[Announcing Releases]] (slightly outdated)
* [[Release Process Debrief]] (slightly outdated)
* [[Tricks and tips]] — Miscellaneous advice (slightly outdated)
*[[Customizing Inkscape]] – Change icons, shortcuts, menus, toolbars and other parts of the user interface

| style="width: 33%; background: #EEE; padding: 1em;" |

== Help Inkscape Without Coding ==
* [[Help wanted]]
* [[Bug management]]
** [[Projects #Bug_Triage]]
* [[Testing]]
** [[macOS alpha|macOS]]
* [[Translation information]]
* [[WebSite]]
* [[Inkscape Classes]]
* [[Conferences]]
* [[Fundraising Ideas]]
* [[Creating Inkscape distributions]] — How to build packages
* [[Updating tracker items]]
* [[Tutorials and help]]
* [[How to start a page]] — How to use the wiki
* [[Creating screencasts]]
* [[About-Screen contest]]
* [[social media|Participate in social media]]
|}

<div style="margin-top: 1em; padding: .5em 1em 1em; border: 1px solid #62C012;">

== Developer Documentation ==
{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 50%; padding-right: 1em;" |
=== First Steps ===
* [[Working with Git]] — How to obtain the source code. A quick start on how to use our version control system.
* [[Compiling Inkscape]]
* [[Developer manual]] — Various important information, be sure to read this before coding
* [[Debugging Inkscape|Debugging]] — Random tips to help debug problems
* [[Janitorial tasks]] — Small tasks that need doing
* [[Doxygen documentation]]
* [[Working with CMake]] — Getting started with CMake coding for configuring and building Inkscape

=== Developer tutorials ===
* [[Architectural overview]] — A high-level look at Inkscape
* [[Preferences subsystem]] — Creating and using preference values

* Extensions
** [[Extension subsystem]] — An overview of the functionality provided by extensions and the possible implementations
** [[Script extensions]] — Extend Inkscape easily using scripting languages (Python, Perl, …)
** [[Python modules for extensions]] — Some helpful routines for use in Python script extensions
** [[INX extension descriptor format]]
* [[Creating Live Path Effects]]
* [[Using libsigc++ signals]]

=== User Interface Discussion===
*[[Interface translation]]
* [[Adding interface verbs]]
*[[Accessible graphics]]
*[[Dialogs reorganization]]
*[[Modal interfaces]]
*[[Text usability]] — Text tool and dialog
*[[KeyboardShortcutsToDo]]
**[[Keyboard profiles]] — How you can help
*[[Statusbar API]]
* [[Animation-(Timeline)]]
*[[Free Desktop Graphic Suite]]
*[[Skeletal Strokes]] — Brushes, Strokes, Pressure Sensibility...

| style="width: 50%;" |

===Development Discussion ===
*[[Roadmap]] — Outdated
*[[Tracking Dependencies|Dependencies]] — What libs are needed to build Inkscape
*[[C++20]] — Which C++20 features can be used
*[[New feature proposals]]
* [[Extension architecture proposals]]
*[[Coding Style|Coding Style Discussion]]
*[[File types]]
*[[Creating a multicolor icon|Icons]]
*[[Color management]]
*[[Printing subsystem]]
*[[SVG Tiny Compliance]]
* [[SVG Test Suite Compliance]] — [[W3C]] full test suite
*[[CSS Support]]
*[[Google Summer of Code]]
* [[Improved Media Management]]
*[[UI Mockup Screenshots]]
* [[Swatch Book]]
*[[Tablet Dialog]]
*[[ViewBoxToDo]] — View box support info
* [[Caching]]
*[[Canvas Rendering Profiling]]
*[[UI and Document coordinates‎]]
* [[GtkMMification]] — Replace C boilerplate with gtkmm objects
*[[CMake Tasks]] — Converting the Inkscape build system to CMake
*[[Bug Reporting Workflow]] — Options for improving Inkscape bug workflow from user to developer

===Miscellaneous===
*[[Inkscape-specific XML attributes]] — Documentation of attributes from Inkscape's XML namespace
*[[Environment variables]] — Overview of important environment variables that modify the behavior of Inkscape and its dependencies.
*[[Extension repository]] — An Internet central for Inkscape extensions
*[[Related programs]]
*[[Sponsors list]]
*[[Contracting Process]]
*[[Wiki Playground]]

===[[Lib2geom]]===
*[[Lib2geom]]
*[[Working with 2Geom FAQ]] — Real-life questions answered about using 2Geom in real code
*[[Lib2geom py2geom]] — Python bindings to 2geom. With this you can use the power of 2geom in Python scripts.

===Historical pages===
These pages are outdated, but linked here for posterity.

*[[Working with Bazaar]] — Our former control version system, no longer used. See [[Working with Git]] for current instructions.
* [[Creating a new SPObject]]

|}
</div>

==See also==
*
[[:Category:Wiki Attic|Wiki Attic]] — Pages that are no longer relevant but kept for historical value

__NOTOC__

[[Category:Top level categories]]

Projects

2025-06-13T11:45:27Z

PBS: Expand GC section

{{DevDiscussion}}

This page lists proposed ideas for projects to improve Inkscape. The original list is from Krzysztof Kosiński. Consider it a permanent work-in-progress "brainstorm" list and feel free to add your own comments and project proposals. None of these are "official" and have not been thoroughly reviewed/debated and so may or may not fit with actual development plans.

== General Codebase ==

=== Object Printing ===

Replace the print functions in the SPxxx classes with a generic "Visitor" pattern and port the different export types (e.g. EMF, PDF, PS) to the new routines.

=== Janitorial Work ===

Clean up all unnecessary castings in C++ classes. Remove unnecessary use of "this". Etc.

=== Rename s/SP/Ink/ ===

Various functions and variables have names from the early versions of Sodipodi, these names no longer makes sense (especially for new developers). Renaming s/SP/Ink/ would be ok if there aren't better ideas. This is most prevalent in the object tree, which may or may not be worth changing, but everything that is not part of the object tree should definitely be converted.

=== Retire Garbage Collector ===

We use the Boehm garbage collector in the XML and undo subsystems. This GC usage is likely entirely removable.

Review all classes that derive from <code>GC::Managed</code>:
{| class="wikitable"
! Class !! Comments
|-
| <code>XML::AttributeRecord</code> || Always uniquely owned by <code>XML::SimpleNode</code>.
|-
| <code>XML::CompositeNodeObserver</code> || Never heap-allocated - doesn't even need to be managed.
|-
| <code>XML::Event</code> || Integral part of document undo.
|-
| <code>XML::Node</code> = <code>XML::SimpleNode</code> || In practice, these are the same class. Integral part of XML system.
|-
| <code>XML::Subtree</code> || Used in one ''single'' place, easily removable.
|}
Understand their usage and lifetime patterns, and rewrite them to use standard, deterministic C++ memory management (e.g. smart pointers).

Remaining GC usage is in shared immutable strings used to hold XML attributes (<code>Util::share_string</code>). Replace with an equally-performant alternative.

== Object Tree ==

=== Robust ID handling refactoring ===

Currently ID clash resolution is implemented as a giant switch over object types, listing every possible dependency. Replace this with virtual methods on objects, which provide information on what each object refers to. Improve behavior when a dependency of an object is deleted, and when IDs are changed / deleted from the XML editor.

See id-class.cpp for specifics.

It should be possible to change ID and have
Inkscape update all references. It should also not be automatically
created for all objects. Tav

priority: Longer term

=== Typed XML tree ===

Improve XML tree so that it can store some attributes in parsed,
binary form. The main target of this are the data URIs used to embed
images, which could be stored as binary data only. This work should be
done after completing task 3 (SAX parser), as this will make it
easier.

priority: Longer term

=== XML Refactoring ===
Remove direct manipulation of XML from as many places as possible and replace it with SP tree methods.

== Interface ==
=== On-canvas tool controls ===

More tool controls could be available on-canvas right by the object
being edited. An example of this would be having some of the text
tool controls available right by where text editing is happening
akin to what GIMP provides.

priority: Longer term

=== Numeric input on the canvas ===

Right-clicking on nodes should bring up a numeric entry box which
would allow you to specify its position numericaly. This could allow
us to phase out some of the controls on the top bar. For dynamic
offsets, the numeric entry would simply be the width of the offset

priority: Longer term

=== Unify document and desktop coordinates ===

Change the desktop coordinates to match document coordinates. Make it
so that document coordinates are specified in the coordinate system of
the toplevel SVG element, so that it is possible to emulate other
coordinate systems using a suitable transform attribute or viewBox.

priority: Longer term

=== Shape manipulators ===

The idea here is to rewrite shape tools in the same paradigm as the
node tool. Instead of storing all information about the shape in knots
which differ only by their callbacks, allow to store information in a
higher-level manipulator object. This would enable things like
dragging the side of a rectangle and consistent outlining / update
preferences for all shapes.

priority: Longer term

== SVG Support ==


=== [https://inkscape.org/en/projects/svg2-compliant-flowed-text/ SVG-compliant flowed text (FPRJ-003)] ===

Move the existing flowed text XML representation into an svg:switch
and provide an alternative fallback representation with SVG 1.1 text
objects only.

This should be done via SVG 2 CSS text wrapping
which provides a simple SVG 1.1 fallback mechanism.

priority: Short term
owner: Tav

=== Vector effects ===

Refactor live path effects so that their XML representation matches
that of SVG 2.0 vector effects. Put them in switches, so that the
output is not limited to a single path. Integrate them better with
core Inkscape. For instance, instead of four actions: inset, outset,
dynamic offset, linked offset, there should be only one: offset. Using
it on a normal path would create a dynamic offset, while using it on a
clone would create a linked offset. The same principle would apply to
vector effects: creating them on a normal path would move the path to
defs and replace it with the vector effect, while creating them on
clones would delete the clone and create a reference to the original
path.

Update: Vector effects will be dropped from SVG 2 but we can still refactor
our own code to make it easier to use.

priority: Longer term

=== Better support for linked SVG images ===

Create the document and rendering tree for linked SVG images. Use
Inkscape's renderer instead of relying on the librsvg loader to avoid
inconsistencies. Allow importing the linked image as a group via the
context menu.

There are two main conceptual ways of dealing with linked svg files, one is to treat svg files as 'bitmaps' using our own renderer to generate a bitmap and placing it inside much like we do with including outside png, jpeg files. This has implications involving exporting png with mismatched resolutions and pdf where text and vector elements are no longer vector in the output pdf.

The second method is to treat the svg as an advanced 'clone' which has it's own defs section. This would preserve the vector nature of the included svg file and allow rendering via pdf and png to happen without much exception. The implications of this have not been thought through completely.

priority: Medium term

=== SVG 2 ===

Mesh gradients, hatches, etc. See [[SVG2|SVG2 page]]. Tav
* Improve support for SVG switches: the first recognized element in a switch should appear directly in the SP tree, not as a child of the switch element.

== Paths ==

=== Boolean operations and stroking ===

Add methods to PathVector objects:

a) Set operators (& | - ^), which perform the relevant boolean
operation on the paths. Use the algorithm from CGAL or devise a new
robust algorithm.

b) stroke(double line_width, LineJoin join, LineCap cap, double
miter_limit), which performs the stroke-to-path operation.

c) stroke(double line_width, LineJoin join, LineCap cap, double
miter_limit, std::vector<double> const &dasharray), which performs
stroke-to-path with dashing.

priority: Longer term

== Fonts ==

=== variable fonts usability/UX ===

=== filters UI usability/UX ===

== Print ==

=== Color Management ===

Analyze what users require for CMYK and other aspects of color management,
including a review of what other software does, and what can currently be
done with Inkscape. Examine off the shelf code that could be used (e.g. libcms).
Define what needs implemented in Inkscape's dependencies (e.g. libcairo) vs.
what can or must be done in Inkscape itself. Outline project(s) to implement
the needed changes.
See [[Color_management]] and [[Color Management Planning]] (which represents a head start into this task)

* Improve support for CMYK/spot colors
** Minor UI streamlining
** Eliminate the CMS tab
** Change the CMYK tab to allow selecting the CMYK colors directly
** Allow setting the document to CMYK, which sets a global CMYK profile
** Stores RGB colors as RGB, CMYK colors as CMYK

priority: short term

== Animation ==

There are several distinct types of animation workflows and objectives, such as:

* CSS/SMIL animation - tweening/easing formulas for individual elements, aiming at e.g web display.
* Sequential animation - each layer is a static frame that can be played back with a time delay, and recorded to a video stream
* Keyframe animation - layers represent points on a timeline with objects whose states change through some interpolation mechanism
* Javascript?

While the intent, output, and UI for these may vary, the underlying machinery supporting them may have commonality, so the following projects may apply to one or more of the above types of animation.

=== Object interpolation display ===

Create routines to morph the properties and/or style of an object according to some proportion (such as elapsed time over a time period).

This will need modification of object structures to support the animation attributes, following the SMIL and CSS animation specifications.

contact: Tav
priority: Medium term

=== Object animation property editor UI/UX design ===

Conceptualize how users would add and edit animation properties in Inkscape. What should be done in dialogs vs. in the main interface?
Mockup ideas for how the UI could look. Describe the workflow the user would follow.

=== Time keyed layer display ===

Functionality to display/hide a list of layers in a fixed or variable sequence, or recorded to a sequential output format (e.g. a video output format or numbered raster images).

priority: Medium term

=== Frame transitions ===

Expand on the above projects by organizing objects in sequential layers, where the layers can mark either transition points for a given object, or an object that replaces one or more objects in an earlier frame.

priority: Longer term

=== CSS/SVG Web Animations ===

Export animation properties as corresponding CSS/SVG parameters to output files, following the model from the Web Animations specification so that both SMIL and CSS animations are supported. Inkscape Community/Tav

priority: Longer term

== Technical Writing ==

=== Improve this Project List ===

Review all the projects in this list. Cleanup grammar or phrasing to make the descriptions clearer. Expand on points that are vague. Add links to relevant bug reports, feature requests, blueprints, etc. Add "[Please fill in]" to items that need more information; identify particular questions needing addressed where possible.

=== Inkscape Widgets Doxygen ===

Over the years Inkscape has collected a number of custom UI objects, which have been consolidated to src/widgets/. Many of these are un- or under-documented. For each widget, write doxygen comments in the header file explaining what the widget is and does, and document the widget's public API. In some cases there may be doxygen in the .cpp file for public API functions - this should move to the header.

=== Bring inkscape/doc up to date ===

The doc directory in the Inkscape codebase is used for high level technical documentation including architecture, codebase introduction, and new developer orientation, however it has not been very well maintained and much is obsolete or incorrect. It also needs to be reformatted into Markdown, and appropriate scripts created to generate it into HTML/PDF/SVG. There may be additional developer documentation in Wiki that would be worth inclusion here.

=== Code Doxygen Documentation ===

Ensure all functions declared in header files have doxygen-compatible documentation. See items in [[Janitorial tasks]] for the style we're going for. All doxygen of the core Inkscape code (i.e. excluding 3rd party libraries included in src/*/) should have consistently written and formatted doxygen, which should include descriptions of input, output, and return parameters, identification of potential errors, a one-line brief statement and a more detailed explanation of the routine's purpose.

== User-facing documentation ==

=== Release Notes Improvement ===

Review the release notes for the next major Inkscape release. Update wording and phrasing to be more comprehensible for end users. Fill in missing items where possible. Create and add explanatory graphics (c.f as done in past release notes). Add Known Issues from the previous release that are still relevant.

=== Tutorials ===

* Review existing tutorials and update as appropriate
* Finish or remove unfinished tutorials
* Solicit community-contributed tutorial contributions
* Introduce new tutorials

=== Man page ===

* Update man page
** transcribe the examples to the new command line structure
* Add more helpful examples

=== Manual ===

Create a comprehensive, community-owned Inkscape manual: As a first step, devise a plan for how / where it will be created / hosted, and how versioning is going to work. Define its structure, and a set of editing guidelines. Recruit writers and proofreaders. Write the documentation. Keep the documentation up-to-date with the released Inkscape versions (ongoing task).

== Packaging and Release Management ==

=== Library Package De-integration ===

Several 3rd party codebases are included in Inkscape's codebase (i.e., src/lib*/, src/2geom, possibly livarot?). This has convenience for local patching of our own improvements and simplifies the number of components platform packagers need to deal with, however this increases the weight of our codebase and makes our package larger on platforms such as Linux that have good dependency sharing. Arguably, it may also hinder collaboration with the upstreams or other users of the libraries. Certainly it makes it difficult to roll out fixes to one of those libraries to our users. So, we want these libraries to be packaged and released separately from Inkscape.

For each of these libraries, create a separate git repository in Inkscape's gitlab project for hosting our branch of that project's code. Make sure any of Inkscape's changes to it are clearly registered as distinct git commits. If there is an active upstream project maintaining that library, make sure each of our changes are registered in their patch or bug tracking systems.

In theory, Inkscape should only be using the libraries' public APIs; doublecheck that this is indeed the case, and identify any instances where Inkscape code is bypassing it and accessing library internals directly. These should be filed as high priority bugs in Inkscape's bug tracker.

Lastly, make sure that `make dist` passes successfully for each of our branched libraries, and generates a source tarball. Inform the Release Team of the need to start separately packaging and releasing these libraries in conjunction with Inkscape's release processes.

== Bug Triage ==

With as many bugs as we've accumulated, working on them can seem daunting. Where to start!? Below are some encapsulated projects to try to achieve. Together, the more of these projects that are completed the less daunting the remaining work will be, and the better Inkscape will become!

The [[Bug management]] page in this wiki includes advice on how to judge bug status and importance levels.

''Tip: Some of these tasks could be scripted and automated via the Launchpad email interface. See https://help.launchpad.net/BugTrackerEmailInterface''

<strike>
=== (100% Complete) Update Status for Critical Bugs from New ===

(DONE) Review each Critical bug with Status New, and change status to Incomplete if the last comment on the bug is a question, or Confirmed otherwise. -- Bryce

=== (100% Complete) Update Status for Critical Bugs from Fix Committed ===

Review each Critical bug with Status Fix Committed; most likely these are incorrect. If comments towards the end of the thread indicate a fix was committed to SVN, then it is okay to be in state Fix Committed. Otherwise, move it to a more accurate Status.

=== (100% Complete) Update Status for High Priority Bugs from Fix Committed ===

Review each High priority bug with Status Fix Committed; most likely these are incorrect. If comments towards the end of the thread indicate a fix was committed to SVN, then it is okay to be in state Fix Committed. Otherwise, move it to a more accurate Status.
</strike>

=== Update Status for High Priority Bugs from New ===

Review each High priority bug with Status New, and change status to Incomplete if the last comment on the bug is a question, or Confirmed otherwise.

=== Tag OSX bugs ===

Using the Advanced search, identify bugs that are reported against OSX and update them to include the tag 'osx'.

=== Tag Windows bugs ===

Using the Advanced search, identify bugs that are reported against Windows and update them to include the tag 'windows'. Some bugs are already tagged with 'win32'
: Searched all entries with 'win' in it. Tagged all appropriate bug reports with 'win32'. Now only 'win32' tags exist, but no 'windows' tags. Renaming the tags via the database should be easier than doing it manually (if at all possible). Is this what you guys had in mind? --[[User:Cerno|Cerno]] 15:40, 30 June 2008 (UTC)

=== Link Cairo bugs ===

Do a search for 'cairo'. Review the bugs (there's only about a dozen), and for each, identify if the issue is a Cairo bug. If so, look in the cairo bug tracker at freedesktop.org for a matching bug (or enter a new one if there isn't one already) and link it in via the 'Also affects: +Project'.

=== Set Importance on Confirmed / Fixed Bugs ===

Do a search on Importance=Undecided and Status=Fix Committed,Confirmed,In Progress. (There's 18 of these presently). Review each and assign it an Importance (probably Medium or High in most cases, but use best judgement).

=== Ping Old Low Priority Bugs ===

Search on bugs with Importance=Low, sorted by Oldest First. Go through the bugs that are more than a year old and review them. If they don't seem to have gotten much activity (e.g. few comments), and don't seem to be worth keeping, mark them Incomplete, with the following text:

"Thank you for taking the time to report this bug and helping to make Inkscape better. You reported this bug a long while ago and there hasn't been any activity in it recently. We were wondering is this still an issue for you? Can you try with latest Inkscape release? Thanks in advance."

or if it is a feature request:
"Thank you for taking the time to report this feature request and helping to make Inkscape better. You requested this feature a long while ago and there hasn't been any activity in it recently. We were wondering; is this still on your wishlist? Can you try with latest Inkscape release and see if recent improvements have obsoleted your request? Thanks in advance."

Wait about a month, then follow up with a search against these bugs that have not received a response; they can then be closed as Invalid.

https://wiki.ubuntu.com/Bugs/Status

=== Confirm all appropriate bugs marked Incomplete with responses ===

Search on 'Incomplete with response', and review the feedback that's been given. If it appears the initial triager's information requests were met, and the bug seems legitimate, move it to Confirmed. If there seems to be further questions needing answered, ask them and leave it as incomplete.

As well, specify a priority for these bugs. Generally, issues that cause crashes or data loss are high priority unless they only occur in very narrow situations. Issues which are purely cosmetic or involve very obscure or limited conditions are low priority, and everything else is Medium. Only use Critical priority for extremely serious bugs that will be affecting most everyone using Inkscape.

=== Convert high priority wishlist bugs into blueprints ===

Browse the collection of bugs marked ''wishlist''. Look for sets of related bugs that are all requesting essentially the same feature. Create a corresponding blueprint at [https://blueprints.launchpad.net/inkscape https://blueprints.launchpad.net/inkscape], and use ''Specify a URL'' to attach it to a wiki page. Then consolidate the wishlist bug reports together onto the blueprint page. Specify if you're willing to act as the Drafter for the spec, and carry it through to acceptance, or if you prefer someone else take that role.

Once you've created the specification, use ''Link to bug'' to link each of the related bugs.

=== Close old incomplete bugs with no response ===

Do a query on bugs marked Incomplete with no response, and sort by age. All bugs older than 1 month with no reply can be closed as out of date.
=== [https://inkscape.org/en/projects/box-blur/ Box blur (FPRJ-001)] ===


Currently we always use a very accurate method to compute the Gaussian
blur filter. Add an alternate method which approximates Gaussian blur
using three stacked box blurs (simple averages). This is detailed in
the SVG 1.1 SE specification.


=== Marker Knockout ===

Idea is to clean up markers where part of the line shows through. For example if a triangular arrowhead's tip is on the end point of a line with a relatively thick stroke, the rectangular end corners of the line shows up. Or if you're doing a mid-line marker that needs to have a transparent hole (e.g. a "subway station marker", it needs to show through.

To implement this, draw the line on another surface and mask it with the knockout shape. The filters code uses this approach, as an example. See also the [https://www.w3.org/TR/svg-markers/ SVG Markers] specification.

contact: Tav
priority: Nearer term
=== Restore Ancient Change History ===

Inkscape's earliest development history is missing, with the first commit being "bzr r1" when we migrated to bzr. Prior history was in CVS and is missing. While not a huge priority, it would be nice to have this pre-bzr history resurrected and prepended to our git history.

=== Rewrite / reintroduce 3D box ===
** 3-dimensional grid, perspective deformed, with snapping

=== Git Integration ===
Due to the nature of SVG (text files), versioning might offer a really good way to effectively manage local historical changes even when inkscape is closed. [[https://git-scm.com/ Git]] is a popular versioning software, and is well known among open source contributors. I imagine a versioning system could be "enabled" through the user interface, and allow a user to tag "releases", branch copies if need be, and maintain a historical log of changes. Git could also have been a great way to maintain a branch of different versions of the svg file when the Inkscape project made the change of default dpi for old files recently.

=== Other Misc. Ideas ===
* Improve support for changing the name of the XML element node in response to SP tree changes
* Inkscape for Android
* CAD drawing functionality
* OCR of bitmap traces
* Excentric radial gradients, see e.g. samples/orav.svg in the distribution. --bb

= Finished Projects =

=== [DONE] <s>[https://inkscape.org/en/projects/remove-all-use-of-glist-and-gslist/ Remove all use of GList and GSList]</s> ===


These GLib data structures are poorly designed (they are simple lists
without sentinels, leading to blunders such as O(N) performance when
appending to a doubly-linked list) and not type-safe. Replace all uses
with standard C++ containers or suitable Boost containers.
</style>

=== [DONE] <s>Common build system for all platforms</s> ===

Migrate and port all necessary features to the CMake build system and remove Autotools.

=== [DONE] <s>Use a different data structure for Inkscape::Selection</s> ===

Inkscape::Selection currently uses GSList as its data structure. This
is suboptimal, since a very common operation is checking whether some
object is selected. Change Inkscape::Selection so that its underlying
structure is a boost::multi_index container which implements the same
semantics as Java's LinkedHashSet.

=== [DONE] <s>Remove dom/ directory</s> ===

This directory contains strange code which is barely used. The only
class which is actually used is the URI class.

=== [DONE] <s>Remove SPCurve (refactoring)</s> ===

SPCurve is a thin wrapper around Geom::PathVector which exists for
historical reasons. Its functionality should be added to PathVector,
and SPCurve should be purged.

priority: Medium term

https://gitlab.com/inkscape/inkscape/-/merge_requests/7259

Projects

2025-06-13T10:20:19Z

PBS: Move SPCurve project to done

{{DevDiscussion}}

This page lists proposed ideas for projects to improve Inkscape. The original list is from Krzysztof Kosiński. Consider it a permanent work-in-progress "brainstorm" list and feel free to add your own comments and project proposals. None of these are "official" and have not been thoroughly reviewed/debated and so may or may not fit with actual development plans.

== General Codebase ==

=== Object Printing ===

Replace the print functions in the SPxxx classes with a generic "Visitor" pattern and port the different export types (e.g. EMF, PDF, PS) to the new routines.

=== Janitorial Work ===

Clean up all unnecessary castings in C++ classes. Remove unnecessary use of "this". Etc.

=== Rename s/SP/Ink/ ===

Various functions and variables have names from the early versions of Sodipodi, these names no longer makes sense (especially for new developers). Renaming s/SP/Ink/ would be ok if there aren't better ideas. This is most prevalent in the object tree, which may or may not be worth changing, but everything that is not part of the object tree should definitely be converted.

=== Retire Garbage Collector ===

We use the Boehm garbage collector, but for smart pointers we can use
support in C++-11 now, so most likely any Inkscape-specific gc code can
probably go. Analyze where this code is, what uses it, and how to port
it to use standard code, then delete our gc bits

== Object Tree ==

=== Robust ID handling refactoring ===

Currently ID clash resolution is implemented as a giant switch over object types, listing every possible dependency. Replace this with virtual methods on objects, which provide information on what each object refers to. Improve behavior when a dependency of an object is deleted, and when IDs are changed / deleted from the XML editor.

See id-class.cpp for specifics.

It should be possible to change ID and have
Inkscape update all references. It should also not be automatically
created for all objects. Tav

priority: Longer term

=== Typed XML tree ===

Improve XML tree so that it can store some attributes in parsed,
binary form. The main target of this are the data URIs used to embed
images, which could be stored as binary data only. This work should be
done after completing task 3 (SAX parser), as this will make it
easier.

priority: Longer term

=== XML Refactoring ===
Remove direct manipulation of XML from as many places as possible and replace it with SP tree methods.

== Interface ==
=== On-canvas tool controls ===

More tool controls could be available on-canvas right by the object
being edited. An example of this would be having some of the text
tool controls available right by where text editing is happening
akin to what GIMP provides.

priority: Longer term

=== Numeric input on the canvas ===

Right-clicking on nodes should bring up a numeric entry box which
would allow you to specify its position numericaly. This could allow
us to phase out some of the controls on the top bar. For dynamic
offsets, the numeric entry would simply be the width of the offset

priority: Longer term

=== Unify document and desktop coordinates ===

Change the desktop coordinates to match document coordinates. Make it
so that document coordinates are specified in the coordinate system of
the toplevel SVG element, so that it is possible to emulate other
coordinate systems using a suitable transform attribute or viewBox.

priority: Longer term

=== Shape manipulators ===

The idea here is to rewrite shape tools in the same paradigm as the
node tool. Instead of storing all information about the shape in knots
which differ only by their callbacks, allow to store information in a
higher-level manipulator object. This would enable things like
dragging the side of a rectangle and consistent outlining / update
preferences for all shapes.

priority: Longer term

== SVG Support ==


=== [https://inkscape.org/en/projects/svg2-compliant-flowed-text/ SVG-compliant flowed text (FPRJ-003)] ===

Move the existing flowed text XML representation into an svg:switch
and provide an alternative fallback representation with SVG 1.1 text
objects only.

This should be done via SVG 2 CSS text wrapping
which provides a simple SVG 1.1 fallback mechanism.

priority: Short term
owner: Tav

=== Vector effects ===

Refactor live path effects so that their XML representation matches
that of SVG 2.0 vector effects. Put them in switches, so that the
output is not limited to a single path. Integrate them better with
core Inkscape. For instance, instead of four actions: inset, outset,
dynamic offset, linked offset, there should be only one: offset. Using
it on a normal path would create a dynamic offset, while using it on a
clone would create a linked offset. The same principle would apply to
vector effects: creating them on a normal path would move the path to
defs and replace it with the vector effect, while creating them on
clones would delete the clone and create a reference to the original
path.

Update: Vector effects will be dropped from SVG 2 but we can still refactor
our own code to make it easier to use.

priority: Longer term

=== Better support for linked SVG images ===

Create the document and rendering tree for linked SVG images. Use
Inkscape's renderer instead of relying on the librsvg loader to avoid
inconsistencies. Allow importing the linked image as a group via the
context menu.

There are two main conceptual ways of dealing with linked svg files, one is to treat svg files as 'bitmaps' using our own renderer to generate a bitmap and placing it inside much like we do with including outside png, jpeg files. This has implications involving exporting png with mismatched resolutions and pdf where text and vector elements are no longer vector in the output pdf.

The second method is to treat the svg as an advanced 'clone' which has it's own defs section. This would preserve the vector nature of the included svg file and allow rendering via pdf and png to happen without much exception. The implications of this have not been thought through completely.

priority: Medium term

=== SVG 2 ===

Mesh gradients, hatches, etc. See [[SVG2|SVG2 page]]. Tav
* Improve support for SVG switches: the first recognized element in a switch should appear directly in the SP tree, not as a child of the switch element.

== Paths ==

=== Boolean operations and stroking ===

Add methods to PathVector objects:

a) Set operators (& | - ^), which perform the relevant boolean
operation on the paths. Use the algorithm from CGAL or devise a new
robust algorithm.

b) stroke(double line_width, LineJoin join, LineCap cap, double
miter_limit), which performs the stroke-to-path operation.

c) stroke(double line_width, LineJoin join, LineCap cap, double
miter_limit, std::vector<double> const &dasharray), which performs
stroke-to-path with dashing.

priority: Longer term

== Fonts ==

=== variable fonts usability/UX ===

=== filters UI usability/UX ===

== Print ==

=== Color Management ===

Analyze what users require for CMYK and other aspects of color management,
including a review of what other software does, and what can currently be
done with Inkscape. Examine off the shelf code that could be used (e.g. libcms).
Define what needs implemented in Inkscape's dependencies (e.g. libcairo) vs.
what can or must be done in Inkscape itself. Outline project(s) to implement
the needed changes.
See [[Color_management]] and [[Color Management Planning]] (which represents a head start into this task)

* Improve support for CMYK/spot colors
** Minor UI streamlining
** Eliminate the CMS tab
** Change the CMYK tab to allow selecting the CMYK colors directly
** Allow setting the document to CMYK, which sets a global CMYK profile
** Stores RGB colors as RGB, CMYK colors as CMYK

priority: short term

== Animation ==

There are several distinct types of animation workflows and objectives, such as:

* CSS/SMIL animation - tweening/easing formulas for individual elements, aiming at e.g web display.
* Sequential animation - each layer is a static frame that can be played back with a time delay, and recorded to a video stream
* Keyframe animation - layers represent points on a timeline with objects whose states change through some interpolation mechanism
* Javascript?

While the intent, output, and UI for these may vary, the underlying machinery supporting them may have commonality, so the following projects may apply to one or more of the above types of animation.

=== Object interpolation display ===

Create routines to morph the properties and/or style of an object according to some proportion (such as elapsed time over a time period).

This will need modification of object structures to support the animation attributes, following the SMIL and CSS animation specifications.

contact: Tav
priority: Medium term

=== Object animation property editor UI/UX design ===

Conceptualize how users would add and edit animation properties in Inkscape. What should be done in dialogs vs. in the main interface?
Mockup ideas for how the UI could look. Describe the workflow the user would follow.

=== Time keyed layer display ===

Functionality to display/hide a list of layers in a fixed or variable sequence, or recorded to a sequential output format (e.g. a video output format or numbered raster images).

priority: Medium term

=== Frame transitions ===

Expand on the above projects by organizing objects in sequential layers, where the layers can mark either transition points for a given object, or an object that replaces one or more objects in an earlier frame.

priority: Longer term

=== CSS/SVG Web Animations ===

Export animation properties as corresponding CSS/SVG parameters to output files, following the model from the Web Animations specification so that both SMIL and CSS animations are supported. Inkscape Community/Tav

priority: Longer term

== Technical Writing ==

=== Improve this Project List ===

Review all the projects in this list. Cleanup grammar or phrasing to make the descriptions clearer. Expand on points that are vague. Add links to relevant bug reports, feature requests, blueprints, etc. Add "[Please fill in]" to items that need more information; identify particular questions needing addressed where possible.

=== Inkscape Widgets Doxygen ===

Over the years Inkscape has collected a number of custom UI objects, which have been consolidated to src/widgets/. Many of these are un- or under-documented. For each widget, write doxygen comments in the header file explaining what the widget is and does, and document the widget's public API. In some cases there may be doxygen in the .cpp file for public API functions - this should move to the header.

=== Bring inkscape/doc up to date ===

The doc directory in the Inkscape codebase is used for high level technical documentation including architecture, codebase introduction, and new developer orientation, however it has not been very well maintained and much is obsolete or incorrect. It also needs to be reformatted into Markdown, and appropriate scripts created to generate it into HTML/PDF/SVG. There may be additional developer documentation in Wiki that would be worth inclusion here.

=== Code Doxygen Documentation ===

Ensure all functions declared in header files have doxygen-compatible documentation. See items in [[Janitorial tasks]] for the style we're going for. All doxygen of the core Inkscape code (i.e. excluding 3rd party libraries included in src/*/) should have consistently written and formatted doxygen, which should include descriptions of input, output, and return parameters, identification of potential errors, a one-line brief statement and a more detailed explanation of the routine's purpose.

== User-facing documentation ==

=== Release Notes Improvement ===

Review the release notes for the next major Inkscape release. Update wording and phrasing to be more comprehensible for end users. Fill in missing items where possible. Create and add explanatory graphics (c.f as done in past release notes). Add Known Issues from the previous release that are still relevant.

=== Tutorials ===

* Review existing tutorials and update as appropriate
* Finish or remove unfinished tutorials
* Solicit community-contributed tutorial contributions
* Introduce new tutorials

=== Man page ===

* Update man page
** transcribe the examples to the new command line structure
* Add more helpful examples

=== Manual ===

Create a comprehensive, community-owned Inkscape manual: As a first step, devise a plan for how / where it will be created / hosted, and how versioning is going to work. Define its structure, and a set of editing guidelines. Recruit writers and proofreaders. Write the documentation. Keep the documentation up-to-date with the released Inkscape versions (ongoing task).

== Packaging and Release Management ==

=== Library Package De-integration ===

Several 3rd party codebases are included in Inkscape's codebase (i.e., src/lib*/, src/2geom, possibly livarot?). This has convenience for local patching of our own improvements and simplifies the number of components platform packagers need to deal with, however this increases the weight of our codebase and makes our package larger on platforms such as Linux that have good dependency sharing. Arguably, it may also hinder collaboration with the upstreams or other users of the libraries. Certainly it makes it difficult to roll out fixes to one of those libraries to our users. So, we want these libraries to be packaged and released separately from Inkscape.

For each of these libraries, create a separate git repository in Inkscape's gitlab project for hosting our branch of that project's code. Make sure any of Inkscape's changes to it are clearly registered as distinct git commits. If there is an active upstream project maintaining that library, make sure each of our changes are registered in their patch or bug tracking systems.

In theory, Inkscape should only be using the libraries' public APIs; doublecheck that this is indeed the case, and identify any instances where Inkscape code is bypassing it and accessing library internals directly. These should be filed as high priority bugs in Inkscape's bug tracker.

Lastly, make sure that `make dist` passes successfully for each of our branched libraries, and generates a source tarball. Inform the Release Team of the need to start separately packaging and releasing these libraries in conjunction with Inkscape's release processes.

== Bug Triage ==

With as many bugs as we've accumulated, working on them can seem daunting. Where to start!? Below are some encapsulated projects to try to achieve. Together, the more of these projects that are completed the less daunting the remaining work will be, and the better Inkscape will become!

The [[Bug management]] page in this wiki includes advice on how to judge bug status and importance levels.

''Tip: Some of these tasks could be scripted and automated via the Launchpad email interface. See https://help.launchpad.net/BugTrackerEmailInterface''

<strike>
=== (100% Complete) Update Status for Critical Bugs from New ===

(DONE) Review each Critical bug with Status New, and change status to Incomplete if the last comment on the bug is a question, or Confirmed otherwise. -- Bryce

=== (100% Complete) Update Status for Critical Bugs from Fix Committed ===

Review each Critical bug with Status Fix Committed; most likely these are incorrect. If comments towards the end of the thread indicate a fix was committed to SVN, then it is okay to be in state Fix Committed. Otherwise, move it to a more accurate Status.

=== (100% Complete) Update Status for High Priority Bugs from Fix Committed ===

Review each High priority bug with Status Fix Committed; most likely these are incorrect. If comments towards the end of the thread indicate a fix was committed to SVN, then it is okay to be in state Fix Committed. Otherwise, move it to a more accurate Status.
</strike>

=== Update Status for High Priority Bugs from New ===

Review each High priority bug with Status New, and change status to Incomplete if the last comment on the bug is a question, or Confirmed otherwise.

=== Tag OSX bugs ===

Using the Advanced search, identify bugs that are reported against OSX and update them to include the tag 'osx'.

=== Tag Windows bugs ===

Using the Advanced search, identify bugs that are reported against Windows and update them to include the tag 'windows'. Some bugs are already tagged with 'win32'
: Searched all entries with 'win' in it. Tagged all appropriate bug reports with 'win32'. Now only 'win32' tags exist, but no 'windows' tags. Renaming the tags via the database should be easier than doing it manually (if at all possible). Is this what you guys had in mind? --[[User:Cerno|Cerno]] 15:40, 30 June 2008 (UTC)

=== Link Cairo bugs ===

Do a search for 'cairo'. Review the bugs (there's only about a dozen), and for each, identify if the issue is a Cairo bug. If so, look in the cairo bug tracker at freedesktop.org for a matching bug (or enter a new one if there isn't one already) and link it in via the 'Also affects: +Project'.

=== Set Importance on Confirmed / Fixed Bugs ===

Do a search on Importance=Undecided and Status=Fix Committed,Confirmed,In Progress. (There's 18 of these presently). Review each and assign it an Importance (probably Medium or High in most cases, but use best judgement).

=== Ping Old Low Priority Bugs ===

Search on bugs with Importance=Low, sorted by Oldest First. Go through the bugs that are more than a year old and review them. If they don't seem to have gotten much activity (e.g. few comments), and don't seem to be worth keeping, mark them Incomplete, with the following text:

"Thank you for taking the time to report this bug and helping to make Inkscape better. You reported this bug a long while ago and there hasn't been any activity in it recently. We were wondering is this still an issue for you? Can you try with latest Inkscape release? Thanks in advance."

or if it is a feature request:
"Thank you for taking the time to report this feature request and helping to make Inkscape better. You requested this feature a long while ago and there hasn't been any activity in it recently. We were wondering; is this still on your wishlist? Can you try with latest Inkscape release and see if recent improvements have obsoleted your request? Thanks in advance."

Wait about a month, then follow up with a search against these bugs that have not received a response; they can then be closed as Invalid.

https://wiki.ubuntu.com/Bugs/Status

=== Confirm all appropriate bugs marked Incomplete with responses ===

Search on 'Incomplete with response', and review the feedback that's been given. If it appears the initial triager's information requests were met, and the bug seems legitimate, move it to Confirmed. If there seems to be further questions needing answered, ask them and leave it as incomplete.

As well, specify a priority for these bugs. Generally, issues that cause crashes or data loss are high priority unless they only occur in very narrow situations. Issues which are purely cosmetic or involve very obscure or limited conditions are low priority, and everything else is Medium. Only use Critical priority for extremely serious bugs that will be affecting most everyone using Inkscape.

=== Convert high priority wishlist bugs into blueprints ===

Browse the collection of bugs marked ''wishlist''. Look for sets of related bugs that are all requesting essentially the same feature. Create a corresponding blueprint at [https://blueprints.launchpad.net/inkscape https://blueprints.launchpad.net/inkscape], and use ''Specify a URL'' to attach it to a wiki page. Then consolidate the wishlist bug reports together onto the blueprint page. Specify if you're willing to act as the Drafter for the spec, and carry it through to acceptance, or if you prefer someone else take that role.

Once you've created the specification, use ''Link to bug'' to link each of the related bugs.

=== Close old incomplete bugs with no response ===

Do a query on bugs marked Incomplete with no response, and sort by age. All bugs older than 1 month with no reply can be closed as out of date.
=== [https://inkscape.org/en/projects/box-blur/ Box blur (FPRJ-001)] ===


Currently we always use a very accurate method to compute the Gaussian
blur filter. Add an alternate method which approximates Gaussian blur
using three stacked box blurs (simple averages). This is detailed in
the SVG 1.1 SE specification.


=== Marker Knockout ===

Idea is to clean up markers where part of the line shows through. For example if a triangular arrowhead's tip is on the end point of a line with a relatively thick stroke, the rectangular end corners of the line shows up. Or if you're doing a mid-line marker that needs to have a transparent hole (e.g. a "subway station marker", it needs to show through.

To implement this, draw the line on another surface and mask it with the knockout shape. The filters code uses this approach, as an example. See also the [https://www.w3.org/TR/svg-markers/ SVG Markers] specification.

contact: Tav
priority: Nearer term
=== Restore Ancient Change History ===

Inkscape's earliest development history is missing, with the first commit being "bzr r1" when we migrated to bzr. Prior history was in CVS and is missing. While not a huge priority, it would be nice to have this pre-bzr history resurrected and prepended to our git history.

=== Rewrite / reintroduce 3D box ===
** 3-dimensional grid, perspective deformed, with snapping

=== Git Integration ===
Due to the nature of SVG (text files), versioning might offer a really good way to effectively manage local historical changes even when inkscape is closed. [[https://git-scm.com/ Git]] is a popular versioning software, and is well known among open source contributors. I imagine a versioning system could be "enabled" through the user interface, and allow a user to tag "releases", branch copies if need be, and maintain a historical log of changes. Git could also have been a great way to maintain a branch of different versions of the svg file when the Inkscape project made the change of default dpi for old files recently.

=== Other Misc. Ideas ===
* Improve support for changing the name of the XML element node in response to SP tree changes
* Inkscape for Android
* CAD drawing functionality
* OCR of bitmap traces
* Excentric radial gradients, see e.g. samples/orav.svg in the distribution. --bb

= Finished Projects =

=== [DONE] <s>[https://inkscape.org/en/projects/remove-all-use-of-glist-and-gslist/ Remove all use of GList and GSList]</s> ===


These GLib data structures are poorly designed (they are simple lists
without sentinels, leading to blunders such as O(N) performance when
appending to a doubly-linked list) and not type-safe. Replace all uses
with standard C++ containers or suitable Boost containers.
</style>

=== [DONE] <s>Common build system for all platforms</s> ===

Migrate and port all necessary features to the CMake build system and remove Autotools.

=== [DONE] <s>Use a different data structure for Inkscape::Selection</s> ===

Inkscape::Selection currently uses GSList as its data structure. This
is suboptimal, since a very common operation is checking whether some
object is selected. Change Inkscape::Selection so that its underlying
structure is a boost::multi_index container which implements the same
semantics as Java's LinkedHashSet.

=== [DONE] <s>Remove dom/ directory</s> ===

This directory contains strange code which is barely used. The only
class which is actually used is the URI class.

=== [DONE] <s>Remove SPCurve (refactoring)</s> ===

SPCurve is a thin wrapper around Geom::PathVector which exists for
historical reasons. Its functionality should be added to PathVector,
and SPCurve should be purged.

priority: Medium term

https://gitlab.com/inkscape/inkscape/-/merge_requests/7259

Google Summer of Code

2025-01-02T19:08:24Z

PBS: Mark affinity designer importer as completed

<div style="max-width:70em; margin-left: auto; margin-right: auto">
= Welcome to Inkscape! =

For quite a few years Inkscape has been successfully participating in [http://code.google.com/soc/ Google Summer of Code].

Google has opened up the program to students AND beginners to Open Source who are 18 years are older. Projects can be medium size (~175 hours) or large size (~350 hours). Finish times are flexible, 12 to 22 weeks (with agreement of mentor).

GSoC is a program where Google funds the development of specific features in open source software by university students and other new to open source. You don't need to be a Computer Science student to apply. Features to be developed are picked by Inkscape administrators from the pool of proposals submitted by applicants.

We've mentored about half a dozen students a year since GSoC started. Many students enjoyed their work and continue to be involved; perhaps your mentor will be a past GSoC student! We have a high rate of acceptance of student code into the core codebase. Indeed, GSoC projects have been a key source of some of Inkscape's best features in the past several releases.

If you are interested in joining us this summer, it is time to get your proposal ready. You can choose a proposal from our list of suggestions or come up with one of your own. In either either case, you '''must''' give us a detailed outline of what you plan to do. It is '''highly''' recommended that you discuss your idea as early as possible with Inkscape developers. They not only can give you guidance as you flesh out your proposal but ultimately you must convince them that you can do the work planned in the time allotted. '''If you have not discussed your proposal with Inkscape developers before you apply, your application will be rejected!'''

= Candidate Applications =

* Google program information:
** [https://summerofcode.withgoogle.com/ Home page].
** Summer of Code Application form. Applications open at 18:00 UTC on March 18th, 2024. -> https://developers.google.com/open-source/gsoc/timeline

* Inkscape-specific information:
** [[SOC Application Template]].
** [[Roadmap | Inkscape Roadmap]] - to see our overall objectives.
** [[Projects | Inkscape Development Project Ideas]] - broader list of development ideas.
** [[SOC Writing Project Proposals]] - some guidelines for proposals.
** [[SOC Selection Criteria]] - how we rate applications.

'''Candidate Applications for GSoC 2024 must be submitted to the GSoC site by 18:00 UTC on April 2nd 2024.'''

= The "two patches" rule =

We require two patches from each potential GSoC student, before accepting the student for GSoC participation (it is the same requirement as for obtaining rights to commit changes to the code repository).

The reason for this requirement is that you can show us that you have succeeded in building Inkscape on your PC, and that you have understood a little piece of Inkscape's code and are able to improve it.
Inkscape is a large project, and you really should not try to understand all the code. Many (all?) developers know only parts of the program code!
You can join our [https://inkscape.org/community/discussion/ IRC] channel or [https://chat.inkscape.org/channel/team_devel Rocket Chat] and ask developers for help.

== Suggested "easy" bug fixes or improvements ==

To get you started on Inkscape development, you can find (probably) easy-to-fix bugs or small improvements that require very little knowledge of the whole program by searching our [https://gitlab.com/inkscape/inkscape/issues/ bug-tracker] for bugs tagged with 'easy-fix'.

= Performance Evaluation =

GSoC has two formal evaluation points, at the ''mid-term'' and at the end. These evaluations determine if you receive the stipend from Google. In order to receive a pass for the evaluations you will need to show adequate progress toward your project's goals.

To help you meet your goals and so that your mentor can better evaluate your progress you need to:

* Have frequent, public discussions of your progress. (Don't rely on just your mentor for advice.)
* Have a public Inkscape branch for your code to which you commit regularly.
* Give weekly status reports.

For the final pass, you will normally be required to merge your code into Inkscape trunk.

Remember: ''we want you to succeed!''

= Suggested Project Ideas =

The following is a list of formal project suggestions, but do not feel limited to only these - some of our best contributions have been unique ideas that students had in mind from other sources!

See also [[Development Project Ideas]], [[Refactoring projects]], [[Projects]], and https://blueprints.launchpad.net/inkscape/

==P5. UI-Free Inkscape ==

* Estimation of difficulty: Difficult - Long (350h)
* Potential mentors: Marc Jeanmougin, pbs
* Programming skills: C++, CMake
* Prerequisites: Minimal knowledge of build systems. Experience with GTKmm helpful.

Detailed Description
Inkscape currently builds with X11 and gtk and a lot of graphical dependencies. But since it is allowed to run in commandline, and there are controlled environments (servers) that use it to convert svg to png and to perform actions, there should be no need to force it to build with those. The main goal of this project is to add a WITH_GUI compilation flag that when OFF, does *not* link Inkscape with any graphical dependency. While much work has been done towards this goal, much remains to be done. DONE <s>As a next step, Inkscape's "verbs" which are mostly GUI dependent (even if there is no reason to be) need to be converted to Gio::Actions.</s> More work needs to be done to separate out hidden GUI dependencies that remain after the Verb to Action transition.

Use cases
* Server installs, scripts

==P8. Add Text and Image Support to Live Path Effect System ==
* Estimation of difficulty: Hard - Short (175h)
* Potential mentors: Jabier Arraiza (Spanish, English(not native))
* Programming skills: C++
* Prerequisites: Experience managing bitmaps
Detailed Description
Live Path Effects are non destructive effects applied to paths and shapes standalone or inside a group. 
This is done keepeng a reference to the original data to reaply when needed. 
But ignore text and image elements. 
Things to do:
* Study add image, text, both and maybe others SVG elements to the LPE system.
* Create/adapt minimun one LPE for each new type of element acepted as reference. Suggestion Perspective-Envelope.
Use cases
* Apply live effects to images and text based in C++ code in a non destructive way even in groups with mixed elements types.

==P9. Path Library Improvements ==
* Estimation of difficulty: Hard - Long (350h)
* Potential mentors: Tavmjong Bah, KK
* Programming skills: C++
* Prerequisites: Strong math skills, specifically in geometry.
Detailed Description
Inkscape relies on two geometry libraries for path manipulations: lib2geom and livarot. lib2geom is a generic modern library written specifically with Inkscape in mind. lib2geom is missing some functionality that Inkscape requires and that is found in livarot. This project is to move that functionality into lib2geom (or into separate files) using lib2geom path descriptions. A 2020 GSoC student did a significant amount of work understanding and documenting the issues involved [https://gitlab.com/inkscape/inkscape/-/merge_requests/4416]. This project would be to build on his work.

Specifically, the functionality needed is
* Path offset/inset functions.
* Path simplify.
* Stroke to path function.
* Line scanning (used for flowing text into a shape).

==P11. Improvements to Paint Server Dialog ==

* Estimation of difficulty: Easy to Medium - Short (175h)
* Potential mentors: Tavmjong
* Programming skills: C++
* Prerequisites: Some knowledge of GTK and CSS.
Detailed Description
The ''Paint Server Dialog'' allows a user to visually select a pattern or hatch to use in painting the ''fill'' or ''stroke'' of an object. This project would be to expand the dialog to cover gradients, meshes, and solid colors as well as make other improvements to the dialog. Interaction with the Inkscape's ''UX'' team will be required.

[https://gitlab.com/inkscape/ux/-/issues/40 '''Full poposal''']
== P15. Import and Export extensions ==

*Estimation of difficulty: Flexible, usually easy to medium, Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python, Ability to read technical documents, depending on the format: some reverse engineering
* Prerequisites: minimal knowledge of test-driven development

Detailed Description: Inkscape is alway looking to improve compatibility! Some ideas of relevant file formats - each of them more than enough for one GSoC:*Refactor our '''DXF input and output''' extensions, and expand support towards binary DXF
*Write an as-complete-as-possible '''EPS export''', circumventing the internal information loss in ghostscript (EPS is still relevant for scientific papers, but more and more tools are dropping support, so this is a chance to grab market share - the results of Adobe Distiller are much better than ghostscript's...)
*Rewrite the '''XAML importer''' in Python (currenly XSLT) to match the capabilities of the new XAML exporter (i.e. support for different target frameworks, better text support...) - would have to select carefully what to support (drawing primitives) and what not (control elements) - the boundary is not as clear-cut as it seems.
* Update the '''Synfig export''' to support the latest Synfig developments
* '''Import or export of TikZ'''. There are a few abandoned extensions out there (from which we can borrow), but it's very widely used in science - both import and export could serve an important function in the scientific workflow.
*'''Import of the proprietary fileformats''' of Vectornator or Vectorstyler (which seem in their infancy and users at some point will sit on a bunch of files that they can't open anymore because their SAAS model wasn't profitable) .
*'''Import of CGM''' - old, but ISO standardized. Was supported once and dropped when the uniconvertor extension was removed for 1.0.
* '''Python based EMF / WMF importer -''' the current (core Inkscape) C extension is unmaintained and Python would probably be the right way to get more collaboration on it. A lot of public archives sit on mountains of EMF files. Note that the Document Foundation recently did a lot of work properly importing those files, so we can learn from them / maybe even join forces...
*your favorite file format? - also have a look here: https://office.inkscape.org/nextcloud/index.php/s/Tq6cdDDGay6taCw
==P16. Gcodetools refactoring and documentation==

*Estimation of difficulty: Easy- Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python
* Prerequisites: Maker background / familiarity with the Maker community

Detailed Description: [https://gitlab.com/inkscape/extras/extensions-gcodetools/ Gcodetools] is a set of Inkscape extensions that deal with reading and creating Gcode files, mostly for use in laser cutters or plotters. For this project, ideally someone with a Makerspace background will
#query maker spaces on their needs regarding gcodetools,
#implement those needs together with unit tests,
# improve the test coverage of Gcodetools,
#write proper documentation for it. (doesn't really exist at the moment).
==P17. Packing / Nesting as an Inkscape extension==

*Estimation of difficulty: Medium, Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python
* Prerequisites: Computational geometry

Detailed Description: In this project, a set of packing / nesting algorithms will be implemented:
*[https://en.wikipedia.org/wiki/Cutting_stock_problem Linear nesting] is not too useful in SVG, but might be a good place to get acquainted with the problem. 2D cutting stock problem would be very interesting to have and would work great with the new multipage functionality.
*For efficient packing of free form objects, we might just re-implement [https://github.com/Jack000/SVGnest SVGNest] in Python. There are probably some more recent research papers which would be interesting to implement as a comparison.

== P19. Improving UI of Live path effects ==
*Estimation of difficulty: Medium- Hard, Short or Long depending on scope (175h or 350h)
*Potential mentors: Mike, jabier ,??
* Programming skills: GTK 4, C++
*Prerequisites: Front end UI , familiarity with Live path effects
[[File:Imageasdasda qrq.png|thumb|146x146px]]

Detailed Description: This project Should implement Proposed UI clean up of Controls . LPE controls shoulbe be more user freindly and predictive,

[https://gitlab.com/inkscape/ux/-/issues/?sort=popularity&state=opened&label_name%5B%5D=Dialog%3A%3ALPE&first_page_size=100 '''Full Proposed designs''']

[[File:Imageasd.png|right|frameless|466x466px]]
== P20. Recolor Artwork ==
* Estimation of difficulty: Variable - Short (90h or 175h)
* Potential mentors: Adam Belis ?
* Programming skills: usually C++
* Prerequisites:

Detailed Description
An easy and convenient way how to change any color from the selection. Useful for experimenting and tweaking colors.

[https://gitlab.com/inkscape/inbox/-/issues/6095 '''Full proposal Here''']

Use cases
* fast Editing color in whole project without of need for swatches
*easier work for color harmonies in a project
*Easier iteration and visioning of designs

==Pxx. Your project ==
* Estimation of difficulty: Variable - Short or Long (175h or 350h)
* Potential mentors: Marc Jeanmougin
* Programming skills: usually C++
* Prerequisites: good ideas

Detailed Description
The most successful GSoC we had in the past were students coming with their own past, use cases and ideas for Inkscape. Many basic tools like 3d cubes or connectors you can see in Inkscape now have been brought by brilliant people (like you) with ideas. If we think that your project fits with Inkscape (ie: has its place with a vector graphic editor), we can help you refining your ideas and help bring shiny new stuff to life!

Use cases
* Amaze us!

= Successful SOC Projects from Previous Years =
* 2005
** Connectors
** Inkboard
** [http://www.openclipart.org/ Open Clip Art Library (OCAL)] Interface
** DXF Import / Export
* [[Google Summer of Code 2006|2006]]
** Support for SVG Filters
** Filter Effects
** PDF export
** Inkboard Protocol Spec / Lib Conversion
* [[Google Summer of Code 2007|2007]]
** Text Style Improvements
** PDF import
** Live Path Effects
** 3D Box Tool
** UI for SVG Filter Effects
** Raster Functionality
** Importing from, and Exporting to, a remote ccHost instance
* [[Google Summer of Code 2008|2008]]
** SVG Fonts support
** 2Geom refactoring project - port most geometry code to 2Geom
** lib2geom: interactive applications showing off the power of lib2geom
** Tech drawing abilities
** A test suite
* 2009
** [[GSoC2009 Node Tool Rewrite|Node tool rewrite]]
** D-Bus scripting API
** Connector tool improvements
** ICC/CMYK workflow
* 2010
** Cairo-based rendering
** C++ification of SP Layer
* 2011
** Rendering caching
** Javascript support improvements
** CSS support improvements
* 2012
** Usibility Improvements for Guides
** [[Tiling tool|On-canvas support for Tessellations]]
** Creating python bindings for lib2geom
* [[Google Summer of Code 2013|2013]]
** Recolor Tool
** Improved Units Support
** Electronics CAD Support
** New From Templates Dialog
** New Raster to Vector Algorithm
* 2014
** Better Support for SVG Paints
** Robust Boolean and Stroking Operations for 2Geom
* 2016
** [[GSoC 2016 Better data structure for selections|Better data structure for selections]]
** [[Style Editor|CSS Style Sheet Editor]]
* 2017
** SVG 2 Text Support
** Better CSS Style Sheet Support
* 2019
** Mesh gradient and hatches polyfills. Paint server dialog.
* 2020
** [https://gitlab.com/vanntile/inkscape-gsoc-2020 New dialog system.]
** [https://gitlab.com/rathod-sahaab/gsoc-2020-inkscape Command palette dialog.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4416 Documenting livarot]
* 2021
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3420 On canvas marker editing.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3328 Verbs to Gio::Actions.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3294 On canvas alignment snapping.]
* 2022
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4692 Tab Structure.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4694 Font Collections.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4756 Modernizing Memory Management.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4504 OCR Support.]
* 2023
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/5335 GTK4 toolbar port preparation]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/5624 Customizable Appearance of Canvas Controls]
* 2024
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/6578 Node-based filter editor]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/6492 Improving UX of Node tool and Bezier tool]
** [https://gitlab.com/inkscape/extras/extension-afdesign Affinity Designer importer]

[[Category:Developer Documentation]]
</div>

Google Summer of Code

2024-12-22T15:30:13Z

PBS: Add self to mentors list for "UI-free Inkscape"

<div style="max-width:70em; margin-left: auto; margin-right: auto">
= Welcome to Inkscape! =

For quite a few years Inkscape has been successfully participating in [http://code.google.com/soc/ Google Summer of Code].

Google has opened up the program to students AND beginners to Open Source who are 18 years are older. Projects can be medium size (~175 hours) or large size (~350 hours). Finish times are flexible, 12 to 22 weeks (with agreement of mentor).

GSoC is a program where Google funds the development of specific features in open source software by university students and other new to open source. You don't need to be a Computer Science student to apply. Features to be developed are picked by Inkscape administrators from the pool of proposals submitted by applicants.

We've mentored about half a dozen students a year since GSoC started. Many students enjoyed their work and continue to be involved; perhaps your mentor will be a past GSoC student! We have a high rate of acceptance of student code into the core codebase. Indeed, GSoC projects have been a key source of some of Inkscape's best features in the past several releases.

If you are interested in joining us this summer, it is time to get your proposal ready. You can choose a proposal from our list of suggestions or come up with one of your own. In either either case, you '''must''' give us a detailed outline of what you plan to do. It is '''highly''' recommended that you discuss your idea as early as possible with Inkscape developers. They not only can give you guidance as you flesh out your proposal but ultimately you must convince them that you can do the work planned in the time allotted. '''If you have not discussed your proposal with Inkscape developers before you apply, your application will be rejected!'''

= Candidate Applications =

* Google program information:
** [https://summerofcode.withgoogle.com/ Home page].
** Summer of Code Application form. Applications open at 18:00 UTC on March 18th, 2024. -> https://developers.google.com/open-source/gsoc/timeline

* Inkscape-specific information:
** [[SOC Application Template]].
** [[Roadmap | Inkscape Roadmap]] - to see our overall objectives.
** [[Projects | Inkscape Development Project Ideas]] - broader list of development ideas.
** [[SOC Writing Project Proposals]] - some guidelines for proposals.
** [[SOC Selection Criteria]] - how we rate applications.

'''Candidate Applications for GSoC 2024 must be submitted to the GSoC site by 18:00 UTC on April 2nd 2024.'''

= The "two patches" rule =

We require two patches from each potential GSoC student, before accepting the student for GSoC participation (it is the same requirement as for obtaining rights to commit changes to the code repository).

The reason for this requirement is that you can show us that you have succeeded in building Inkscape on your PC, and that you have understood a little piece of Inkscape's code and are able to improve it.
Inkscape is a large project, and you really should not try to understand all the code. Many (all?) developers know only parts of the program code!
You can join our [https://inkscape.org/community/discussion/ IRC] channel or [https://chat.inkscape.org/channel/team_devel Rocket Chat] and ask developers for help.

== Suggested "easy" bug fixes or improvements ==

To get you started on Inkscape development, you can find (probably) easy-to-fix bugs or small improvements that require very little knowledge of the whole program by searching our [https://gitlab.com/inkscape/inkscape/issues/ bug-tracker] for bugs tagged with 'easy-fix'.

= Performance Evaluation =

GSoC has two formal evaluation points, at the ''mid-term'' and at the end. These evaluations determine if you receive the stipend from Google. In order to receive a pass for the evaluations you will need to show adequate progress toward your project's goals.

To help you meet your goals and so that your mentor can better evaluate your progress you need to:

* Have frequent, public discussions of your progress. (Don't rely on just your mentor for advice.)
* Have a public Inkscape branch for your code to which you commit regularly.
* Give weekly status reports.

For the final pass, you will normally be required to merge your code into Inkscape trunk.

Remember: ''we want you to succeed!''

= Suggested Project Ideas =

The following is a list of formal project suggestions, but do not feel limited to only these - some of our best contributions have been unique ideas that students had in mind from other sources!

See also [[Development Project Ideas]], [[Refactoring projects]], [[Projects]], and https://blueprints.launchpad.net/inkscape/

==P5. UI-Free Inkscape ==

* Estimation of difficulty: Difficult - Long (350h)
* Potential mentors: Marc Jeanmougin, pbs
* Programming skills: C++, CMake
* Prerequisites: Minimal knowledge of build systems. Experience with GTKmm helpful.

Detailed Description
Inkscape currently builds with X11 and gtk and a lot of graphical dependencies. But since it is allowed to run in commandline, and there are controlled environments (servers) that use it to convert svg to png and to perform actions, there should be no need to force it to build with those. The main goal of this project is to add a WITH_GUI compilation flag that when OFF, does *not* link Inkscape with any graphical dependency. While much work has been done towards this goal, much remains to be done. DONE <s>As a next step, Inkscape's "verbs" which are mostly GUI dependent (even if there is no reason to be) need to be converted to Gio::Actions.</s> More work needs to be done to separate out hidden GUI dependencies that remain after the Verb to Action transition.

Use cases
* Server installs, scripts

==P8. Add Text and Image Support to Live Path Effect System ==
* Estimation of difficulty: Hard - Short (175h)
* Potential mentors: Jabier Arraiza (Spanish, English(not native))
* Programming skills: C++
* Prerequisites: Experience managing bitmaps
Detailed Description
Live Path Effects are non destructive effects applied to paths and shapes standalone or inside a group. 
This is done keepeng a reference to the original data to reaply when needed. 
But ignore text and image elements. 
Things to do:
* Study add image, text, both and maybe others SVG elements to the LPE system.
* Create/adapt minimun one LPE for each new type of element acepted as reference. Suggestion Perspective-Envelope.
Use cases
* Apply live effects to images and text based in C++ code in a non destructive way even in groups with mixed elements types.

==P9. Path Library Improvements ==
* Estimation of difficulty: Hard - Long (350h)
* Potential mentors: Tavmjong Bah, KK
* Programming skills: C++
* Prerequisites: Strong math skills, specifically in geometry.
Detailed Description
Inkscape relies on two geometry libraries for path manipulations: lib2geom and livarot. lib2geom is a generic modern library written specifically with Inkscape in mind. lib2geom is missing some functionality that Inkscape requires and that is found in livarot. This project is to move that functionality into lib2geom (or into separate files) using lib2geom path descriptions. A 2020 GSoC student did a significant amount of work understanding and documenting the issues involved [https://gitlab.com/inkscape/inkscape/-/merge_requests/4416]. This project would be to build on his work.

Specifically, the functionality needed is
* Path offset/inset functions.
* Path simplify.
* Stroke to path function.
* Line scanning (used for flowing text into a shape).

==P11. Improvements to Paint Server Dialog ==

* Estimation of difficulty: Easy to Medium - Short (175h)
* Potential mentors: Tavmjong
* Programming skills: C++
* Prerequisites: Some knowledge of GTK and CSS.
Detailed Description
The ''Paint Server Dialog'' allows a user to visually select a pattern or hatch to use in painting the ''fill'' or ''stroke'' of an object. This project would be to expand the dialog to cover gradients, meshes, and solid colors as well as make other improvements to the dialog. Interaction with the Inkscape's ''UX'' team will be required.

[https://gitlab.com/inkscape/ux/-/issues/40 '''Full poposal''']
== P15. Import and Export extensions ==

*Estimation of difficulty: Flexible, usually easy to medium, Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python, Ability to read technical documents, depending on the format: some reverse engineering
* Prerequisites: minimal knowledge of test-driven development

Detailed Description: Inkscape is alway looking to improve compatibility! Some ideas of relevant file formats - each of them more than enough for one GSoC:*Refactor our '''DXF input and output''' extensions, and expand support towards binary DXF
*Write an as-complete-as-possible '''EPS export''', circumventing the internal information loss in ghostscript (EPS is still relevant for scientific papers, but more and more tools are dropping support, so this is a chance to grab market share - the results of Adobe Distiller are much better than ghostscript's...)
*Rewrite the '''XAML importer''' in Python (currenly XSLT) to match the capabilities of the new XAML exporter (i.e. support for different target frameworks, better text support...) - would have to select carefully what to support (drawing primitives) and what not (control elements) - the boundary is not as clear-cut as it seems.
* Update the '''Synfig export''' to support the latest Synfig developments
* '''Import or export of TikZ'''. There are a few abandoned extensions out there (from which we can borrow), but it's very widely used in science - both import and export could serve an important function in the scientific workflow.
*'''Import of the proprietary fileformats''' of Affinity Design, Vectornator, Vectorstyler (especially the last two seem in their infancy and users at some point will sit on a bunch of files that they can't open anymore because their SAAS model wasn't profitable) .
*'''Import of CGM''' - old, but ISO standardized. Was supported once and dropped when the uniconvertor extension was removed for 1.0.
* '''Python based EMF / WMF importer -''' the current (core Inkscape) C extension is unmaintained and Python would probably be the right way to get more collaboration on it. A lot of public archives sit on mountains of EMF files. Note that the Document Foundation recently did a lot of work properly importing those files, so we can learn from them / maybe even join forces...
*your favorite file format? - also have a look here: https://office.inkscape.org/nextcloud/index.php/s/Tq6cdDDGay6taCw
==P16. Gcodetools refactoring and documentation==

*Estimation of difficulty: Easy- Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python
* Prerequisites: Maker background / familiarity with the Maker community

Detailed Description: [https://gitlab.com/inkscape/extras/extensions-gcodetools/ Gcodetools] is a set of Inkscape extensions that deal with reading and creating Gcode files, mostly for use in laser cutters or plotters. For this project, ideally someone with a Makerspace background will
#query maker spaces on their needs regarding gcodetools,
#implement those needs together with unit tests,
# improve the test coverage of Gcodetools,
#write proper documentation for it. (doesn't really exist at the moment).
==P17. Packing / Nesting as an Inkscape extension==

*Estimation of difficulty: Medium, Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python
* Prerequisites: Computational geometry

Detailed Description: In this project, a set of packing / nesting algorithms will be implemented:
*[https://en.wikipedia.org/wiki/Cutting_stock_problem Linear nesting] is not too useful in SVG, but might be a good place to get acquainted with the problem. 2D cutting stock problem would be very interesting to have and would work great with the new multipage functionality.
*For efficient packing of free form objects, we might just re-implement [https://github.com/Jack000/SVGnest SVGNest] in Python. There are probably some more recent research papers which would be interesting to implement as a comparison.

== P19. Improving UI of Live path effects ==
*Estimation of difficulty: Medium- Hard, Short or Long depending on scope (175h or 350h)
*Potential mentors: Mike, jabier ,??
* Programming skills: GTK 4, C++
*Prerequisites: Front end UI , familiarity with Live path effects
[[File:Imageasdasda qrq.png|thumb|146x146px]]

Detailed Description: This project Should implement Proposed UI clean up of Controls . LPE controls shoulbe be more user freindly and predictive,

[https://gitlab.com/inkscape/ux/-/issues/?sort=popularity&state=opened&label_name%5B%5D=Dialog%3A%3ALPE&first_page_size=100 '''Full Proposed designs''']

[[File:Imageasd.png|right|frameless|466x466px]]
== P20. Recolor Artwork ==
* Estimation of difficulty: Variable - Short (90h or 175h)
* Potential mentors: Adam Belis ?
* Programming skills: usually C++
* Prerequisites:

Detailed Description
An easy and convenient way how to change any color from the selection. Useful for experimenting and tweaking colors.

[https://gitlab.com/inkscape/inbox/-/issues/6095 '''Full proposal Here''']

Use cases
* fast Editing color in whole project without of need for swatches
*easier work for color harmonies in a project
*Easier iteration and visioning of designs

==Pxx. Your project ==
* Estimation of difficulty: Variable - Short or Long (175h or 350h)
* Potential mentors: Marc Jeanmougin
* Programming skills: usually C++
* Prerequisites: good ideas

Detailed Description
The most successful GSoC we had in the past were students coming with their own past, use cases and ideas for Inkscape. Many basic tools like 3d cubes or connectors you can see in Inkscape now have been brought by brilliant people (like you) with ideas. If we think that your project fits with Inkscape (ie: has its place with a vector graphic editor), we can help you refining your ideas and help bring shiny new stuff to life!

Use cases
* Amaze us!

= Successful SOC Projects from Previous Years =
* 2005
** Connectors
** Inkboard
** [http://www.openclipart.org/ Open Clip Art Library (OCAL)] Interface
** DXF Import / Export
* [[Google Summer of Code 2006|2006]]
** Support for SVG Filters
** Filter Effects
** PDF export
** Inkboard Protocol Spec / Lib Conversion
* [[Google Summer of Code 2007|2007]]
** Text Style Improvements
** PDF import
** Live Path Effects
** 3D Box Tool
** UI for SVG Filter Effects
** Raster Functionality
** Importing from, and Exporting to, a remote ccHost instance
* [[Google Summer of Code 2008|2008]]
** SVG Fonts support
** 2Geom refactoring project - port most geometry code to 2Geom
** lib2geom: interactive applications showing off the power of lib2geom
** Tech drawing abilities
** A test suite
* 2009
** [[GSoC2009 Node Tool Rewrite|Node tool rewrite]]
** D-Bus scripting API
** Connector tool improvements
** ICC/CMYK workflow
* 2010
** Cairo-based rendering
** C++ification of SP Layer
* 2011
** Rendering caching
** Javascript support improvements
** CSS support improvements
* 2012
** Usibility Improvements for Guides
** [[Tiling tool|On-canvas support for Tessellations]]
** Creating python bindings for lib2geom
* [[Google Summer of Code 2013|2013]]
** Recolor Tool
** Improved Units Support
** Electronics CAD Support
** New From Templates Dialog
** New Raster to Vector Algorithm
* 2014
** Better Support for SVG Paints
** Robust Boolean and Stroking Operations for 2Geom
* 2016
** [[GSoC 2016 Better data structure for selections|Better data structure for selections]]
** [[Style Editor|CSS Style Sheet Editor]]
* 2017
** SVG 2 Text Support
** Better CSS Style Sheet Support
* 2019
** Mesh gradient and hatches polyfills. Paint server dialog.
* 2020
** [https://gitlab.com/vanntile/inkscape-gsoc-2020 New dialog system.]
** [https://gitlab.com/rathod-sahaab/gsoc-2020-inkscape Command palette dialog.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4416 Documenting livarot]
* 2021
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3420 On canvas marker editing.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3328 Verbs to Gio::Actions.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3294 On canvas alignment snapping.]
* 2022
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4692 Tab Structure.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4694 Font Collections.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4756 Modernizing Memory Management.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4504 OCR Support.]
* 2023
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/5335 GTK4 toolbar port preparation]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/5624 Customizable Appearance of Canvas Controls]
* 2024
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/6578 Node-based filter editor]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/6492 Improving UX of Node tool and Bezier tool]

[[Category:Developer Documentation]]
</div>

Google Summer of Code

2024-12-22T15:23:06Z

PBS: Add links to Documenting Livarot GSoC

<div style="max-width:70em; margin-left: auto; margin-right: auto">
= Welcome to Inkscape! =

For quite a few years Inkscape has been successfully participating in [http://code.google.com/soc/ Google Summer of Code].

Google has opened up the program to students AND beginners to Open Source who are 18 years are older. Projects can be medium size (~175 hours) or large size (~350 hours). Finish times are flexible, 12 to 22 weeks (with agreement of mentor).

GSoC is a program where Google funds the development of specific features in open source software by university students and other new to open source. You don't need to be a Computer Science student to apply. Features to be developed are picked by Inkscape administrators from the pool of proposals submitted by applicants.

We've mentored about half a dozen students a year since GSoC started. Many students enjoyed their work and continue to be involved; perhaps your mentor will be a past GSoC student! We have a high rate of acceptance of student code into the core codebase. Indeed, GSoC projects have been a key source of some of Inkscape's best features in the past several releases.

If you are interested in joining us this summer, it is time to get your proposal ready. You can choose a proposal from our list of suggestions or come up with one of your own. In either either case, you '''must''' give us a detailed outline of what you plan to do. It is '''highly''' recommended that you discuss your idea as early as possible with Inkscape developers. They not only can give you guidance as you flesh out your proposal but ultimately you must convince them that you can do the work planned in the time allotted. '''If you have not discussed your proposal with Inkscape developers before you apply, your application will be rejected!'''

= Candidate Applications =

* Google program information:
** [https://summerofcode.withgoogle.com/ Home page].
** Summer of Code Application form. Applications open at 18:00 UTC on March 18th, 2024. -> https://developers.google.com/open-source/gsoc/timeline

* Inkscape-specific information:
** [[SOC Application Template]].
** [[Roadmap | Inkscape Roadmap]] - to see our overall objectives.
** [[Projects | Inkscape Development Project Ideas]] - broader list of development ideas.
** [[SOC Writing Project Proposals]] - some guidelines for proposals.
** [[SOC Selection Criteria]] - how we rate applications.

'''Candidate Applications for GSoC 2024 must be submitted to the GSoC site by 18:00 UTC on April 2nd 2024.'''

= The "two patches" rule =

We require two patches from each potential GSoC student, before accepting the student for GSoC participation (it is the same requirement as for obtaining rights to commit changes to the code repository).

The reason for this requirement is that you can show us that you have succeeded in building Inkscape on your PC, and that you have understood a little piece of Inkscape's code and are able to improve it.
Inkscape is a large project, and you really should not try to understand all the code. Many (all?) developers know only parts of the program code!
You can join our [https://inkscape.org/community/discussion/ IRC] channel or [https://chat.inkscape.org/channel/team_devel Rocket Chat] and ask developers for help.

== Suggested "easy" bug fixes or improvements ==

To get you started on Inkscape development, you can find (probably) easy-to-fix bugs or small improvements that require very little knowledge of the whole program by searching our [https://gitlab.com/inkscape/inkscape/issues/ bug-tracker] for bugs tagged with 'easy-fix'.

= Performance Evaluation =

GSoC has two formal evaluation points, at the ''mid-term'' and at the end. These evaluations determine if you receive the stipend from Google. In order to receive a pass for the evaluations you will need to show adequate progress toward your project's goals.

To help you meet your goals and so that your mentor can better evaluate your progress you need to:

* Have frequent, public discussions of your progress. (Don't rely on just your mentor for advice.)
* Have a public Inkscape branch for your code to which you commit regularly.
* Give weekly status reports.

For the final pass, you will normally be required to merge your code into Inkscape trunk.

Remember: ''we want you to succeed!''

= Suggested Project Ideas =

The following is a list of formal project suggestions, but do not feel limited to only these - some of our best contributions have been unique ideas that students had in mind from other sources!

See also [[Development Project Ideas]], [[Refactoring projects]], [[Projects]], and https://blueprints.launchpad.net/inkscape/

==P5. UI-Free Inkscape ==

* Estimation of difficulty: Difficult - Long (350h)
* Potential mentors: Marc Jeanmougin
* Programming skills: C++, CMake
* Prerequisites: Minimal knowledge of build systems. Experience with GtkMM helpful.

Detailed Description
Inkscape currently builds with X11 and gtk and a lot of graphical dependencies. But since it is allowed to run in commandline, and there are controlled environments (servers) that use it to convert svg to png and to perform actions, there should be no need to force it to build with those. The main goal of this project is to add a WITH_GUI compilation flag that when OFF, does *not* link Inkscape with any graphical dependency. While much work has been done towards this goal, much remains to be done. DONE <s>As a next step, Inkscape's "verbs" which are mostly GUI dependent (even if there is no reason to be) need to be converted to Gio::Actions.</s> More work needs to be done to separate out hidden GUI dependencies that remain after the Verb to Action transition.

Use cases
* Server installs, scripts

==P8. Add Text and Image Support to Live Path Effect System ==
* Estimation of difficulty: Hard - Short (175h)
* Potential mentors: Jabier Arraiza (Spanish, English(not native))
* Programming skills: C++
* Prerequisites: Experience managing bitmaps
Detailed Description
Live Path Effects are non destructive effects applied to paths and shapes standalone or inside a group. 
This is done keepeng a reference to the original data to reaply when needed. 
But ignore text and image elements. 
Things to do:
* Study add image, text, both and maybe others SVG elements to the LPE system.
* Create/adapt minimun one LPE for each new type of element acepted as reference. Suggestion Perspective-Envelope.
Use cases
* Apply live effects to images and text based in C++ code in a non destructive way even in groups with mixed elements types.

==P9. Path Library Improvements ==
* Estimation of difficulty: Hard - Long (350h)
* Potential mentors: Tavmjong Bah, KK
* Programming skills: C++
* Prerequisites: Strong math skills, specifically in geometry.
Detailed Description
Inkscape relies on two geometry libraries for path manipulations: lib2geom and livarot. lib2geom is a generic modern library written specifically with Inkscape in mind. lib2geom is missing some functionality that Inkscape requires and that is found in livarot. This project is to move that functionality into lib2geom (or into separate files) using lib2geom path descriptions. A 2020 GSoC student did a significant amount of work understanding and documenting the issues involved [https://gitlab.com/inkscape/inkscape/-/merge_requests/4416]. This project would be to build on his work.

Specifically, the functionality needed is
* Path offset/inset functions.
* Path simplify.
* Stroke to path function.
* Line scanning (used for flowing text into a shape).

==P11. Improvements to Paint Server Dialog ==

* Estimation of difficulty: Easy to Medium - Short (175h)
* Potential mentors: Tavmjong
* Programming skills: C++
* Prerequisites: Some knowledge of GTK and CSS.
Detailed Description
The ''Paint Server Dialog'' allows a user to visually select a pattern or hatch to use in painting the ''fill'' or ''stroke'' of an object. This project would be to expand the dialog to cover gradients, meshes, and solid colors as well as make other improvements to the dialog. Interaction with the Inkscape's ''UX'' team will be required.

[https://gitlab.com/inkscape/ux/-/issues/40 '''Full poposal''']
== P15. Import and Export extensions ==

*Estimation of difficulty: Flexible, usually easy to medium, Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python, Ability to read technical documents, depending on the format: some reverse engineering
* Prerequisites: minimal knowledge of test-driven development

Detailed Description: Inkscape is alway looking to improve compatibility! Some ideas of relevant file formats - each of them more than enough for one GSoC:*Refactor our '''DXF input and output''' extensions, and expand support towards binary DXF
*Write an as-complete-as-possible '''EPS export''', circumventing the internal information loss in ghostscript (EPS is still relevant for scientific papers, but more and more tools are dropping support, so this is a chance to grab market share - the results of Adobe Distiller are much better than ghostscript's...)
*Rewrite the '''XAML importer''' in Python (currenly XSLT) to match the capabilities of the new XAML exporter (i.e. support for different target frameworks, better text support...) - would have to select carefully what to support (drawing primitives) and what not (control elements) - the boundary is not as clear-cut as it seems.
* Update the '''Synfig export''' to support the latest Synfig developments
* '''Import or export of TikZ'''. There are a few abandoned extensions out there (from which we can borrow), but it's very widely used in science - both import and export could serve an important function in the scientific workflow.
*'''Import of the proprietary fileformats''' of Affinity Design, Vectornator, Vectorstyler (especially the last two seem in their infancy and users at some point will sit on a bunch of files that they can't open anymore because their SAAS model wasn't profitable) .
*'''Import of CGM''' - old, but ISO standardized. Was supported once and dropped when the uniconvertor extension was removed for 1.0.
* '''Python based EMF / WMF importer -''' the current (core Inkscape) C extension is unmaintained and Python would probably be the right way to get more collaboration on it. A lot of public archives sit on mountains of EMF files. Note that the Document Foundation recently did a lot of work properly importing those files, so we can learn from them / maybe even join forces...
*your favorite file format? - also have a look here: https://office.inkscape.org/nextcloud/index.php/s/Tq6cdDDGay6taCw
==P16. Gcodetools refactoring and documentation==

*Estimation of difficulty: Easy- Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python
* Prerequisites: Maker background / familiarity with the Maker community

Detailed Description: [https://gitlab.com/inkscape/extras/extensions-gcodetools/ Gcodetools] is a set of Inkscape extensions that deal with reading and creating Gcode files, mostly for use in laser cutters or plotters. For this project, ideally someone with a Makerspace background will
#query maker spaces on their needs regarding gcodetools,
#implement those needs together with unit tests,
# improve the test coverage of Gcodetools,
#write proper documentation for it. (doesn't really exist at the moment).
==P17. Packing / Nesting as an Inkscape extension==

*Estimation of difficulty: Medium, Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python
* Prerequisites: Computational geometry

Detailed Description: In this project, a set of packing / nesting algorithms will be implemented:
*[https://en.wikipedia.org/wiki/Cutting_stock_problem Linear nesting] is not too useful in SVG, but might be a good place to get acquainted with the problem. 2D cutting stock problem would be very interesting to have and would work great with the new multipage functionality.
*For efficient packing of free form objects, we might just re-implement [https://github.com/Jack000/SVGnest SVGNest] in Python. There are probably some more recent research papers which would be interesting to implement as a comparison.

== P19. Improving UI of Live path effects ==
*Estimation of difficulty: Medium- Hard, Short or Long depending on scope (175h or 350h)
*Potential mentors: Mike, jabier ,??
* Programming skills: GTK 4, C++
*Prerequisites: Front end UI , familiarity with Live path effects
[[File:Imageasdasda qrq.png|thumb|146x146px]]

Detailed Description: This project Should implement Proposed UI clean up of Controls . LPE controls shoulbe be more user freindly and predictive,

[https://gitlab.com/inkscape/ux/-/issues/?sort=popularity&state=opened&label_name%5B%5D=Dialog%3A%3ALPE&first_page_size=100 '''Full Proposed designs''']

[[File:Imageasd.png|right|frameless|466x466px]]
== P20. Recolor Artwork ==
* Estimation of difficulty: Variable - Short (90h or 175h)
* Potential mentors: Adam Belis ?
* Programming skills: usually C++
* Prerequisites:

Detailed Description
An easy and convenient way how to change any color from the selection. Useful for experimenting and tweaking colors.

[https://gitlab.com/inkscape/inbox/-/issues/6095 '''Full proposal Here''']

Use cases
* fast Editing color in whole project without of need for swatches
*easier work for color harmonies in a project
*Easier iteration and visioning of designs

==Pxx. Your project ==
* Estimation of difficulty: Variable - Short or Long (175h or 350h)
* Potential mentors: Marc Jeanmougin
* Programming skills: usually C++
* Prerequisites: good ideas

Detailed Description
The most successful GSoC we had in the past were students coming with their own past, use cases and ideas for Inkscape. Many basic tools like 3d cubes or connectors you can see in Inkscape now have been brought by brilliant people (like you) with ideas. If we think that your project fits with Inkscape (ie: has its place with a vector graphic editor), we can help you refining your ideas and help bring shiny new stuff to life!

Use cases
* Amaze us!

= Successful SOC Projects from Previous Years =
* 2005
** Connectors
** Inkboard
** [http://www.openclipart.org/ Open Clip Art Library (OCAL)] Interface
** DXF Import / Export
* [[Google Summer of Code 2006|2006]]
** Support for SVG Filters
** Filter Effects
** PDF export
** Inkboard Protocol Spec / Lib Conversion
* [[Google Summer of Code 2007|2007]]
** Text Style Improvements
** PDF import
** Live Path Effects
** 3D Box Tool
** UI for SVG Filter Effects
** Raster Functionality
** Importing from, and Exporting to, a remote ccHost instance
* [[Google Summer of Code 2008|2008]]
** SVG Fonts support
** 2Geom refactoring project - port most geometry code to 2Geom
** lib2geom: interactive applications showing off the power of lib2geom
** Tech drawing abilities
** A test suite
* 2009
** [[GSoC2009 Node Tool Rewrite|Node tool rewrite]]
** D-Bus scripting API
** Connector tool improvements
** ICC/CMYK workflow
* 2010
** Cairo-based rendering
** C++ification of SP Layer
* 2011
** Rendering caching
** Javascript support improvements
** CSS support improvements
* 2012
** Usibility Improvements for Guides
** [[Tiling tool|On-canvas support for Tessellations]]
** Creating python bindings for lib2geom
* [[Google Summer of Code 2013|2013]]
** Recolor Tool
** Improved Units Support
** Electronics CAD Support
** New From Templates Dialog
** New Raster to Vector Algorithm
* 2014
** Better Support for SVG Paints
** Robust Boolean and Stroking Operations for 2Geom
* 2016
** [[GSoC 2016 Better data structure for selections|Better data structure for selections]]
** [[Style Editor|CSS Style Sheet Editor]]
* 2017
** SVG 2 Text Support
** Better CSS Style Sheet Support
* 2019
** Mesh gradient and hatches polyfills. Paint server dialog.
* 2020
** [https://gitlab.com/vanntile/inkscape-gsoc-2020 New dialog system.]
** [https://gitlab.com/rathod-sahaab/gsoc-2020-inkscape Command palette dialog.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4416 Documenting livarot]
* 2021
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3420 On canvas marker editing.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3328 Verbs to Gio::Actions.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3294 On canvas alignment snapping.]
* 2022
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4692 Tab Structure.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4694 Font Collections.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4756 Modernizing Memory Management.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4504 OCR Support.]
* 2023
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/5335 GTK4 toolbar port preparation]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/5624 Customizable Appearance of Canvas Controls]
* 2024
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/6578 Node-based filter editor]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/6492 Improving UX of Node tool and Bezier tool]

[[Category:Developer Documentation]]
</div>

Google Summer of Code

2024-12-22T15:11:55Z

PBS: Add completed 2024 projects

<div style="max-width:70em; margin-left: auto; margin-right: auto">
= Welcome to Inkscape! =

For quite a few years Inkscape has been successfully participating in [http://code.google.com/soc/ Google Summer of Code].

Google has opened up the program to students AND beginners to Open Source who are 18 years are older. Projects can be medium size (~175 hours) or large size (~350 hours). Finish times are flexible, 12 to 22 weeks (with agreement of mentor).

GSoC is a program where Google funds the development of specific features in open source software by university students and other new to open source. You don't need to be a Computer Science student to apply. Features to be developed are picked by Inkscape administrators from the pool of proposals submitted by applicants.

We've mentored about half a dozen students a year since GSoC started. Many students enjoyed their work and continue to be involved; perhaps your mentor will be a past GSoC student! We have a high rate of acceptance of student code into the core codebase. Indeed, GSoC projects have been a key source of some of Inkscape's best features in the past several releases.

If you are interested in joining us this summer, it is time to get your proposal ready. You can choose a proposal from our list of suggestions or come up with one of your own. In either either case, you '''must''' give us a detailed outline of what you plan to do. It is '''highly''' recommended that you discuss your idea as early as possible with Inkscape developers. They not only can give you guidance as you flesh out your proposal but ultimately you must convince them that you can do the work planned in the time allotted. '''If you have not discussed your proposal with Inkscape developers before you apply, your application will be rejected!'''

= Candidate Applications =

* Google program information:
** [https://summerofcode.withgoogle.com/ Home page].
** Summer of Code Application form. Applications open at 18:00 UTC on March 18th, 2024. -> https://developers.google.com/open-source/gsoc/timeline

* Inkscape-specific information:
** [[SOC Application Template]].
** [[Roadmap | Inkscape Roadmap]] - to see our overall objectives.
** [[Projects | Inkscape Development Project Ideas]] - broader list of development ideas.
** [[SOC Writing Project Proposals]] - some guidelines for proposals.
** [[SOC Selection Criteria]] - how we rate applications.

'''Candidate Applications for GSoC 2024 must be submitted to the GSoC site by 18:00 UTC on April 2nd 2024.'''

= The "two patches" rule =

We require two patches from each potential GSoC student, before accepting the student for GSoC participation (it is the same requirement as for obtaining rights to commit changes to the code repository).

The reason for this requirement is that you can show us that you have succeeded in building Inkscape on your PC, and that you have understood a little piece of Inkscape's code and are able to improve it.
Inkscape is a large project, and you really should not try to understand all the code. Many (all?) developers know only parts of the program code!
You can join our [https://inkscape.org/community/discussion/ IRC] channel or [https://chat.inkscape.org/channel/team_devel Rocket Chat] and ask developers for help.

== Suggested "easy" bug fixes or improvements ==

To get you started on Inkscape development, you can find (probably) easy-to-fix bugs or small improvements that require very little knowledge of the whole program by searching our [https://gitlab.com/inkscape/inkscape/issues/ bug-tracker] for bugs tagged with 'easy-fix'.

= Performance Evaluation =

GSoC has two formal evaluation points, at the ''mid-term'' and at the end. These evaluations determine if you receive the stipend from Google. In order to receive a pass for the evaluations you will need to show adequate progress toward your project's goals.

To help you meet your goals and so that your mentor can better evaluate your progress you need to:

* Have frequent, public discussions of your progress. (Don't rely on just your mentor for advice.)
* Have a public Inkscape branch for your code to which you commit regularly.
* Give weekly status reports.

For the final pass, you will normally be required to merge your code into Inkscape trunk.

Remember: ''we want you to succeed!''

= Suggested Project Ideas =

The following is a list of formal project suggestions, but do not feel limited to only these - some of our best contributions have been unique ideas that students had in mind from other sources!

See also [[Development Project Ideas]], [[Refactoring projects]], [[Projects]], and https://blueprints.launchpad.net/inkscape/

==P5. UI-Free Inkscape ==

* Estimation of difficulty: Difficult - Long (350h)
* Potential mentors: Marc Jeanmougin
* Programming skills: C++, CMake
* Prerequisites: Minimal knowledge of build systems. Experience with GtkMM helpful.

Detailed Description
Inkscape currently builds with X11 and gtk and a lot of graphical dependencies. But since it is allowed to run in commandline, and there are controlled environments (servers) that use it to convert svg to png and to perform actions, there should be no need to force it to build with those. The main goal of this project is to add a WITH_GUI compilation flag that when OFF, does *not* link Inkscape with any graphical dependency. While much work has been done towards this goal, much remains to be done. DONE <s>As a next step, Inkscape's "verbs" which are mostly GUI dependent (even if there is no reason to be) need to be converted to Gio::Actions.</s> More work needs to be done to separate out hidden GUI dependencies that remain after the Verb to Action transition.

Use cases
* Server installs, scripts

==P8. Add Text and Image Support to Live Path Effect System ==
* Estimation of difficulty: Hard - Short (175h)
* Potential mentors: Jabier Arraiza (Spanish, English(not native))
* Programming skills: C++
* Prerequisites: Experience managing bitmaps
Detailed Description
Live Path Effects are non destructive effects applied to paths and shapes standalone or inside a group. 
This is done keepeng a reference to the original data to reaply when needed. 
But ignore text and image elements. 
Things to do:
* Study add image, text, both and maybe others SVG elements to the LPE system.
* Create/adapt minimun one LPE for each new type of element acepted as reference. Suggestion Perspective-Envelope.
Use cases
* Apply live effects to images and text based in C++ code in a non destructive way even in groups with mixed elements types.

==P9. Path Library Improvements ==
* Estimation of difficulty: Hard - Long (350h)
* Potential mentors: Tavmjong Bah, KK
* Programming skills: C++
* Prerequisites: Strong math skills, specifically in geometry.
Detailed Description
Inkscape relies on two geometry libraries for path manipulations: lib2geom and livarot. lib2geom is a generic modern library written specifically with Inkscape in mind. lib2geom is missing some functionality that Inkscape requires and that is found in livarot. This project is to move that functionality into lib2geom (or into separate files) using lib2geom path descriptions. A 2020 GSoC student did a significant amount of work understanding and documenting the issues involved. This project would be to build on his work.

Specifically, the functionality needed is
* Path offset/inset functions.
* Path simplify.
* Stroke to path function.
* Line scanning (used for flowing text into a shape).

==P11. Improvements to Paint Server Dialog ==

* Estimation of difficulty: Easy to Medium - Short (175h)
* Potential mentors: Tavmjong
* Programming skills: C++
* Prerequisites: Some knowledge of GTK and CSS.
Detailed Description
The ''Paint Server Dialog'' allows a user to visually select a pattern or hatch to use in painting the ''fill'' or ''stroke'' of an object. This project would be to expand the dialog to cover gradients, meshes, and solid colors as well as make other improvements to the dialog. Interaction with the Inkscape's ''UX'' team will be required.

[https://gitlab.com/inkscape/ux/-/issues/40 '''Full poposal''']
== P15. Import and Export extensions ==

*Estimation of difficulty: Flexible, usually easy to medium, Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python, Ability to read technical documents, depending on the format: some reverse engineering
* Prerequisites: minimal knowledge of test-driven development

Detailed Description: Inkscape is alway looking to improve compatibility! Some ideas of relevant file formats - each of them more than enough for one GSoC:*Refactor our '''DXF input and output''' extensions, and expand support towards binary DXF
*Write an as-complete-as-possible '''EPS export''', circumventing the internal information loss in ghostscript (EPS is still relevant for scientific papers, but more and more tools are dropping support, so this is a chance to grab market share - the results of Adobe Distiller are much better than ghostscript's...)
*Rewrite the '''XAML importer''' in Python (currenly XSLT) to match the capabilities of the new XAML exporter (i.e. support for different target frameworks, better text support...) - would have to select carefully what to support (drawing primitives) and what not (control elements) - the boundary is not as clear-cut as it seems.
* Update the '''Synfig export''' to support the latest Synfig developments
* '''Import or export of TikZ'''. There are a few abandoned extensions out there (from which we can borrow), but it's very widely used in science - both import and export could serve an important function in the scientific workflow.
*'''Import of the proprietary fileformats''' of Affinity Design, Vectornator, Vectorstyler (especially the last two seem in their infancy and users at some point will sit on a bunch of files that they can't open anymore because their SAAS model wasn't profitable) .
*'''Import of CGM''' - old, but ISO standardized. Was supported once and dropped when the uniconvertor extension was removed for 1.0.
* '''Python based EMF / WMF importer -''' the current (core Inkscape) C extension is unmaintained and Python would probably be the right way to get more collaboration on it. A lot of public archives sit on mountains of EMF files. Note that the Document Foundation recently did a lot of work properly importing those files, so we can learn from them / maybe even join forces...
*your favorite file format? - also have a look here: https://office.inkscape.org/nextcloud/index.php/s/Tq6cdDDGay6taCw
==P16. Gcodetools refactoring and documentation==

*Estimation of difficulty: Easy- Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python
* Prerequisites: Maker background / familiarity with the Maker community

Detailed Description: [https://gitlab.com/inkscape/extras/extensions-gcodetools/ Gcodetools] is a set of Inkscape extensions that deal with reading and creating Gcode files, mostly for use in laser cutters or plotters. For this project, ideally someone with a Makerspace background will
#query maker spaces on their needs regarding gcodetools,
#implement those needs together with unit tests,
# improve the test coverage of Gcodetools,
#write proper documentation for it. (doesn't really exist at the moment).
==P17. Packing / Nesting as an Inkscape extension==

*Estimation of difficulty: Medium, Short or Long depending on scope (175h or 350h)
*Potential mentors: Jonathan
* Programming skills: Python
* Prerequisites: Computational geometry

Detailed Description: In this project, a set of packing / nesting algorithms will be implemented:
*[https://en.wikipedia.org/wiki/Cutting_stock_problem Linear nesting] is not too useful in SVG, but might be a good place to get acquainted with the problem. 2D cutting stock problem would be very interesting to have and would work great with the new multipage functionality.
*For efficient packing of free form objects, we might just re-implement [https://github.com/Jack000/SVGnest SVGNest] in Python. There are probably some more recent research papers which would be interesting to implement as a comparison.

== P19. Improving UI of Live path effects ==
*Estimation of difficulty: Medium- Hard, Short or Long depending on scope (175h or 350h)
*Potential mentors: Mike, jabier ,??
* Programming skills: GTK 4, C++
*Prerequisites: Front end UI , familiarity with Live path effects
[[File:Imageasdasda qrq.png|thumb|146x146px]]

Detailed Description: This project Should implement Proposed UI clean up of Controls . LPE controls shoulbe be more user freindly and predictive,

[https://gitlab.com/inkscape/ux/-/issues/?sort=popularity&state=opened&label_name%5B%5D=Dialog%3A%3ALPE&first_page_size=100 '''Full Proposed designs''']

[[File:Imageasd.png|right|frameless|466x466px]]
== P20. Recolor Artwork ==
* Estimation of difficulty: Variable - Short (90h or 175h)
* Potential mentors: Adam Belis ?
* Programming skills: usually C++
* Prerequisites:

Detailed Description
An easy and convenient way how to change any color from the selection. Useful for experimenting and tweaking colors.

[https://gitlab.com/inkscape/inbox/-/issues/6095 '''Full proposal Here''']

Use cases
* fast Editing color in whole project without of need for swatches
*easier work for color harmonies in a project
*Easier iteration and visioning of designs

==Pxx. Your project ==
* Estimation of difficulty: Variable - Short or Long (175h or 350h)
* Potential mentors: Marc Jeanmougin
* Programming skills: usually C++
* Prerequisites: good ideas

Detailed Description
The most successful GSoC we had in the past were students coming with their own past, use cases and ideas for Inkscape. Many basic tools like 3d cubes or connectors you can see in Inkscape now have been brought by brilliant people (like you) with ideas. If we think that your project fits with Inkscape (ie: has its place with a vector graphic editor), we can help you refining your ideas and help bring shiny new stuff to life!

Use cases
* Amaze us!

= Successful SOC Projects from Previous Years =
* 2005
** Connectors
** Inkboard
** [http://www.openclipart.org/ Open Clip Art Library (OCAL)] Interface
** DXF Import / Export
* [[Google Summer of Code 2006|2006]]
** Support for SVG Filters
** Filter Effects
** PDF export
** Inkboard Protocol Spec / Lib Conversion
* [[Google Summer of Code 2007|2007]]
** Text Style Improvements
** PDF import
** Live Path Effects
** 3D Box Tool
** UI for SVG Filter Effects
** Raster Functionality
** Importing from, and Exporting to, a remote ccHost instance
* [[Google Summer of Code 2008|2008]]
** SVG Fonts support
** 2Geom refactoring project - port most geometry code to 2Geom
** lib2geom: interactive applications showing off the power of lib2geom
** Tech drawing abilities
** A test suite
* 2009
** [[GSoC2009 Node Tool Rewrite|Node tool rewrite]]
** D-Bus scripting API
** Connector tool improvements
** ICC/CMYK workflow
* 2010
** Cairo-based rendering
** C++ification of SP Layer
* 2011
** Rendering caching
** Javascript support improvements
** CSS support improvements
* 2012
** Usibility Improvements for Guides
** [[Tiling tool|On-canvas support for Tessellations]]
** Creating python bindings for lib2geom
* [[Google Summer of Code 2013|2013]]
** Recolor Tool
** Improved Units Support
** Electronics CAD Support
** New From Templates Dialog
** New Raster to Vector Algorithm
* 2014
** Better Support for SVG Paints
** Robust Boolean and Stroking Operations for 2Geom
* 2016
** [[GSoC 2016 Better data structure for selections|Better data structure for selections]]
** [[Style Editor|CSS Style Sheet Editor]]
* 2017
** SVG 2 Text Support
** Better CSS Style Sheet Support
* 2019
** Mesh gradient and hatches polyfills. Paint server dialog.
* 2020
** [https://gitlab.com/vanntile/inkscape-gsoc-2020 New dialog system.]
** [https://gitlab.com/rathod-sahaab/gsoc-2020-inkscape Command palette dialog.]
** Path operations.
* 2021
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3420 On canvas marker editing.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3328 Verbs to Gio::Actions.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/3294 On canvas alignment snapping.]
* 2022
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4692 Tab Structure.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4694 Font Collections.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4756 Modernizing Memory Management.]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/4504 OCR Support.]
* 2023
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/5335 GTK4 toolbar port preparation]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/5624 Customizable Appearance of Canvas Controls]
* 2024
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/6578 Node-based filter editor]
** [https://gitlab.com/inkscape/inkscape/-/merge_requests/6492 Improving UX of Node tool and Bezier tool]

[[Category:Developer Documentation]]
</div>

C++20

2024-07-10T00:50:31Z

PBS: Update for Ubuntu 24.04

See also [[C++11]], [[C++17]], [[C++23]].

Some things that will be interesting to use once C++20 is common:

{| class="wikitable"
|-
! Feature !! Since !! Can use? !! GCC !! Apple Clang !! Comment
|-
| <code>std::span</code> || C++20 || style="background: lightgreen;" | from 1.4 || 10 || 11.0.3 || Handle buffers like standard library containers without risk of overflow.
|-
| <code>std::format</code> || C++20 || style="background: pink;" | not yet || 13 || 15.3 || Better and more efficient formatting of strings. [https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p0645r10.html Text Formatting]
|-
| <code>std::lerp</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9 || 11.0.3 || Linear interpolation. (ui/tools/pencil-tool.cpp)
|-
| <code>std::bit_floor</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9/10 || 11.0.3/13.0.0 || Compute <code>floor(log2(x))</code>. (helper/mathfns.h)
|-
| Concepts || C++20 || from 1.4? || 6/10 || 12.0.0 Partial || Safer templating. (ui/controller.h)
|-
| Coroutines || C++20 || style="background: pink;" | not yet || 10 || 10.0.1 Partial, 15.3 Full || Simpler asynchronous code. (trace/trace.cpp)
|-
| <code>std::make_unique_for_overwrite</code>
|| C++20 || style="background: pink;" | not yet || 11 || 15.0.0 || Don't zero arrays allocated using std::make_unique. (util/pool.cpp)
|-
| Ranges || C++20 || style="background: pink;" | not yet || || ? || (ui/dialog/swatches.cpp)
|-
| [https://stackoverflow.com/a/60244416/5075760 Structural templates]
|| C++20 || from 1.4? || || Partial || Allow instances of arbitrary literal classes as template parameters. (display/drawing.cpp)
|-
| Mathematical Constants || C++20 || || 10 || 12.0.5 || Constants like <code>std::numbers::pi</code>.
|-
| Heterogenous lookup in <code>std::unordered_map</code>
|| C++20 || style="background: pink;" | not yet || || || Faster lookup, use of smart pointers as keys.
|-
|<code>consteval static</code> member functions
|C++20
| style="background: pink;" | not yet
|
|
|Guaranteed compile time evaluation of member functions (stronger than <code>constexpr</code>)
|}

References:

* General: https://en.cppreference.com/w/Template:cpp/compiler_support/20
* Apple Clang: https://developer.apple.com/documentation/xcode-release-notes

As of 10 July 2024, the CI runners for the various supported platforms are
* Linux:
** appimage:linux: GNU 13.2.0 (building on Ubuntu 24.04)
** inkscape:linux: Same as above
* Windows
** inkscape:windows:build: GNU 13.2.0
** inkscape:windows:dist: Same as above
* macOS:
** inkscape::macos:arm: Apple Clang 15.0.0
** inkscape:macos:x64: Apple Clang 13.0.0 (temporarily disabled since GTK4 port)

We strive to support latest Debian stable and latest Ubuntu LTS.
{| class="wikitable"
|-
! Distro || gcc || clang || glib || glibmm || gtk4 || gtkmm4 || Can build?
|-
| Debian 12 (Bookworm, stable) || 12.2.0 || 15.0.6 || style="background: pink;" | 2.74.6 || style="background: pink;" | 2.74.0 || style="background: wheat;" | 4.8.3 || style="background: wheat;" | 4.8.3 || ❌
|-
| Ubuntu 24.04 (Noble) || 13.2.0 || 18.1.3 || 2.80.0 || 2.78.1 || 4.14.2 || style="background: wheat;" | 4.10.1 || ✅
|}

The build requires glibmm >= 2.78.1 and gtkmm4 >= 4.14. The build system will supply its own gtkmm4 if out-of-date. Therefore the build only currently works out of the box on Ubuntu 24.04.

Deprecated items that we still use:
* warning: implicit capture of ‘this’ via ‘[=]’ is deprecated in C++20 [-Wdeprecated] https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2018/p0806r2.html
* warning: bitwise operation between different enumeration types ‘Box3D::Axis’ and ‘Box3D::FrontOrRear’ is deprecated [-Wdeprecated-enum-enum-conversion]

C++20

2024-04-19T21:53:43Z

PBS: Add heterogenous lookup; can't use yet (macOS)

See also [[C++11]], [[C++17]], [[C++23]].

Some things that will be interesting to use once C++20 is common:

{| class="wikitable"
|-
! Feature !! Since !! Can use? !! GCC !! Apple Clang !! Comment
|-
| <code>std::span</code> || C++20 || style="background: lightgreen;" | from 1.4 || 10 || 11.0.3 || Handle buffers like standard library containers without risk of overflow.
|-
| <code>std::format</code> || C++20 || style="background: pink;" | not yet || 13 || 15.3 || Better and more efficient formatting of strings. [https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p0645r10.html Text Formatting]
|-
| <code>std::lerp</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9 || 11.0.3 || Linear interpolation. (ui/tools/pencil-tool.cpp)
|-
| <code>std::bit_floor</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9/10 || 11.0.3/13.0.0 || Compute <code>floor(log2(x))</code>. (helper/mathfns.h)
|-
| Concepts || C++20 || from 1.4? || 6/10 || 12.0.0 Partial || Safer templating. (ui/controller.h)
|-
| Coroutines || C++20 || style="background: pink;" | not yet || 10 || 10.0.1 Partial, 15.3 Full || Simpler asynchronous code. (trace/trace.cpp)
|-
| <code>std::make_unique_for_overwrite</code>
|| C++20 || style="background: pink;" | not yet || 11 || 15.0.0 || Don't zero arrays allocated using std::make_unique. (util/pool.cpp)
|-
| Ranges || C++20 || style="background: pink;" | not yet || || ? || (ui/dialog/swatches.cpp)
|-
| [https://stackoverflow.com/a/60244416/5075760 Structural templates]
|| C++20 || from 1.4? || || Partial || Allow instances of arbitrary literal classes as template parameters. (display/drawing.cpp)
|-
| Mathematical Constants || C++20 || || 10 || 12.0.5 || Constants like <code>std::numbers::pi</code>.
|-
| Heterogenous lookup in <code>std::unordered_map</code>
|| C++20 || style="background: pink;" | not yet || || || Faster lookup, use of smart pointers as keys.
|}

References:

* General: https://en.cppreference.com/w/Template:cpp/compiler_support/20
* Apple Clang: https://developer.apple.com/documentation/xcode-release-notes

As of 27 March 2024, the CI runners for the various supported platforms are
* Linux:
** appimage:linux: GNU 13.2.0 (building on Ubuntu 23.10)
** inkscape:linux: Same as above
* Windows
** inkscape:windows:build: GNU 13.2.0
** inkscape:windows:dist: Same as above
* macOS:
** inkscape::macos:arm: Apple Clang 15.0.0
** inkscape:macos:x64: Apple Clang 13.0.0 (temporarily disabled since GTK4 port)

We strive to support latest Debian stable and latest Ubuntu LTS. However, we had to break that promise since the GTK4 port, which requires gtkmm4 >= 4.14:
{| class="wikitable"
|-
! Distro || gcc || clang || gtkmm4
|-
| Debian 12 (Bookworm, stable) || 12.2.0 || 15.0.6 || 4.8.3
|-
| Ubuntu 22.04 (Jammy Jellyfish) || 12.3.0 || 15.0.7 || Not packaged!
|-
| Ubuntu 23.04 (Lunar) || 13.1.0 || 16.0.0 || 4.10.1
|-
| Ubuntu 24.04 (Noble) || 13.2.0 || 18.1.0 || 4.10.1 (???)
|}

Ubuntu users therefore have the following options:

* Wait for Ubuntu 24.04, expected around 25 April 2024.
* Upgrade to Ubuntu 24.04 now.
* Upgrade to Ubuntu 23.10 and build gtkmm4 from source, as is currently done by CI.
* ???

Deprecated items that we still use:
* warning: implicit capture of ‘this’ via ‘[=]’ is deprecated in C++20 [-Wdeprecated] https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2018/p0806r2.html
* warning: bitwise operation between different enumeration types ‘Box3D::Axis’ and ‘Box3D::FrontOrRear’ is deprecated [-Wdeprecated-enum-enum-conversion]

C++20

2024-04-17T22:41:24Z

PBS: Mention Windows CI is back

See also [[C++11]], [[C++17]], [[C++23]].

Some things that will be interesting to use once C++20 is common:

{| class="wikitable"
|-
! Feature !! Since !! Can use? !! GCC !! Apple Clang !! Comment
|-
| <code>std::span</code> || C++20 || style="background: lightgreen;" | from 1.4 || 10 || 11.0.3 || Handle buffers like standard library containers without risk of overflow.
|-
| <code>std::format</code> || C++20 || style="background: pink;" | not yet || 13 || 15.3 || Better and more efficient formatting of strings. [https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p0645r10.html Text Formatting]
|-
| <code>std::lerp</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9 || 11.0.3 || Linear interpolation. (ui/tools/pencil-tool.cpp)
|-
| <code>std::bit_floor</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9/10 || 11.0.3/13.0.0 || Compute floor(log2(x)). (helper/mathfns.h)
|-
| <code>Concepts</code> || C++20 || from 1.4? || 6/10 || 12.0.0 Partial || Safer templating. (ui/controller.h)
|-
| <code>Coroutines</code> || C++20 || style="background: pink;" | not yet || 10 || 10.0.1 Partial, 15.3 Full || Simpler asynchronous code. (trace/trace.cpp)
|-
| <code>std::make_unique_for_overwrite</code>
|| C++20 || style="background: pink;" | not yet || 11 || 15.0.0 || Don't zero arrays allocated using std::make_unique. (util/pool.cpp)
|-
| <code>Ranges</code> || C++20 || style="background: pink;" | not yet || || ? || for (init; decl : expr). (ui/dialog/swatches.cpp)
|-
| <code>[https://stackoverflow.com/a/60244416/5075760 Structural templates]</code>
|| C++20 || from 1.4? || || Partial || Allow instances of arbitrary literal classes as template parameters. (display/drawing.cpp)
|-
| <code>Mathematical Constants</code>
|| C++20 || || 10 || 12.0.5 || Constants like std::numbers::pi.
|}

References:

* General: https://en.cppreference.com/w/Template:cpp/compiler_support/20
* Apple Clang: https://developer.apple.com/documentation/xcode-release-notes

As of 27 March 2024, the CI runners for the various supported platforms are
* Linux:
** appimage:linux: GNU 13.2.0 (building on Ubuntu 23.10)
** inkscape:linux: Same as above
* Windows
** inkscape:windows:build: GNU 13.2.0
** inkscape:windows:dist: Same as above
* macOS:
** inkscape::macos:arm: Apple Clang 15.0.0
** inkscape:macos:x64: Apple Clang 13.0.0 (temporarily disabled since GTK4 port)

We strive to support latest Debian stable and latest Ubuntu LTS. However, we had to break that promise since the GTK4 port, which requires gtkmm4 >= 4.14:
{| class="wikitable"
|-
! Distro || gcc || clang || gtkmm4
|-
| Debian 12 (Bookworm, stable) || 12.2.0 || 15.0.6 || 4.8.3
|-
| Ubuntu 22.04 (Jammy Jellyfish) || 12.3.0 || 15.0.7 || Not packaged!
|-
| Ubuntu 23.04 (Lunar) || 13.1.0 || 16.0.0 || 4.10.1
|-
| Ubuntu 24.04 (Noble) || 13.2.0 || 18.1.0 || 4.10.1 (???)
|}

Ubuntu users therefore have the following options:

* Wait for Ubuntu 24.04, expected around 25 April 2024.
* Upgrade to Ubuntu 24.04 now.
* Upgrade to Ubuntu 23.10 and build gtkmm4 from source, as is currently done by CI.
* ???

Deprecated items that we still use:
* warning: implicit capture of ‘this’ via ‘[=]’ is deprecated in C++20 [-Wdeprecated] https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2018/p0806r2.html
* warning: bitwise operation between different enumeration types ‘Box3D::Axis’ and ‘Box3D::FrontOrRear’ is deprecated [-Wdeprecated-enum-enum-conversion]

C++20

2024-03-27T05:43:24Z

PBS: Update to reflect latest CI changes, add new information

See also [[C++11]], [[C++17]].

Some things that will be interesting to use once C++20 is common:

{| class="wikitable"
|-
! Feature !! Since !! Can use? !! GCC !! Apple Clang !! Comment
|-
| <code>std::span</code> || C++20 || style="background: lightgreen;" | from 1.4 || 10 || 11.0.3 || Handle buffers like standard library containers without risk of overflow.
|-
| <code>std::format</code> || C++20 || style="background: pink;" | not yet || 13 || N/A || Better and more efficient formatting of strings. [https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p0645r10.html Text Formatting]
|-
| <code>std::lerp</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9 || 11.0.3 || Linear interpolation. (ui/tools/pencil-tool.cpp)
|-
| <code>std::bit_floor</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9/10 || 11.0.3/13.0.0 || Compute floor(log2(x)). (helper/mathfns.h)
|-
| <code>Concepts</code> || C++20 || from 1.4? || 6/10 || 12.0.0 Partial || Safer templating. (ui/controller.h)
|-
| <code>Coroutines</code> || C++20 || style="background: pink;" | not yet || 10 || 10.0.1 Partial || Simpler asynchronous code. (trace/trace.cpp)
|-
| <code>std::make_unique_for_overwrite</code>
|| C++20 || style="background: pink;" | not yet || 11 || N/A || Don't zero arrays allocated using std::make_unique. (util/pool.cpp)
|-
| <code>Ranges</code> || C++20 || style="background: pink;" | not yet || || ? || for (init; decl : expr). (ui/dialog/swatches.cpp)
|-
| <code>[https://stackoverflow.com/a/60244416/5075760 Structural templates]</code>
|| C++20 || from 1.4? || || Partial || Allow instances of arbitrary literal classes as template parameters. (display/drawing.cpp)
|-
| <code>Mathematical Constants</code>
|| C++20 || || 10 || 12.0.5 || Constants like std::numbers::pi.
|}

References:

* General: https://en.cppreference.com/w/Template:cpp/compiler_support/20
* Apple Clang: https://developer.apple.com/documentation/xcode-release-notes

As of 27 March 2024, the CI runners for the various supported platforms are
* Linux:
** appimage:linux: GNU 13.2.0 (building on Ubuntu 23.10)
** inkscape:linux: Same as above
* Windows
** inkscape:windows:build: GNU 13.2.0 (temporarily disabled since GTK4 port)
** inkscape:windows:dist: Same as above
* macOS:
** inkscape::macos:arm: Apple Clang 15.0.0
** inkscape:macos:x64: Apple Clang 13.0.0 (temporarily disabled since GTK4 port)

We strive to support latest Debian stable and latest Ubuntu LTS. However, we had to break that promise since the GTK4 port, which requires gtkmm4 >= 4.14:
{| class="wikitable"
|-
! Distro || gcc || clang || gtkmm4
|-
| Debian 12 (Bookworm, stable) || 12.2.0 || 15.0.6 || 4.8.3
|-
| Ubuntu 22.04 (Jammy Jellyfish) || 12.3.0 || 15.0.7 || Not packaged!
|-
| Ubuntu 23.04 (Lunar) || 13.1.0 || 16.0.0 || 4.10.1
|}

Ubuntu users therefore have the following options:

* Wait for Ubuntu 24.04, expected around 25 April 2024.
* Upgrade to Ubuntu 24.04 now.
* Upgrade to Ubuntu 23.10 and build gtkmm4 from source, as is currently done by CI.
* ???

Deprecated items that we still use:
* warning: implicit capture of ‘this’ via ‘[=]’ is deprecated in C++20 [-Wdeprecated] https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2018/p0806r2.html
* warning: bitwise operation between different enumeration types ‘Box3D::Axis’ and ‘Box3D::FrontOrRear’ is deprecated [-Wdeprecated-enum-enum-conversion]

C++20

2023-12-08T12:25:42Z

PBS: Mark coroutines as unsupported

See also [[C++11]], [[C++17]].

Some things that will be interesting to use once C++20 is common:

{| class="wikitable"
|-
! Feature !! Since !! Can use? !! GCC !! Apple Clang !! Comment
|-
| <code>std::span</code> || C++20 || style="background: lightgreen;" | from 1.4 || 10 || 11.0.3 || Handle buffers like standard library containers without risk of overflow.
|-
| <code>std::format</code> || C++20 || style="background: pink;" | not yet || 13 || N/A || Better and more efficient formatting of strings. [https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p0645r10.html Text Formatting]
|-
| <code>std::lerp</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9 || 11.0.3 || Linear interpolation. (ui/tools/pencil-tool.cpp)
|-
| <code>std::bit_floor</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9/10 || 11.0.3/13.0.0 || Compute floor(log2(x)). (helper/mathfns.h)
|-
| <code>Concepts</code> || C++20 || from 1.4? || 6/10 || 12.0.0 Partial || Safer templating. (ui/controller.h)
|-
| <code>Coroutines</code> || C++20 || style="background: pink;" | not yet || 10 || 10.0.1 Partial || Simpler asynchronous code. (trace/trace.cpp)
|-
| <code>std::make_unique_for_overwrite</code>
|| C++20 || style="background: pink;" | not yet || 11 || N/A || Don't zero arrays allocated using std::make_unique. (util/pool.cpp)
|-
| <code>Ranges</code> || C++20 || style="background: pink;" | not yet || || ? || for (init; decl : expr). (ui/dialog/swatches.cpp)
|-
| <code>[https://stackoverflow.com/a/60244416/5075760 Structural templates]</code>
|| C++20 || from 1.4? || || Partial || Allow instances of arbitrary literal classes as template parameters. (display/drawing.cpp)
|-
| <code>Mathematical Constants</code>
|| C++20 || || 10 || 12.0.5 || Constants like std::numbers::pi.
|}

As of 6 September 2023, the CI runners for:
* Linux:
** appimage:linux GNU 10.5 (Building on "oldest supported Ubuntu LTS release", we must wait until April 2025 to use a newer GNU version!) Note: Gtkmm4 is not available in Ubuntu 20.04 or 22.04!
** inkscape:linux GNU 11.4.0
* Windows
** inkscape:windows:build Gnu 13.1.0
** inkscape:windows:dist Same as above.
* macOS:
** inkscape::macos:arm Apple Clang 13.1.6
** inkscape:macos:x64: Apple Clang 14.0.0.

We strive to support lastest Debian stable and latest Ubuntu LTS. But this may not be possible for a gtk4 based release. Ideally, we would target gtkmm4 4.10 as it has a critical scrolling bug fix.
{| class="wikitable"
|-
! Distro || gcc || clang || gtkmm4
|-
| Debian 12 (Bookworm, stable) || 12.2.0 || 15.0.6 || 4.8.3
|-
| Ubuntu 22.04 (Jammy Jellyfish) || 12.3.0 || 15.0.7 || Not packaged!
|-
| Ubuntu 23.04 (Lunar) || 13.1.0 || 16.0.0 || 4.10.1
|}

Errors and Deprecated items that we use:
* error: call of overloaded ‘lerp(double, double&, double&)’ is ambiguous (ui/knot/knot-holder-entity.cpp)
* warning: implicit capture of ‘this’ via ‘[=]’ is deprecated in C++20 [-Wdeprecated] https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2018/p0806r2.html
* warning: bitwise operation between different enumeration types ‘Box3D::Axis’ and ‘Box3D::FrontOrRear’ is deprecated [-Wdeprecated-enum-enum-conversion]

C++20

2023-10-23T14:50:58Z

PBS: Mark std::views as unavailable on Apple clang

See also [[C++11]], [[C++17]].

Some things that will be interesting to use once C++20 is common:

{| class="wikitable"
|-
! Feature !! Since !! Can use? !! GCC !! Apple Clang !! Comment
|-
| <code>std::span</code> || C++20 || style="background: lightgreen;" | from 1.4 || 10 || 11.0.3 || Handle buffers like standard library containers without risk of overflow.
|-
| <code>std::format</code> || C++20 || style="background: pink;" | || 13 || N/A || Better and more efficient formatting of strings. [https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2019/p0645r10.html Text Formatting]
|-
| <code>std::lerp</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9 || 11.0.3 || Linear interpolation. (ui/tools/pencil-tool.cpp)
|-
| <code>std::bit_floor</code> || C++20 || style="background: lightgreen;" | from 1.4 || 9/10 || 11.0.3/13.0.0 || Compute floor(log2(x)). (helper/mathfns.h)
|-
| <code>Concepts</code> || C++20 || from 1.4? || 6/10 || 12.0.0 Partial || Safer templating. (ui/controller.h)
|-
| <code>Coroutines</code> || C++20 || || 10 || 10.0.1 Partial || Simpler asynchronous code. (trace/trace.cpp)
|-
| <code>std::make_unique_for_overwrite</code> || C++20 || style="background: pink;" | || 11 || N/A || Don't zero arrays allocated using std::make_unique. (util/pool.cpp)
|-
| <code>Ranges</code> || C++20 || style="background: pink;" | from 1.4? || || ? || for (init; decl : expr). (ui/dialog/swatches.cpp)
|-
| <code>[https://stackoverflow.com/a/60244416/5075760 Structural templates]</code> || C++20 || from 1.4? || || Partial || Allow instances of arbitrary literal classes as template parameters. (display/drawing.cpp)
|-
| <code>Mathematical Constants</code>|| C++20 || || 10 || 12.0.5 || Constants like std::numbers::pi.
|}

As of 6 September 2023, the CI runners for:
* Linux:
** appimage:linux GNU 10.5 (Building on "oldest supported Ubuntu LTS release", we must wait until April 2025 to use a newer GNU version!) Note: Gtkmm4 is not available in Ubuntu 20.04 or 22.04!
** inkscape:linux GNU 11.4.0
* Windows
** inkscape:windows:build Gnu 13.1.0
** inkscape:windows:dist Same as above.
* macOS:
** inkscape::macos:arm Apple Clang 13.1.6
** inkscape:macos:x64: Apple Clang 14.0.0.

We strive to support lastest Debian stable and latest Ubuntu LTS. But this may not be possible for a gtk4 based release. Ideally, we would target gtkmm4 4.10 as it has a critical scrolling bug fix.
{| class="wikitable"
|-
! Distro || gcc || clang || gtkmm4
|-
| Debian 12 (Bookworm, stable) || 12.2.0 || 15.0.6 || 4.8.3
|-
| Ubuntu 22.04 (Jammy Jellyfish) || 12.3.0 || 15.0.7 || Not packaged!
|-
| Ubuntu 23.04 (Lunar) || 13.1.0 || 16.0.0 || 4.10.1
|}

Errors and Deprecated items that we use:
* error: call of overloaded ‘lerp(double, double&, double&)’ is ambiguous (ui/knot/knot-holder-entity.cpp)
* warning: implicit capture of ‘this’ via ‘[=]’ is deprecated in C++20 [-Wdeprecated] https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2018/p0806r2.html
* warning: bitwise operation between different enumeration types ‘Box3D::Axis’ and ‘Box3D::FrontOrRear’ is deprecated [-Wdeprecated-enum-enum-conversion]

C++20

2023-09-02T03:34:53Z

PBS: Class types as non-type template parameters -> partial

See also [[C++11]], [[C++17]].

Some things that will be interesting to use once C++20 is common:

{| class="wikitable"
|-
! Feature !! Since !! Can use? !! Apple Clang !! Comment
|-
| <code>std::span</code> || C++20 || style="background: lightgreen;" | from 1.3? || 11.0.3 || Handle buffers like standard library containers without risk of overflow.
|-
| <code>std::format</code> || C++20 || style="background: pink;" | || N/A || Better and more efficient formatting of strings.
|-
| <code>std::lerp</code> || C++20 || style="background: lightgreen;" | from 1.4? || 11.0.3 || Linear interpolation. (ui/tools/pencil-tool.cpp)
|-
| <code>std::bit_floor</code> || C++20 || style="background: lightgreen;" | from 1.4? || 11.0.3/13.0.0 || Compute floor(log2(x)). (helper/mathfns.h)
|-
| <code>Concepts</code> || C++20 || from 1.4? || 12.0.0 Partial || Safer templating. (ui/controller.h)
|-
| <code>Coroutines</code> || C++20 || || 10.0.1 Partial || Simpler asynchronous code. (trace/trace.cpp)
|-
| <code>std::make_unique_for_overwrite</code> || C++20 || style="background: pink;" | || N/A || Don't zero arrays allocated using std::make_unique. (util/pool.cpp)
|-
| <code>Ranges</code> || C++20 || from 1.4? || ? || for (init; decl : expr). (ui/dialog/swatches.cpp)
|-
| <code>[https://stackoverflow.com/a/60244416/5075760 Structural templates]</code> || C++20 || from 1.4? || Partial || Allow instances of arbitrary literal classes as template parameters. (display/drawing.cpp)
|}

As of 1 September 2023, the CI runners for macOS are using Apple Clang 13.1.6 (ARM) and Apple Clang 14.0.0 (Intel64).

C++20

2023-09-02T03:25:59Z

PBS: Expand some descriptions

See also [[C++11]], [[C++17]].

Some things that will be interesting to use once C++20 is common:

{| class="wikitable"
|-
! Feature !! Since !! Can use? !! Apple Clang !! Comment
|-
| <code>std::span</code> || C++20 || style="background: lightgreen;" | from 1.3? || 11.0.3 || Handle buffers like standard library containers without risk of overflow.
|-
| <code>std::format</code> || C++20 || style="background: pink;" | || N/A || Better and more efficient formatting of strings.
|-
| <code>std::lerp</code> || C++20 || style="background: lightgreen;" | from 1.4? || 11.0.3 || Linear interpolation. (ui/tools/pencil-tool.cpp)
|-
| <code>std::bit_floor</code> || C++20 || style="background: lightgreen;" | from 1.4? || 11.0.3/13.0.0 || Compute floor(log2(x)). (helper/mathfns.h)
|-
| <code>Concepts</code> || C++20 || from 1.4? || 12.0.0 Partial || Safer templating. (ui/controller.h)
|-
| <code>Coroutines</code> || C++20 || || 10.0.1 Partial || Simpler asynchronous code. (trace/trace.cpp)
|-
| <code>std::make_unique_for_overwrite</code> || C++20 || style="background: pink;" | || N/A || Don't zero arrays allocated using std::make_unique. (util/pool.cpp)
|-
| <code>Ranges</code> || C++20 || from 1.4? || ? || for (init; decl : expr). (ui/dialog/swatches.cpp)
|-
| <code>[https://stackoverflow.com/a/60244416/5075760 Structural templates]</code> || C++20 || from 1.4? || ? || Allow instances of arbitrary literal classes as template parameters. (display/drawing.cpp)
|}

As of 1 September 2023, the CI runners for macOS are using Apple Clang 13.1.6 (ARM) and Apple Clang 14.0.0 (Intel64).

Inkscape

2023-06-09T06:56:56Z

PBS: Move 2023 hackfest from planned/upcoming to past

This is a freeform area for Inkscape development and discussion. Curious about [[wiki syntax]]?

{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 33%; background: #EEE; padding: 1em;" |
== Project Info ==
* [http://www.inkscape.org/ Inkscape Homepage]
* [[About Inkscape]]
* [[Features of Inkscape|Features]]
* [[FAQ]] — Frequently Asked Questions
* [[Supported operating systems]]
* [[Tools]] — Supporting Tools and Applications
* [[Galleries]]
* [[Inkscape coverage|Coverage]] — Awards, articles, presentations, books about Inkscape
* [[Inkscape popularity|Popularity]]
* [[Inkscape invariants|Inkscape's Mission]]
* [https://inkscape.org/en/community/ Communication] — How to reach us
* [[Announcement to Sodipodi]] — This started it all
* [[Branding]]
* [[Travel Reimbursement Policy]]
* [[Funded Project System Development]]
* [[:Category:Hackfest|Hackfests]]
** upcoming/proposed events:
** past events:
::: [[Hackfest2023_Bensberg|2023 Bensberg]]
::: [[Hackfest2019 SCALE|2019 Pasadena (SCALE)]], [[Hackfest2019 Saarbrücken|2019 Saarbrücken (LGM)]]
::: [[Hackfest2018|2018 Boston]], [[Hackfest2018 LGM|2018 Seville (LGM)]], [[Hackfest2018 Kiel|2018 Kiel]]
::: [[Hackfest2017|2017 Paris]]
::: [[Hackfest2016|2016 Leeds (LGM)]]
::: [[Hackfest2015|2015 Toronto (LGM)]]

| style="width: 33%; padding: 1em;" |

== User Documentation ==
* [[Installing Inkscape|Installation]]
* [[International and Local Communities]]
* [[Inkscape glossary]]
* [[User manual information]] — Where to find the free Inkscape manual and how to contribute to it
* [http://inkscape.org/en/learn/tutorials/ Tutorials]
* [[Inkscape SVG vs. plain SVG]]
* [[Output format requirements]] — What's needed to save in some formats
* [[Extension requirements]] — What's needed to use some extensions (slightly outdated)
* [[Extension reference]] — What each extension does (slightly outdated)
* [[Connector tool tutorial]]
* [[Installing fonts]]
* [[Emergency save]] — Recovery in case Inkscape crashed
* [[Release notes]]
** ''[[Release notes/1.3|Inkscape 1.3]]'' — ''development branch''
** '''[[Release notes/1.2|Inkscape 1.2]]''' ([[Release notes/1.2.1|1.2.1]], [[Release_notes/1.2.2|1.2.2]]) — ''current stable release branch''
** [[Release notes/1.1|Inkscape 1.1]] ([[Release notes/1.1.1|1.1.1]], [[Release notes/1.1.2|1.1.2]])
* [[Announcing Releases]] (slightly outdated)
* [[Release Process Debrief]] (slightly outdated)
* [[Tricks and tips]] — Miscellaneous advice, may be slightly outdated

| style="width: 33%; background: #EEE; padding: 1em;" |

== Help Inkscape Without Coding ==
* [[Help wanted]]
* [[Bug management]]
** [[Projects#Bug_Triage]]
* [[Testing]]
** [[macOS alpha]]
* [[Translation information]]
* [[WebSite]]
* [[Inkscape Classes]]
* [[Conferences]]
* [[Fundraising Ideas]]
* [[Creating Inkscape distributions]] — How to build packages
* [[Stable branch updates]]
* [[Updating tracker items]]
* [[Tutorials and help]]
* [[How to start a page]] — How to use the wiki
* [[Creating screencasts]]
* [[About-Screen contest]]
* [[social media|Participate in social media]]
|}

<div style="margin-top: 1em; padding: .5em 1em 1em; border: 1px solid #62C012;">

== Developer Documentation ==
{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 50%; padding-right: 1em;" |
=== First Steps ===
* [[Working with Git]] — How to obtain the source code. A quick start on how to use our version control system.
* [[Compiling Inkscape]]
* [[Developer manual]] — Various important information, be sure to read this before coding
* [[Debugging Inkscape|Debugging]] — Random tips to help debug problems
* [[Janitorial tasks]] — Small tasks that need doing
* [[Doxygen documentation]]
* [[Working with CMake]] — Getting started with CMake coding for configuring and building Inkscape

=== Developer tutorials ===
* [[Architectural overview]] — A high-level look at Inkscape
* [[Preferences subsystem]] — Creating and using preference values

* Extensions
** [[Extension subsystem]] — An overview of the functionality provided by extensions and the possible implementations
** [[Script extensions]] — Extend Inkscape easily using scripting languages (Python, Perl, …)
** [[Python modules for extensions]] — Some helpful routines for use in Python script extensions
** [[INX extension descriptor format]]
* [[Creating Live Path Effects]]
* [[Using libsigc++ signals]]
*[[Windows development on Linux]]

=== User Interface Discussion===
*[[Interface translation]]
* [[Adding interface verbs]]
*[[Accessible graphics]]
* [[Object Manager]]
*[[Dialogs reorganization]]
*[[Modal interfaces]]
*[[Text usability]] — Text tool and dialog
*[[KeyboardShortcutsToDo]]
**[[Keyboard profiles]] — How you can help
*[[Statusbar API]]
* [[Animation-(Timeline)]]
*[[Free Desktop Graphic Suite]]
*[[Skeletal Strokes]] — Brushes, Strokes, Pressure Sensibility...

| style="width: 50%;" |

===Development Discussion ===
*[[Roadmap]] — The main todo list
*[[Tracking Dependencies|Dependencies]] — What libs are needed to build Inkscape
*[[C++11]] — Which C++11 features can be used
*[[New feature proposals]]
* [[Extension architecture proposals]]
*[[Coding Style|Coding Style Discussion]]
*[[File types]]
*[[Application icons]] — Application + Interface
*[[Icons]]
*[[Color management]]
*[[Printing subsystem]]
*[[SVG Tiny Compliance]]
* [[SVG Test Suite Compliance]] — [[W3C]] full test suite
*[[CSS Support]]
*[[Google Summer of Code]]
* [[Improved Media Management]]
*[[UI Mockup Screenshots]]
* [[Swatch Book]]
*[[Tablet Dialog]]
*[[ViewBoxToDo]] — View box support info
* [[Caching]]
*[[Canvas Rendering Profiling]]
*[[UI and Document coordinates‎]]
* [[GtkMMification]] — Replace C boilerplate with gtkmm objects
*[[CMake Tasks]] — Converting the Inkscape build system to CMake
*[[Bug Reporting Workflow]] — Options for improving Inkscape bug workflow from user to developer
*[[1.0 Release Bug Fix List]] — List of bugs that need to be fixed for 1.0
*[[1.0 Release Planning]] — Roadmap and planning for 1.0 Release

===Miscellaneous===
*[[Inkscape-specific XML attributes]] — Documentation of attributes from Inkscape's XML namespace
*[[Environment variables]] — Overview of important environment variables that modify the behavior of Inkscape and its dependencies.
*[[Extension repository]] — An Internet central for Inkscape extensions
*[[Related programs]]
*[[Sponsors list]]
*[[Contracting Process]]
*[[Wiki Playground]]

===[[Lib2geom]]===
*[[Lib2geom]]
*[[Working with 2Geom FAQ]] — Real-life questions answered about using 2Geom in real code
*[[Lib2geom py2geom]] — Python bindings to 2geom. With this you can use the power of 2geom in Python scripts.

===Historical pages===
These pages are outdated, but linked here for posterity.

*[[Working with Bazaar]] — Our former control version system, no longer used. See [[Working with Git]] for current instructions.
* [[Creating a new SPObject]]

|}
</div>

==See also==
*
[[:Category:Wiki Attic|Wiki Attic]] — Pages that are no longer relevant but kept for historical value

__NOTOC__

[[Category:Top level categories]]

Installing Inkscape

2023-03-03T20:30:33Z

PBS: Adjust layout of images

{{Other languages|en=Installing Inkscape}}

This page explains how to install Inkscape, either the stable or the development version. For instructions on how to compile Inkscape from the source code, see [[Compiling Inkscape]].

The latest stable version can always be found on the [https://inkscape.org/release/ Download page]. The latest development versions are available from [https://gitlab.com/inkscape/inkscape/-/commits/master GitLab].
== Installing the stable version ==
=== '''macOS''' ===
DMG files can be downloaded from the [https://inkscape.org/release/ Download page]. Click the box labelled macOS and choose Intel or arm64 architecture. Once the download is complete, installation is the same as for any other DMG.

See also the [https://inkscape.org/learn/faq/#mac-os-x-specific-issues section dedicated to macOS in our FAQ], and the [https://inkscape-manuals.readthedocs.io/en/latest/installing-on-mac.html readthedocs] page for installation on macOS.
=== Linux ===

On most Linux systems, you can use the software installer provided with your system (look for "software" in your start menu) to install Inkscape.

Visit the [https://inkscape.org/release/ Download page] to see a list of other available options and installation methods for each available version.

==== Ubuntu or Debian ====
Probably the easiest way to install on Debian/Ubuntu is to use the <code>apt</code> command.

Open a terminal and type:
sudo apt-get update
sudo apt-get install inkscape

If your Ubuntu version does not have the most recent Inkscape version in its repositories (yet), the next section describes how to use the [https://launchpad.net/~inkscape.dev/+archive/ubuntu/stable stable PPA] to get it.

==== Ubuntu (new stable versions) ====

The most recent version (slightly newer than what is available directly from Ubuntu) is available from our [https://launchpad.net/~inkscape.dev/+archive/ubuntu/stable/ stable PPA] for Ubuntu and derivative Linux distributions:

<pre>
sudo add-apt-repository universe
sudo add-apt-repository ppa:inkscape.dev/stable
sudo apt-get update
sudo apt install inkscape
</pre>

==== openSUSE ====

openSUSE includes Inkscape in the Gnome repositories. The newest version of Inkscape is in Gnome:Apps.
=== Windows ===
You can find the installer on the [http://www.inkscape.org/release/ Download page]. Normally you want to choose "64-bit architecture" and "Windows Installer Package (msi)". Installing should be an easy step-by-step (next-next-finish) process.

== Installing the development version ==
First be warned. Unstable and development mean you likely will encounter crashes, usability problems and sometimes lose data. Ctrl+S will become your friend. If you cannot take this risk, please use the stable version instead.

If you are still reading, you are probably one of the brave ones who wants to be on the bleeding edge. If so, follow the steps below.

'''Don't forget:''' Please help Inkscape by reporting bugs, encouraging developers or fixing bugs yourself. If you find bugs, make sure to include the debug information which can be found in <code>Help > About</code>.

=== '''macOS''' ===
See [[Installing Inkscape#Finding development versions on GitLab|Finding development versions on GitLab]] below for instructions to download the development version, then install it in the same way as the stable version.

=== Linux ===
You can run an [https://appimage.org/ AppImage] of the latest development version on any Linux distribution. See [[Installing Inkscape#Finding development versions on GitLab|Finding development versions on GitLab]] below for instructions on how to download. To run, extract the zip and run the executable inside.

'''Tip:''' If you don't want to trust our executable, you can run it with sandboxing using [https://wiki.archlinux.org/title/Firejail firejail]: <code>firejail --appimage ...</code>.

==== Ubuntu ====
Development versions (inkscape-trunk) are also available from our [https://launchpad.net/~inkscape.dev/+archive/ubuntu/trunk trunk PPA] for Ubuntu and derivative Linux distributions. Follow the commands at https://inkscape.org/release/inkscape-dev/gnulinux/ubuntu/ppa/dl/ .

=== Windows ===

=== 1. Download the latest build ===
Follow the instructions on [https://inkscape.org/release/inkscape-dev/windows/ the inkscape-dev Download page] to download a 7zip file of the latest development build. Save the file (<code>inkscape-....7z</code>) to your Downloads folder.

==== 2. Extract the .7z archive ====
Extract the archive using the [http://www.7-zip.org/ 7zip unpacker]: Open the Downloads folder in Explorer, right-click on the 7zip file and choose 7-Zip → Extract to "inkscape-....".

You will get a directory which contains several files including <code>inkscape.exe</code>.

==== 3. Run inkscape ====
Run the <code>inkscape.exe</code> file by double clicking it. That's it. You can also drag files to <code>inkscape.exe</code> to have these opened.

==== Multiple versions for testing ====
For testing purposes it is good to be able to test multiple versions of Inkscape to find when and where some problem first appeared. For this reason you are able to store and use as many parallel versions of Inkscape as your disk has room for.
== Finding development versions on GitLab ==
Recent development builds can be found using the GitLab CI infrastructure. They do however require clicking through several pages to find:

# Visit https://gitlab.com/inkscape/inkscape/-/commits/master.
# On the the top row of the table, click the green tick on the right. (Lower rows correspond to older versions.)
# On the next page, click the left green tick under stages, and choose the version appropriate for your platform.
# On the next page, click the Download button.

This allows testing not just the latest development version but any earlier version, allowing bugs to be pinpointed to the version that introduced them.

[[File:Gitlab-download-instructions-1.png|alt=Click the green tick with alt text "Pipeline: passed/failed"|none|thumb|Step 2]]
[[File:Gitlab-download-instructions-2.png|alt=Click the leftmost green tick under "stages" with alt text "build passed:failed"|none|thumb|Step 3]]
[[File:Gitlab-download-instructions-3.png|alt=Click the download button|none||thumb|Step 4]]
[[Category:User Documentation]]

Installing Inkscape

2023-02-20T16:22:32Z

PBS: Fix dead links, add instructions for using GitLab

{{Other languages|en=Installing Inkscape}}

This page explains how to install Inkscape, either the stable or the development version. For instructions on how to compile Inkscape from the source code, see [[Compiling Inkscape]].

The latest stable version can always be found on the [https://inkscape.org/release/ Download page]. The latest development versions are available from [https://gitlab.com/inkscape/inkscape/-/commits/master GitLab].
== Installing the stable version ==
=== '''macOS''' ===
DMG files can be downloaded from the [https://inkscape.org/release/ Download page]. Click the box labelled macOS and choose Intel or arm64 architecture. Once the download is complete, installation is the same as for any other DMG.

See also the [https://inkscape.org/learn/faq/#mac-os-x-specific-issues section dedicated to macOS in our FAQ], and the [https://inkscape-manuals.readthedocs.io/en/latest/installing-on-mac.html readthedocs] page for installation on macOS.
=== Linux ===

On most Linux systems, you can use the software installer provided with your system (look for "software" in your start menu) to install Inkscape.

Visit the [https://inkscape.org/release/ Download page] to see a list of other available options and installation methods for each available version.

==== Ubuntu or Debian ====
Probably the easiest way to install on Debian/Ubuntu is to use the <code>apt</code> command.

Open a terminal and type:
sudo apt-get update
sudo apt-get install inkscape

If your Ubuntu version does not have the most recent Inkscape version in its repositories (yet), the next section describes how to use the [https://launchpad.net/~inkscape.dev/+archive/ubuntu/stable stable PPA] to get it.

==== Ubuntu (new stable versions) ====

The most recent version (slightly newer than what is available directly from Ubuntu) is available from our [https://launchpad.net/~inkscape.dev/+archive/ubuntu/stable/ stable PPA] for Ubuntu and derivative Linux distributions:

<pre>
sudo add-apt-repository universe
sudo add-apt-repository ppa:inkscape.dev/stable
sudo apt-get update
sudo apt install inkscape
</pre>

==== openSUSE ====

openSUSE includes Inkscape in the Gnome repositories. The newest version of Inkscape is in Gnome:Apps.
=== Windows ===
You can find the installer on the [http://www.inkscape.org/release/ Download page]. Normally you want to choose "64-bit architecture" and "Windows Installer Package (msi)". Installing should be an easy step-by-step (next-next-finish) process.

== Installing the development version ==
First be warned. Unstable and development mean you likely will encounter crashes, usability problems and sometimes lose data. Ctrl+S will become your friend. If you cannot take this risk, please use the stable version instead.

If you are still reading, you are probably one of the brave ones who wants to be on the bleeding edge. If so, follow the steps below.

'''Don't forget:''' Please help Inkscape by reporting bugs, encouraging developers or fixing bugs yourself. If you find bugs, make sure to include the debug information which can be found in <code>Help > About</code>.

=== '''macOS''' ===
See [[Installing Inkscape#Finding development versions on GitLab|Finding development versions on GitLab]] below for instructions to download the development version, then install it in the same way as the stable version.

=== Linux ===
You can run an [https://appimage.org/ AppImage] of the latest development version on any Linux distribution. See [[Installing Inkscape#Finding development versions on GitLab|Finding development versions on GitLab]] below for instructions on how to download. To run, extract the zip and run the executable inside.

'''Tip:''' If you don't want to trust our executable, you can run it with sandboxing using [https://wiki.archlinux.org/title/Firejail firejail]: <code>firejail --appimage ...</code>.

==== Ubuntu ====
Development versions (inkscape-trunk) are also available from our [https://launchpad.net/~inkscape.dev/+archive/ubuntu/trunk trunk PPA] for Ubuntu and derivative Linux distributions. Follow the commands at https://inkscape.org/release/inkscape-dev/gnulinux/ubuntu/ppa/dl/ .

=== Windows ===

=== 1. Download the latest build ===
Follow the instructions on [https://inkscape.org/release/inkscape-dev/windows/ the inkscape-dev Download page] to download a 7zip file of the latest development build. Save the file (<code>inkscape-....7z</code>) to your Downloads folder.

==== 2. Extract the .7z archive ====
Extract the archive using the [http://www.7-zip.org/ 7zip unpacker]: Open the Downloads folder in Explorer, right-click on the 7zip file and choose 7-Zip → Extract to "inkscape-....".

You will get a directory which contains several files including <code>inkscape.exe</code>.

==== 3. Run inkscape ====
Run the <code>inkscape.exe</code> file by double clicking it. That's it. You can also drag files to <code>inkscape.exe</code> to have these opened.

==== Multiple versions for testing ====
For testing purposes it is good to be able to test multiple versions of Inkscape to find when and where some problem first appeared. For this reason you are able to store and use as many parallel versions of Inkscape as your disk has room for.
== Finding development versions on GitLab ==
Recent development builds can be found using the GitLab CI infrastructure. They do however require clicking through several pages to find:

# Visit https://gitlab.com/inkscape/inkscape/-/commits/master.
# On the the top row of the table, click the green tick on the right. (Lower rows correspond to older versions.)
# On the next page, click the left green tick under stages, and choose the version appropriate for your platform.
# On the next page, click the Download button.

This allows testing not just the latest development version but any earlier version, allowing bugs to be pinpointed to the version that introduced them.

[[File:Gitlab-download-instructions-1.png|alt=Click the green tick with alt text "Pipeline: passed/failed"|thumb|Step 1]]
[[File:Gitlab-download-instructions-2.png|alt=Click the leftmost green tick under "stages" with alt text "build passed:failed"|thumb|Step 2]]
[[File:Gitlab-download-instructions-3.png|alt=Click the download button|thumb|Step 3]]
[[Category:User Documentation]]

File:Gitlab-download-instructions-3.png

2023-02-20T16:07:28Z

PBS:

Navigating GitLab CI - Step 3

File:Gitlab-download-instructions-2.png

2023-02-20T16:04:42Z

PBS:

Navigating GitLab CI - Step 2

File:Gitlab-download-instructions-1.png

2023-02-20T16:01:05Z

PBS:

Navigating GitLab CI - Step 1

Compiling Inkscape

2023-02-07T18:46:32Z

PBS: add internal lib2geom instructions

Hopefully, Inkscape will compile right out of the box, according to the 'Getting Started' instructions on https://inkscape.org/develop/getting-started/ . If it doesn't, well that's what this page is for. 

 '''If you've come here without reading the Getting Started page, [https://inkscape.org/develop/getting-started/ please do so first], as it mentions some important things that this page does not.'''


Jot down notes, questions, findings, tips, etc. here on things you run into. It's a good idea to make mention of what version of the code you're trying to compile, the distribution you're running, and other such information that might be pertinent.

If legitimate bugs are found or patches developed, please move them to the [https://inkscape.org/contribute/report-bugs/ tracker] rather than inlining them here.

== Notes ==

Please use CMake instead of Automake for Inkscape 0.92 onwards.

CMake is a crossplatform makefile generator similar to autotools. It tests dependencies and creates makefiles to be used with make.

Please see the [[CMake]] wiki page.

== OS & Distribution Specific ==

* '''Linux'''
** [[CompilingUbuntu|Ubuntu]]
** [[CompilingSlackware|Slackware]]
* [[CompilingMacOsX|Mac OS X]]
* [[Compiling Inkscape on Windows|Windows]]
* [[Compiling Inkscape on Chrome OS|Chrome OS]]
* '''Cross-compiling'''
** [[CrossCompilingOsX|For OS X (from Linux)]]
** [[CrossCompilingWindows|For Windows (from Linux)]]

== Package Config (pkg-config) ==

If you must compile and install any of these from source, you may find an error like this when trying to
compile them or Inkscape itself:
<pre>
checking for gtk+-2.0 >= 2.0.0 libxml-2.0 >= 2-2.4.24 sigc++-1.2 gtkmm-2.0... Package gtkmm-2.0 was not found in the pkg-config search path.
Perhaps you should add the directory containing `gtkmm-2.0.pc'
to the PKG_CONFIG_PATH environment variable
No package 'gtkmm-2.0' found
</pre>

A solution is to set the PKG_CONFIG_PATH variable as so:
* for Bash: <code>export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig:/usr/lib/pkgconfig</code>
* for csh: <code>setenv PKG_CONFIG_PATH /usr/local/lib/pkgconfig:/usr/lib/pkgconfig</code>

A good place to put this line is in your .bashrc or .cshrc file.

== Dependencies ==

If your distro does not have some packages available (like many don't, ie, Fedora Core 2), you must often download and build source packages and/or install them yourself. See [[Tracking Dependencies]].

== Developer Compilation ==

Plain vanilla compilation is done as documented in INSTALL.

Now, you should use [[CMake]] to compile Inkscape:
<pre>
mkdir build
cd build
cmake ..
make
</pre>

For old versions of inkscape before 0.92, you can still use autoconf:
<pre>
./autogen.sh # optionally
./configure
make
</pre>

Then, to run tests and install Inkscape, you may do:
<pre>
make check
sudo make install || su -c "make install"
</pre>

See INSTALL.md for more on that.

But if you're going to be doing a lot of development, there's some tricks and techniques you should know, to get best results.

# Turn off optimization.
# Use ccache for faster compilation.
# Set up a separate build directory (nice for testing both gcc and g++, or cross-compiling).
# Use ninja or the make -j N flag to increment the number of threads available to make, with N = 1 + number of processors.

Example: Setting up the build environment (in separate tree), and using ccache for faster
compilations on a dual-processor machine, with no optimization and full debug symbols, assuming /bin/bash:
<pre>
mkdir build
git clone --recurse-submodules https://gitlab.com/inkscape/inkscape.git
cd build
cmake ../inkscape -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_BUILD_TYPE=Debug -G Ninja
ninja
</pre>

See [[Testing Inkscape]] for information on building and executing (unit) tests.

=== Internal lib2geom ===
If the version of Inkscape you are trying to build depends on recent lib2geom features, you'll need to add <code>-DWITH_INTERNAL_2GEOM=ON</code> to the cmake command to use the development version of lib2geom rather than the system version.
[[Category:Developer Documentation]]

Release notes/1.3

2023-02-07T08:38:15Z

PBS: Blanket typo-fixing

{{Box| '''These Release Notes are in Draft Status.'''

Note: Not all animations work, due to Wiki bugs with resizing images. Release notes will be transferred to website, there animations will be working.

Important Links:
* [https://gitlab.com/inkscape/inkscape/commits/master Commit History Main Program (starting from: xxx)]
* [https://gitlab.com/inkscape/extensions/-/commits/master Commit History Extensions (starting from: xxx)]
* [https://gitlab.com/inkscape/inkscape-docs/documentation/-/tree/master Commit History Documentation (starting from: xxx)]

}}

{{Box| Pending questions:

}}

== Release highlights ==




* Pattern editor, pattern canvas controls, and pattern performance.
*Shape builder - New tool for building complex shapes from simple shapes. (Live Boolean tool)
*Live path effects dialog - Totally new and improved
*Filter editor - New redesign
*'''And so much more!'''

==Performance==
There has been lots of effort to improve performance of all aspects in Inkscape. Lots of refactoring of various inefficient code, rewritten handling of patterns, and moving bitmap tracing off-main-thread are some examples.

Canvas rendering is now both multithreaded and done off-main-thread. This should significantly improve performance while zooming/panning/transforming objects if your CPU has more than one core.

In some cases you can see '''2-4x speed''' improvements.

You can set core count in <code>Preferences > Rendering > Number of Threads</code>. The default is to use as many as possible.

https://gitlab.com/inkscape/inkscape/-/merge_requests?scope=all&state=merged&label_name[]=Project%3A%3AMultithreading

https://gitlab.com/inkscape/inkscape/-/merge_requests/4760

==General user interface ==
[[File:Indicators of used colors.png|thumb|indicators of used colors]]
Color palettes have an indicator showing the stroke and fill of the selected object. The first 4 colors are pinned and have the ability to become larger than the rest. Colors can be pinned/unpinned in the context menu.

[[File:Inkscape BHd0t2kzml.gif]]

===New feature paste on page===
You can copy and paste objects from one page to another: <code>Edit > Specials Paste > Paste on page</code>

https://gitlab.com/inkscape/inkscape/-/merge_requests/4695

===Old-style permanent snapping toolbar===
An option was added in <code>Settings > Interface > Toolbars</code> to show the detailed snapping options permanently in a dedicated toolbar, similar to Inkscape version 1.1 and earlier.

===Keyboard shortcuts===

The keyboard shortcuts for aligning objects vertically and horizontally have been moved to the numeric keypad, where the other alignment shortcuts are, too:

*Vertical alignment was moved from <kbd>Ctrl+Alt+T</kbd> to <kbd>'''Ctrl+Alt+Numpad 1'''</kbd>
*Horizontal alignment was moved from <kbd>Ctrl+Alt+H</kbd> to <kbd>'''Ctrl+Alt+Numpad 7'''</kbd>
[[File:OKLAB.png|thumb|474x474px]]
If you find yourself unable to reach the new shortcuts (for example, because your laptop does not have a keypad, or because the shortcuts do not work - may be the case on Linux with Xfce), you can set them to something else by changing '''both''' the alignment shortcut '''and''' the function that now uses that shortcut (if any). Use the search in <code>Edit > Preferences > Interface > Keyboard</code>. It also allows searching for shortcuts, not only for their name (e.g. search for 'ctrl+alt+t' to find the new default action that is executed when that combo is pressed).

===Color Picker===
Added support for the '''OKLab''' and '''OKLch''' color spaces which have just been adopted into the CSS Color Module Level 4 [https://www.w3.org/TR/css-color-4/#ok-lab draft recommendation]. OKLab is described in detail by its creator in an interesting blog post. The new picker is called "OKHSL" and is available from the dropdown.

=== '''Rulers'''===
Improved look. Fixed a performance penalty by caching text labels. Added indicator of selection (it's possible to turn off in preferences).

===Command bar===
Improved UI https://gitlab.com/inkscape/inkscape/-/merge_requests/4988

[[File:Command bar .png|none|thumb|508x508px]]

==Canvas==

Pressing '''<code>F</code>''' temporarily hides on-canvas overlays (transformation handles, grids, guides...). This allows quick preview of final artwork without any distractions.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4395

Added display overlay controls in top right corners. You need to have scrollbars enabled to see it.

[[File:Canvas overlays.png|399x399px]]

===OpenGL (GPU) accelerated canvas===
An OpenGL-accelerated display mode was added to the canvas to speed up panning, zooming and rotating.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4133

This is NOT a fully GPU-based renderer; content is still rendered on the CPU in exactly the same way as before, so large performance improvements are not to be expected. It does however result in a smoother display and lower CPU usage, especially on HiDPI screens.

OpenGL mode is highly experimental and is turned off by default. It can be turned on at

Preferences -> Rendering -> Enable OpenGL

Note however the following caveats:

*Due to packaging problems, when using the Linux AppImage, OpenGL support either does not work (on X11) or crashes (on Wayland).
* Due to GTK3 bugs, OpenGL mode crashes on Windows, blacks out the screen on MacOS, is slower than software rendering on Linux X11, and is only really usable on Wayland.

For these reasons, it is not expected to be useful until we migrate to GTK4, where we hope that at least some of these bugs have been fixed.

===Smooth auto-scrolling===
Auto-scrolling happens when you drag an object off the edge of the canvas. We improved smoothness of this action.

https://gitlab.com/inkscape/inkscape/-/merge_requests/5027

==Tools==
You can right click on any tool in toolbox to see tool preferences.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4982

===Selection tool===
New commands:

*'''Reapply transform''': ''Ctrl+Alt+T'' - This allows a user to perform a transformation multiple times and works from the canvas edits or from transform dialog or the select toolbar. Shortcut needs to change, it opens a terminal on Linux.
*'''Duplicate and transform''': ''Ctrl+Alt+D'' -This performs a duplication and then reapplies the previous transform to the duplicate. Shortcut needs to change, it minimizes the window on Linux.
https://gitlab.com/inkscape/inkscape/-/merge_requests/4506
*'''Clone while dragging:''' drag object + C - Drag and object and press C to clone it in the current position. https://gitlab.com/inkscape/inkscape/-/merge_requests/4752

[[File:Inkscape xfsvsc2oY9.gif|thumb|editing pattern on canvas]]

===Node tool===

====Pattern editing====
Pattern editing on canvas is now easier; you can click on any part of a pattern and it will show you controls at that position. We also added an outline that shows you the edges of the pattern. The first square controls position, the circle controls rotation, and the second square controls size. Hold shift to constrain proportions.

We also fixed performance problems with patterns, so now you can have smaller patterns in project and zoom in on them without worrying about Inkscape eating up all your RAM.

====Lasso selection mode====
We added new lasso selection mode. Hold alt and draw around nodes you want to select. Useful for selecting nodes inside of complicated geometry.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4747
===Shape Builder tool (New tool) ===
New tool for fast shape building and Boolean operations. Shortcut: <code>X</code>.

Use: Select multiple overlapping shapes and select the Shape Builder tool. The selection will be fragmented on overlapping areas, while everything else will be hidden until you leave the shape builder. Now you '''Click and drag''' to combine segments together or hold '''Shift + Click and drag''' to subtract, and '''Single click''' on segments to split. Adding is represented by a blue color, removing by pink.

[[File:Shape_builder.gif]]

https://gitlab.com/inkscape/inkscape/-/merge_requests/4709
[[File:Ezgif.com-gif-maker (12).gif|right|600x600px]]

===Pages tool ===
The pages tool now has controls for margins (guides):

* An attribute on the page element to record the margin
*A new html/css style box model with tests
*New UI to set margins in the toolbar
* New on-canvas controls for moving margins (with ctrl/shift)
*New display of margins in the same canvas group as the page border

*Snapping for page margins

https://gitlab.com/inkscape/inkscape/-/merge_requests/4523
=== Gradient tool ===

*Allow changing the ''repeat'' setting when multiple gradients are selected.
*Show 'Multiple gradients' in the stop list when multiple gradients are selected (instead of a random stop).
*Allow editing of the offset of the start/end stops.
*Keep the stop selected after the offset is changed in the toolbar (instead of selecting the first stop of the gradient).

https://gitlab.com/inkscape/inkscape/-/merge_requests/4339
==Path Operations==

New commands:

'''Fracture''' <code>Path → Fracture</code> - every overlapping path will be split into separate object.

'''Flatten''' <code>Path → Flatten</code> - overlapping objects will be flattened visually (it will delete paths that are hidden behind a top path). Useful for separating colors for Screen printing and offset printing.
== Masking / Clipping==

*A new option to '''preserve clips / masks when ungrouping''' objects has been added (<code>Edit → Preferences → Behavior → Clippaths and masks: When ungroup, clip/mask is preserved in children</code>). The option is active by default. This means that when you now ungroup a group that has been clipped, the elements inside it will inherit the clip. Previously, the clip was removed and everything became un-clipped. To go back to previous default behavior, deactivate this new option. ([https://gitlab.com/inkscape/inkscape/-/merge_requests/3564 MR #3564])
[[File:Pattern editor1.gif|alt=Pattern editor|right|Pattern editor]]

== Dialogs ==

=== Fill and Stroke Dialog===

====New pattern editor====
Added in to UI. You can preview patterns, change Name, Size, Rotation, Offset, Gaps and Colors for some specific patterns. We also added collections of patterns in <code>~paint/</code> so it's easier to be organized. Since this allows having many more patterns preinstalled, we also added a search function and a few new default patterns.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4938

===Filter editor===
[[File:Filter-resize.gif|alt=Filter-resize|Filter-resize|left]]

Redesign of this dialog:

*Filter selection moved to a popover
* Effects are listed in a popup menu and can be selected by searching (by name)
* Adjusted connector sizes to make them more compact
* Fixed an issue where all parameters would initially be visible in a docked filter dialog
*Fixed min size of parameters panel to make it fit in a narrow docked dialog
*Reactive layout to accommodate wide dialog
*Added primitive filter attributes to fe-image and fe-tile (#1417)
*Replaced GTK color picker with Inkscape color picker

*Sources can now be hidden (for most use cases only the source graphic is useful; other inputs are broken or need ux work). https://gitlab.com/inkscape/inkscape/-/merge_requests/4720[[File:Inkscape Y7U4yzIFTq.gif|thumb]]

===Layers and Objects ===
UX improvements:

*You can click and drag to change visibility of multiple objects
* Selecting on group does not auto expand
*Selecting multiple objects and and changing visibility/locking applies to all selected
* We added a search feature; it's a limited implementation - it does not auto-apply search and you need to search for more than 3 characters.
*We added a hover indicator for rows and layer colors
*Added controls for opacity and blending mode

We added shortcuts for layers navigation and actions:

*Arrows to navigate
*Space bar confirms (select, apply, open)
*Shift -> <- open close group
*Shift up down to move in Z order
[[File:VirtualBoxVM I675gipqe1.gif|thumb|1017x1017px|Place holder demo of new LPE dialog]]

===Live Path Effects ( LPE )===

====New redesigned LPE dialog====
The compact new design merges organization and controls into one unit. You can reorder LPE by dragging and dropping the whole effect. It adds a fast search box, and a fast dropdown for adding effects.

Each LPE has 5 controls:

*Show/hide controls
*Visibility of effect
*Delete effect
*Context menu
** Re-order
**Duplicate
**Set as default
** Flatten

[[File:LPE organization.png|right|266x266px]]

==== Reorganization of LPEs====
Since we needed a more compact way to show all LPEs, we decided on a list that is organized into 6 categories:

Tools, Distort, Generate, Convert, Experimental + Favorite

==== Changes ====
*Setting presets for LPE was moved into contextual menu
*Setting Favorite LPE was moved into contextual menu
*Added new feature: flatten - This will apply effect to geometry. It will apply all effects in the stack.
*We removed LPE gallery (you can still enable it in preferences if you wish: <code>Preferences > Behavior > LPE</code>)
*To see experimental LPEs you need to enable it in Preferences: <code>Preferences > Behavior > LPE</code>
*Added an indicator showing which object is selected
* Added conversion commands when you select text objects - since text does not support LPEs yet we added a workaround that converts text to paths or clones the text.
* If you select an object that is associated with an LPE (Clone, Boolean operations, Bend, Fill between many, etc...) you will see a button in the dialog that will take you to the linked geometry/controls.
*Labels inside effects are aligned nicely

https://gitlab.com/inkscape/inkscape/-/merge_requests/4677
===XML Editor===
[[File:Syntax highlighting.png|thumb|392x392px]]
We did small cosmetic changes to this dialog: smaller icons (16x16px), removed text tool tips. Added responsive layout and moved layout controls to the top in a dropdown (auto layout is the default option).

==== Syntax readability====
For improving readability we added syntax highlighting and auto line-breaking. This works for CSS style tag, inline styling, d <path data>. You can change change highlighting themes in <code>Preferences > Interface > Theming</code>

====d < path data >====
We added a feature to round path data. You can also set how many decimal points you want to round to.

[[File:Inkscape GAlKvNTcCm.gif]]

https://gitlab.com/inkscape/inkscape/-/merge_requests/4885

=== Symbols===
This dialog got a new redesign:

*Migrated dialog settings to a popover.
*Saving dialog UI state in preferences (current symbol set and settings are remembered).
*Larger range for scaling (tile size) and symbol zooming.
*Fixed symbol selection color for dark themes.
*Added option to show symbols names.
*Rendering symbols at screen resolution - sharp (high-dpi aware).
*List of symbol sets is searchable and can be filtered.
*Symbol search is live (no need to press enter).
* Symbol rendering is done on-demand, to limit memory use and time needed to switch sets.
*Stats: total number of symbols / how many are visible.

======New features======

*You can drag and drop symbols on canvas and they are going to be placed exactly where you dropped them.
*A new icon - the "peace" symbol.
*Improved performance.
*Add visio modern formats vssx and vsdx. Symbols are loaded once, not in each window.
*We added new stock symbols SJJB map icons.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4975

https://gitlab.com/inkscape/inkscape/-/merge_requests/4994

https://gitlab.com/inkscape/inkscape/-/merge_requests/4666

https://gitlab.com/inkscape/inkscape/-/merge_requests/4883

https://gitlab.com/inkscape/inkscape/-/merge_requests/4793

https://gitlab.com/inkscape/inkscape/-/merge_requests/4784

===Bitmap Tracer===
Got significant performance boost and a progress bar. Now it runs in the background, allowing you to cancel it if it's taking too long.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4702

=== Export Dialog===
We added new options for how to export multipage in PDF and SVG formats.

https://gitlab.com/inkscape/inkscape/-/merge_requests/5002

===Document Resources Dialog (NEW)===
Added a new dialog that shows you an overview of what assets are currently inside your document. You can edit names and export some of the resources from this dialog.

It presents the following document assets:

*fonts
*styles
*colors
*swatches
*gradients
*filters
*patterns
*symbols
*markers
*images
*external references

https://gitlab.com/inkscape/inkscape/-/merge_requests/5003

==Filters==

==Live path effects==
Performance of most of the effects was improved.

===Roughen===
UI clean-up and reordering of the controls.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4872

=== Taper Stroke===
Added support for sub-paths.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4906

=== Power Stroke===
Added support for sub-paths.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4880

==Import / Export ==

==Templates==

All template dialogs (Welcome screen, New from Template, Page tool default sizes) now use the same template sizes ([https://gitlab.com/inkscape/extensions/-/merge_requests/479] MR #479)

==Customization / Theming==
Added user.css to UI folder to allow tweaking UI without interfering with or fully overriding other css files. https://gitlab.com/inkscape/inkscape/-/merge_requests/5004

Fixed hidden icons on menus: https://gitlab.com/inkscape/inkscape/-/merge_requests/4686

==Other==
Added support for <code>href</code> and <code>xlink:href</code> in SVG header. This makes Inkscape more compatible with SVG 2.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4596

==MacOS-specific Changes==

== Windows-specific Changes==

== Extensions==

===Features===
Speed up processing especially on complex documents: https://gitlab.com/inkscape/inkscape/-/merge_requests/4996

====General Extension Changes====

====New Extensions====

==== Particular extensions====

===Bugs fixed===

====All extensions====

====Particular extensions====

===Extension Development ===

====API Changes for Third-Party Extension Developers ====

====Extension Development Documentation====

==== Under the hood ====

==Command line==
Added a new parameter --actions-file. You specify a list like in --actions but in a file to allow bypassing Windows comandline length limit, and also to allow reuse of action lists.

Added a new parameter --active-window / -q that runs all commands on the active window of an already-running instance of Inkscape.

==Behind the curtains==

==Notable bugfixes==
===Crash fixes===

Fixed a crash that occurred…

* When…

===Other bug fixes===

* LPE related undo bugs: https://gitlab.com/inkscape/inkscape/-/merge_requests/4520
*Fixed bspline LPE with cusp nodes when initially using with node tool. https://gitlab.com/inkscape/inkscape/-/merge_requests/5016
*<use>s retain their LPE correctly when unlinked or converted to paths. The old convert to paths behaviour is still available in the Preferences. https://gitlab.com/inkscape/inkscape/-/merge_requests/5016

===Even more bug fixes===

There were even more issues fixed than those listed above, but these probably only affect a small proportion of users, or are relevant for development and packaging only.

For a complete list, visit [https://gitlab.com/inkscape/inkscape/-/issues?milestone_title=Inkscape+1.3 our GitLab issue tracker] and see the [https://gitlab.com/inkscape/inkscape/-/commits/1.3.x commit history].

==Translations==

The following UI translations received updates:

*…

The Windows installer translation was updated for:

*…

The following documentation translations received updates:

*…

===Contributing to interface translations===

Want to help with translations? [https://inkscape.org/contribute/translations/ Learn how to help!]

==Documentation==

===Contributing to documentation and documentation translation===
Contributions to the documentation translations, as well as improvements to its contents, are welcome at [https://gitlab.com/inkscape/inkscape-docs/documentation the inkscape-docs repository].

==Website==

==Important changes for packagers==

==Known issues==

==Other releases==

{{:Release notes}}

Developer manual

2023-02-05T07:31:33Z

PBS: /* Introduction */ Update developer access, C++ references

= Inkscape Developer’s Manual =

== Introduction ==

For those of you just joining us, or who have been with us but are just
now getting the itch to work on Inkscape, I thought I’d give some tips
for how to get started working in the codebase based on our own
experiences.

One of the first things most people wonder is “What should I work on?”.
As you may have already noticed, we generally don’t “assign” projects.
We figure there’s plenty more work to do than people to do it, so you
may as well work on something that you’re either interested in or that
adds something of benefit to you; that’s extra motivation to get your
own itches scratched.

If you’re really stumped though, we keep a detailed [[Roadmap]] in wiki that
you’re welcome to browse through to look for ideas of things to work
on. Tasks that do not have names beside them are open for anyone to
take; if you want to take ownership of a task, just put your name beside
it. Feel free to add or reword tasks as needed, although try not to
load up the current milestone with tasks that aren’t critical for the
release. Feel free to work on stuff that is several milestones down the
road; there’s rarely any problem with getting stuff done sooner than
planned. ;-)

We have a process for gaining GitLab Developer access. The reason is that
while it is important that we keep access to the codebase open, we don’t
want to be crazy and leave it wide open to any random passer-by. The
process is that we require that the person make two contributions
(patches, documentation, web collateral, etc.) and then make a request
to get account access.

In general you won’t need Developer role in order to start doing
development, because you can create merge requests with only a regular account. Due to GitLab constraints however, you won't be able to run Windows or MacOS CI - but we can always do that for you.

When you first start hacking on Inkscape code, I wouldn’t recommend
taking an objective of implementing a specific feature, because you will
need some time to familiarize yourself with the codebase, and because
you won’t really know what features are going to be straightforward to
implement and which will be highly challenging. Of course, if you have
the time and love adventures, this might be a fun way to go.

There are four approaches that I’ve seen people effectively use in
getting into the codebase:

<ul>
<li>Write code documentation. Some people who don’t mind adding
comments to code or writing docs find it useful to just go through
code they’re interested in working on and writing up what it does.
The codebase is in dire need of better docs, so this approach pays
dividends well into the future.
</li>

<li>Fix bugs. Tracing down the cause of reported bugs is an effective
way to gain understanding of the codebase in small chunks. Many
common bugs can be traced down and fixed in a matter of hours, and
often will identify some bit of code in need of refactoring or
extension. Note that some of our older bugs are in the system
because they’re hard to fix, so you’ll want to work on the more
recent ones.
</li>

<li>Chip in on a group effort. Occasionally we identify a major
refactoring effort (such as when we converted from C to C++), that
we encourage lots of people to help on, in the philosophy that many
hands make light work. This work tends to be pretty rote so is
not hard for new folks to get involved with; it just takes time. We
generally have one of these kinds of efforts per release. It
usually isn’t glamorous work, but in aggregate moves the codebase
forward in a major way.
</li>

<li>Subsystem/module work. Some people want to get their hands in the
details quick, so take the approach of developing new code separate
from the codebase, to be integrated in later. This generally tends
to take a larger time commitment than the other approaches, but can be
an effective approach in some circumstances. We have a SVN module
called <code>experimental</code> that you’re welcome to house your work until
it’s ready for prime time.
</li>
</ul>

Beyond that, you’re going to find the documentation for the Inkscape
code is pretty scarce. We’ve worked on bits and pieces but
unfortunately the vast majority of the code is undocumented. On the
plus side, often you can implement the stuff you care about after
learning only a limited portion of the codebase.

I think you’d find Inkscape an enjoyable Open Source project to work on.
There’s a huge range of interesting and useful skills that can be
learned from it, plus the developers are great guys to participate with.
The project itself runs smoothly and puts a premium on keeping things
friendly and low-stress, so heated arguments are rare. The users have
been great to work with and very appreciative of even small new features
and fixes. Plus, since Inkscape is so visual in nature, it’s very cool
to see how your little changes make noticeable improvements to the app
overall.

== C++ Reference ==

*The C++ Core Guidelines. A set of rules for using modern C++ well, emphasizing safety and simplicity.https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines

*The C++ FAQ (with answers). We strongly recommend that everyone read this site comprehensively. You should not need to bookmark it, it should already be at the top of your autocomplete list![https://isocpp.org/wiki/faq/ https://isocpp.org/wiki/faq] [http://www.parashift.com/c++-faq-lite/ http://www.parashift.com/c++-faq-lite] (previous version)It is actually more in-depth than the name FAQ suggests. Many experienced C++ programmers would benefit from it.

*C++ Reference. Documentation of all features of the language and standard library.https://cppreference.com

== Please use const ==

Please be very aggressive in adding ''const'' to any code you write. It will help us understand code better and will prevent bugs from creeping in. It is very easy to remove ''const'' later on, but very hard to add it.

''const'' can go on either side of a type. However once you get into references and pointers and such with C++, you generally read those from right-to-left. So it makes the code a little more legible if the ''const'' comes between the variable type and name.

int const foo;
// RTL reading gives "foo is a constant int".

And then:

int const & foo;
// RTL reading gives "foo is a reference to a constant int"

int const * foo;
// RTL reading gives "foo is a pointer to a constant int"

whereas:

int * const foo;
// RTL reading gives "foo is a constant pointer to an int"

Read also:
* [http://www.cprogramming.com/tutorial/const_correctness.html Const Correctness]
* [http://yosefk.com/c++fqa/const.html Const Correctness]

== Strings ==
Please make sure any user-visible strings are localizable. This requires wrapping them with "_(" and ")", like so:

<code>"Select object"</code>
becomes
<code>_("Select object")</code>

In case the interpretation of the string may be ambiguous or may differ according to context, you can add a context prefix (that won't be displayed) in order to eliminate the ambiguity.
<code>"Ambiguous string"</code>
can then become
<code>C_("Context", "Ambiguous string")</code>

For more complex things, please check the gettext/localization documentation.
See also http://library.gnome.org/devel/glib/unstable/glib-I18N.html

== Implementing User Interface Changes ==

[[UI improvements]] are enjoyable to work on because they produce visible changes in how Inkscape works. These improvements are one of the most tangible ways to help improve how Inkscape works; thus, we strongly support new developers wishing to work in these areas.

It is also very important to us that Inkscape presents an organized, productive, and easily discoverable interface to users. Because of this it is important that new Inkscape UI developers work to ensure changes make Inkscape’s UI *more* consistent, *more* flexible, *more* cohesive, and so on. We don’t have firm rules about what can and cannot done, in order to ensure plenty of freedom for innovation. However, we can outline some general principles and guidelines that are important to keep in mind:

Don’t please the artist—BE the artist. Many times UI is designed and created by programmers who “understand what the user wants”. But in Inkscape we believe that the best requirements list is the list inside the user’s head. Requirements docs, usability studies, and so on are very indirect ways of transferring this gut-level understanding from user to programmer. We believe the best way to ensure this information is communicated clearly is for the user to BE the programmer. Or, alternatively, for the programmer to BECOME a user.

This is why we so strongly encourage users to get involved in coding, and why we so strongly encourage programmers to focus on the features that are most important to them personally. This is also why it is absolutely critical to pay close attention to what users report when using a new feature—often they can tip you off to alternate designs that achieve the same result in a better way.

Eliminate limitations. Commercial software is often developed to fulfill feature requirement lists from a marketing department. As such, it’s common to see the feature implemented to meet the requirement exactly, and no more. However, especially with artistic software, art is often found outside what seems reasonable. So when putting in a new feature, avoid the temptation to limit it to what you expect people to use it for—instead generalize it and open as many parameters as possible for tweaking, and let the artist decide what is reasonable. That’s their job.

As an example, a drawing program might want to support the features “feather” and “drop shadow”. Obviously, users need these important features. Commercial software may well implement these as distinct features, each with their own UI controls. However, these features are just special cases of the more general gaussian blur, and in Inkscape we implemented *that*. With that in place, artists can do feathering and blur, and a variety of other effects.

It is interesting to note that, as an open collaborative standard, SVG
necessarily has the same goals as Inkscape: a minimum set of
universal, well thought-out building blocks that can accommodate the
widest possible range of graphics and applications. Thus, simply by
following the SVG philosophy, Inkscape scores quite a few important
points over commercial software. Live clones, patterns that can be contain any
objects, layers that are essentially groups and can be easily
converted to/from groups. These are all examples where the underlying
universality of SVG directly translates into extremely valuable user
features.

== Implementing New SVG Features ==

The most important way to help Inkscape is to implement a new SVG feature in it. Our hope is to eventually support ALL SVG features, so if you can help check one off the list, it brings us close to the nirvana of 100% SVG compliance. :-)

Generally we find that implementation of an SVG feature goes through three discrete stages:

<ol>
<li>Find the appropriate tags and attributes in the SVG spec</li>
<li>Implement support for rendering files with these tags</li>
<li>Implement support for UI controls to edit the tags</li>
</ol>

Step 1 is mostly a research project. Start by reading the SVG spec so you
can learn about the tag, the attributes that go with it, and so forth.
It is good practice to set up a page in the Wiki for storing your notes
as you do this process, so that in case you don’t make it to steps 2 and
3, then maybe someone else can benefit from your research.

Step 2 is the fun part. It helps to be comfortable with Inkscape internals
for this part. Depending on the feature, it may require advanced
knowledge of transformation, rendering, document management, and so on.
For this part, just hand-edit an SVG file to put the tags in that you
found in step #1, and keep plugging away at the code until Inkscape
displays things as the specification dictates. It can help to compare
your work with Batik, as we use that program as our reference
implementation.

Step 3 is the most important stage. It is the point at which the
feature becomes available for users. This step often requires knowledge
of Gtk+, for creating dialogs, widgets, menus, etc. for allowing the
user to edit the characteristics of the feature. Be sure to listen to
feedback from other developers and users—especially if there are
different opinions. It is hard to come up with UI that everyone can
agree on, but it is worth the work to achieve this—the more critique
your UI survives, the better loved the feature will be for future users.

Looking through Inkscape’s history, these stages are often done by different people. If you’re new to Inkscape, you may find working on stages 1 and 3 easiest, but there are many developers who can answer questions when you’re ready to dig into the internals, so don’t be afraid to ask questions!

== Standards Compliance - Extension Namespaces ==

* Only elements and attributes from our extension namespaces that ''do not affect rendering'' may be saved in SVG documents.
* Generally, this means that extension elements and attributes should only be used to provide UI hints.
* Extension elements and attributes should ''only'' be used where an existing facility provided by XML or SVG is not sufficient.

== Global Verbs ==

Here’s a readers’ digest summary of how Inkscape accelerators work:

A global mapping between key combinations and integer [[verb]] IDs
(<code>sp_verb_t</code>) is maintained in <code>shortcuts.cpp</code>; these are registered using
<code>sp_shortcut_set()</code>.

Given an <code>sp_verb_t</code> and an <code>SPView</code>, you can get an SPAction which
represents that action in that view. These mappings are currently
hard-coded in <code>verbs.cpp</code>.

<code>SPActions</code> derive from <code>NRActiveObject</code>, which putatively provides a
“lightweight” method of doing callbacks (vs <code>GObject</code> signals). I
don’t completely understand how it works.

<code>SPActions</code> also contain the label, image, etc, used for buttons and
menuitems.

<code>sp_shortcut_invoke()</code> looks up the <code>SPAction</code> for a keypress and <code>SPView</code> and
invokes it automatically. <code>SPEventContexts</code> call it for keypresses that they do not handle themselves.

== Garbage collection ==

As you know, many automatic garbage collectors (like <code>libgc</code>) only
free and recycle memory periodically. This means you may have some
extra slush that could be freed, but hasn’t yet.

There are other forces at work, though...

Pretty much all allocators, whether automatic or not, whether the
system <code>malloc()</code> or some custom allocator like <code>libgc</code>’s, work the
same way: they request large blocks of memory from the operating
system, then divvy those blocks into smaller ones internally to
satisfy application allocation requests.

When an application frees memory, that memory is usually recycled
internally rather than returned to the OS immediately. The reason
for this is that the large memory blocks acquired from the OS must
be completely unused before they can actually be freed.

For example, let’s say an allocator acquires 16 8MB blocks from
the OS in response to 32768 4k application allocations...

In a worst-case scenario, it’s possible that the application could
free 32752 of those 4k blocks but the remaining 16 4k just happen
to be distributed across the 16 8MB blocks requested from the OS.

If that happens, from the application’s point of view it may only
have 64k allocated, but as far as the OS is concerned, it’s still
using 128MB!

Note that this applies to nearly all allocators in common use.

While it’s unusual for things to get quite that bad, memory
fragmentation is common enough that many popular allocators (for
example Perl’s) simply don’t bother trying to return memory to the
OS at all (the memory will still get forcibly reclaimed by the OS
when the process exits).

[ FWIW, <code>libgc</code>’s allocator is one of the ones that _does_ make an
effort to release memory to the OS, but it is limited by
fragmentation like any other ]

Also note that for various reasons, the statistics you get from the
OS aren’t going to directly reflect the amount of heap-allocated
memory. Be careful drawing conclusions from only looking at e.g.
the output of <code>top(1)</code>...

(The worst thing is, due to the modern practice of
overcommitting memory, the OS may literally lie to an application
about the amount of memory it is being given, hoping the
application won’t really try to use it all.)

The best approach to evaluating memory usage is if you can ask the
allocator for information on memory usage directly, as that matches
the world from the point of view of the application.

leftover gradients/markers/patterns will get automatically cleaned up when the objects that use them are deleted.

Caveats:

* this only applies to such objects created with a build of Inkscape which post-dates this commit (June 7 2004) 

* not all automatically-created objects will necessarily be collected; the code that creates them needs to be updated to set the correct collection policy

* paint objects won’t get collected until another editing operation takes place, since <code>NRArenaShape</code> currently holds onto an <code>SPStyle</code> for too long

Technical details:

Assuming its collection policy permits it, an object will be collected
if neither it nor its descendants have any outstanding inter-document
URI references (nonzero <code>SPObject::hrefcount</code>).

There are two “policies” for collecting orphans:

* “with-parent” - the object will only be collected if one of its ancestors is collected

* “always” - the object is always collected if unused

(a third policy might be “never”, which would necessarily also prevent
that object’s ancestors from ever being collected; I do not plan on
implementing it)

The policy in effect is determined by the inkscape:collect attribute.

Be careful with the “always” policy; it really only makes sense for
“private” objects that are indirectly created behind the scenes (e.g. by
selecting a fill or marker option in the GUI).

<code>SPDocument</code> manages a queue of objects to collect; <code>SPObject</code> handles the machinery for actually queueing them when their <code>hrefcount</code> falls (based on policy), and performing the actual collection (<code>delete</code>).
<code>SPDocument::collectObjects()</code> performs a collection pass. It’s currently only called from <code>sp_document_maybe_done()</code>.

== Inkscape Experimental SVN ==

The <code>experimental</code> module in Inkscape SVN is provided as a kind of “scratchpad” for
working up new ideas that aren’t quite ready for folding into the main codebase.
This includes architectural sketches, examples, experimental patchsets, tools & utilities, or
whatever else strikes the developer’s fancy.

Please create a subdirectory within <code>experimental/</code> for your work. You’re welcome to either post
the stuff at the top level or create a subdirectory for yourself. Things linked in at the top level
should be considered fair game for other developers to collaborate on; items posted under
a developer’s username should be considered ask-first. Same sort of idea as wiki.

One of the principles behind this module is the idea of a shared working space. Other developers
working in experimental can fairly easily see what others are working on in the tree, and perhaps
borrow or contribute ideas back and forth. Since it is by definition not ‘production’ code, the
work may be incomplete or in a non-compileable state...and that’s okay.

When an experiment has matured to the point of being actually useful, please move it out of
the experimental module to someplace more appropriate. Alternatively, if the experimental work has become obsolete or irrelevant, please remove it so we can avoid having the experimental tree get too bulky.

== Directory Organization ==

=== Distribution / Packaging Files ===

Files related to generation of distribution packages should go under inkscape/packaging, as follows:

inkscape/packaging/
common/
debian/
fedora/
fink/
mandrake/
suse/

=== "Share" Collateral ===

A variety of items are installed in addition to the program itself, and placed into a <code>share</code> directory structured as follows:

AUTHORS
NEWS
clipart/
examples/
extensions/
fonts/
gradients/
icons/
keyboards/
markers/
palettes/
patterns/
screens/
about.svg
templates/
tutorials/

In the SVN codebase, all of these are placed in <code>inkscape/share/</code> (except <code>AUTHORS</code> and <code>NEWS</code> which will be copied to share during installation. The idea is that in theory, this entire tree structure can be copied into place on the user’s machine.

However, we need to provide the user some level of control over the installation. They may wish to exclude some items, or may wish to augment the default install with some items external to the Inkscape package. For example, they may wish to incorporate external clipart collections. One approach would be to install symlinks in the given component directory to the external collection. For example, if the flags package were to install into <code>/usr/share/flags-svg/</code>, we’d just symlink there.

=== Code modules ===
Several parts of the code were written in a modular way, and they have been
accordingly placed in subdirectories of <code>src/</code>, while the main src directory
still contains the biggest part. To get a first overview of the modules, you
might want to have a look at these dependency graphs before you read deeper
into the source code (outside at the moment):
<s>
[http://www.ark.in-berlin.de/gri-debug.svgz]
[http://www.ark.in-berlin.de/gri-dialogs.svgz]
[http://www.ark.in-berlin.de/gri-display.svgz]
[http://www.ark.in-berlin.de/gri-io.svgz]
[http://www.ark.in-berlin.de/gri-libcroco.svgz]
[http://www.ark.in-berlin.de/gri-libnr.svgz]
[http://www.ark.in-berlin.de/gri-libnrtype.svgz]
[http://www.ark.in-berlin.de/gri-livarot.svgz]
[http://www.ark.in-berlin.de/gri-widgets.svgz]
[http://www.ark.in-berlin.de/gri-xml.svgz]</s> (links broken)


These are not all modules! For questions about how to generate these graphs
with graph-includes, please [mailto:rwst@users.sf.net].

Question on <code>.svgz</code> files: Is the server sending the right <code>Content-Encoding:</code> header?
This matters to Mozilla browsers in standards compliance mode! http://jwatt.org/svg/authoring/#server-configuration

= See Also =
* [[DirectoryReorgProposal]]
* [[InkscapeJanitors]]
* [[CompilingInkscape]]

= Links =
[http://advogato.org/article/51.html Software Quality]

[[Category:Developer Documentation]]

Using libsigc++ signals

2023-02-04T12:24:36Z

PBS: /* Memory safety */ Fix Emitter -> Receiver

This is a very short guide to using libsigc++ signals. They can make complex code with a lot of things to update after each change in some data structure very simple.

==What are signals?==
Signals are type-safe callbacks, essentially lists of function pointers on steroids. Each signal stores a list of '''slots'''. A slot defines what should be done when the signal is '''emitted'''. Typically an object emits the signal when it changes state. When a signal is emitted, the slots from the signal's slot list are executed, and sometimes a result is returned.

Note that libsigc++ signals have absolutely nothing to do with POSIX signals. They are however almost identical to Qt signals and slots.

==Defining signals==
Signals are typically defined as public attributes like this:

class Emitter
{
public:
void increaseNumber(int by) {
_number += by;
signal_number_changed.emit(by);
}

int getNumber() const { return _number; }

'''sigc::signal<void (int)> signal_number_changed;'''

private:
int _number = 0;
};

std::ostream &operator<<(std::ostream &o, Emitter const &e) {
o << e.getNumber();
return o;
}

Several Inkscape classes use private signal attributes and define accessor methods for connecting slots, but this prevents you from using some advanced features. Wrapping them all in accessors isn't worth the hassle.

<tt>signal</tt> is a class template. It takes a function type parameter defining the types of parameters passed to each slot when the signal is ''emitted'', and the type that the slot must return.

==Connecting to signals==
The <tt>signal</tt> class has a <tt>connect</tt> method, which takes a slot and adds it to the list of the signal's slots. Any '''function object''' can be used as a slot, including any lambda. Raw function pointers and member function pointers can also be used, provided they are wrapped as function objects using <tt>sigc::ptr_fun()</tt> and <tt>sigc::mem_fun()</tt> respectively. Here is a typical example:

class Receiver
{
public:
Receiver(Emitter &emitter) {
emitter.signal_number_changed.connect(
'''sigc::mem_fun'''(*this, &Receiver::_handleNumberChange)
);
}

private:
void _handleNumberChange(int increment) {
std::cout << "The number increased by " << increment << std::endl;
}
};

<tt>sigc::mem_fun()</tt> produces a function object that invokes a given method on the given object when it is called. Now whenever the number stored in the <tt>Emitter</tt> class changes, all <tt>Receiver</tt> objects created with this <tt>Emitter</tt> object will have the <tt>_handleNumberChange()</tt> method called.

==Memory safety==
The above example is only memory-safe if the lifetime of the <tt>Receiver</tt> can be guaranteed to end before the lifetime of the <tt>Emitter</tt>. Otherwise, there is nothing stopping the slot being invoked on a destructed <tt>Receiver</tt>. If this happens in our trivial example it will be harmless, but most of the time it will be a use-after-free, and a crash.

If you are used to Qt signals and slots, this will come as a surprise, because in Qt slots are automatically disconnected when objects are destroyed, making them memory-safe by default. There is no such guarantee in libsigc++; safety must instead be opted-into.

There are two ways to solve this problem.

===Automatic disconnection===
Make <tt>Receiver</tt> publically derive from <tt>sigc::trackable</tt>. Then use any of <tt>sigc::mem_fn()</tt>, <tt>sigc::track_obj()</tt> or <tt>sigc::track_object()</tt> to create slots. The slot will then be disconnected when the object is destroyed.

Here are some further comments and caveats with this approach:

*If you forget to make make <tt>Receiver</tt> inherit from <tt>sigc::trackable</tt>, then <tt>sigc::mem_fn()</tt> and <tt>sigc::track_obj()</tt> will silently fall back to being unsafe, which makes code that uses them fragile. By contrast, <tt>sigc::track_object()</tt> will refuse to compile. However, at the time of writing, the superior <tt>sigc::track_object()</tt> cannot be used yet due to not being supported on all build targets.

*Even with the above approach, signals will be disconnected during the destructor of the <tt>sigc::trackable</tt> base subobject, which happens ''after'' the destructor of the <tt>Receiver</tt> subobject. So it is entirely possible for a sufficiently complicated class hierarchy, written by many different authors and performing complex signal manipulations in its destructor, to invoke slots on destructed objects even when the best practices for <tt>sigc::trackable</tt> and <tt>sigc::track_obj()</tt> are followed. This is not an issue for simple classes, or for the approach of the next section.

===Manual disconnection ===
The <tt>connect()</tt> function actually returns a <tt>sigc::connection</tt> object with a <tt>disconnect()</tt> method that can be used to disconnect the connection. We can use this to improve our example:

class Receiver
{
public:
Receiver(Emitter &emitter) {
'''_conn =''' emitter.signal_number_changed.connect(
sigc::mem_fun(*this, &Receiver::_handleNumberChange)
);
}

'''~Receiver() { _conn.disconnect(); }'''

private:
'''sigc::connection _conn;'''

void _handleNumberChange(int increment) {
std::cout << "The number increased by " << increment << std::endl;
}
};

However, when working with <tt>sigc::connection</tt> there are still a number of traps that make it extremely easy to write bugs:

*If you destroy a connection without disconnecting it, it will not automatically be disconnected.
*Similarly, if you overwrite a connection with another one, the original will not automatically be disconnected.

These errors are some of the most frequent sources of use-after-frees in Inkscape. The problem is that <tt>sigc::connection</tt> behaves a lot like a raw pointer, with <tt>disconnect()</tt> being another way of spelling delete. What is needed is something that behaves more like a <tt>std::unique_ptr</tt>. For that reason, Inkscape has a RAII wrapper around <tt>sigc::connection</tt> called <tt>Inkscape::auto_connection</tt> that does not have these issues, and should be preferred wherever possible.

==Adaptors==
As you can see, we cannot directly access the object that emitted the signal from the handling method. You might think that changing the signal definition in the Emitter class to

sigc::signal<void (Emitter &, int)> signal_number_changed;

is the way to go. However, there are a few problems: first, the Emitter parameter for this slot is always the same (when you connect to another Emitter object from the same Receiver, you are creating a different slot stored in a different Emitter object). Moreover, it may be possible that some handlers only need the information about the number change - for instance, when you derive a class from Emitter and connect to the signals of the superclass, you already have the pointer to the superclass instance in <tt>this</tt>. There is a much better way to solve this problem. Another type of slots that libsigc++ provides are called '''adaptors''' - they allow you to change the type signature of your handler function by binding constant parameters to its invocation, ignoring some parameters supplied by the signal, and more.

===Binding parameters===
Let's say you want to print the name of the emitter that had its number increased. Instead of modifying the signal signature (a thing you sometimes cannot do, for example when you connect to a GTK-- signal), you can '''bind''' a parameter to your functor. First you need to modify the handler function:

void _handleNumberChange('''Emitter &e''', int by) {
std::cout << "Emitter " << e.getName()
<< " increased number by " << by << std::endl;
}

then bind the first parameter like this.

emitter.signal_number_changed.connect(
'''sigc::bind<0>'''(
sigc::mem_fun(*this, &Receiver::_handleNumberChange),
emitter)
)
);

sigc::bind takes an integer template parameter that tells it the zero-based index of the parameter it should bind. 0 denotes the first parameter, and the default value of -1 tells it to bind the last parameter. After this, your handler function will be called with the first parameter holding a reference to the object that emitted the signal.

===Hiding parameters===

Let's say you only want to print the name of the emitter and the current number, and you're not interested in how much it increased. You can then '''hide''' some of the signal's parameters.

void _handleNumberChange(Emitter &e) {
std::cout << "Emitter << e.getName() << " changed its number." << std::endl;
}

emitter.signal_number_changed.connect(
'''sigc::hide'''(
sigc::bind<0>(
sigc::mem_fun(*this, &Receiver::_handleNumberChange),
emitter)
)
)
);

<tt>sigc::hide</tt> takes a template parameter just like <tt>sigc::bind</tt>. Here we use its default value. Also notice that you can easily chain adaptors. This powerful technique allows you to bind handlers to signals even if they weren't designed for each other.

Using the functors <tt>sigc::bind_return</tt> and <tt>sigc::hide_return</tt> you can also manipulate the return type. The first one changes to return type of the slot to that of a constant bound parameter. The second ignores the return value and create a slot returning <tt>void</tt>.

Note that there is an inversion of meaning: you use <tt>sigc::bind</tt> to supply something that isn't present in the signal, and <tt>sigc::hide</tt> to ignore something that isn't needed by the slot. With return adaptors, it's the other way around: you use <tt>sigc::bind_return</tt> to supply something that isn't present in the slot, and <tt>sigc::hide_return</tt> to ignore something that isn't needed by the signal.

=== Advanced: reordering parameters===

Another powerful type of adaptor is <tt>sigc::group</tt>. It allows you to execute arbitrary mathematical expressions on the parameter list before pasing it to the handler. Here is an example.

class SomeGeometricObject {
...
sigc::signal<
void,
Geom::Point const & /* old_position */,
Geom::point const & /* new_position */ > signal_position_changed;

void _handlePositionChange(Geom::Point const &delta) {
std::cout << "Object moved by"
<< ": X=" << delta[Geom::X]
<< ", Y=" << delta[Geom::Y] << std::endl;
}

some_object.signal_position_changed.connect(
'''sigc::group'''(
sigc::mem_fun(*this, &Receiver::_handlePositionChange),
sigc::_2 - sigc::_1
)
);

The objects <tt>sigc::_1</tt> and <tt>sigc::_2</tt> are called '''lambda expressions''', and are used to denote the first and second parameter of the signal. The expression will be evaluated at slot call time, thanks to operator overloading. Note however that if you use variables other than lambdas, their values will be evaluated at connection time. To use references to variables instead of their current values, use <tt>sigc::ref</tt>.

==Return values of signals==

Signals can return a value. By default, they return the value returned from the last evaluated slot, or the default value for this return type of there was none (normally zero for numerical types, <tt>NULL</tt> for pointers, <tt>false</tt> for booleans, etc.).

signal<double> signal_get_length;
double length_from_last_slot = signal_get_length.emit();

This is not ideal, because you lose data from other slots. libsigc++ provides a powerful mechanism for handling return values from multiple slots, called accumulators.

===Accumulators===

Accumulator is a small class template that defines a signal's return type and a call function that evaluates the slot list of a signal. Here is an example accumulator that calculates the sum of the values returned by slots.
template<class T>
struct sum_accumulator {
typedef T result_type;
template<class I>
result_type operator()(I first, I last) {
T sum = 0;
for (; first != last; first ++) sum += *first;
return sum;
}
};

There a few important things to notice:
#Each accumulator must have two public members: a type called <tt>result_type</tt> which defines the return value of the signal's <tt>emit()</tt> function, and an overloaded operator(), taking two arguments of some type (the type in question is called <tt>sigc::internal::slot_iterator_buf</tt>, but it's better to just use a template).
#The parameters of the function call operator are two iterators, pointing to the start and the end of the slot list. The expression <tt>*i</tt> evaluates the slot (i.e. calls it and returns the result).
#It is safe to write things like <tt>sum += (*i) * (*i);</tt> because the results are buffered - each slot is evaluated at most once in each signal emission.

To use the accumulator, you need to changed the signal definition a bit.
sigc::signal<double>::'''accumulated'''<sum_accumulator<int> > signal_get_length;

double sum_of_lengths = signal_get_length.emit();
Now <tt>sum_of_lengths</tt> contains the sum of return values from all the slots.

WARNING: There is an old bug in libsigc++ that makes accumulators severely broken, because their result type must be implicitly convertible to and from the slot return type. See [http://bugzilla.gnome.org/show_bug.cgi?id=586436 this GNOME bug.] It will be fixed in the next libsigc++ release. --[[User:Tweenk|Tweenk]] 09:27, 31 December 2009 (UTC)

==Conventions and tips==
*Your signals should only have parameters that can change with each invocation. For example, a position change signal could have the old and new positions as the parameters. In particular, signals should not have the emitting object as a parameter. The proper way to connect to a signal from a different object is to use <tt>sigc::bind</tt> like this:
class SomeObject {
public:
sigc::signal<void> signal_update;
...
};
class OtherObject {
...
void onUpdate(SomeObject &so);
};
...
some_object.signal_update.connect(
sigc::bind<0>(
sigc::mem_fun(other_object, &OtherObject::onUpdate),
some_object));
In the example, a reference is bound (because the SomeObject parameter will never need to be NULL), but you can also use a pointer.

*Use the C++ wrappers for GTK+ as a reference for good signal parameter choices.
*The memory and performance overhead of adding signals to an object is quite small - most things are handled at compile time thanks to the use of templates.
*When using [[Boost shared pointers]], you cannot bind them as the "emitting object" parameter to slots. That's because the shared pointer will be copied into the object's slot list, keeping it in memory indefinitely. You need to use a weak pointer, which won't prevent the object's desctruction, but can be used to obtain a regular shared pointer. See [[Shared pointers]] for a more detailed guide.

==See Also==
[http://libsigc.sourceforge.net/libsigc2/docs/index.html libsigc++ reference documentation]
[http://bugzilla.gnome.org/show_bug.cgi?id=586436 Gnome bug #586436 - epic accumulator fail]

Using libsigc++ signals

2023-02-04T05:56:58Z

PBS: Bring earlier sections up to date, add memory safety section

This is a very short guide to using libsigc++ signals. They can make complex code with a lot of things to update after each change in some data structure very simple.

==What are signals?==
Signals are type-safe callbacks, essentially lists of function pointers on steroids. Each signal stores a list of '''slots'''. A slot defines what should be done when the signal is '''emitted'''. Typically an object emits the signal when it changes state. When a signal is emitted, the slots from the signal's slot list are executed, and sometimes a result is returned.

Note that libsigc++ signals have absolutely nothing to do with POSIX signals. They are however almost identical to Qt signals and slots.

==Defining signals==
Signals are typically defined as public attributes like this:

class Emitter
{
public:
void increaseNumber(int by) {
_number += by;
signal_number_changed.emit(by);
}

int getNumber() const { return _number; }

'''sigc::signal<void (int)> signal_number_changed;'''

private:
int _number = 0;
};

std::ostream &operator<<(std::ostream &o, Emitter const &e) {
o << e.getNumber();
return o;
}

Several Inkscape classes use private signal attributes and define accessor methods for connecting slots, but this prevents you from using some advanced features. Wrapping them all in accessors isn't worth the hassle.

<tt>signal</tt> is a class template. It takes a function type parameter defining the types of parameters passed to each slot when the signal is ''emitted'', and the type that the slot must return.

==Connecting to signals==
The <tt>signal</tt> class has a <tt>connect</tt> method, which takes a slot and adds it to the list of the signal's slots. Any '''function object''' can be used as a slot, including any lambda. Raw function pointers and member function pointers can also be used, provided they are wrapped as function objects using <tt>sigc::ptr_fun()</tt> and <tt>sigc::mem_fun()</tt> respectively. Here is a typical example:

class Receiver
{
public:
Receiver(Emitter &emitter) {
emitter.signal_number_changed.connect(
'''sigc::mem_fun'''(*this, &Receiver::_handleNumberChange)
);
}

private:
void _handleNumberChange(int increment) {
std::cout << "The number increased by " << increment << std::endl;
}
};

<tt>sigc::mem_fun()</tt> produces a function object that invokes a given method on the given object when it is called. Now whenever the number stored in the <tt>Emitter</tt> class changes, all <tt>Receiver</tt> objects created with this <tt>Emitter</tt> object will have the <tt>_handleNumberChange()</tt> method called.

==Memory safety==
The above example is only memory-safe if the lifetime of the <tt>Receiver</tt> can be guaranteed to end before the lifetime of the <tt>Emitter</tt>. Otherwise, there is nothing stopping the slot being invoked on a destructed <tt>Receiver</tt>. If this happens in our trivial example it will be harmless, but most of the time it will be a use-after-free, and a crash.

If you are used to Qt signals and slots, this will come as a surprise, because in Qt slots are automatically disconnected when objects are destroyed, making them memory-safe by default. There is no such guarantee in libsigc++; safety must instead be opted-into.

There are two ways to solve this problem.

===Automatic disconnection===
Make <tt>Emitter</tt> publically derive from <tt>sigc::trackable</tt>. Then use any of <tt>sigc::mem_fn()</tt>, <tt>sigc::track_obj()</tt> or <tt>sigc::track_object()</tt> to create slots. The slot will then be disconnected when the object is destroyed.

Here are some further comments and caveats with this approach:

*If you forget to make make <tt>Emitter</tt> inherit from <tt>sigc::trackable</tt>, then <tt>sigc::mem_fn()</tt> and <tt>sigc::track_obj()</tt> will silently fall back to being unsafe, which makes code that uses them fragile. By contrast, <tt>sigc::track_object()</tt> will refuse to compile. However, at the time of writing, the superior <tt>sigc::track_object()</tt> cannot be used yet due to not being supported on all build targets.

*Even with the above approach, signals will be disconnected during the destructor of the <tt>sigc::trackable</tt> base subobject, which happens ''after'' the destructor of the <tt>Emitter</tt> subobject. So it is entirely possible for a sufficiently complicated class hierarchy, written by many different authors and performing complex signal manipulations in its destructor, to invoke slots on destructed objects even when the best practices for <tt>sigc::trackable</tt> and <tt>sigc::track_obj()</tt> are followed. This is not an issue for simple classes, or for the approach of the next section.

===Manual disconnection ===
The <tt>connect()</tt> function actually returns a <tt>sigc::connection</tt> object with a <tt>disconnect()</tt> method that can be used to disconnect the connection. We can use this to improve our example:

class Receiver
{
public:
Receiver(Emitter &emitter) {
'''_conn =''' emitter.signal_number_changed.connect(
sigc::mem_fun(*this, &Receiver::_handleNumberChange)
);
}

'''~Receiver() { _conn.disconnect(); }'''

private:
'''sigc::connection _conn;'''

void _handleNumberChange(int increment) {
std::cout << "The number increased by " << increment << std::endl;
}
};

However, when working with <tt>sigc::connection</tt> there are still a number of traps that make it extremely easy to write bugs:

*If you destroy a connection without disconnecting it, it will not automatically be disconnected.
*Similarly, if you overwrite a connection with another one, the original will not automatically be disconnected.

These errors are some of the most frequent sources of use-after-frees in Inkscape. The problem is that <tt>sigc::connection</tt> behaves a lot like a raw pointer, with <tt>disconnect()</tt> being another way of spelling delete. What is needed is something that behaves more like a <tt>std::unique_ptr</tt>. For that reason, Inkscape has a RAII wrapper around <tt>sigc::connection</tt> called <tt>Inkscape::auto_connection</tt> that does not have these issues, and should be preferred wherever possible.

==Adaptors==
As you can see, we cannot directly access the object that emitted the signal from the handling method. You might think that changing the signal definition in the Emitter class to

sigc::signal<void (Emitter &, int)> signal_number_changed;

is the way to go. However, there are a few problems: first, the Emitter parameter for this slot is always the same (when you connect to another Emitter object from the same Receiver, you are creating a different slot stored in a different Emitter object). Moreover, it may be possible that some handlers only need the information about the number change - for instance, when you derive a class from Emitter and connect to the signals of the superclass, you already have the pointer to the superclass instance in <tt>this</tt>. There is a much better way to solve this problem. Another type of slots that libsigc++ provides are called '''adaptors''' - they allow you to change the type signature of your handler function by binding constant parameters to its invocation, ignoring some parameters supplied by the signal, and more.

===Binding parameters===
Let's say you want to print the name of the emitter that had its number increased. Instead of modifying the signal signature (a thing you sometimes cannot do, for example when you connect to a GTK-- signal), you can '''bind''' a parameter to your functor. First you need to modify the handler function:

void _handleNumberChange('''Emitter &e''', int by) {
std::cout << "Emitter " << e.getName()
<< " increased number by " << by << std::endl;
}

then bind the first parameter like this.

emitter.signal_number_changed.connect(
'''sigc::bind<0>'''(
sigc::mem_fun(*this, &Receiver::_handleNumberChange),
emitter)
)
);

sigc::bind takes an integer template parameter that tells it the zero-based index of the parameter it should bind. 0 denotes the first parameter, and the default value of -1 tells it to bind the last parameter. After this, your handler function will be called with the first parameter holding a reference to the object that emitted the signal.

===Hiding parameters===

Let's say you only want to print the name of the emitter and the current number, and you're not interested in how much it increased. You can then '''hide''' some of the signal's parameters.

void _handleNumberChange(Emitter &e) {
std::cout << "Emitter << e.getName() << " changed its number." << std::endl;
}

emitter.signal_number_changed.connect(
'''sigc::hide'''(
sigc::bind<0>(
sigc::mem_fun(*this, &Receiver::_handleNumberChange),
emitter)
)
)
);

<tt>sigc::hide</tt> takes a template parameter just like <tt>sigc::bind</tt>. Here we use its default value. Also notice that you can easily chain adaptors. This powerful technique allows you to bind handlers to signals even if they weren't designed for each other.

Using the functors <tt>sigc::bind_return</tt> and <tt>sigc::hide_return</tt> you can also manipulate the return type. The first one changes to return type of the slot to that of a constant bound parameter. The second ignores the return value and create a slot returning <tt>void</tt>.

Note that there is an inversion of meaning: you use <tt>sigc::bind</tt> to supply something that isn't present in the signal, and <tt>sigc::hide</tt> to ignore something that isn't needed by the slot. With return adaptors, it's the other way around: you use <tt>sigc::bind_return</tt> to supply something that isn't present in the slot, and <tt>sigc::hide_return</tt> to ignore something that isn't needed by the signal.

=== Advanced: reordering parameters===

Another powerful type of adaptor is <tt>sigc::group</tt>. It allows you to execute arbitrary mathematical expressions on the parameter list before pasing it to the handler. Here is an example.

class SomeGeometricObject {
...
sigc::signal<
void,
Geom::Point const & /* old_position */,
Geom::point const & /* new_position */ > signal_position_changed;

void _handlePositionChange(Geom::Point const &delta) {
std::cout << "Object moved by"
<< ": X=" << delta[Geom::X]
<< ", Y=" << delta[Geom::Y] << std::endl;
}

some_object.signal_position_changed.connect(
'''sigc::group'''(
sigc::mem_fun(*this, &Receiver::_handlePositionChange),
sigc::_2 - sigc::_1
)
);

The objects <tt>sigc::_1</tt> and <tt>sigc::_2</tt> are called '''lambda expressions''', and are used to denote the first and second parameter of the signal. The expression will be evaluated at slot call time, thanks to operator overloading. Note however that if you use variables other than lambdas, their values will be evaluated at connection time. To use references to variables instead of their current values, use <tt>sigc::ref</tt>.

==Return values of signals==

Signals can return a value. By default, they return the value returned from the last evaluated slot, or the default value for this return type of there was none (normally zero for numerical types, <tt>NULL</tt> for pointers, <tt>false</tt> for booleans, etc.).

signal<double> signal_get_length;
double length_from_last_slot = signal_get_length.emit();

This is not ideal, because you lose data from other slots. libsigc++ provides a powerful mechanism for handling return values from multiple slots, called accumulators.

===Accumulators===

Accumulator is a small class template that defines a signal's return type and a call function that evaluates the slot list of a signal. Here is an example accumulator that calculates the sum of the values returned by slots.
template<class T>
struct sum_accumulator {
typedef T result_type;
template<class I>
result_type operator()(I first, I last) {
T sum = 0;
for (; first != last; first ++) sum += *first;
return sum;
}
};

There a few important things to notice:
#Each accumulator must have two public members: a type called <tt>result_type</tt> which defines the return value of the signal's <tt>emit()</tt> function, and an overloaded operator(), taking two arguments of some type (the type in question is called <tt>sigc::internal::slot_iterator_buf</tt>, but it's better to just use a template).
#The parameters of the function call operator are two iterators, pointing to the start and the end of the slot list. The expression <tt>*i</tt> evaluates the slot (i.e. calls it and returns the result).
#It is safe to write things like <tt>sum += (*i) * (*i);</tt> because the results are buffered - each slot is evaluated at most once in each signal emission.

To use the accumulator, you need to changed the signal definition a bit.
sigc::signal<double>::'''accumulated'''<sum_accumulator<int> > signal_get_length;

double sum_of_lengths = signal_get_length.emit();
Now <tt>sum_of_lengths</tt> contains the sum of return values from all the slots.

WARNING: There is an old bug in libsigc++ that makes accumulators severely broken, because their result type must be implicitly convertible to and from the slot return type. See [http://bugzilla.gnome.org/show_bug.cgi?id=586436 this GNOME bug.] It will be fixed in the next libsigc++ release. --[[User:Tweenk|Tweenk]] 09:27, 31 December 2009 (UTC)

==Conventions and tips==
*Your signals should only have parameters that can change with each invocation. For example, a position change signal could have the old and new positions as the parameters. In particular, signals should not have the emitting object as a parameter. The proper way to connect to a signal from a different object is to use <tt>sigc::bind</tt> like this:
class SomeObject {
public:
sigc::signal<void> signal_update;
...
};
class OtherObject {
...
void onUpdate(SomeObject &so);
};
...
some_object.signal_update.connect(
sigc::bind<0>(
sigc::mem_fun(other_object, &OtherObject::onUpdate),
some_object));
In the example, a reference is bound (because the SomeObject parameter will never need to be NULL), but you can also use a pointer.

*Use the C++ wrappers for GTK+ as a reference for good signal parameter choices.
*The memory and performance overhead of adding signals to an object is quite small - most things are handled at compile time thanks to the use of templates.
*When using [[Boost shared pointers]], you cannot bind them as the "emitting object" parameter to slots. That's because the shared pointer will be copied into the object's slot list, keeping it in memory indefinitely. You need to use a weak pointer, which won't prevent the object's desctruction, but can be used to obtain a regular shared pointer. See [[Shared pointers]] for a more detailed guide.

==See Also==
[http://libsigc.sourceforge.net/libsigc2/docs/index.html libsigc++ reference documentation]
[http://bugzilla.gnome.org/show_bug.cgi?id=586436 Gnome bug #586436 - epic accumulator fail]

Inkscape

2023-02-04T03:33:22Z

PBS: Remove boost::shared_ptr section; std::shared_ptr is now standard C++

This is a freeform area for Inkscape development and discussion. Curious about [[wiki syntax]]?

{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 33%; background: #EEE; padding: 1em;" |
== Project Info ==
* [http://www.inkscape.org/ Inkscape Homepage]
* [[About Inkscape]]
* [[Features of Inkscape|Features]]
* [[FAQ]] — Frequently Asked Questions
* [[Supported operating systems]]
* [[Tools]] — Supporting Tools and Applications
* [[Galleries]]
* [[Inkscape coverage|Coverage]] — Awards, articles, presentations, books about Inkscape
* [[Inkscape popularity|Popularity]]
* [[Inkscape invariants|Inkscape's Mission]]
* [https://inkscape.org/en/community/ Communication] — How to reach us
* [[Announcement to Sodipodi]] — This started it all
* [[Branding]]
* [[Travel Reimbursement Policy]]
* [[Funded Project System Development]]
* [[:Category:Hackfest|Hackfests]]
** upcoming/proposed events: [[Hackfest2023_Bensberg|2023 Bensberg]]
** past events:
::: [[Hackfest2019 SCALE|2019 Pasadena (SCALE)]], [[Hackfest2019 Saarbrücken|2019 Saarbrücken (LGM)]]
::: [[Hackfest2018|2018 Boston]], [[Hackfest2018 LGM|2018 Seville (LGM)]], [[Hackfest2018 Kiel|2018 Kiel]]
::: [[Hackfest2017|2017 Paris]]
::: [[Hackfest2016|2016 Leeds (LGM)]]
::: [[Hackfest2015|2015 Toronto (LGM)]]

| style="width: 33%; padding: 1em;" |

== User Documentation ==
* [[Installing Inkscape|Installation]]
* [[International and Local Communities]]
* [[Inkscape glossary]]
* [[User manual information]] — Where to find the free Inkscape manual and how to contribute to it
* [http://inkscape.org/en/learn/tutorials/ Tutorials]
* [[Inkscape SVG vs. plain SVG]]
* [[Output format requirements]] — What's needed to save in some formats
* [[Extension requirements]] — What's needed to use some extensions (slightly outdated)
* [[Extension reference]] — What each extension does (slightly outdated)
* [[Connector tool tutorial]]
* [[Installing fonts]]
* [[Emergency save]] — Recovery in case Inkscape crashed
* [[Release notes]]
** ''[[Release notes/1.3|Inkscape 1.3]]'' — ''development branch''
** '''[[Release notes/1.2|Inkscape 1.2]]''' ([[Release notes/1.2.1|1.2.1]], [[Release_notes/1.2.2|1.2.2]]) — ''current stable release branch''
** [[Release notes/1.1|Inkscape 1.1]] ([[Release notes/1.1.1|1.1.1]], [[Release notes/1.1.2|1.1.2]])
* [[Announcing Releases]] (slightly outdated)
* [[Release Process Debrief]] (slightly outdated)
* [[Tricks and tips]] — Miscellaneous advice, may be slightly outdated

| style="width: 33%; background: #EEE; padding: 1em;" |

== Help Inkscape Without Coding ==
* [[Help wanted]]
* [[Bug management]]
** [[Projects#Bug_Triage]]
* [[Testing]]
** [[macOS alpha]]
* [[Translation information]]
* [[WebSite]]
* [[Inkscape Classes]]
* [[Conferences]]
* [[Fundraising Ideas]]
* [[Creating Inkscape distributions]] — How to build packages
* [[Stable branch updates]]
* [[Updating tracker items]]
* [[Tutorials and help]]
* [[How to start a page]] — How to use the wiki
* [[Creating screencasts]]
* [[About-Screen contest]]
* [[social media|Participate in social media]]
|}

<div style="margin-top: 1em; padding: .5em 1em 1em; border: 1px solid #62C012;">

== Developer Documentation ==
{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 50%; padding-right: 1em;" |
=== First Steps ===
* [[Working with Git]] — How to obtain the source code. A quick start on how to use our version control system.
* [[Compiling Inkscape]]
* [[Developer manual]] — Various important information, be sure to read this before coding
* [[Debugging Inkscape|Debugging]] — Random tips to help debug problems
* [[Janitorial tasks]] — Small tasks that need doing
* [[Doxygen documentation]]
* [[Working with CMake]] — Getting started with CMake coding for configuring and building Inkscape

=== Developer tutorials ===
* [[Architectural overview]] — A high-level look at Inkscape
* [[Preferences subsystem]] — Creating and using preference values

* Extensions
** [[Extension subsystem]] — An overview of the functionality provided by extensions and the possible implementations
** [[Script extensions]] — Extend Inkscape easily using scripting languages (Python, Perl, …)
** [[Python modules for extensions]] — Some helpful routines for use in Python script extensions
** [[INX extension descriptor format]]
* [[Creating Live Path Effects]]
* [[Using libsigc++ signals]]
*[[Windows development on Linux]]

=== User Interface Discussion===
*[[Interface translation]]
* [[Adding interface verbs]]
*[[Accessible graphics]]
* [[Object Manager]]
*[[Dialogs reorganization]]
*[[Modal interfaces]]
*[[Text usability]] — Text tool and dialog
*[[KeyboardShortcutsToDo]]
**[[Keyboard profiles]] — How you can help
*[[Statusbar API]]
* [[Animation-(Timeline)]]
*[[Free Desktop Graphic Suite]]
*[[Skeletal Strokes]] — Brushes, Strokes, Pressure Sensibility...

| style="width: 50%;" |

===Development Discussion ===
*[[Roadmap]] — The main todo list
*[[Tracking Dependencies|Dependencies]] — What libs are needed to build Inkscape
*[[C++11]] — Which C++11 features can be used
*[[New feature proposals]]
* [[Extension architecture proposals]]
*[[Coding Style|Coding Style Discussion]]
*[[File types]]
*[[Application icons]] — Application + Interface
*[[Icons]]
*[[Color management]]
*[[Printing subsystem]]
*[[SVG Tiny Compliance]]
* [[SVG Test Suite Compliance]] — [[W3C]] full test suite
*[[CSS Support]]
*[[Google Summer of Code]]
* [[Improved Media Management]]
*[[UI Mockup Screenshots]]
* [[Swatch Book]]
*[[Tablet Dialog]]
*[[ViewBoxToDo]] — View box support info
* [[Caching]]
*[[Canvas Rendering Profiling]]
*[[UI and Document coordinates‎]]
* [[GtkMMification]] — Replace C boilerplate with gtkmm objects
*[[CMake Tasks]] — Converting the Inkscape build system to CMake
*[[Bug Reporting Workflow]] — Options for improving Inkscape bug workflow from user to developer
*[[1.0 Release Bug Fix List]] — List of bugs that need to be fixed for 1.0
*[[1.0 Release Planning]] — Roadmap and planning for 1.0 Release

===Miscellaneous===
*[[Inkscape-specific XML attributes]] — Documentation of attributes from Inkscape's XML namespace
*[[Environment variables]] — Overview of important environment variables that modify the behavior of Inkscape and its dependencies.
*[[Extension repository]] — An Internet central for Inkscape extensions
*[[Related programs]]
*[[Sponsors list]]
*[[Wiki Playground]]

===[[Lib2geom]]===
*[[Lib2geom]]
*[[Working with 2Geom FAQ]] — Real-life questions answered about using 2Geom in real code
*[[Lib2geom py2geom]] — Python bindings to 2geom. With this you can use the power of 2geom in Python scripts.

===Historical pages===
These pages are outdated, but linked here for posterity.

*[[Working with Bazaar]] — Our former control version system, no longer used. See [[Working with Git]] for current instructions.
* [[Creating a new SPObject]]

|}
</div>

==See also==
*
[[:Category:Wiki Attic|Wiki Attic]] — Pages that are no longer relevant but kept for historical value

__NOTOC__

[[Category:Top level categories]]

Boost shared pointers

2023-02-04T03:29:15Z

PBS: Move to attic

= Notice: C++11 =
C++11 offers <tt>unique_ptr</tt> and <tt>shared_ptr</tt>, and should be used instead.

==Boost shared pointers==
The Boost library is a set of peer-reviewed C++ libraries that play well with STL, and some of them are considered for inclusion in future versions of the C++ standard. They are generally regarded as well designed, useful, and powerful. They are also cross platform. All header-only Boost libraries can be used in Inkscape, since Boost is an accepted compile time dependency.

This short tutorial will deal with the use of Boost shared pointers. They can be used to significantly reduce the amount of code needed for efficient memory management. Shared pointers with semantics identical to Boost ones are part of the C++ Library Technical Report 1, and will be included as part of the standard library in a future revision of C++.

If the ownership of objects is clear, investigate whether the simpler and lower overhead <tt>std::auto_ptr</tt> or <tt>boost::scoped_ptr</tt> can meet your needs. If you mainly need to use <tt>shared_ptr</tt> to put smart pointers in containers (since <tt>std::auto_ptr</tt> cannot be used in this way), investigate Boost pointer containers like <tt>boost::ptr_list</tt>.

==Rationale==
The memory management problem is how to guarantee that a program does not have any memory leaks. It can be solved with simple reference conuting if there are no cycles between objects. There are two approaches to solve it when :
# Garbage collection. Objects are created and left alone when no longer needed. When the memory is low, a background process kicks in and reclaims memory used by objects that can no longer be reached from the stack. This is the method used in most scripting languages, as well as Java and CLR. However, it has some drawbacks. Firstly, destructors can run at some indeterminate time after the object becomes unused, or never. This precludes using the RAII idiom. Secondly, there is some memory overhead associated with maintaining a garbage-collected heap. Thirdly, it requires some type information to be preserved at runtime, to determine where the garbage collector should look for object references - otherwise unrelated data can alias pointers, preventing some objects from being colleted.
# Shared and weak pointers. This approach uses two types of object references to break the cycles. A shared pointer will keep the pointed object in memory, while a weak pointer can be used to obtain a shared pointer to the same object, but will not prevent the object from destruction. This approach requires more programming effort and adds some (negligible) overhead to each operation on the shared pointer, but makes object destruction predictable.

The second method suits C++ better than garbage collection. Firstly, there is generally little to no type information present at runtime to determine where to look for pointers to objects; Garbage collectors for C++ and C must assume that all data on the stack and all contents of the objects' memory are pointers to other objects (also known as conservative garbage collection). This can cause some unused memory to never be freed, because some integer in some object happens to have the same value as some other object's address. Secondly, since the C++ standard library and other libraries frequently use the RAII idiom, many C++ objects (like <tt>std::fstream</tt>) have non-trivial destructors. If those destructors are not run right after the object becomes unused, the program may hold on to resources it no longer uses, like file descriptors or database connections. Finally, using tricks like storing the color of a red-black tree node in the low bit of a pointer can in theory cause objects to be collected before they become unused, bu this can be mitigated with anchoring.

==Shared pointers==
Shared pointer is a smart pointer (a C++ object wih overloaded <tt>operator*()</tt> and <tt>operator->()</tt>) that keeps a pointer to an object and a pointer to a shared reference count. Every time a copy of the smart pointer is made using the copy constructor, the reference count is incremented. When a shared pointer is destroyed, the reference count for its object is decremented. Shared pointers constructed from raw pointers initially have a reference count of 1. When the reference count reaches 0, the pointed object is destroyed, and the memory it occupies is freed. You do not need to explicitly destroy objects: it will be done automatically when the last pointer's destructor runs.

===Usage===
When creating a new object with <tt>new</tt>, use it as a constructor argument of a <tt>boost::shared_ptr</tt>.
boost::shared_ptr<Foo> foo_ptr(new Foo());
You can reassign the pointer to a new object using the member function <tt>reset()</tt>. This will decrease the reference count of the old object, if any, and reinitialize the object with the argument and a reference count of 1.
foo_ptr.reset(new Foo());

Note however that you cannot obtain a shared pointer to an object from a raw pointer. This will cause a segmentation fault:
void some_function(Foo *f) {
boost::shared_ptr<Foo> fptr(f);
fptr->something();
}
...
Foo *foo = new Foo();
some_function(foo);
foo->something();
That's because the temporary <tt>fptr</tt> is initialized with a reference count of 1. After the function returns, the reference count is zero and the object is destroyed. <tt>foo->something()</tt> will then fail, because <tt>foo</tt> no longer points to a valid object.

An uninitialized shared pointer is ''empty''. This is equivalent to NULL for raw pointers. You can check for an empty shared pointer using this code:
if (foo) {
// foo points to an object
} else {
// foo is empty
}

A raw pointer can be retrieved using the <tt>get()</tt> method.
Foo *rawptr = fptr.get();

==Weak pointers==
Weak pointers can only be used to obtain a shared pointer to the same object, and check whether the object was already destroyed. They can be used to break circular references between objects. A weak pointer that points to an object that was already destroyed is called ''expired''. Empty weak pointers (that don't point to any object) are also expired.

Here is an example:
boost::shared_ptr<Foo> foo(new Foo());
boost::weak_ptr<Foo> weakfoo(foo);
...
boost::shared_ptr<Foo> fptr = weakfoo.lock();
if (fptr) {
// object still exists
} else {
// object already destroyed
}

Weak pointers cannot be dereferenced for thread safety reasons. If some other thread destroyed the object after you checked the weak pointer for expiry but before you used it, you would get a crash. Shared pointers can be obtained from weak pointers using use of two methods:
# <tt>boost::shared_ptr<Foo> fptr = weakfoo.lock();</tt> - fptr will be empty if <tt>weakfoo</tt> is expired. An exception will never be thrown.
# <tt>boost::shared_ptr<Foo> fptr(weakfoo);</tt> - the exception <tt>std::tr1::bad_weak_ptr</tt> will be thrown if <tt>weakfoo</tt> is expired.

==Shared pointers in member functions==
Sometimes a shared pointer to the current object is needed in its member function. Boost provides a mixin template class called <tt>enable_shared_from_this</tt>, which defines a no-argument member function called <tt>shared_from_this()</tt>. It returns a shared pointer to <tt>this</tt>. At least one instance of a shared pointer to this object must exist before the first use of this method; otherwise it has undefined results (usually crash). The best way to guarantee that this is condition met is to make the constructor protected and provide a factory method that returns a shared pointer to the newly created object.
class Foo : public boost::enable_shared_from_this<Foo> {
public:
void someMethod() {
boost::shared_ptr<Foo> this_ = shared_from_this();
// use pointer...
}
...
static boost::shared_ptr<Foo> create() {
return boost::shared_ptr<Foo>(new Foo());
}
protected:
Foo() { ... }
...
};

==See also==
*[http://www.boost.org/doc/libs/1_39_0/libs/smart_ptr/shared_ptr.htm Full shared_ptr documentation at official Boost website]
*[http://www.boost.org/doc/libs/1_39_0/libs/ptr_container/doc/ptr_container.html Boost Pointer Container library]
[[Category:Wiki Attic]]

Boost shared pointers

2023-02-04T03:23:53Z

PBS: Update C++11 notice

Release notes/1.3

2023-02-03T05:31:15Z

PBS: /* OpenGL Canvas rendering (GPU rendering) */ Add more detail and clarifications

{{Box| '''These Release Notes are in Draft Status.'''

Note: Not all animations work, due to Wiki bugs with resizing images. Release notes will be transferred to website, there animations will be working.

Important Links:
* [https://gitlab.com/inkscape/inkscape/commits/master Commit History Main Program (starting from: xxx)]
* [https://gitlab.com/inkscape/extensions/-/commits/master Commit History Extensions (starting from: xxx)]
* [https://gitlab.com/inkscape/inkscape-docs/documentation/-/tree/master Commit History Documentation (starting from: xxx)]

}}

{{Box| Pending questions:

}}

== Release highlights ==




* Pattern editor , Pattern canvas controls, and pattern performance
*Shape builder - New tool for building complex shapes form simple shapes. = live Boolean tool
*Live Path effects Dialog - Totally new improved
*Filter editor - New Redesign
* '''and so much more!'''

== Performance ==
There has be lots of effort to improve performance of all aspects in Inkscape. Lots of refactoring of various inefficient code: Display- small hacks, handling of Patterns , Paint server and filters. After that we added Multi treading to Bitmap tracing, ...(more to come)

https://gitlab.com/inkscape/inkscape/-/merge_requests?scope=all&state=merged&label_name[]=Project%3A%3AMultithreading

== General user interface ==
[[File:Indicators of used colors.png|thumb|indicators of used colors]]
Color palettes have indicator color of stroke and fill of selected object. The first 4 colors are pinned and have the ability to become larger than the rest. Other than the special "none" color, the remaining 3 can be customized by editing the file <code>palettes/default-fixed-colors.gpl</code>.

[[File:Inkscape BHd0t2kzml.gif]]

=== New feature paste on page ===
You can copy and paste object from one page to another. <code>Edit > Specials Paste > Paste on page</code>

https://gitlab.com/inkscape/inkscape/-/merge_requests/4695

=== Old-style permanent snapping toolbar ===
An option was added in <code>Settings > Interface > Toolbars</code> to show the detailed snapping options permanently in a dedicated toolbar, similar to Inkscape version 1.1 and earlier.

=== Keyboard shortcuts ===

The keyboard shortcuts for aligning objects vertically and horizontally have been moved to the numeric keypad, where the other alignment shortcuts are, too:

* Vertical alignment was moved from <kbd>Ctrl+Alt+T</kbd> to <kbd>'''Ctrl+Alt+Numpad 1'''</kbd>
* Horizontal alignment was moved from <kbd>Ctrl+Alt+H</kbd> to <kbd>'''Ctrl+Alt+Numpad 7'''</kbd>
[[File:OKLAB.png|thumb|358x358px]]
If you find yourself unable to reach the new shortcuts (for example, because your laptop does not have a keypad, or because the shortcuts do not work - may be the case on Linux with Xfce), you can set them to something else by changing '''both''' the alignment shortcut '''and''' the function that now uses that shortcut (if any). Use the search in <code>Edit > Preferences > Interface > Keyboard</code>. It also allows searching for shortcuts, not only for their name (e.g. search for 'ctrl+alt+t' to find the new default action that is executed when that combo is pressed).

=== Color Picker ===
Added support for the '''OKLab''' and '''OKLch''' color spaces which have just been adopted into the CSS Color Module Level 4 [https://www.w3.org/TR/css-color-4/#ok-lab draft recommendation]. OKLab is described in detail by its creator in an interesting blog post. The new picker is called "OKHSL" and is available from the dropdown.

=== '''Rulers''' ===
Improved look. Fixed performance penalty. Added indicator of selection (its possible to trun off in preferences)

== Canvas ==

Pressing '''<code>F</code>''' temporarily hides on-canvas overlays (transformation handles, grids, guides ...). This allows quick preview of final artwork without any distractions.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4395

Added display overlay controls in top right corners. You need to have scrollbars enable to see it.

[[File:Canvas overlays.png|399x399px]]

=== OpenGL (GPU) accelerated canvas ===
An OpenGL-accelerated display mode was added to the canvas to speed up panning, zooming and rotating.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4133

This is NOT a fully GPU-based renderer; content is still rendered on the CPU in exactly the same way as before, so large performance improvements are not to be expected. It does however result in a smoother display and lower CPU usage, especially on HiDPI screens.

OpenGL mode is highly experimental and is turned off by default. It can be turned on at

Preferences -> Rendering -> Enable OpenGL

Note however the following caveats:

* Due to packaging problems, when using the Linux AppImage, OpenGL support either does not work (on X11) or crashes (on Wayland).
* Due to GTK3 bugs, OpenGL mode crashes on Windows, blacks out the screen on MacOS, is slower than software rendering on Linux X11, and is only really usable on Wayland.

For these reasons, it is not expected to be useful until we migrate to GTK4, where we hope that at least some of these bugs have been fixed.
== Tools ==

=== Selection tool ===
new commands:

* '''Reapply transform''': ''Ctrl+Alt+T'' - This allows a user to perform a transformation multiple times and works from the canvas edits or from transform dialog or the select toolbar. Shortcut needs to change, it opens a terminal on Linux.
* '''Duplicate and transform''': ''Ctrl+Alt+D'' -This performs a duplication and then reapplies the previous transform to the duplicate. Shortcut needs to change, it minimizes the window on Linux.
* '''Clone while dragging:''' drag object + C - Drag object move it and press C to clone in current position https://gitlab.com/inkscape/inkscape/-/merge_requests/4752 https://gitlab.com/inkscape/inkscape/-/merge_requests/4506

[[File:Inkscape xfsvsc2oY9.gif|thumb|editing pattern on canvas]]

=== Node tool ===

==== Pattern editing ====
Pattern editing on canvas is now easier you can click on any part of pattern and it will show you controls on that position. We also outline that shows you edges of pattern. First square controls position circle controls rotation and second square controls size hold shift to constrain proportions.

We also fixed performance problems with patterns so now you can have smaller patterns in project and also its possible to zoom in on pattern

==== Lasso selection mode ====
We added new lasso selection mode hold alt and draw around nodes you want to select. Useful fore selecting nodes inside of complicated geometry

https://gitlab.com/inkscape/inkscape/-/merge_requests/4747

=== Shape Builder tool (New tool) ===
New tool for fast shape building and Boolean operations. Shortcut <code>X</code>

Use: Select multiple overlapping shapes and select shipbuilder tool. Selection will be fragmented on overlapping areas everything else is going to be hidden until you confirm operation. Now you '''Click and drag''' to combine segments together or hold '''Shift + Click and drag''' to substract and '''Sigle click''' on segment to split. Adding is represented by Blue color removing by pink

[[File:Shape_builder.gif]]

https://gitlab.com/inkscape/inkscape/-/merge_requests/4709
[[File:Ezgif.com-gif-maker (12).gif|right|600x600px]]

=== Pages tool ===
Have controls for margins (guids):

* An attribute on the page element to record the margin
* A new html/css style box model with tests
* New UI to set margins in the toolbar
* New on canvas controls for moving margins (with ctrl/shift)
* New display of margins in the same canvas group as the page border

* Snapping for page margins

https://gitlab.com/inkscape/inkscape/-/merge_requests/4523

=== Gradient tool ===

* Allowing to change the ''repeat'' setting when multiple gradients are selected.
* Showing 'Multiple gradients' in the stop list when multiple gradients are selected (instead of a random stop).
* Allowing the editing of the offset of the start/end stops.
* Keeping the stop selected after the offset is changed in the toolbar (instead of selecting the 1st stop of the gradient).

https://gitlab.com/inkscape/inkscape/-/merge_requests/4339

== Path Operations ==

New commands:

'''Fracture''' Path->fracture - every overlapping path will be silted in to separate object

'''Flatten''' Path->flatten - overlapping object vi be flatten visually (it will delete path that are hidden behind a top path). Useful for separating colors for Screen printing and offset printing

== Masking / Clipping ==

* A new option to '''preserve clips / masks when ungrouping''' objects has been added (<code>Edit → Preferences → Behavior → Clippaths and Masks: When ungroup, clip/mask is preserved in childrens</code>). The option is active by default. This means that when you now ungroup a group that has been clipped, the elements inside it will inherit the clip. Previously, the clip was removed and everything became un-clipped. To go back to previous default behavior, deactivate this new option. ([https://gitlab.com/inkscape/inkscape/-/merge_requests/3564 MR #3564]) -->
[[File:Pattern editor1.gif|alt=Pattern editor|right|Pattern editor]]

== Dialogs ==

=== Fill and stroke Dialog ===

==== New pattern editor ====
Added in to UI. You can preview patterns change name, size, rotation, offset, gaps and colors for some specific patterns. We also added collections of patterns <code>~paint/pattern.svg</code> so its easier to be organized . Since this allows having much more patterns preset we also added search function .

=== Filter editor ===
[[File:Filter-resize.gif|alt=Filter-resize|Filter-resize|left]]

Redesign of this dialog:

* Filter selection moved to a popover
* Effects are listed in a popup menu and can be selected by searching (by name)
* Adjusted connector sizes to make them more compact
* Fixed an issue where all parameters would initially be visible in a docked filter dialog
* Fixed min size of parameters panel to make it fit in a narrow docked dialog
* Reactive layout to accommodate wide dialog
* Added primitive filter attributes to fe-image and fe-tile (#1417)
* Replaced GTK color picker with Inkscape color picker

* Sources can now be hidden (for most use cases only the source graphics is useful; other inputs are broken or need ux work) https://gitlab.com/inkscape/inkscape/-/merge_requests/4720[[File:Inkscape Y7U4yzIFTq.gif|thumb]]

=== Layers and Objects ===
UX improvements:

* you can click and drag to change visibility of multiple objects
* selecting on group does not auto expand .
* Selecting multiple object and and changing visibility/locking applies to all selected
* We added search feature, Its limited implmentation.it does not auto apply search and you need to search for more 3 characters
* we added hover indicator for rows and layer colors
* added controls for opacity and blending mode

We added shortcuts for layers navigation and actions:

* arrows to navigate
* space bur confirms (select, apply, open)
* shift -> <- open close group
* shift up down to move in Z order

[[File:VirtualBoxVM I675gipqe1.gif|thumb|1017x1017px|Place holder demo of new LPE dialog]]

=== Live Path Effects ( LPE ) ===
New redesigned LPE dialog.

The compacted design merges organization and controls into one unit. You can reorder LPE by drag and drop whole effect. It adds fast search box and fast dropdown for adding effects.

Single LPE has 5 controls:

* Show/Hide Controls
* Visibility of Effect
* Delete Effect
* Context menu
** Re-order
** Duplicate
** Set as default
** Flatten

[[File:LPE organization.png|right|266x266px]]
Reorganization of LPEs:

Since we needed more compact way show All LPEs we Decided on a list that is organizes in to 6 Categories :

Tools ,Distort, Generate, Convert, Experimental + Favorite

Changes:

* Setting presets for LPE was moved in to contextual menu
* Setting Favorite LPE was moved in to contextual menu
* Added New feature flatten - This will apply effect to geometry , It will apply all effects in a stuck
* We removed LPE gallery (you can sill enable it in Preferences if you wish <code>Preferences -> Behavior -> LPE</code>
* To see experimental LPEs you need to enable it in Preferences <code>Preferences -> Behavior -> LPE</code>
* Added indicator which object is selected
* Added conversion commands when you select text objects - Since Text does not support LPEs yet we added workaround that convert text to path or clones the text
* If you select Object that is assorted with other LPE (Clone, Bool operations, Bend, Fill between many etc...) You will see button in Dialog that will take you to linked geometry/controls

https://gitlab.com/inkscape/inkscape/-/merge_requests/4677

=== XML Editor ===
[[File:Syntax highlighting.png|thumb|392x392px]]
We did small cosmetic changes to this dialog: smaller icons 16x16px , removed text tool tips. Added responsive layout and moved layout controls to top in to dropdown (auto layout is default option).

==== Syntax highlighting: ====
For improving readability we added syntax color coding and auto line braking. This work for CSS style tag, Inline styling, d <path data> . You change change color coding themes in <code>Preferences -> Interface -> Theming</code>

https://gitlab.com/inkscape/inkscape/-/merge_requests/4885

=== Symbols ===
You can drag and drop symbols on canvas and they are going to be place exactly where you dropped them. New icon "peace". Improved performance . Add visio modern formats vssx and vsdx. Symbols are load once, not in each window

https://gitlab.com/inkscape/inkscape/-/merge_requests/4666

https://gitlab.com/inkscape/inkscape/-/merge_requests/4883

https://gitlab.com/inkscape/inkscape/-/merge_requests/4793

https://gitlab.com/inkscape/inkscape/-/merge_requests/4784

=== Bitmap Tracer ===
Got significant performance boost. Now it takes advantage of CPU multithreading.

https://gitlab.com/inkscape/inkscape/-/merge_requests/4702

=== Command bar ===
Improved UI https://gitlab.com/inkscape/inkscape/-/merge_requests/4988

== Filters ==

== Live path effects ==
All labels are no align to one line.

Tapper Stroke and powerstroke now handle paths with multiples subpaths https://gitlab.com/inkscape/inkscape/-/merge_requests/4906 https://gitlab.com/inkscape/inkscape/-/merge_requests/4880

UI and Lale clean up for:

Roughen LPE

https://gitlab.com/inkscape/inkscape/-/merge_requests/4872

== Import / Export ==

== Templates ==

All template dialogs (Welcome screen, New from Template, Page tool default sizes) now use the same template sizes ([https://gitlab.com/inkscape/extensions/-/merge_requests/479] MR #479)

== Customization / Theming ==
added user.css to UI folder to allow tweak UI without interferences or full override other css files https://gitlab.com/inkscape/inkscape/-/merge_requests/5004

Fixed hidden icons on menus: https://gitlab.com/inkscape/inkscape/-/merge_requests/4686

== Other ==

== macOS-specific Changes ==

== Windows-specific Changes ==

== Extensions ==

=== Features ===
Speedup processing specialy on complex docs https://gitlab.com/inkscape/inkscape/-/merge_requests/4996

==== General Extension Changes ====

==== New Extensions ====

==== Particular extensions ====

=== Bugs fixed ===

==== All extensions ====

==== Particular extensions ====

=== Extension Development ===

==== API Changes for Third-Party Extension Developers ====

==== Extension Development Documentation ====

==== Under the hood ====

== Command line ==
Added a new parameter --actions-file you send a list like in --actions but in a file to allow bypass windows comand line limit also for beter reuse it

?Added new parameter --active-window / -q that run all commands to the active desktop

== Behind the curtains ==

== Notable bugfixes ==

=== Crash fixes ===

Fixed a crash that occurred …

* when …

=== Other bug fixes ===

* LPE related Undo bugs https://gitlab.com/inkscape/inkscape/-/merge_requests/4520
*Fixed bspline LPE with cusp nodes when start using with node tool https://gitlab.com/inkscape/inkscape/-/merge_requests/5016
*Uses retain LPE correctly when unliked or convert to paths. Old convert to paths is available by prefs. https://gitlab.com/inkscape/inkscape/-/merge_requests/5016

=== Even more bug fixes ===

There were even more issues fixed than those listed above, but these probably only affect a small portion of users, or are relevant for development and packaging only.

For a complete list, visit [https://gitlab.com/inkscape/inkscape/-/issues?milestone_title=Inkscape+1.3 our GitLab issue tracker] and see the [https://gitlab.com/inkscape/inkscape/-/commits/1.3.x commit history].

== Translations ==

The following UI translations received updates:

* …

The Windows installer translation was updated for:

* …

The following documentation translations received updates:

* …

=== Contributing to interface translations ===

Want to help with translations? [https://inkscape.org/contribute/translations/ Learn how to help!]

== Documentation ==

=== Contributing to documentation and documentation translation ===
Contributions to the documentation translations, as well as improvements to its contents, are welcome at [https://gitlab.com/inkscape/inkscape-docs/documentation the inkscape-docs repository].

== Website ==

== Important changes for packagers ==

== Known issues ==

== Other releases ==

{{:Release notes}}

Inkscape

2023-02-03T05:08:11Z

PBS: Update latest hackfest to 2023 Bensberg

This is a freeform area for Inkscape development and discussion. Curious about [[wiki syntax]]?

{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 33%; background: #EEE; padding: 1em;" |
== Project Info ==
* [http://www.inkscape.org/ Inkscape Homepage]
* [[About Inkscape]]
* [[Features of Inkscape|Features]]
* [[FAQ]] — Frequently Asked Questions
* [[Supported operating systems]]
* [[Tools]] — Supporting Tools and Applications
* [[Galleries]]
* [[Inkscape coverage|Coverage]] — Awards, articles, presentations, books about Inkscape
* [[Inkscape popularity|Popularity]]
* [[Inkscape invariants|Inkscape's Mission]]
* [https://inkscape.org/en/community/ Communication] — How to reach us
* [[Announcement to Sodipodi]] — This started it all
* [[Branding]]
* [[Travel Reimbursement Policy]]
* [[Funded Project System Development]]
* [[:Category:Hackfest|Hackfests]]
** upcoming/proposed events: [[Hackfest2023_Bensberg|2023 Bensberg]]
** past events:
::: [[Hackfest2019 SCALE|2019 Pasadena (SCALE)]], [[Hackfest2019 Saarbrücken|2019 Saarbrücken (LGM)]]
::: [[Hackfest2018|2018 Boston]], [[Hackfest2018 LGM|2018 Seville (LGM)]], [[Hackfest2018 Kiel|2018 Kiel]]
::: [[Hackfest2017|2017 Paris]]
::: [[Hackfest2016|2016 Leeds (LGM)]]
::: [[Hackfest2015|2015 Toronto (LGM)]]

| style="width: 33%; padding: 1em;" |

== User Documentation ==
* [[Installing Inkscape|Installation]]
* [[International and Local Communities]]
* [[Inkscape glossary]]
* [[User manual information]] — Where to find the free Inkscape manual and how to contribute to it
* [http://inkscape.org/en/learn/tutorials/ Tutorials]
* [[Inkscape SVG vs. plain SVG]]
* [[Output format requirements]] — What's needed to save in some formats
* [[Extension requirements]] — What's needed to use some extensions (slightly outdated)
* [[Extension reference]] — What each extension does (slightly outdated)
* [[Connector tool tutorial]]
* [[Installing fonts]]
* [[Emergency save]] — Recovery in case Inkscape crashed
* [[Release notes]]
** ''[[Release notes/1.3|Inkscape 1.3]]'' — ''development branch''
** '''[[Release notes/1.2|Inkscape 1.2]]''' ([[Release notes/1.2.1|1.2.1]], [[Release_notes/1.2.2|1.2.2]]) — ''current stable release branch''
** [[Release notes/1.1|Inkscape 1.1]] ([[Release notes/1.1.1|1.1.1]], [[Release notes/1.1.2|1.1.2]])
* [[Announcing Releases]] (slightly outdated)
* [[Release Process Debrief]] (slightly outdated)
* [[Tricks and tips]] — Miscellaneous advice, may be slightly outdated

| style="width: 33%; background: #EEE; padding: 1em;" |

== Help Inkscape Without Coding ==
* [[Help wanted]]
* [[Bug management]]
** [[Projects#Bug_Triage]]
* [[Testing]]
** [[macOS alpha]]
* [[Translation information]]
* [[WebSite]]
* [[Inkscape Classes]]
* [[Conferences]]
* [[Fundraising Ideas]]
* [[Creating Inkscape distributions]] — How to build packages
* [[Stable branch updates]]
* [[Updating tracker items]]
* [[Tutorials and help]]
* [[How to start a page]] — How to use the wiki
* [[Creating screencasts]]
* [[About-Screen contest]]
* [[social media|Participate in social media]]
|}

<div style="margin-top: 1em; padding: .5em 1em 1em; border: 1px solid #62C012;">

== Developer Documentation ==
{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 50%; padding-right: 1em;" |
=== First Steps ===
* [[Working with Git]] — How to obtain the source code. A quick start on how to use our version control system.
* [[Compiling Inkscape]]
* [[Developer manual]] — Various important information, be sure to read this before coding
* [[Debugging Inkscape|Debugging]] — Random tips to help debug problems
* [[Janitorial tasks]] — Small tasks that need doing
* [[Doxygen documentation]]
* [[Working with CMake]] — Getting started with CMake coding for configuring and building Inkscape

=== Developer tutorials ===
* [[Architectural overview]] — A high-level look at Inkscape
* [[Preferences subsystem]] — Creating and using preference values

* Extensions
** [[Extension subsystem]] — An overview of the functionality provided by extensions and the possible implementations
** [[Script extensions]] — Extend Inkscape easily using scripting languages (Python, Perl, …)
** [[Python modules for extensions]] — Some helpful routines for use in Python script extensions
** [[INX extension descriptor format]]
* [[Creating Live Path Effects]]
* [[Boost shared pointers]]
* [[Using libsigc++ signals]]
* [[Windows development on Linux]]

=== User Interface Discussion ===
* [[Interface translation]]
* [[Adding interface verbs]]
* [[Accessible graphics]]
* [[Object Manager]]
* [[Dialogs reorganization]]
* [[Modal interfaces]]
* [[Text usability]] — Text tool and dialog
* [[KeyboardShortcutsToDo]]
** [[Keyboard profiles]] — How you can help
* [[Statusbar API]]
* [[Animation-(Timeline)]]
* [[Free Desktop Graphic Suite]]
* [[Skeletal Strokes]] — Brushes, Strokes, Pressure Sensibility...

| style="width: 50%;" |

=== Development Discussion ===
* [[Roadmap]] — The main todo list
* [[Tracking Dependencies|Dependencies]] — What libs are needed to build Inkscape
* [[C++11]] — Which C++11 features can be used
* [[New feature proposals]]
* [[Extension architecture proposals]]
* [[Coding Style|Coding Style Discussion]]
* [[File types]]
* [[Application icons]] — Application + Interface
* [[Icons]]
* [[Color management]]
* [[Printing subsystem]]
* [[SVG Tiny Compliance]]
* [[SVG Test Suite Compliance]] — [[W3C]] full test suite
* [[CSS Support]]
* [[Google Summer of Code]]
* [[Improved Media Management]]
* [[UI Mockup Screenshots]]
* [[Swatch Book]]
* [[Tablet Dialog]]
* [[ViewBoxToDo]] — View box support info
* [[Caching]]
* [[Canvas Rendering Profiling]]
* [[UI and Document coordinates‎]]
* [[GtkMMification]] — Replace C boilerplate with gtkmm objects
* [[CMake Tasks]] — Converting the Inkscape build system to CMake
* [[Bug Reporting Workflow]] — Options for improving Inkscape bug workflow from user to developer
* [[1.0 Release Bug Fix List]] — List of bugs that need to be fixed for 1.0
* [[1.0 Release Planning]] — Roadmap and planning for 1.0 Release

=== Miscellaneous ===
* [[Inkscape-specific XML attributes]] — Documentation of attributes from Inkscape's XML namespace
* [[Environment variables]] — Overview of important environment variables that modify the behavior of Inkscape and its dependencies.
* [[Extension repository]] — An Internet central for Inkscape extensions
* [[Related programs]]
* [[Sponsors list]]
* [[Wiki Playground]]

=== [[Lib2geom]] ===
* [[Lib2geom]]
* [[Working with 2Geom FAQ]] — Real-life questions answered about using 2Geom in real code
* [[Lib2geom py2geom]] — Python bindings to 2geom. With this you can use the power of 2geom in Python scripts.

=== Historical pages ===
These pages are outdated, but linked here for posterity.

* [[Working with Bazaar]] — Our former control version system, no longer used. See [[Working with Git]] for current instructions.
* [[Creating a new SPObject]]

|}
</div>

== See also ==
* [[:Category:Wiki Attic|Wiki Attic]] — Pages that are no longer relevant but kept for historical value

__NOTOC__

[[Category:Top level categories]]

Hackfest2020 Rennes

2023-02-03T04:56:09Z

PBS: Update postponement date to 2023

POSTPONED TO 2023

This page details the planning of Inkscape's PROPOSED 2020 hackfest in Rennes, France, May ? to May ?. It is just prior to LGM which is from May 26 to May 29th.

Other pages: [[Hackfest2020 Rennes Topics]], [[Hackfest2020 Rennes Attendees]].

Old: [[Hackfest2019 Saarbrücken]], [[Hackfest2019 SCALE]], [[Hackfest2018 Kiel]], [[Hackfest2018 LGM]], [[Hackfest2018]], [[Hackfest2017]], [[Hackfest2016]], [[Hackfest2015]].

= Hackfest: Rennes, France =

==Description==

A hackfest! We will work on Inkscape bugs, new features, and packaging as well as website issues; in fact anything that can benefit from developers and users being physically in the same space.

The hackfest will take place before (and continue informally through) the [https://libregraphicsmeeting.org/2020/ 2020 LGM conference].

==Rennes==

Rennes is a city about two hours by train west of Paris.

* [https://en.wikipedia.org/wiki/Rennes Rennes on Wikipedia]
* [https://www.tourisme-rennes.com/en Tourism (official)]

==Venue==

The hackfest will take place at Activdesign, 11b rue Jean le Hô. It's an art school who teach Inkscape, Krita, Blender and Godot.

==LGM==

Tuesday, 26th of May through Friday, 29th of May.

* Tuesday and Wednesday: ISTIC - Rennes 1 University.
* Thursday and Friday: "Le Jardin Moderne" & Activdesign

==Catering==
The center of the city is plenty of fast food or restaurant. The center is at 20 min by bus. Otherwise, there is some fast food near walking (burger king, and sandwich) or the restaurant of the Jardin Moderne (closed on monday) at 5 min by feet.

==Facilities==

* Wireless
* Europlug type C and F.
* LCD projector
* white board
* Café, Tea, micro-waves, water
* 1 big room with table and chair
* 1 sofa

==Nearby Amenities==
The center is at 20 min in bus.

==Hotels==
In the center of the city you have some hostels with ** or *****.
Near Activdesign there is an ibis budget.

==Hackfest Dinner==

An informal dinner will be held on ?.
Lot of choice of restaurant : japonese, breton, italian, marocco. All are very good. Maybe is depending on the number. Japonese restaurant is quite little and the marocco is bigger and also very good. The breton are plenty but the good one have to be booked.

==Attendance==

Anybody interested in Inkscape is welcome to attend. Funding support for travel expenses is based on past contributions to Inkscape. See the [[Hackfest2020 Rennes Attendees]] page for more details.

==Hackfest Topics and Schedule==

A schedule will be developed based on input from attendees and the Inkscape community. See the [[Hackfest2020 Rennes Topics]] page for further details.

==Helpers==

The following folk have offered to assist with organization work, in limited capacities:

* You
* And you?
* Tav
* Elisa (working at Activdesign)

[[Category:Hackfest]]

*