TODOs¶
High-level TODOlist¶
Todo
Content
0th pass:
Observe every single function in Inkscape
Sort into sections (by largely grouping them, e.g. shapes, paths, extensions, dialogs, etc.)
1st pass:
Add content
Add missing sections as we go
Identify recurring concepts
Add screenshot placeholders
2nd pass:
Add concepts section and chapter, add screenshot placeholders
Add content for missing sections
Identify areas needing expertise, make connections
3rd pass:
Add all screenshots
Interview or seek help from professionals on areas needing expertise
Fill in those content
Grep for common motifs, make a glossary
Make an index page
4th pass (stable bugfix branch after):
Pass a round of proofreading (with people other than myself)
Clarification and bugfixing
5th pass
Start translation infra of stable bugfix branch
Invite people to translate
Work on the Trad. Chi version (shouldn’t be too hard with DeepL)
6th pass (release coordination after):
Swap out screenshots needing updates for 1.5
Last minute checks (make checklist)
Work with translators to finalize translations
Infra
Write a extension role to load icons on demand
Write a extension directive to load artwork at build time
Add Gitlab CI for builds
Add PDF format
Add EPUB format
Write a version and language selector via ReadTheDocs API
Add selector at build time so the API doesn’t need to be called
TODOlist From All Files¶
Todo
Rewrite this to fit Inkscape
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/contribute/manual/guidelines/writing.rst, line 5.)
Todo
Insert troubleshooting section link here when done.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/contribute/manual/guidelines/writing.rst, line 61.)
Todo
Insert troubleshooting section link here when done.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/contribute/manual/guidelines/writing.rst, line 91.)
Todo
Content
0th pass:
Observe every single function in Inkscape
Sort into sections (by largely grouping them, e.g. shapes, paths, extensions, dialogs, etc.)
1st pass:
Add content
Add missing sections as we go
Identify recurring concepts
Add screenshot placeholders
2nd pass:
Add concepts section and chapter, add screenshot placeholders
Add content for missing sections
Identify areas needing expertise, make connections
3rd pass:
Add all screenshots
Interview or seek help from professionals on areas needing expertise
Fill in those content
Grep for common motifs, make a glossary
Make an index page
4th pass (stable bugfix branch after):
Pass a round of proofreading (with people other than myself)
Clarification and bugfixing
5th pass
Start translation infra of stable bugfix branch
Invite people to translate
Work on the Trad. Chi version (shouldn’t be too hard with DeepL)
6th pass (release coordination after):
Swap out screenshots needing updates for 1.5
Last minute checks (make checklist)
Work with translators to finalize translations
Infra
Write a extension role to load icons on demand
Write a extension directive to load artwork at build time
Add Gitlab CI for builds
Add PDF format
Add EPUB format
Write a version and language selector via ReadTheDocs API
Add selector at build time so the API doesn’t need to be called
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/contribute/manual/todolist.rst, line 8.)
Todo
Revisit this later, when Object Properties chapter has been written [No object properties currently]
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/3d-boxes.rst, line 371.)
Todo
revisit this part at a later point when the Object Properties chapter is done. New in 1.5, Fill and Stroke properties not yet available
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/ellipses-and-arcs.rst, line 144.)
Todo
Examples{link} using the Ellipse/Arc tool
Ellipses as thought bubble
Circle as 3D shaded sphere
Pie chart
Snowman
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/ellipses-and-arcs.rst, line 193.)
Todo
[image] example GIF of drawing a rectangle.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/index.rst, line 13.)
Todo
[screenshot] screenshot of the tool controls bar.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/index.rst, line 17.)
Todo
[screenshot] decorative cursor screenshot to the right.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/index.rst, line 20.)
Todo
link to handle accent color in the preferences
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/rectangles.rst, line 77.)
Todo
Inkscape units link
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/rectangles.rst, line 122.)
Todo
revisit this part at a later point when the Object Properties chapter is done.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/rectangles.rst, line 142.)
Todo
See also
Examples{link} using rectangle tool
As a frame
As a background
Square as a circle
A building
A silhouette oceanliner
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/rectangles.rst, line 164.)
Todo
fix this text link, after the Preferences section has been written.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/spirals.rst, line 23.)
Todo
fix this text link, after the Preferences section has been written.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/spirals.rst, line 30.)
Todo
Fix Rotation snap angle link when Preferences section has been written
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/spirals.rst, line 67.)
Todo
revisit this part at a later point when the Object Properties chapter is done. (No object properties currently)
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/spirals.rst, line 124.)
Todo
Examples{link} using spiral tool
Fill/gradient (odd/even)
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/spirals.rst, line 178.)
Todo
revisit this part at a later point when the Object Properties chapter is done.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/stars-and-polygons.rst, line 180.)
Todo
Examples{link} using star tool
Regular star
Flower
Mandala
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/create/shapes/stars-and-polygons.rst, line 220.)
Todo
Add crash dialog screenshot here.
Add home folder term.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/doc-management/backup-recover.rst, line 68.)
Todo
Add welcome dialog with emergency save screenshot here.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/doc-management/backup-recover.rst, line 81.)
Todo
Add link to the UI sections when done
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/doc-management/create-and-open.rst, line 15.)
Todo
Add term tab in glossary
Add links to chapters
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/doc-management/create-and-open.rst, line 27.)
Todo
Test saving in all file formats!
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/doc-management/export/index.rst, line 13.)
Todo
Test saving in all file formats!
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/doc-management/export/save.rst, line 13.)
Todo
link the above to the relevant section in the preferences
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/doc-management/import/images.rst, line 56.)
Todo
system requirements
instructions on downloading stable versions or different builds
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/install/index.rst, line 7.)
Todo
add update instructions
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/install/installing-on-linux.rst, line 46.)
Todo
add update instructions
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/install/installing-on-macos.rst, line 21.)
Todo
add update instructions
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/install/installing-on-windows.rst, line 81.)
Todo
Assess whether this really belongs here (perhaps it should be under UI)– comment from brynn - At first I thought it seems appropriate. But most of it repeats information that was given above. So now I’m thinking it probably is not needed.
Consult someone or the source code for these modes
Add figures for each mode - from brynn - you mean the tiny icon in the corner? I’d keep at the bottom of our todo list
Add display mode popup screenshot
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/canvas/display-modes.rst, line 126.)
Todo
Double-check Find/Replace, Make a Bitmap Copy, - I guessed where these link location will be in the manual. For Select All - fill in the correct Category under Preferences, after those categories have been created. Also delete my comments after those items are fixed.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/menu-bar/edit-menu.rst, line 65.)
Todo
Make sure to use the default version of Inkscape to make screenshots. When there are different icons related to different OS, show all 3 icons. Also make sure the same person makes the “circles and arrows” so that they look consistent throughout the manual.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/menu-bar/index.rst, line 13.)
Todo
Double-check Find/Replace, Make a Bitmap Copy, - I guessed where these link location will be in the manual. For Select All - fill in the correct Category under Preferences, after those categories have been created. Also delete my comments after those items are fixed.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/menu-bar/index.rst, line 146.)
Todo
For all the items above where I wrote “I guessed….” or “not sure….”, we need to decide where these items will be covered in the manual, and correct the links, if I guessed wrong. Don’t forget to delete my comments, after the items are fixed.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/menu-bar/index.rst, line 207.)
Todo
Fill Between Paths might be changed before 1.5 is released. Also find out where Trace Bitmap will be covered in the manual, then make the correct link. Delete comments after items are fixed.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/menu-bar/index.rst, line 396.)
Todo
Fill Between Paths might be changed before 1.5 is released. Also find out where Trace Bitmap will be covered in the manual, then make the correct link. Delete comments after items are fixed.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/menu-bar/path-menu.rst, line 67.)
Todo
For all the items above where I wrote “I guessed….” or “not sure….”, we need to decide where these items will be covered in the manual, and correct the links, if I guessed wrong. Don’t forget to delete my comments, after the items are fixed.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/menu-bar/view-menu.rst, line 57.)
Todo
Double-check the manual locations for the links for the last 7 items. Lines 98 - 111. I’m not sure if I chose the right section/chapters.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/tool-controls-bar/index.rst, line 117.)
Todo
The eye icon has no tooltip, see my note above. Line 221. Also, delete my comment after item is fixed.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/tool-controls-bar/index.rst, line 230.)
Todo
Fix Superscript and Subscript chapters.
I don’t really know what text-orientation-auto means (or does), so I fudged a description - probably should fix.
Probably should double-check all 3 of those orientation things ;-)
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/tool-controls-bar/index.rst, line 645.)
Todo
1 – fix all these links if necessary - I’m not sure where the Paint Bucket tool will be covered in the manual 2 – add the last icon – some kind of reset - waiting for support
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/tool-controls-bar/index.rst, line 816.)
Todo
1 - find out exactly where the Spray tool will live, and fix all the links 2 - double-check No Color Overlaps and Prevent Overlapping Objects
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/tool-controls-bar/index.rst, line 943.)
Todo
Create new chapter in manual. Temporarily used “Zooming and The Zoom Tool”. If it changes, fix all the links.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/tool-controls-bar/index.rst, line 1179.)
Todo
Create new chapter. Temporarily put in Doc Mgmt > Document Setup > Multiple Pages > Pages Tool. Fix all the links if that changes.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/tool-controls-bar/index.rst, line 1217.)
Todo
This doesn’t seem to fit here too - maybe for the user interface chapter – This is brynn answering - well, this IS the Interface chapter - although maybe you mean the introductory Interface chapter? I’m thinking possibly this should be called Canvas Management?? because canvases are organized in tabs and windows. Windows are not really able to be organized. But canvases can be organized. Being called “canvas management”, maybe it would belong as a child of the Canvas chapter? I’m going to attempt a re-write - separately, so your original does not get lost. Uumm, since I dont know how to create a new page, I’m going to write it at the end of this page. When we decide which one to use, we can delete the other.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/window-management.rst, line 10.)
Todo
[screenshot] Add screenshot of the tab bar
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/interface/window-management.rst, line 18.)
Todo
[all the links in the last few paragraphs may need to be fixed later]
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/introduction/how-to-use.rst, line 26.)
Todo
(“Relink to Copied” might be changed to “Switch Clone Source” (due to a bug report I posted) - double-check before publishing, and rewrite if necessary)
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/object-manip/clones/create-and-manage-clones.rst, line 56.)
Todo
make a link to the “Clone Original Path LPE” chapter after that chapter is created
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/object-manip/clones/create-and-manage-clones.rst, line 64.)
Todo
Re-check before publishing. There may be current work on Lock/Hide: https://gitlab.com/inkscape/inbox/-/issues/12903
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/object-manip/copy-paste-delete.rst, line 87.)
Todo
I would like the word “object”, at the end of the first sentence, to be bold – and also to be a link to the glossary. I tried a few different things with ** and the glossary code, but none of them worked. Thanks.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/object-manip/index.rst, line 9.)
Todo
[screenshot] add screenshot of the about dialog here
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/basics/copy-system-info.rst, line 18.)
Todo
Add link to preference reset
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/basics/report-bugs.rst, line 18.)
Todo
Add SVG 1.1 / SVG 2 export options link here
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/basics/svg-and-xml.rst, line 20.)
Todo
[image] Add figure demonstration of vector vs. raster
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/basics/vector-and-raster-graphics.rst, line 13.)
Todo
Add read mores for raster export and image embed/linking in this section
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/basics/vector-and-raster-graphics.rst, line 19.)
Todo
How and why SVG compliance?
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/history.rst, line 17.)
Todo
When are the teams established?
Quick history of community building (forums, mailing lists, chatroom)
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/history.rst, line 26.)
Todo
become a more general illustration/graphic design application
shift to GTK3
quality-of-life additions
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/history.rst, line 38.)
Todo
shift to GTK4
performance regression fixes
UX studies and improvements
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/history.rst, line 47.)
Todo
big ideas such as animation, node graph support, paragraph tools and vector brushes
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/history.rst, line 56.)
Todo
Add the version/language selector and document it here.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/index.rst, line 43.)
Todo
[screenshot] Inkscape gallery screenshot
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/overview/resources/gallery.rst, line 7.)
Todo
Fix the code so that the line above a bullet list is not bold.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/pos-transform/positioning/grids.rst, line 21.)
Todo
Use a screenshot tool that captures the mouse, so that the image will show a mouse hovering over one guideline. Make the mouse hover over the vertical guide. And also include the status bar, in the screenshot. See below.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/pos-transform/positioning/guides.rst, line 14.)
Todo
This video needs to show the mouse, and ideally it should be able to show when the mouse is clicked. Also it needs to show when keys are pressed.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/pos-transform/positioning/guides.rst, line 36.)
Todo
(ltlnx, I’m not flexible on this particular “tiny”) Also, I’d like “anchor point” and “guide origin” above to be bolded. I’m not sure if the ‘term’ code will do that?
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/pos-transform/positioning/guides.rst, line 121.)
Todo
Link to the Preferences section here when done.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/setup/initial-preferences.rst, line 7.)
Todo
after writing Preferences chapter add the link here
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/setup/welcome-dialog.rst, line 36.)
Todo
Fill out the examples.
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/tutorials/quickstart/index.rst, line 12.)
Todo
Research which workflows use Inkscape as part of it
(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/inkscape-ltlnx/checkouts/latest/source/workflows/index.rst, line 7.)