Projects - Revision history

PBS: Expand GC section

2025-06-13T11:45:27Z

Expand GC section

← Older revision		Revision as of 11:45, 13 June 2025
Line 20:		Line 20:
	=== Retire Garbage Collector ===		=== Retire Garbage Collector ===

	We use the Boehm garbage collector~~, but for smart pointers we can use~~		We use the Boehm garbage collector in the XML and undo subsystems. This GC usage is likely entirely removable.
	~~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~~

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

PBS: Move SPCurve project to done

2025-06-13T10:20:19Z

Move SPCurve project to done

← Older revision		Revision as of 10:20, 13 June 2025
Line 165:		Line 165:
	priority: Longer term		priority: Longer term

	~~=== Remove SPCurve (refactoring) ===~~

	~~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 term~~
	== Fonts ==		== Fonts ==

Line 431:		Line 424:
	This directory contains strange code which is barely used. The only		This directory contains strange code which is barely used. The only
	class which is actually used is the URI class.		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

Doctormo: Removed cruft

2023-08-31T17:02:42Z

Removed cruft

Show changes

Moini: /* Color Management */

2021-06-03T12:38:06Z

Color Management

← Older revision		Revision as of 12:38, 3 June 2021
Line 334:		Line 334:
	what can or must be done in Inkscape itself. Outline project(s) to implement		what can or must be done in Inkscape itself. Outline project(s) to implement
	the needed changes.		the needed changes.
	See [[Color_management]].		See [[Color_management]] and [[Color Management Planning]] (which represents a head start into this task)

	* Improve support for CMYK/spot colors		* Improve support for CMYK/spot colors

Moini: /* Man page */

2019-05-15T00:18:55Z

Man page

← Older revision		Revision as of 00:18, 15 May 2019
Line 423:		Line 423:

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

Moini: Add manual and man page, small restructuring of documentation parts

2019-05-11T21:54:53Z

Add manual and man page, small restructuring of documentation parts

← Older revision		Revision as of 21:54, 11 May 2019
Line 394:		Line 394:

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

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

	=== Inkscape Widgets Doxygen ===		=== Inkscape Widgets Doxygen ===
Line 411:		Line 407:
	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.		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.

	== ~~Tutorials~~ ==		== 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		* Solicit community-contributed tutorial contributions
	* Introduce new tutorials		* Introduce new tutorials

			=== Man page ===

			* Update man page
			* 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).

BryceHarrington: /* Other Misc. Ideas */

2019-04-19T04:22:28Z

Other Misc. Ideas

← Older revision		Revision as of 04:22, 19 April 2019
Line 609:		Line 609:
	* Improve support for changing the name of the XML element node in response to SP tree changes.		* Improve support for changing the name of the XML element node in response to SP tree changes.
	* Live path effects: investigate extending to cover generic vector transformations (vector effects). Provide live versions of several destructive operations: boolean ops, stroke to path, text to path, etc.		* Live path effects: investigate extending to cover generic vector transformations (vector effects). Provide live versions of several destructive operations: boolean ops, stroke to path, text to path, etc.
	* Mesh gradient support
	* Javascript support		* Javascript support
	* Evaluate pdf exporter to join features from scribus Export		* Evaluate pdf exporter to join features from scribus Export
Line 619:		Line 618:
	** TopDraw		** TopDraw
	* OCR of bitmap traces		* OCR of bitmap traces
			* Excentric radial gradients, see e.g. samples/orav.svg in the distribution. --bb

	= Finished Projects =		= Finished Projects =

CTooley: /* Other */ Adding in a possible future project for someone who's adventurous enough (git integration)

2018-12-06T19:49:10Z

Other: Adding in a possible future project for someone who's adventurous enough (git integration)

← Older revision		Revision as of 19:49, 6 December 2018
Line 602:		Line 602:
	=== Rewrite / reintroduce 3D box ===		=== Rewrite / reintroduce 3D box ===
	** 3-dimensional grid, perspective deformed, with snapping		** 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 ===		=== Other Misc. Ideas ===

BryceHarrington: /* Project Infrastructure */

2018-07-07T20:00:49Z

Project Infrastructure

← Older revision		Revision as of 20:00, 7 July 2018
Line 506:		Line 506:
	== Project Infrastructure ==		== Project Infrastructure ==

	=== ~~Development~~ Project ~~Management System~~ ===		=== Project Services Backup ===

	~~Enhance Inkscape's web tools~~ for ~~managing development projects~~.		Create ansible scripts to install and configure a rsnapshot service for backing up other services hosted at cloudscale.ch. A big part of this task is making step-by-step documentation for non-rsnapshot aware people to easily follow in adding services to the rsnapshot config.

	* Estimation of ~~difficulty: Moderately hard~~		A devel virtual machine will be provided for doing devel/testing of the ansible scripts; this vm can be blown away and rebuilt on request, and will match the provisioning for the production system that this service will be running on.
	* Potential mentors: Bryce Harrington
	* Programming skills needed: Python
	* Prerequisites: Working knowledge of Django web application development

	~~<u>Detailed Description</u>~~		=== Mediawiki Migration ===

	~~Design and implement tools to allow submitting and editing ideas for development projects~~. ~~Create various project listing views that display projects that need further editing, lists of projects meeting various criteria (e~~.g. ~~janitorial, new features, programming language, etc~~.~~), assigned projects, completed projects~~, and ~~so forth~~.		Currently we are hosting wiki.inkscape.org on an antique vm hosted at OSUOSL. This needs to be migrated to hosting at cloudscale.ch, and updated to the latest version of Mediawiki. There are several steps to this project:

	~~This work would be part of a larger, ongoing effort~~ to ~~unify Inkscape's various collections of task ideas into~~ a ~~single system,~~ to ~~make them easier for potential contributors~~ to ~~review and select from~~. ~~Some of this project has already been implemented, so you would be focusing~~ on ~~enhancing its user interfaces~~ to ~~make it more powerful and more broadly usable~~.		1. Create ansible scripting to install mediawiki on a cloudscale.ch vm.
			2. Create scripts to update our existing wiki content to latest mediawiki (hopefully trivial...)
			3. Install mediawiki on cloudscale.ch production vm
			4. Put old wiki into read-only mode
			5. Update wiki content and deploy to production vm
			6. Request DNS change
			7. Announce wiki migration is completed

	~~<u>Use Cases<~~/u>		A devel virtual machine will be provided for doing devel/testing of the ansible scripts; this vm can be blown away and rebuilt on request, and will match the provisioning for the production system that this service will be running on.
	* "Janitorial" tasks suitable for new developers looking for easy ways to get involved in Inkscape development
	* Google Summer of ~~Code Project Ideas (~~this ~~page!!)~~
	* Funded development work, ~~with funds supplied by various fundraisers~~
	* User-supplied requests for ~~feature enhancements~~

	~~<u>Related Material</u>~~		Once we have mediawiki installable via ansible, the next step would be to
	* Current collections of tasks that we ~~want~~ to ~~eventually migrate into this system:~~
	** http://wiki.inkscape.org/wiki/index.php/Janitorial_tasks
	** https://blueprints.launchpad.net/inkscape/
	* [https://inkscape.org/en/support-us/funded-development/ High level specification for the system]
	* [[FundedProjectSystemDevelopment]] related tasks

	=== Content Management for main website ===		=== Content Management for main website ===

	Contact: martin/ryan		Contact: martin/ryan


	== Other ==		== Other ==

BryceHarrington: Add garbage collector task, as discussed with Tav at hackfest

2018-04-08T19:22:01Z

Add garbage collector task, as discussed with Tav at hackfest

← Older revision		Revision as of 19:22, 8 April 2018
Line 34:		Line 34:

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