Difference between revisions of "Roadmap"

From Inkscape Wiki
Jump to navigation Jump to search
(added CDR import/export to the list of tasks)
 
(156 intermediate revisions by 25 users not shown)
Line 1: Line 1:
== Inkscape Development Roadmap ==
+
This is a working document showing specific near-term tasks needed for achieving the numbered milestones. It is '''not a wishlist''' of features to be included in future releases. Because people often work on whatever they feel like, only the current and current+1 releases should be taken seriously.  Beyond that is mainly conjectural.
  
NOTE: This is a working document showing specific near-term tasks needed for achieving milestones. The number in front of the version is in reference to the milestone.
+
''See [[OldRoadmap]] for milestones that have already been achieved.''
  
''Milestones 0-9 have been completed since the start of the Inkscape Project. See [[OldRoadmap]]''
+
=== Inkscape 0.92 ~ Infrastructure Focus ===
 +
* (DONE) <s>Set up autogeneration of Inkscape source code documentation ([http://wiki.inkscape.org/wiki/index.php/Doxygen_documentation Doxygen not available online according to old wiki page] but [http://fossies.org/dox/inkscape-0.91pre2/ available here (fossies.org)])</s> (http://jenkins.inkscape.org/job/Inkscape_trunk_doxygen/doxygen/)
 +
** (DONE) <s>Put it publicly somewhere on the inkscape domain for "official" access.</s> (http://jenkins.inkscape.org/job/Inkscape_trunk_doxygen/doxygen/)
 +
* (DONE) <s>Build system: migrate away from Autotools (See [[Build system improvements]])</s>
 +
** (DONE) <s>Decide between CMake and Waf</s>
 +
*** (DONE) <s>Alex will be doing a "neutral party" review of the two</s>  Decision to go with cmake for now.
 +
** (DONE) <s>Get decided system working</s>
 +
*** See [[CMake_Tasks]]
 +
** (DONE) <s>Switch release tools to use new build system</s>  Documented for now; will wait on mechanizing it until after switch to git.
 +
** (DONE) <s>Switch packaging tools to use new build system</s>
 +
** (DONE) <s>Retain Autotools support one final release (legacy support)</s>, then drop next release.
 +
* (DONE) <s>Make the Windows uninstaller work (reevaluate this, we now have msi installer for win32 and Win64)</s>
  
 +
=== 2Geom 1.0 ===
 +
* 2geom maintenance
 +
** Stop embedding 2Geom in Inkscape's codebase; handle it as a regular dependency
 +
** Move project to gitlab, from https://launchpad.net/lib2geom, http://lib2geom.sourceforge.net/, and https://github.com/inkscape/lib2geom [kk]
 +
** Possibly start doing lib2geom releases in conjunction with Inkscape's releases? [bryce]
 +
** Add to PPAs and other CI / autobuilds we already use for Inkscape [alex + bryce]
  
=== Milestone 12 - Inkscape 0.46 ===
+
=== Inkscape 1.0alpha ~ Maintenance and Optimization Focus ===
 +
* (DONE) <s>Migration to Git</s>
 +
* (DONE) <s>Migration to GitLab</s>
 +
* (DONE) <s>Decide which Unit testing framework to use ([http://inkscape.13.x6.nabble.com/Unit-testing-td4967386.html Discussion July 2013 didn't get much traction])</s>
 +
** Hackfest consensus is Google test.
 +
* (DONE) <s>Set up continuous builds (e.g. Travis CI / Appveyor or gitlab)</s>
 +
* (DONE) <s>Make C++11 compiler a hard requirement</s>
 +
* (DONE) <s>Drop Autotools support (See [[Build system improvements]])</s>
 +
* (DONE) <s>Migrate potrace to be an external dependency</s> Done for 0.92
 +
* (DONE) <s>Gtk3/UI revamp</s> Down to bug fixing and follow-on work
  
New/Changed Dependencies:
+
* Split out less well maintained extensions to an 'extras' package
* Gtk 2.8
+
** Add a test suite that runs each extension against a collection of test documents
 +
** Possibly start doing inkscape-extras releases in conjunction with Inkscape's releases?
 +
** If we don't achieve this by this release, push it to 1.1 or later
 +
* Split tutorials and other content from the main executable, to enable them to be updated independently of our main release process
 +
** Need to investigate where we stand with this, and re-evaluate more precisely what we want to do this release
 +
* Prepatory work for expanded testing
 +
** Document how to do the tests
 +
** Create or identify a good model test case
 +
** Implement example unit tests for:  SP objects, verbs, cmdline options, live effects, UI dialogs, UI widgets/tools, UI view, etc.
 +
** Start collecting regression svg files in a testing repository somewhere
 +
* Thorough testing of document recovery after crash.  Make this more robust.
 +
** Need to better define what we want to test
 +
** How should the crash be triggered?
 +
** What should the document be?
 +
** Need to be careful about what cases we actually want to consider
 +
* Improved performance
 +
** with an empty start
 +
** when starting up with an existing file
 +
** peppering printfs in the startup logic shows that some routines that should get called one time only, actually get called multiple times
 +
** need to investigate if there is existing instrumentation tools that could be used to identify recursion or other causes of slowness during startup
 +
* Improved mailing list archive
 +
** Move existing archive to inkscape.org or add an archive mirror at inkscape.org ("official" inkscape information is spread out wide between different domains), this would be an improvement.
 +
** Consider also bringing lib2geom mailing lists?
 +
** inkscape: We need postmaster@inkscape.org and abuse@inkscape.org set up.  Maybe as part of a mailing list refresh?
 +
* Set up effort to package selected branches and organize community testing around them
 +
** Use this initially for changes planned for landing in 1.0
 +
** Once we're feature-frozen for 1.0, use this mechanism for wider testing of new feature work
 +
* Gtk+ 3 migration: Goal is a clean, deprecation-free build
 +
** Stop using GtkActions. Migrate toolbars to use plain widgets, and GAction
 +
** Turn Inkscape into a proper Gtk::Application.  Stop using Gtk::Main
 +
** GtkMM/C++ify and clean up toolbar code
 +
** Remove unused GtkAction-based widgets
  
Architectural Refactoring Effort:
+
=== Inkscape 1.0beta ~ Test Case and Documentation Writing Focus ===
* Eliminate all use of sp_repr_new in favor of XML::Document::* classes (see [http://article.gmane.org/gmane.comp.graphics.inkscape.devel/19068]
+
* Write unit test cases
* Migrate SPObject to native C++ classes
+
** Core functions
* Implement [http://grin-optics.org gradient] UI "release" handler to deal with gradient garbage collection (see bug 984854)
+
* Better translations - keep track of % translations for all languages. Drive to 95% on all major languages.
* Eliminate use of the style.h types in as much of codebase as possible, particularly display/*.
+
* Cleanup website and wiki
* Create an SPObject API for tracking references and avoiding id clashes on import and interdocument copy/paste. What we need are a void SPDocument::importCopies([set of SPObjects]), and an [set of SPObjects] SPObject::dependencies() method.
+
** Move pages of value to users from wiki to the main website
* Replace style.cpp entirely, with a clearer and cleaner version.
+
** Trim down amount of legacy material presented in the wiki
* 2geom Integration
+
* Coder stories
* Cairo Adoption Effort:
+
** different stories about how to do common development tasks, like hooking in a new widget or adding support of a new SVG tag
** Prereq: Is renderer immune to the same kinds of numerical problems we see with our new renderer, libnr, or libart?
+
** have people sketch in what they know, then pass around for critique to optimize the description
** Will the new renderer improve performance for most users?
+
** where to store the documentation?  Where would someone look?
** Integrate a Cairo-based SVG Canvas library
 
  
Codebase Cleanup Effort:
+
=== Inkscape 1.0 ===
* Change to use of GQuarks instead of #defines where feasible
+
* Strict bugfix focus, with all development targeted to feature branches
* Learn and use autoscan and autoreconf to find out which configure tests are still needed.
+
* This will be a long term stable release series
* Clean up configure.in
 
* (PARTIALLY DONE) [[DirectoryReorgProposal]]
 
* Convert all tabs into spaces (convert tabs to 4 spaces)
 
* Rename all '[[SPFooBar]]' routines to '[[FooBar]]' and put into namespaces
 
** (DONE) dialogs folder
 
* Convert use of gboolean to bool where feasible
 
* Switch from use of TRUE/FALSE to true/false
 
  
File Format Support Effort:
+
-----------------------------------
* PDF Import/Export
+
'''Following is a WIP draft of the post-1.0 release goals; this is not yet finalized, and should not be taken as official yet'''
** Identify remaining problems with the Cairo-based PDF tool
+
-----------------------------------
** Ensure clippaths, transparency, bitmaps, etc. all work
 
** Generate multipage PDF documents
 
** Choice of PDF spec. (PDF/X-1a, PDF/X-3)
 
** Define bleed and slug areas for offset printing
 
** Add crop, bleed and registration marks
 
** Add file info/comments
 
** Add color bars
 
* Native Adobe Illustrator file Import/Export
 
** Requires good PDF Import/Export
 
* Native CorelDRAW file Import/Export
 
* Visio support
 
** Add extension for use of [[VDX2SVG]] (http://vdxtosvg.sourceforge.net/)
 
** Add extension for use of [[PDF2SVG]] (http://www.solidcode.net/pdf2svg/ - this doesn't actually link to a useful page)
 
* DXF import/export
 
* gdkpixbuf(?) - would give JPEG support
 
  
Extensions Effort:
+
=== Inkscape 1.1 ~ New Features ===
* Implement extension API
+
* Land feature branches held for post-1.0
* Implement extension registry
+
* SVG Flowed Text
* Complete Extension preferences dialog
+
** Fix flowtext
* Dia-like smart shapes support
+
** Implement SVG 2 flowed text which has a natural SVG 1.1 fallback.
 +
** Ex. https://dl.dropboxusercontent.com/u/65084033/irc/ask-smart-questions.svg
 +
* Externalize some (easy) dependencies for better modularization
 +
** Break libdepixelize out to its own library
 +
** Break libnrtype out to its own library
 +
** Break libuemf out to its own library
 +
** Switch to using libcroco as a regular dependency (not embedded in our codebase).
 +
*** Contact maintainer to see if still actively maintaining, and if can roll a new release for us
 +
*** Else, consider adopting maintenance of the library under the Inkscape project umbrella
 +
*** Or consider replacement with libcss or other CSS parser.
 +
*** See http://inkscape.13.x6.nabble.com/Should-inkscape-take-over-libcroco-td2784457.html
 +
** Switch to using Adaptagrams (libvpsc, libcola & libavoid) as a regular dependency
 +
*** Contact maintainer to see if still actively maintaining, and if can roll a new release for us
 +
*** Else, consider adopting maintenance of the library under the Inkscape project umbrella
 +
*** See https://bugs.launchpad.net/inkscape/+bug/1353833
 +
* Complete conversion to GTK 3
 +
** Drop use of libgdl in place of GtkNotebook
 +
** Be smarter about toolbar layout so we never have invisible (but necessary) buttons off the screen.
 +
** Rework panels so that they resize consistently and display contents better.  Consider moving back to dialogs in some cases or moving more functionality to the canvas.
 +
* Begin development of new plugin / extension system(s)
 +
** C++ API with Python bindings
 +
** Review the D-Bus scripting API GSoC work from 0.48 timeframe
 +
** Easy to create
 +
** Powerful enough to do LPEs, filters, etc.
 +
** Probably need several different APIs for different levels in the codebase, such as atop the object model, one for canvas stuff, one atop the UI, etc.
 +
*** For object layer will require better division from UI, so it doesn't require a selection for items to operate on
 +
** Include a debug print of the loaded extensions/plugins/etc.
 +
** Establish an Extensions Center for community-collaborative sharing/reviewing/maintaining extensions
 +
*** Core extensions are shipped with Inkscape
 +
*** User review ranking
 +
*** Developer review ranking
 +
*** Auto-QC ranking (mechanical testing, and checking for docs, test cases, etc.)
 +
** Search the Extensions Center and install from within Inkscape
 +
* Switch to using Poppler's API rather than using internals (the current situation causes regular breakage with new releases of Poppler)
 +
* [[GtkMMification]]
 +
* Improved performance
 +
** Working with large files
 +
** Working with files with lots of filters
 +
* Consider setting up workflow (passing tests, test coverage, code review) for getting code into trunk.
 +
** Improve new contributor experience for getting patch reviews
 +
** Switch patch review software from launchpad to something like mailing list + patchwork, or phabricator
 +
* make msi Windows install multilingual
 +
* Implement application-scope actions and "remixable" user interfaces:
 +
** Replace "Verbs" with application-scope Gio::Action definitions.
 +
** Define user-interface using Gtk::Builder XML files.
 +
** Provide command-line "headless" access to application actions.
 +
** Provide documentation for all actions, and tutorial for GUI customization
  
User Interface Effort:
+
=== Inkscape 1.2 ~ Refactoring ===
* Object-to-object snapping
+
* Split backend / GUI frontend
* Enhanced grid system
+
* Flip y-coordinate to match SVG.
* improvement of svg patterns UI - make it similar to gradient-drag, instead of piggybacking knotholder
+
** Introduce a backwards compatibility mechanism that will allow us to modify the XML representation of editing info. This is needed to bring the desktop coordinate system in line with SVG due to guideline and 3D box problems (they save desktop coordinates in the XML). This can be done either at the SP tree level or by moving to a SAX-based parser which updates the editing information as the document is parsed.
* Palettes
 
** Custom palettes like from Gnome
 
** Ability to load 3rd-party palettes (e.g. Pantone, Trumatch, Focoltone, Toyo, etc.)
 
* Implement [[LittleCMS]] as color management system
 
* Implement iso & hex grid
 
* Editable toolbars (libegg)
 
* Reenable fuzzy font matching [bb]
 
* Improve freehand curve smoothness [pjrm, paraprax]
 
* Geometrical constraints
 
** "Perpendicular-to", "Parallel-to", etc.
 
* Path trimming/extending/offset
 
* Filleting tool
 
  
Desktop Integration Effort:
 
* [[WebDAV/FTP]] support via GNOME-VFS, Neon, or the like
 
* Make printing work more efficiently and reliably
 
* Inter-application cut-and-paste
 
* Inter-application drag-and-drop
 
* Clipart manager GUI
 
 
Testing Effort:
 
* Include some rendering tests in `make check'.
 
* Get 'make check' to pass on Win32 and OSX
 
* Investigate performance measurement testing for Inkscape
 
 
Animation Effort
 
* Prereq: We need a conceptualization of how it should work
 
* Currently, part of the concept discussion is at [[Animation-(Timeline)|here]]
 
 
SVG Feature Compliance Effort:
 
* Ability to select which SVG spec version to save as
 
* Multi-page
 
* Animation
 
* Implement perspective transformations via [[PerspectiveObject]]
 
* Scripting
 
* Path editing
 
* Shaped strokes
 
* Markers
 
** Inherit stroke properties like color
 
** On-canvas editing
 
** Fix snapping issue
 
* Masking/clippaths
 
** on-canvas editing
 
** Should work like gradient tool to apply transparency
 
* [http://sourceforge.net/tracker/index.php?func=detail&aid=893812&group_id=93438&atid=604309 hyperlinking]
 
* Ensure Inkscape does not throw away the internal DTD subsets of documents it reads
 
* Real CMYK / LAB / HSB support
 
 
Inkboard Effort
 
* Stabilize the code by closing crash bugs in the bug tracker
 
* Ensure multi-user conferences work across most JEP-compliant Jabber servers
 
* Conduct an informal security analysis of Inkboard for security flaws
 
 
=== Milestone 13 - Inkscape 0.47 ===
 
 
New/Changed Dependencies:
 
* Gtk 2.10
 
 
=== Milestone 14 - Inkscape 0.48 ===
 
=== Milestone 15 - Inkscape 0.49 ===
 
=== Milestone 16 - Inkscape 0.50 - SVG Mobile Support ===
 
=== Milestone 17 - Inkscape 0.51 ===
 
=== Milestone 18 - Inkscape 0.52 ===
 
=== Milestone 19 - Inkscape 0.53 ===
 
=== Milestone 20 - Inkscape 0.54 ===
 
=== Milestone 21 - Inkscape 0.55 ===
 
 
=== ??? - Inkscape 1.00 - Full SVG 1.1 support ===
 
 
=== Milestone [Future] ===
 
  
 
[[Category:Developer Documentation]]
 
[[Category:Developer Documentation]]

Latest revision as of 20:21, 8 April 2018

This is a working document showing specific near-term tasks needed for achieving the numbered milestones. It is not a wishlist of features to be included in future releases. Because people often work on whatever they feel like, only the current and current+1 releases should be taken seriously. Beyond that is mainly conjectural.

See OldRoadmap for milestones that have already been achieved.

Inkscape 0.92 ~ Infrastructure Focus

2Geom 1.0

Inkscape 1.0alpha ~ Maintenance and Optimization Focus

  • (DONE) Migration to Git
  • (DONE) Migration to GitLab
  • (DONE) Decide which Unit testing framework to use (Discussion July 2013 didn't get much traction)
    • Hackfest consensus is Google test.
  • (DONE) Set up continuous builds (e.g. Travis CI / Appveyor or gitlab)
  • (DONE) Make C++11 compiler a hard requirement
  • (DONE) Drop Autotools support (See Build system improvements)
  • (DONE) Migrate potrace to be an external dependency Done for 0.92
  • (DONE) Gtk3/UI revamp Down to bug fixing and follow-on work
  • Split out less well maintained extensions to an 'extras' package
    • Add a test suite that runs each extension against a collection of test documents
    • Possibly start doing inkscape-extras releases in conjunction with Inkscape's releases?
    • If we don't achieve this by this release, push it to 1.1 or later
  • Split tutorials and other content from the main executable, to enable them to be updated independently of our main release process
    • Need to investigate where we stand with this, and re-evaluate more precisely what we want to do this release
  • Prepatory work for expanded testing
    • Document how to do the tests
    • Create or identify a good model test case
    • Implement example unit tests for: SP objects, verbs, cmdline options, live effects, UI dialogs, UI widgets/tools, UI view, etc.
    • Start collecting regression svg files in a testing repository somewhere
  • Thorough testing of document recovery after crash. Make this more robust.
    • Need to better define what we want to test
    • How should the crash be triggered?
    • What should the document be?
    • Need to be careful about what cases we actually want to consider
  • Improved performance
    • with an empty start
    • when starting up with an existing file
    • peppering printfs in the startup logic shows that some routines that should get called one time only, actually get called multiple times
    • need to investigate if there is existing instrumentation tools that could be used to identify recursion or other causes of slowness during startup
  • Improved mailing list archive
    • Move existing archive to inkscape.org or add an archive mirror at inkscape.org ("official" inkscape information is spread out wide between different domains), this would be an improvement.
    • Consider also bringing lib2geom mailing lists?
    • inkscape: We need postmaster@inkscape.org and abuse@inkscape.org set up. Maybe as part of a mailing list refresh?
  • Set up effort to package selected branches and organize community testing around them
    • Use this initially for changes planned for landing in 1.0
    • Once we're feature-frozen for 1.0, use this mechanism for wider testing of new feature work
  • Gtk+ 3 migration: Goal is a clean, deprecation-free build
    • Stop using GtkActions. Migrate toolbars to use plain widgets, and GAction
    • Turn Inkscape into a proper Gtk::Application. Stop using Gtk::Main
    • GtkMM/C++ify and clean up toolbar code
    • Remove unused GtkAction-based widgets

Inkscape 1.0beta ~ Test Case and Documentation Writing Focus

  • Write unit test cases
    • Core functions
  • Better translations - keep track of % translations for all languages. Drive to 95% on all major languages.
  • Cleanup website and wiki
    • Move pages of value to users from wiki to the main website
    • Trim down amount of legacy material presented in the wiki
  • Coder stories
    • different stories about how to do common development tasks, like hooking in a new widget or adding support of a new SVG tag
    • have people sketch in what they know, then pass around for critique to optimize the description
    • where to store the documentation? Where would someone look?

Inkscape 1.0

  • Strict bugfix focus, with all development targeted to feature branches
  • This will be a long term stable release series

Following is a WIP draft of the post-1.0 release goals; this is not yet finalized, and should not be taken as official yet


Inkscape 1.1 ~ New Features

  • Land feature branches held for post-1.0
  • SVG Flowed Text
  • Externalize some (easy) dependencies for better modularization
    • Break libdepixelize out to its own library
    • Break libnrtype out to its own library
    • Break libuemf out to its own library
    • Switch to using libcroco as a regular dependency (not embedded in our codebase).
    • Switch to using Adaptagrams (libvpsc, libcola & libavoid) as a regular dependency
  • Complete conversion to GTK 3
    • Drop use of libgdl in place of GtkNotebook
    • Be smarter about toolbar layout so we never have invisible (but necessary) buttons off the screen.
    • Rework panels so that they resize consistently and display contents better. Consider moving back to dialogs in some cases or moving more functionality to the canvas.
  • Begin development of new plugin / extension system(s)
    • C++ API with Python bindings
    • Review the D-Bus scripting API GSoC work from 0.48 timeframe
    • Easy to create
    • Powerful enough to do LPEs, filters, etc.
    • Probably need several different APIs for different levels in the codebase, such as atop the object model, one for canvas stuff, one atop the UI, etc.
      • For object layer will require better division from UI, so it doesn't require a selection for items to operate on
    • Include a debug print of the loaded extensions/plugins/etc.
    • Establish an Extensions Center for community-collaborative sharing/reviewing/maintaining extensions
      • Core extensions are shipped with Inkscape
      • User review ranking
      • Developer review ranking
      • Auto-QC ranking (mechanical testing, and checking for docs, test cases, etc.)
    • Search the Extensions Center and install from within Inkscape
  • Switch to using Poppler's API rather than using internals (the current situation causes regular breakage with new releases of Poppler)
  • GtkMMification
  • Improved performance
    • Working with large files
    • Working with files with lots of filters
  • Consider setting up workflow (passing tests, test coverage, code review) for getting code into trunk.
    • Improve new contributor experience for getting patch reviews
    • Switch patch review software from launchpad to something like mailing list + patchwork, or phabricator
  • make msi Windows install multilingual
  • Implement application-scope actions and "remixable" user interfaces:
    • Replace "Verbs" with application-scope Gio::Action definitions.
    • Define user-interface using Gtk::Builder XML files.
    • Provide command-line "headless" access to application actions.
    • Provide documentation for all actions, and tutorial for GUI customization

Inkscape 1.2 ~ Refactoring

  • Split backend / GUI frontend
  • Flip y-coordinate to match SVG.
    • Introduce a backwards compatibility mechanism that will allow us to modify the XML representation of editing info. This is needed to bring the desktop coordinate system in line with SVG due to guideline and 3D box problems (they save desktop coordinates in the XML). This can be done either at the SP tree level or by moving to a SAX-based parser which updates the editing information as the document is parsed.