Difference between revisions of "Roadmap"

From Inkscape Wiki
Jump to navigation Jump to search
(→‎2Geom 1.0: Mark tasks as done.)
 
(179 intermediate revisions by 29 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>
  
=== Milestone 10 - RFE's & Extensions Implementation - Inkscape 0.44 ===
+
=== 2Geom 1.0 ===
 +
* 2geom maintenance
 +
** (DONE) <s>Stop embedding 2Geom in Inkscape's codebase; handle it as a regular dependency</s> (https://gitlab.com/inkscape/inkscape/-/merge_requests/2109)
 +
** (DONE) <s>Move project to gitlab, from https://launchpad.net/lib2geom, http://lib2geom.sourceforge.net/, and https://github.com/inkscape/lib2geom [kk]</s> (https://gitlab.com/inkscape/lib2geom)
 +
** 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]
  
New/Changed Dependencies
+
=== Inkscape 1.0alpha ~ Maintenance and Optimization Focus ===
* (DONE) Add libcroco
+
* (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
  
Internals
+
* 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
  
* Implement extension API
+
=== Inkscape 1.0beta ~ Test Case and Documentation Writing Focus ===
* Implement extension registry
+
* Write unit test cases
* Complete Extension preferences dialog
+
** Core functions
* (DONE) Reduce open/total RFE ratio to 55%
+
* Better translations - keep track of % translations for all languages.  Drive to 95% on all major languages.
* masks/clippaths
+
* Cleanup website and wiki
** (DONE)Implement creation
+
** Move pages of value to users from wiki to the main website
** on-canvas editing
+
** Trim down amount of legacy material presented in the 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.
+
* Coder stories
* Implement gradient UI "release" handler to deal with gradient garbage collection (see bug 984854)
+
** different stories about how to do common development tasks, like hooking in a new widget or adding support of a new SVG tag
* improvement of svg patterns UI - make it similar to gradient-drag, instead of piggybacking knotholder
+
** 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?
  
RFE's
+
=== Inkscape 1.0 ===
* [http://sourceforge.net/tracker/index.php?func=detail&aid=893812&group_id=93438&atid=604309 hyperlinking]
+
* Strict bugfix focus, with all development targeted to feature branches
*(DONE, in .43?) tools: add/remove points on path, bezier drag
+
* This will be a long term stable release series
  
Maintenance
+
-----------------------------------
* Learn and use autoscan and autoreconf to find out which configure tests are still needed.
+
'''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'''
* Clean up configure.in
+
-----------------------------------
* (PARTIALLY DONE) [http://inkscape.org/cgi-bin/wiki.pl?DirectoryReorgProposal Directory Reorganization] (rejon)
 
* When run without installing, make it look for icon image file(s) locally so we don't get garbage icons
 
  
Testing
+
=== Inkscape 1.1 ~ New Features ===
* (DONE) Implement tests of Inkscape against the [[W3C]] test suite [rick beton, bryce]
+
* Land feature branches held for post-1.0
* Include some rendering tests in `make check'.
+
* SVG Flowed Text
 +
** Fix flowtext
 +
** 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
  
=== Milestone 11 - Import[[/Export]] Feature Enhancements - Inkscape 0.45 ===
+
=== 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.
  
* integrate [[Googles_Summer_Of_Code]] 2006 work, i.e. [[Filter_Effects|SVG Filters]] and [[User:Daleharvey|formalising the protocol for inkboard communication]]
 
* Make printing work more efficiently and reliably
 
* Enhance file manager
 
* PDF Export
 
* Investigate ps2ai, pstoedit and ai2svg conversion options (potential EPS support?)
 
* Import of native Adobe Illustrator files
 
* Other RFE's related to Import[[/Export]]
 
* Add extension for use of [[VDX2SVG]] (http://vdxtosvg.sourceforge.net/)
 
* Add extension for use of [[PDF2SVG]] (http://www.solidcode.net/pdf2svg/)
 
* [[WebDAV/FTP]] support via GNOME-VFS, Neon, or the like
 
 
=== Milestone 12 - Style Refactoring - Inkscape 0.46 ===
 
 
* Eliminate use of the style.h types in as much of codebase as possible, particularly display/*.
 
* Change to use of GQuarks instead of #defines where feasible
 
* Editable toolbars (libegg)
 
 
=== Milestone 13 - Bug Hunt & RFE's - Inkscape 0.47 ===
 
 
* Reduce open/total RFE ratio to 40%
 
* Reduce open/total bug ratio to 5%
 
 
=== Milestone 14 - Drawing Feature Enhancements - Inkscape 0.48 ===
 
 
* Object-to-object snapping
 
* (DONE) Markers
 
* Enhanced grid system
 
* Inter-application cut-and-paste
 
* Inter-application drag-and-drop
 
* Clipart manager GUI
 
* Hyperlinking
 
* (DONE) Load-from-URL
 
 
=== Milestone 15 - Style Rewrite & libcroco - Inkscape 0.49 ===
 
 
* Replace style.cpp entirely, with a clearer and cleaner version.
 
* (DONE) Integrate use of libcroco for handling Cascading Style Sheets.
 
 
* Palettes
 
 
(suggestion: having custom palletes, like from Gnome )
 
(suggestion: accuraced palettes from colour norms, like Pantone, Trumatch, Focoltone, Toyo, etc. (since lots of people uses it, specially professionally) - problem: some are patented/copyrighted, which seems each norm company like this must be contacted for authorization (?) - as well, is also an open-source colour norm standard welcome? (which works on both video/printing outputs, like Pantone seems to be?) )
 
 
 
=== Milestone 16 - Cairoification - Inkscape 0.50 ===
 
 
* Prereq: Is renderer immune to the same kinds of numerical problems we see with our new renderer, libnr, or libart?
 
* Create a Cairo-based SVG Canvas library
 
 
=== Milestone 17 - Animation Conceptualization - Inkscape 0.51 ===
 
 
* Prereq: We need a conceptualization of how it should work
 
* Currently, part of the concept discussion is at [[Animation-(Timeline)|here]]
 
 
 
=== Milestone 18 - Fonts Revisited - Inkscape 0.52 ===
 
 
* Reenable fuzzy font matching [bb]
 
* (DONE) Bidirectional text in Pango needs attention
 
* (DONE) [[MakeVertical]] in Pango needs attention
 
 
=== Milestone 19 - Palettes - Inkscape 0.53 ===
 
 
* Implement [[LittleCMS]] as color management system
 
* (DONE) Create a swatches dialog
 
 
=== Milestone 20 - Full Animation Support - Inkscape 0.54 ===
 
 
=== Milestone 21 - RFE's - Inkscape 0.55 ===
 
 
* Reduce open/total RFE ratio to 30%
 
 
 
=== Milestone [Future] ===
 
* Investigate performance measurement testing for Inkscape
 
* Convert all tabs into spaces (convert tabs to 4 spaces)
 
* Rename all '[[SPFooBar]]' routines to '[[FooBar]]' and put into namespaces
 
** (DONE) dialogs folder
 
* Investigate SVG docs where SVG is not the default namespace used at the root -- e.g. <svg:svg xmlns:svg="http://...etc"><svg:rect.../><blah></svg:svg> -- <blah> would end up getting shoehorned into the svg namespace
 
* Write an Internal DTD subset describing the custom Inkscape XML elements, for validation against SVG DTD
 
* Ensure Inkscape does not throw away the internal DTD subsets of documents it reads
 
* Start thinking about 1.0 when major functionality gaps are closed ((BASICALLY DONE) layers, (DONE) color palette, (DONE) gradient tool, mask tool, (DONE) patterns, (DONE) text on path and in shape, (DONE) text selection, perspective transforms, SVG filters, scripting, path editing, shaped strokes)
 
* Implement preliminary support for iso & hex grid [njh]
 
* Implement perspective transformations via [[PerspectiveObject]]
 
* Improve freehand curve smoothness [pjrm, paraprax]
 
* Review X1-1GUITest on SF
 
* Review usability links at http://openusability.org/docman/?group_id=52
 
* Review usability links at http://openusability.org/docman/?group_id=57
 
  
 
[[Category:Developer Documentation]]
 
[[Category:Developer Documentation]]

Latest revision as of 19:13, 26 June 2020

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.