Difference between revisions of "Google Summer of Code"

From Inkscape Wiki
Jump to navigation Jump to search
 
(122 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 +
<div style="max-width:70em; margin-left: auto; margin-right: auto">
 
= Welcome to Inkscape! =
 
= Welcome to Inkscape! =
  
For a few years Inkscape was successful in participating in Google Summer Of Code.
+
For quite a few years Inkscape has been successfully participating in [http://code.google.com/soc/ Google Summer of Code].
  
 
GSoC is a program where Google funds the development of specific features in open source software by university students. 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 students.
 
GSoC is a program where Google funds the development of specific features in open source software by university students. 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 students.
Line 7: Line 8:
 
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.
 
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.
  
The Inkscape team plans to focus this summer on codebase cleanup and refactoring. This will affect the type of projects we can accept this year; we're looking for ones that either won't affect core code too significantly (such as Extension scripts, or File Input/Output formats) or that would actually result in improving the state of the codebase (adding tests, modularization, etc.).  Students who have already been active developers in Inkscape previously will be allowed more latitude to work on core code (particularly if it will result in cleanup/refactoring of their past work).
+
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!'''
  
 
= Student Applications =
 
= Student Applications =
  
* Google program information
+
* Google program information:
** Summer of Code Application form
+
** [https://summerofcode.withgoogle.com/ Home page].
* Inkscape-specific information
+
** Summer of Code Application form. Applications open at 18:00 UTC on March 25th.
** [[SOC Application Template]]
 
** [[Roadmap | Inkscape Roadmap]] - to see our overall objectives
 
** [[SOC Writing Project Proposals]] - some guidelines for proposals
 
** [[SOC Selection Criteria]] - how we rate applications
 
  
= SOC Features =
+
* Inkscape-specific information:
(TODO complete the list)
+
** [[SOC Application Template]].
* 2007
+
** [[Roadmap | Inkscape Roadmap]] - to see our overall objectives.
** Live Path Effects
+
** [[Projects | Inkscape Development Project Ideas]] - broader list of development ideas.
* 2008
+
** [[SOC Writing Project Proposals]] - some guidelines for proposals.
** 2Geom refactoring project - port most geometry code to 2Geom
+
** [[SOC Selection Criteria]] - how we rate applications.
* 2009
+
 
** [[GSoC 2009 Node Tool Rewrite|Node tool rewrite]]
+
'''Student Applications for GSoC 2019 must be submitted to the GSoC site by 18:00 UTC on April 9th 2019.'''
** D-Bus scripting API
 
** Connector tool improvements
 
  
 
= The "two patches" rule =
 
= The "two patches" rule =
Line 35: Line 30:
 
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.  
 
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!
 
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 jabber/IRC channel and ask developers for help.
+
You can join our [https://inkscape.org/community/discussion/ IRC] channel and ask developers for help.
To get you started on Inkscape development, here is a list of (probably) easy-to-fix bugs or small improvements that require very little knowledge of the whole program.
 
  
 
== Suggested "easy" bug fixes or improvements ==
 
== Suggested "easy" bug fixes or improvements ==
  
* [https://bugs.launchpad.net/inkscape/+bug/530957 Bug #530957 “Save as dialog regression with filename”]: (MS Windows) File save dialog - the "save/save as/save a copy" dialog should fill in a suggested file name *without* extension. For example, if I am working on a file "hello.svg", and press "save a copy", the file name input field should have the text "hello" in it.
+
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://bugs.launchpad.net/inkscape 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/
 +
 
 +
==P1. Better CSS Style Sheet Support==
 +
 
 +
Enhance Inkscape's support for CSS style sheets.
 +
 
 +
* Estimation of difficulty: Moderately hard
 +
* Potential mentors: Tavmjong Bah
 +
* Programming skills needed:  C++
 +
* Prerequisites: Experience with CSS style sheets.
 +
 
 +
<u>Detailed Description</u>
 +
 
 +
Inkscape has rudimentary support for CSS style sheets that can read and parse one internal style sheet. A 2016 GSoC project added a simple style dialog that can create and modify the internal style sheet. The dialog is very limited and is not intuitive to use. A 2017 GSoC project added support for CSS 3 selectors. This project will extend the usefulness of that dialog by making it more user friendly and by extending its functionality. The use of CSS classes should eventually replace the Selection Set dialog.
 +
 
 +
<u>Use Cases</u>
 +
 
 +
* Support externally created SVGs.
 +
* Producing better SVGs for the Web.
 +
* Changing style on multiple objects at once (palettes).
 +
 
 +
<u>Related Material</u>
 +
 
 +
* [https://www.w3.org/TR/CSS2/ CSS 2 Specification]
 +
* [https://www.w3.org/TR/css-2015/ CSS 2015 Snapshot]
 +
 
 +
==P3. Slice items==
 +
[[File:Cuttool.png|200px|thumb|right|Example of result of the split using straight lines only]]
 +
Add slicing Live Path Effect (LPE)
 +
* Estimation of difficulty: Moderately hard
 +
* Potential mentors: Jabier Arraiza (Spanish, some English)
 +
* Programming skills needed:  C++
 +
 
 +
<u>Detailed Description</u><br />
 +
The goal is a LPE, to slice items.<br />
 +
It accept a path parameter (storing a path) as cutter.<br />
 +
The effect create pieces by the split path.<br />
 +
Can be added multiple times to add more splits.<br />
 +
We have the code of mirror symmetry LPE and rotate copies LPE as reference.<br />
 +
Also we can force or better ask to convert strokes to path previously to apply the effect (one line command, but we need advert is a destructive LPE)<br />
 +
Study generate a HTML image map definition.<br />
 +
<u>Use Cases</u>
 +
* Better item slicing.
 +
* Create HTML image maps
 +
* Split a item and use for example on PNG export option export as separate objects.
 +
 
 +
==P4. SVG 2 Text Support==
 +
 
 +
* Estimation of difficulty: Hard
 +
* Potential mentors: Tavmjong Bah, Martin Owens
 +
* Programming skills needed: C++
 +
* Prerequisites: Familiarity with text layout. Knowledge of CSS.
  
* [https://bugs.launchpad.net/inkscape/+bug/408566 Bug #408566 “Program won't save files without given extension on Win32”]: (MS Windows) A folder in the path with a dot '.' in its name prevents automatic adding of the file name extension and saves the file without suffix.
+
<u>Detailed Description</u>
  
* [https://bugs.launchpad.net/inkscape/+bug/561503 Bug #561503 “Setting grid origin has no effect”]: (all platforms)
+
Inkscape currently has a non-compliant flowed text feature, that is text automatically being flowed inside a rectangle or some other shape. It is based on SVG 1.2 which never became a published W3C specification. Inkscape's flowed text needs to be made compatible with both SVG2 and SVG 1.1. A GSoC 2017 project re-implemented flowed text using SVG 2 methods. While this code has been integrated into Inkscape, it is not yet the default when generating flowed text. This project is to fully test the new code, fix any bugs, improve the UI interface, and finally, to make it the default method for flowed text. This is a high priority item!
  
= Suggested Ideas =
+
<u>Use Cases</u>
 +
* Proper text flow into rectangles and other shapes.
  
== Generic ideas ==
+
<u>Related Material</u>
 +
* [https://svgwg.org/svg2-draft/text.html Current draft of SVG 2 text specification.]
  
* Font editing and creation features, e.g. [https://blueprints.launchpad.net/inkscape/+spec/designing-svg-fonts-using-styles designing SVG fonts using styles]
+
==P5. UI-Free Inkscape ==
* [https://blueprints.launchpad.net/inkscape/+spec/new-from-template-dialog 'New From Template' dialog]
 
* [https://blueprints.launchpad.net/inkscape/+spec/kidscape-project kidscape] - Condensed version of Inkscape aimed at young kids and small form factor devices
 
* [https://blueprints.launchpad.net/inkscape/+spec/cutter-control Cutter control] - Enable Inkscape's use with vinyl cutters.
 
* [https://blueprints.launchpad.net/inkscape/+spec/guides-improvement Guides Improvements]
 
  
== Import/export projects ==
+
* Estimation of difficulty: Difficult
 +
* Potential mentors: Marc Jeanmougin
 +
* Programming skills: C++, CMake
 +
* Prerequisites: Minimal knowledge of build systems. Experience with GtkMM helpful.
  
* Importing of 3D scene files in 16 file formats using [http://assimp.sourceforge.net/ Open Asset Import Library]
+
<u>Detailed Description</u>
* [https://blueprints.launchpad.net/inkscape/+spec/xar-to-svg-converter xar-to-svg converter] - Converter for Xara Xtreme to Inkscape
+
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. 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.
* [https://blueprints.launchpad.net/inkscape/+spec/kml-svg-translation KML SVG translation] - For use of Inkscape with Google Earth or Maps
 
  
== Internal work, rendering, speedups ==
 
  
* C++ize the SP layer and make XML nodes private.*
+
<u>Use cases</u>
* Remove livarot in favor of 2Geom, improving 2Geom where necessary (e.g. boolops).
+
* Server installs, scripts
* Switching primary rendering engine from Livarot/libnr to Cairo. DONE
 
* [https://blueprints.launchpad.net/inkscape/+spec/icc-for-cairo ICC Color Management for cairo outputs] - Would allow Inkscape to produce CMYK PDFs and PSs with Cairo.
 
* [http://wiki.inkscape.org/wiki/index.php/TextRework Text layout rewrite]: Move flow-text into Inkscape name space. Add support for hyphenation, paragraph indentation, underlining, etc.
 
  
== Better SVG standard coverage ==
+
==P6. Refactoring==
 +
* Estimation of difficulty: Moderate
 +
* Potential mentors: Tavmjong Bah
 +
* Programming skills: C++
 +
* Prerequisites: proficient C++.
  
* Full SVG viewbox support
+
<u>Detailed Description</u>
* [[multipage | Multiple Page support]]
+
Inkscape began life as the C program Sodipodi. Sodipodi was mostly the work of one person who had a clear vision of how the code should work. A major motivation of the Inkscape fork was to allow others to easily contribute to development. This resulted in rapid development but at a cost: the code has become much messier and now lacks a clear vision. This project is to work on refactoring the code. Refactoring can take many forms. It could be creating a better directory structure with README's that describe the purpose and function of the code in each directory. This would include rewriting code to reduce dependencies across directories (which would help, for example, in achieving a headless version of Inkscape). It could be the continued transition from C to C++ which often results in major reductions in the number of code lines. Or it could be identifying and eliminating redundant code. Refactoring is an important skill of which many books have been written. Here's a chance to gain valuable experience!
  
== Live Path Effects related ==
+
==P7. Polyfills ==
 +
* Estimation of difficulty: Variable
 +
* Potential mentors: Tavmjong Bah
 +
* Programming skills: JavaScript
 +
* Prerequisites: Experience in web development.
  
* [https://blueprints.launchpad.net/inkscape/+spec/power-stroke Power Stroke] - Modulated width stroke LPE.
+
<u>Detailed Description</u>
* [https://blueprints.launchpad.net/inkscape/+spec/lpe-blueprint More Live Path Effects] - There is a lengthy list of ideas to choose from here.
+
Many features of SVG 2 have yet to (and may never) make it into browsers. We can support those features by writing <i>polyfills</i> which implement missing functionality using JavaScript.
  
== Tools and shapes related ==
+
==P8. Add Text and Image Support to Live Path Effect System ==
 +
* Estimation of difficulty: Hard
 +
* Potential mentors: Jabier Arraiza (Spanish, English(not native))
 +
* Programming skills: C++
 +
* Prerequisites: Experience managing bitmaps
 +
<u>Detailed Description</u>
 +
Live Path Effects are non destructive effects applied to paths and shapes standalone or inside a group.<br />
 +
This is done keepeng a reference to the original data to reaply when needed.<br />
 +
But ignore text and image elements.<br />
 +
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.
 +
<u>Use cases</u>
 +
* Apply live effects to images and text based in C++ code in a non destructive way even in groups with mixed elements types.
  
* Multi shape editing - ability to edit more than 1 shape (like ellipse or star) at once, with extra features like resizing rectangles by dragging their edges.
+
==P9. Path Library Improvements ==
* [https://blueprints.launchpad.net/inkscape/+spec/transformation-anchors Transformation Anchors]
+
* Estimation of difficulty: Hard
* Further development of [http://generalpicture.com/svg/shapeopera.html Shape Opera], a simple Javascript framework for  morphing Inkscape PATH shapes.
+
* Potential mentors: Tavmjong Bah, KK
* Add a palette of objects to Inkscape. Such a palette would contain often used objects and would allow categorizing such objects. Examples of categories: UML, electric, network.
+
* Programming skills: C++
* [https://blueprints.launchpad.net/inkscape/+spec/inkscape-connectors Connector tool improvements] - Expose new libavoid functionality: orthogonal routing, connector ports, curved connectors. (Mentor: Michael Wybrow)
+
* Prerequisites: Strong math skills, specifically in geometry.
* Arrowhead/marker improvements
+
<u>Detailed Description</u>
* [https://blueprints.launchpad.net/inkscape/+spec/fillet-tool Fillet/Chamfer tool]
+
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.
 +
Specifically, the functionality needed is
 +
* Path offset/inset functions.
 +
* Path simplify.
 +
* Stroke to path function.
 +
* Line scanning (used for flowing text into a shape).
  
Please do not feel limited to the above ideas - some of our best contributions have been unique ideas that students had in mind from other sources!
+
==P10. Your project ==
 +
* Estimation of difficulty: Variable
 +
* Potential mentors: Marc Jeanmougin
 +
* Programming skills: usually C++
 +
* Prerequisites: good ideas
 +
 
 +
<u>Detailed Description</u>
 +
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!
 +
 
 +
<u>Use cases</u>
 +
* 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.
  
For more ideas, please see https://blueprints.launchpad.net/inkscape/
+
[[Category:Developer Documentation]]
 +
</div>

Latest revision as of 11:50, 22 January 2020

Welcome to Inkscape!

For quite a few years Inkscape has been successfully participating in Google Summer of Code.

GSoC is a program where Google funds the development of specific features in open source software by university students. 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 students.

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!

Student Applications

  • Google program information:
    • Home page.
    • Summer of Code Application form. Applications open at 18:00 UTC on March 25th.

Student Applications for GSoC 2019 must be submitted to the GSoC site by 18:00 UTC on April 9th 2019.

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 Bazaar 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 IRC channel 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 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/

P1. Better CSS Style Sheet Support

Enhance Inkscape's support for CSS style sheets.

  • Estimation of difficulty: Moderately hard
  • Potential mentors: Tavmjong Bah
  • Programming skills needed: C++
  • Prerequisites: Experience with CSS style sheets.

Detailed Description

Inkscape has rudimentary support for CSS style sheets that can read and parse one internal style sheet. A 2016 GSoC project added a simple style dialog that can create and modify the internal style sheet. The dialog is very limited and is not intuitive to use. A 2017 GSoC project added support for CSS 3 selectors. This project will extend the usefulness of that dialog by making it more user friendly and by extending its functionality. The use of CSS classes should eventually replace the Selection Set dialog.

Use Cases

  • Support externally created SVGs.
  • Producing better SVGs for the Web.
  • Changing style on multiple objects at once (palettes).

Related Material

P3. Slice items

Example of result of the split using straight lines only

Add slicing Live Path Effect (LPE)

  • Estimation of difficulty: Moderately hard
  • Potential mentors: Jabier Arraiza (Spanish, some English)
  • Programming skills needed: C++

Detailed Description
The goal is a LPE, to slice items.
It accept a path parameter (storing a path) as cutter.
The effect create pieces by the split path.
Can be added multiple times to add more splits.
We have the code of mirror symmetry LPE and rotate copies LPE as reference.
Also we can force or better ask to convert strokes to path previously to apply the effect (one line command, but we need advert is a destructive LPE)
Study generate a HTML image map definition.
Use Cases

  • Better item slicing.
  • Create HTML image maps
  • Split a item and use for example on PNG export option export as separate objects.

P4. SVG 2 Text Support

  • Estimation of difficulty: Hard
  • Potential mentors: Tavmjong Bah, Martin Owens
  • Programming skills needed: C++
  • Prerequisites: Familiarity with text layout. Knowledge of CSS.

Detailed Description

Inkscape currently has a non-compliant flowed text feature, that is text automatically being flowed inside a rectangle or some other shape. It is based on SVG 1.2 which never became a published W3C specification. Inkscape's flowed text needs to be made compatible with both SVG2 and SVG 1.1. A GSoC 2017 project re-implemented flowed text using SVG 2 methods. While this code has been integrated into Inkscape, it is not yet the default when generating flowed text. This project is to fully test the new code, fix any bugs, improve the UI interface, and finally, to make it the default method for flowed text. This is a high priority item!

Use Cases

  • Proper text flow into rectangles and other shapes.

Related Material

P5. UI-Free Inkscape

  • Estimation of difficulty: Difficult
  • 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. 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.


Use cases

  • Server installs, scripts

P6. Refactoring

  • Estimation of difficulty: Moderate
  • Potential mentors: Tavmjong Bah
  • Programming skills: C++
  • Prerequisites: proficient C++.

Detailed Description Inkscape began life as the C program Sodipodi. Sodipodi was mostly the work of one person who had a clear vision of how the code should work. A major motivation of the Inkscape fork was to allow others to easily contribute to development. This resulted in rapid development but at a cost: the code has become much messier and now lacks a clear vision. This project is to work on refactoring the code. Refactoring can take many forms. It could be creating a better directory structure with README's that describe the purpose and function of the code in each directory. This would include rewriting code to reduce dependencies across directories (which would help, for example, in achieving a headless version of Inkscape). It could be the continued transition from C to C++ which often results in major reductions in the number of code lines. Or it could be identifying and eliminating redundant code. Refactoring is an important skill of which many books have been written. Here's a chance to gain valuable experience!

P7. Polyfills

  • Estimation of difficulty: Variable
  • Potential mentors: Tavmjong Bah
  • Programming skills: JavaScript
  • Prerequisites: Experience in web development.

Detailed Description Many features of SVG 2 have yet to (and may never) make it into browsers. We can support those features by writing polyfills which implement missing functionality using JavaScript.

P8. Add Text and Image Support to Live Path Effect System

  • Estimation of difficulty: Hard
  • 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
  • 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. Specifically, the functionality needed is

  • Path offset/inset functions.
  • Path simplify.
  • Stroke to path function.
  • Line scanning (used for flowing text into a shape).

P10. Your project

  • Estimation of difficulty: Variable
  • 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
  • 2006
    • Support for SVG Filters
    • Filter Effects
    • PDF export
    • Inkboard Protocol Spec / Lib Conversion
  • 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
  • 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
  • 2010
    • Cairo-based rendering
    • C++ification of SP Layer
  • 2011
    • Rendering caching
    • Javascript support improvements
    • CSS support improvements
  • 2012
  • 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
  • 2017
    • SVG 2 Text Support
    • Better CSS Style Sheet Support
  • 2019
    • Mesh gradient and hatches polyfills. Paint server dialog.