Inkscape Wiki - User contributions [en]

Contribute to Documentation with reStructuredText

2025-05-27T14:32:45Z

Ltlnx:

To contribute to recent Inkscape documentations, we have to write our docs in [https://de.wikipedia.org/wiki/ReStructuredText reStructuredText] file format (<code>*.rst</code>). It's similar to Markdown, but still different.

The Inkscape documentation is built up on [https://github.com/sphinx-doc/sphinx Sphinx], which is some kind of special engine. To easily contribute without being a professional developer, we can use VSCodium and some plugin to edit those <code>*.rst</code> files and preview (render) them.

=== Install VS Code or VSCodium ===
With VSCodium we can edit <code>*.rst</code> files with ease. There's native syntax highlighting. But we cannot render the final result by default (needs a separate extension).

Downloads:

[https://code.visualstudio.com Visual Studio Code]

[https://vscodium.com VSCodium] (same like Visual Studio Code, but fully Open Source!)
[[File:Esbonio.png|alt=The Esbonio extension on the VSCode marketplace|thumb|The Esbonio extension on the VSCode marketplace]]

=== Install Esbonia Extension ===
This extension is required to render <code>*.rst</code> files. Rendering helps to validate, that the code we wrote is valid before we commit and push to Inkscape repositories. It can show a live HTML preview of the documentation, so the preview contents change whenever the document is updated. Syncronised scrolling between the source and preview is also supported.

Download/Install: https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio

=== Install additional requirements ===
'''Ubuntu:'''

We install Sphinx globally to system, that's why we use the <code>python3-*</code> packages:
sudo apt install python3-sphinx python3-doc8
After this, we have following commands available for CLI also:
sphinx-apidoc sphinx-autogen sphinx-build sphinx-quickstart
''See also https://www.sphinx-doc.org/en/master/usage/installation.html''
=== Clone the documentation ===
cd ~/
git clone https://gitlab.com/inkscape/extensions.git
[[File:Rst-vscodium.png|Live preview of rST files in VSCodium|alt=Live preview of rST files in VSCodium|thumb]]

=== Open the folder within VSCodium ===
... and begin to contribute!
=== Troubleshooting ===

* '''My opened <code>*.rst</code> file is not rendered:''' Opening a single file without an active workspace is not currently supported and will lead to errors, which might not be communicated to the user visually. Open the folder containing your documentation project in VSCode instead!

Contribute to Documentation with reStructuredText

2025-05-27T09:04:15Z

Ltlnx:

To contribute to recent Inkscape documentations, we have to write our docs in [https://de.wikipedia.org/wiki/ReStructuredText reStructuredText] file format (<code>*.rst</code>). It's similar to Markdown, but still different.

The Inkscape documentation is built up on [https://github.com/sphinx-doc/sphinx Sphinx], which is some kind of special engine. To easily contribute without being a professional developer, we can use VSCodium and some plugin to edit those <code>*.rst</code> files and preview (render) them.

=== Install VS Code or VSCodium ===
With VSCodium we can edit <code>*.rst</code> files with ease. There's native syntax highlighting. But we cannot render the final result by default (needs a separate extension).

Downloads:

[https://code.visualstudio.com Visual Studio Code]

[https://vscodium.com VSCodium] (same like Visual Studio Code, but fully Open Source!)
[[File:Esbonio.png|alt=The Esbonio extension on the VSCode marketplace|thumb|The Esbonio extension on the VSCode marketplace]]

=== Install Esbonia Extension ===
This extension is required to render <code>*.rst</code> files. Rendering helps to validate, that the code we wrote is valid before we commit and push to Inkscape repositories. It can show a live HTML preview of the documentation, so the preview contents change whenever the document is updated. Syncronised scrolling between the source and preview is also supported.

Download/Install: https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio

=== Install additional requirements ===
We install Sphinx globally to system, that's why we use the <code>python3-*</code> packages:
sudo apt install python3-sphinx python3-doc8
After this, we have following commands available for CLI also:
sphinx-apidoc sphinx-autogen sphinx-build sphinx-quickstart
''See also https://www.sphinx-doc.org/en/master/usage/installation.html''[[File:Rst-vscodium.png|Live preview of rST files in VSCodium|alt=Live preview of rST files in VSCodium|thumb]]

=== Clone the documentation ===
cd ~/
git clone https://gitlab.com/inkscape/extensions.git

=== Open the folder within VSCodium ===
... and begin to contribute!
=== Troubleshooting ===

* '''My opened <code>*.rst</code> file is not rendered''' Opening a single file without an active workspace is not currently supported and will lead to errors, which might not be communicated to the user visually. Open the folder containing your documentation project in VSCode instead!

Contribute to Documentation with reStructuredText

2025-05-27T09:03:44Z

Ltlnx:

To contribute to recent Inkscape documentations, we have to write our docs in [https://de.wikipedia.org/wiki/ReStructuredText reStructuredText] file format (<code>*.rst</code>). It's similar to Markdown, but still different.

The Inkscape documentation is built up on [https://github.com/sphinx-doc/sphinx Sphinx], which is some kind of special engine. To easily contribute without being a professional developer, we can use VSCodium and some plugin to edit those <code>*.rst</code> files and preview (render) them.

=== Install VS Code or VSCodium ===
With VSCodium we can edit <code>*.rst</code> files with ease. There's native syntax highlighting. But we cannot render the final result by default (needs a separate extension).

Downloads:

[https://code.visualstudio.com Visual Studio Code]

[https://vscodium.com VSCodium] (same like Visual Studio Code, but fully Open Source!)
[[File:Esbonio.png|alt=The Esbonio extension on the VSCode marketplace|thumb|The Esbonio extension on the VSCode marketplace]]

=== Install Esbonia Extension ===
This extension is required to render <code>*.rst</code> files. Rendering helps to validate, that the code we wrote is valid before we commit and push to Inkscape repositories. It can show a live HTML preview of the documentation, so the preview contents change whenever the document is updated. Syncronised scrolling between the source and preview is also supported.

Download/Install: https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio

=== Install additional requirements ===
We install Sphinx globally to system, that's why we use the <code>python3-*</code> packages:
sudo apt install python3-sphinx python3-doc8
After this, we have following commands available for CLI also:
sphinx-apidoc sphinx-autogen sphinx-build sphinx-quickstart
''See also https://www.sphinx-doc.org/en/master/usage/installation.html''[[File:Rst-vscodium.png|Live preview of rST files in VSCodium|alt=Live preview of rST files in VSCodium|thumb|600x600px]]

=== Clone the documentation ===
cd ~/
git clone https://gitlab.com/inkscape/extensions.git

=== Open the folder within VSCodium ===
... and begin to contribute!
=== Troubleshooting ===

* '''My opened <code>*.rst</code> file is not rendered''' Opening a single file without an active workspace is not currently supported and will lead to errors, which might not be communicated to the user visually. Open the folder containing your documentation project in VSCode instead!

Contribute to Documentation with reStructuredText

2025-05-27T09:03:21Z

Ltlnx:

To contribute to recent Inkscape documentations, we have to write our docs in [https://de.wikipedia.org/wiki/ReStructuredText reStructuredText] file format (<code>*.rst</code>). It's similar to Markdown, but still different.

The Inkscape documentation is built up on [https://github.com/sphinx-doc/sphinx Sphinx], which is some kind of special engine. To easily contribute without being a professional developer, we can use VSCodium and some plugin to edit those <code>*.rst</code> files and preview (render) them.

=== Install VS Code or VSCodium ===
With VSCodium we can edit <code>*.rst</code> files with ease. There's native syntax highlighting. But we cannot render the final result by default (needs a separate extension).

Downloads:

[https://code.visualstudio.com Visual Studio Code]

[https://vscodium.com VSCodium] (same like Visual Studio Code, but fully Open Source!)
[[File:Esbonio.png|alt=The Esbonio extension on the VSCode marketplace|thumb|The Esbonio extension on the VSCode marketplace]]

=== Install Esbonia Extension ===
This extension is required to render <code>*.rst</code> files. Rendering helps to validate, that the code we wrote is valid before we commit and push to Inkscape repositories. It can show a live HTML preview of the documentation, so the preview contents change whenever the document is updated. Syncronised scrolling between the source and preview is also supported.

Download/Install: https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio

=== Install additional requirements ===
We install Sphinx globally to system, that's why we use the <code>python3-*</code> packages:
sudo apt install python3-sphinx python3-doc8
After this, we have following commands available for CLI also:
sphinx-apidoc sphinx-autogen sphinx-build sphinx-quickstart
''See also https://www.sphinx-doc.org/en/master/usage/installation.html''

=== Clone the documentation ===
cd ~/
git clone https://gitlab.com/inkscape/extensions.git

=== Open the folder within VSCodium ===
... and begin to contribute![[File:Rst-vscodium.png|Live preview of rST files in VSCodium|alt=Live preview of rST files in VSCodium|thumb|600x600px]]

=== Troubleshooting ===

* '''My opened <code>*.rst</code> file is not rendered''' Opening a single file without an active workspace is not currently supported and will lead to errors, which might not be communicated to the user visually. Open the folder containing your documentation project in VSCode instead!

Contribute to Documentation with reStructuredText

2025-05-27T09:01:28Z

Ltlnx:

To contribute to recent Inkscape documentations, we have to write our docs in [https://de.wikipedia.org/wiki/ReStructuredText reStructuredText] file format (<code>*.rst</code>). It's similar to Markdown, but still different.

The Inkscape documentation is built up on [https://github.com/sphinx-doc/sphinx Sphinx], which is some kind of special engine. To easily contribute without being a professional developer, we can use VSCodium and some plugin to edit those <code>*.rst</code> files and preview (render) them.

=== Install VS Code or VSCodium ===
With VSCodium we can edit <code>*.rst</code> files with ease. There's native syntax highlighting. But we cannot render the final result by default (needs a separate extension).

Downloads:

[https://code.visualstudio.com Visual Studio Code]

[https://vscodium.com VSCodium] (same like Visual Studio Code, but fully Open Source!)
[[File:Esbonio.png|alt=The Esbonio extension on the VSCode marketplace|thumb|The Esbonio extension on the VSCode marketplace]]

=== Install Esbonia Extension ===
This extension is required to render <code>*.rst</code> files. Rendering helps to validate, that the code we wrote is valid before we commit and push to Inkscape repositories. It can show a live HTML preview of the documentation, so the preview contents change whenever the document is updated. Syncronised scrolling between the source and preview is also supported.

Download/Install: https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio

=== Install additional requirements ===
We install Sphinx globally to system, that's why we use the <code>python3-*</code> packages:
sudo apt install python3-sphinx python3-doc8
After this, we have following commands available for CLI also:
sphinx-apidoc sphinx-autogen sphinx-build sphinx-quickstart
''See also https://www.sphinx-doc.org/en/master/usage/installation.html''

=== Clone the documentation ===
cd ~/
git clone https://gitlab.com/inkscape/extensions.git

=== Open the folder within VSCodium and begin to contribute ===
[[File:Rst-vscodium.png|left|Live preview of rST files in VSCodium]]

=== Troubleshooting ===

My opened <code>*.rst</code> file is not rendered

Opening a single file without an active workspace is not currently supported and will lead to errors, which might not be communicated to the user visually. Open the folder containing your documentation project in VSCode instead!

Contribute to Documentation with reStructuredText

2025-05-27T09:00:53Z

Ltlnx: Add media

To contribute to recent Inkscape documentations, we have to write our docs in [https://de.wikipedia.org/wiki/ReStructuredText reStructuredText] file format (<code>*.rst</code>). It's similar to Markdown, but still different.

The Inkscape documentation is built up on [https://github.com/sphinx-doc/sphinx Sphinx], which is some kind of special engine. To easily contribute without being a professional developer, we can use VSCodium and some plugin to edit those <code>*.rst</code> files and preview (render) them.

=== Install VS Code or VSCodium ===
With VSCodium we can edit <code>*.rst</code> files with ease. There's native syntax highlighting. But we cannot render the final result by default (needs a separate extension).

Downloads:

[https://code.visualstudio.com Visual Studio Code]

[https://vscodium.com VSCodium] (same like Visual Studio Code, but fully Open Source!)
[[File:Esbonio.png|alt=The Esbonio extension on the VSCode marketplace|thumb|The Esbonio extension on the VSCode marketplace]]

=== Install Esbonia Extension ===
This extension is required to render <code>*.rst</code> files. Rendering helps to validate, that the code we wrote is valid before we commit and push to Inkscape repositories. It can show a live HTML preview of the documentation, so the preview contents change whenever the document is updated. Syncronised scrolling between the source and preview is also supported.

Download/Install: https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio

=== Install additional requirements ===
We install Sphinx globally to system, that's why we use the <code>python3-*</code> packages:
sudo apt install python3-sphinx python3-doc8
After this, we have following commands available for CLI also:
sphinx-apidoc sphinx-autogen sphinx-build sphinx-quickstart
''See also https://www.sphinx-doc.org/en/master/usage/installation.html''

=== Clone the documentation ===
cd ~/
git clone https://gitlab.com/inkscape/extensions.git

=== Open the folder within VSCodium and begin to contribute ===
[[File:Rst-vscodium.png|left|frame|Live preview of rST files in VSCodium]]

=== Troubleshooting ===

My opened <code>*.rst</code> file is not rendered

Opening a single file without an active workspace is not currently supported and will lead to errors, which might not be communicated to the user visually. Open the folder containing your documentation project in VSCode instead!

File:Esbonio.png

2025-05-27T09:00:10Z

Ltlnx:

The Esbonio extension on the VSCode marketplace.

File:Rst-vscodium.png

2025-05-27T08:58:05Z

Ltlnx:

Screenshot of VSCodium running the reStructuredText plugin.

Inkscape/Contribute to Documentation with reStructuredText

2025-05-27T08:56:18Z

Ltlnx: Ltlnx moved page Inkscape/Contribute to Documentation with reStructuredText to Contribute to Documentation with reStructuredText

#REDIRECT [[Contribute to Documentation with reStructuredText]]

Contribute to Documentation with reStructuredText

2025-05-27T08:56:18Z

Ltlnx: Ltlnx moved page Inkscape/Contribute to Documentation with reStructuredText to Contribute to Documentation with reStructuredText

To contribute to recent Inkscape documentations, we have to write our docs in [https://de.wikipedia.org/wiki/ReStructuredText reStructuredText] file format (<code>*.rst</code>). It's similar to Markdown, but still different.

The Inkscape documentation is built up on [https://github.com/sphinx-doc/sphinx Sphinx], which is some kind of special engine. To easily contribute without being a professional developer, we can use VSCodium and some plugin to edit those <code>*.rst</code> files and preview (render) them.

=== Install VS Code or VSCodium ===
With VSCodium we can edit <code>*.rst</code> files with ease. There's native syntax highlighting. But we cannot render the final result by default (needs a separate extension).

Downloads:

[https://code.visualstudio.com Visual Studio Code]

[https://vscodium.com VSCodium] (same like Visual Studio Code, but fully Open Source!)

=== Install Esbonia Extension ===
This extension is required to render <code>*.rst</code> files. Rendering helps to validate, that the code we wrote is valid before we commit and push to Inkscape repositories. It can show a live HTML preview of the documentation, so the preview contents change whenever the document is updated. Syncronised scrolling between the source and preview is also supported.

Download/Install: [https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio](https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio

=== Install additional requirements ===
We install Sphinx globally to system, that's why we use the <code>python3-*</code> packages:
sudo apt install python3-sphinx python3-doc8
After this, we have following commands available for CLI also:
sphinx-apidoc sphinx-autogen sphinx-build sphinx-quickstart
See also [https://www.sphinx-doc.org/en/master/usage/installation.html](https://www.sphinx-doc.org/en/master/usage/installation.html)

=== Clone the documentation ===
cd ~/
git clone https://gitlab.com/inkscape/extensions.git

=== Open the folder within VSCodium and begin to contribute ===

=== Troubleshooting ===

My opened <code>*.rst</code> file is not rendered

Opening a single file without an active workspace is not currently supported and will lead to errors, which might not be communicated to the user visually. Open the folder containing your documentation project in VSCode instead!

Contribute to Documentation with reStructuredText

2025-05-27T08:53:32Z

Ltlnx: Created page with "To contribute to recent Inkscape documentations, we have to write our docs in [https://de.wikipedia.org/wiki/ReStructuredText reStructuredText] file format (<code>*.rst</code>..."

To contribute to recent Inkscape documentations, we have to write our docs in [https://de.wikipedia.org/wiki/ReStructuredText reStructuredText] file format (<code>*.rst</code>). It's similar to Markdown, but still different.

The Inkscape documentation is built up on [https://github.com/sphinx-doc/sphinx Sphinx], which is some kind of special engine. To easily contribute without being a professional developer, we can use VSCodium and some plugin to edit those <code>*.rst</code> files and preview (render) them.

=== Install VS Code or VSCodium ===
With VSCodium we can edit <code>*.rst</code> files with ease. There's native syntax highlighting. But we cannot render the final result by default (needs a separate extension).

Downloads:

[https://code.visualstudio.com Visual Studio Code]

[https://vscodium.com VSCodium] (same like Visual Studio Code, but fully Open Source!)

=== Install Esbonia Extension ===
This extension is required to render <code>*.rst</code> files. Rendering helps to validate, that the code we wrote is valid before we commit and push to Inkscape repositories. It can show a live HTML preview of the documentation, so the preview contents change whenever the document is updated. Syncronised scrolling between the source and preview is also supported.

Download/Install: [https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio](https://marketplace.visualstudio.com/items?itemName=swyddfa.esbonio

=== Install additional requirements ===
We install Sphinx globally to system, that's why we use the <code>python3-*</code> packages:
sudo apt install python3-sphinx python3-doc8
After this, we have following commands available for CLI also:
sphinx-apidoc sphinx-autogen sphinx-build sphinx-quickstart
See also [https://www.sphinx-doc.org/en/master/usage/installation.html](https://www.sphinx-doc.org/en/master/usage/installation.html)

=== Clone the documentation ===
cd ~/
git clone https://gitlab.com/inkscape/extensions.git

=== Open the folder within VSCodium and begin to contribute ===

=== Troubleshooting ===

My opened <code>*.rst</code> file is not rendered

Opening a single file without an active workspace is not currently supported and will lead to errors, which might not be communicated to the user visually. Open the folder containing your documentation project in VSCode instead!

Inkscape Summit 2025 Nuremberg

2025-04-13T03:49:55Z

Ltlnx: /* Add your ideas here! */

[[File:Inksummit2025.png|left|thumb|150x150px]]
This page details the planning of Inkscape's 2025 summit in Nuremberg, Germany. The hackfest will take place on '''May 24–28, 2025'''. We are looking to bring together a group of '''17 attendees'''. We are fully booked and the number of participants is final now.

This summit takes place directly before the 2025 Libre Graphics Meeting.

Previous events: [[Hackfest2023 Bensberg]], [[Hackfest2019 Saarbrücken]], [[Hackfest2019 SCALE]], [[Hackfest2018 Kiel]], [[Hackfest2018 LGM]], [[Hackfest2018]], [[Hackfest2017]], [[Hackfest2016]], [[Hackfest2015]].
[[Category:Hackfest]]

= Agenda =

=== Add your ideas here! ===

* Bug triaging
** Issue filtering (useful application for AI?)
** Feature requests: how to collect into actionable projects
* Development
** LPE refactoring
** 1.5
*** Selection cues
*** Status bar
** 1.4.1 (1.4.2?)
*** Add Interface test cases (replay certain steps to create an artwork) to check for feature breakage
*** Canvas performance
* Documentation
** Cleaning up documentation (wiki, dev docs, user docs, extension docs)
* Extensions
** "Using Inkscape to make physical things"
*** Have a look at Hatch Embroidery (paid software that has a cool preview feature and thousands of advanced options that are hard to understand)
** svgpie and inkex
*** Separation of concerns? (svgpie for SVG wrangling, inkex for an API to the Inkscape interface)
** async extensions (new extension type in development, enables extensions to receive updated info from the document while running)
* Organization
** Foundation/organization setup (what needs actions/help?)
**Relationship between Inkscape and commercial actors (e.g. advertising companies / developers available for contract work, support contracts)
**Grants program
** Long-term goal setting
* UX
** Charter & policy
** Design discussion
*** Decide which improvements we want to land in 1.5 (high-level)
*** Object properties (for text, for multi-selection)
*** new settings (we have tools, but need all other categories)
*** LPEs and their panels
*** CMYK export workflow
*** Swatches dialog
*** Text tab of Text and Font dialog. What is it's purpose? Can spell-checking be moved completely on-canvas? (There is on-canvas spell checking via the Check Spelling dialog but misspelled words aren't shown unless this dialog is called.)
* Website
** Website working group and charter
** Infrastructure update (less 502s)
** Library update (django 5)
** Design/UX overhaul
** Separate funding page? (Blender, Krita, Thunderbird and KDE have it)

=== Non-Inkscape stuff ===

Ideas for socializing and getting away from screens

* Movies
* Card games
* Pub
* Take a group picture
* ?

Inkscape Summit 2025 Nuremberg

2025-04-02T19:59:47Z

Ltlnx: Add website working group item

[[File:Inksummit2025.png|left|thumb|150x150px]]
This page details the planning of Inkscape's 2025 summit in Nuremberg, Germany. The hackfest will take place on '''May 24–28, 2025'''. We are looking to bring together a group of '''17 attendees'''. We are fully booked and the number of participants is final now.

This summit takes place directly before the 2025 Libre Graphics Meeting.

Previous events: [[Hackfest2023 Bensberg]], [[Hackfest2019 Saarbrücken]], [[Hackfest2019 SCALE]], [[Hackfest2018 Kiel]], [[Hackfest2018 LGM]], [[Hackfest2018]], [[Hackfest2017]], [[Hackfest2016]], [[Hackfest2015]].
[[Category:Hackfest]]

= Agenda =

=== Add your ideas here! ===

* Bug triaging
** Issue filtering (useful application for AI?)
** Feature requests: how to collect into actionable projects
* Development
** LPE refactoring
** 1.5
*** Selection cues
*** Status bar
** 1.4.1 (1.4.2?)
*** Add Interface test cases (replay certain steps to create an artwork) to check for feature breakage
*** Canvas performance
* Documentation
** Cleaning up documentation (wiki, dev docs, user docs, extension docs)
* Extensions
** "Using Inkscape to make physical things"
*** Have a look at Hatch Embroidery (paid software that has a cool preview feature and thousands of advanced options that are hard to understand)
** svgpie and inkex
*** Separation of concerns? (svgpie for SVG wrangling, inkex for an API to the Inkscape interface)
** async extensions (new extension type in development, enables extensions to receive updated info from the document while running)
* Organization
** Foundation/organization setup (what needs actions/help?)
**Relationship between Inkscape and commercial actors (e.g. advertising companies / developers available for contract work, support contracts)
**Grants program
** Long-term goal setting
* UX
** Charter & policy
** Design discussion
*** Object properties (for text, for multi-selection)
*** new settings (we have tools, but need all other categories)
*** LPEs and their panels
*** CMYK export workflow
*** Swatches dialog
*** Text tab of Text and Font dialog. What is it's purpose? Can spell-checking be moved completely on-canvas? (There is on-canvas spell checking via the Check Spelling dialog but misspelled words aren't shown unless this dialog is called.)
* Website
** Website working group and charter
** Infrastructure update (less 502s)
** Library update (django 5)
** Design/UX overhaul
** Separate funding page? (Blender, Krita, Thunderbird and KDE have it)

=== Non-Inkscape stuff ===

Ideas for socializing and getting away from screens

* Movies
* Card games
* Pub
* Take a group picture
* ?

Release notes/1.4.1

2025-04-02T16:45:22Z

Ltlnx: Mac tofu issue is not fixed yet, also update translation languages

{{Box| '''These Release Notes are in Draft Status.'''

Important Links:
* [https://gitlab.com/inkscape/inkscape/commits/1.4.x Commit History Main Program]
* [https://gitlab.com/inkscape/extensions/-/commits/1.4.x Commit History Extensions]
* [https://gitlab.com/inkscape/inkscape-docs/documentation/-/tree/1.4.x Commit History Documentation]

}}

{{Box| Pending questions:

* …
}}

== Release highlights ==

'''Definitely not released yet.'''

== Changes and Bug Fixes ==

Inkscape 1.4.1 is a '''maintenance and bugfix release''', which brings you fixes for many critical or irritating bugs, and even two new features.

The most important fixes and changes in this release are:

* a new splash screen, providing a visual cue while Inkscape loads in the background
* greatly improved Affinity Designer files (.afdesign) import
* more than '''X crash/freeze fixes''', many of which affected PDF import
* improvements to boolean operations
* and almost '''Y more bug fixes'''

=== General User Interface ===

* Some toolbars now have more collapsible groups, allowing Inkscape to fit on 720p screens ([https://gitlab.com/inkscape/inkscape/-/issues/4987 Bug #4987], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6910 MR #6910], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6707, MR #6707]).
* A new splash screen has been added, letting users know that Inkscape is loading. This can be turned off in ''Preference > Interface > Windows > Miscellaneous''
* Closing the welcome dialog does not create a new Window ([https://gitlab.com/inkscape/inbox/-/issues/6746 Bug #6746],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6584, MR #6584]).
* Status bar hint for guides has been updated to show effect of double clicking on guide ([https://gitlab.com/inkscape/inkscape/-/merge_requests/6772 MR #6772]).
* Moving with arrow keys works as expected for non integer values of nudge ([https://gitlab.com/inkscape/inkscape/-/issues/5308 Bug #5308],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6830 MR #6830]).
* Modular grid now renders with inverted y axis ([https://gitlab.com/inkscape/inkscape/-/merge_requests/6917 MR #6917]).

=== Dialogs ===

==== General ====

==== Align and Distribute Dialog ====

* Irrelevant alignment options are now correctly hidden on opening the Align and Distribute dialog ([https://gitlab.com/inkscape/inkscape/-/issues/5187 Bug #5187], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6730 MR #6730]).

==== Export Dialog ====

* Batch Export: Missing directory prompts creation of directory ([https://gitlab.com/inkscape/inkscape/-/merge_requests/6882 MR #6882]).

==== Fill and Stroke Dialog ====

* Colors of Asian patterns can now be changed ([https://gitlab.com/inkscape/inbox/-/issues/9089 Bug #9089],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6748 MR #6748])

==== Layers and Objects Dialog ====

* Several crash fixes ([])
* Children of selected groups now show highlights ()

==== Swatches Dialog ====

* .ase color palettes using the LAB color space are imported correctly ([https://gitlab.com/inkscape/inkscape/-/issues/5372 Bug #5372],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6809 MR #6809])
* loading color palettes through the dialog no longer crashes ([https://gitlab.com/inkscape/inkscape/-/issues/5448 Bug #5448], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6895 MR #6895])

=== Tools ===

==== Calligraphy Tool ====

* Missing end-parentheses in tooltips have been restored [https://gitlab.com/inkscape/inkscape/-/merge_requests/6486 MR #6486]

==== Ellipse Tool ====

* SVG attributes of circles are updated correctly ([https://gitlab.com/inkscape/inbox/-/issues/11365 Bug #11365], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6837 MR #6837])

==== Measure Tool ====

* Measure toolbar no longer has multiple 'Options' popovers ([https://gitlab.com/inkscape/inkscape/-/issues/5160 Bug #5160],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6815 MR #6815])

==== Node Tool ====

* Inkscape no longer crashes on undo after node operations ([https://gitlab.com/inkscape/inkscape/-/issues/4447 Bug #4447],[https://gitlab.com/inkscape/inkscape/-/issues/4599 Bug #4599],[https://gitlab.com/inkscape/inkscape/-/issues/4893 Bug #4893],[https://gitlab.com/inkscape/inkscape/-/issues/5028 Bug #5028],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6701 MR #6701])

==== Text Tool ====

* Inkscape no longer freezes when versions of Noto Color Emoji Fonts containing SVG glyphs are used ([https://gitlab.com/inkscape/inkscape/-/issues/5368 Bug #5368],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6827 MR #6827]).

=== Images ===

* Making a bitmap copy now respects antialias setting ([https://gitlab.com/inkscape/inkscape/-/merge_requests/6925 MR #6925]).

=== Clipboard ===

* Pasting Mesh Gradient no longer crashes ([https://gitlab.com/inkscape/inkscape/-/issues/5350 Bug #5350] [https://gitlab.com/inkscape/inkscape/-/merge_requests/6865 MR #6865])
* Copying clones pointing to objects in a different open document does not crash anymore ([https://gitlab.com/inkscape/inkscape/-/issues/5282 Bug #5282], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6868 MR #6868]).
* Copy-Pasting clones of groups moved to a different layers now works ([https://gitlab.com/inkscape/inkscape/-/issues/5422 Bug #5422],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6921 MR #6921])
* Pasting doesn't open a new window if SVG import mode is set to 'new' ([https://gitlab.com/inkscape/inkscape/-/merge_requests/6929 MR #6929])

=== Import / Export ===

* Inkscape '''no longer crashes''' when '''importing a PDF file''' with '''Type-3/Bitmap Colored fonts''' ([https://gitlab.com/inkscape/inkscape/-/issues/5235 Bug #5235], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6811 MR #6811]).
* PDF import handles consecutive clippings properly ([https://gitlab.com/inkscape/inkscape/-/issues/4135 Bug #4135],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6912 MR #6912]).
* The new PDF importer now handles character and word spacing in text properly ([https://gitlab.com/inkscape/inkscape/-/issues/5367 Bug #5367], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6828 MR #6828]).
* Inkscape now automatically appends the correct extension upon changing file type ([https://gitlab.com/inkscape/inkscape/-/issues/5246 Bug #5246],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6768 MR #6768])
* Links are no longer misplaced when exporting to PDF ([https://gitlab.com/inkscape/inkscape/-/issues/5299 Bug #5299], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6779 MR #6779]).
* Documents with links no longer fail to export under non-English locales ([https://gitlab.com/inkscape/inkscape/-/issues/5354 Bug #5354],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6816 MR #6816]).
* Invalid URIs do not lead to crashes on export ([https://gitlab.com/inkscape/inkscape/-/issues/5249 Bug #5249],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6856 MR #6856]).
* Inkscape defaults to SVG and not WMF if no extension if provided ([https://gitlab.com/inkscape/inkscape/-/issues/5490 Bug #5490],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6952 MR #6952])

=== Path Operations ===

* Boolean operations now respect fill-rule even if it is specified as a separate attribute ([https://gitlab.com/inkscape/inkscape/-/issues/5437 Bug #5437],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6876 MR #6876]).
* Better division for paths containing arcs (circles and ellipses, for example) [https://gitlab.com/inkscape/inkscape/-/issues/2875 Bug #2875],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6152 MR #6152].
* Shape builder no longer deforms circles that intersect with other shapes ([https://gitlab.com/inkscape/inkscape/-/issues/4453 Bug #4453],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6152 MR #6152]).
* Intersection on circles produces better result ([https://gitlab.com/inkscape/inkscape/-/issues/3543 Bug #3543],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6152 MR #6152]).

=== Live Path Effects ===

* Boolean LPE: Difference mode can now handle holes properly ([https://gitlab.com/inkscape/inkscape/-/issues/3265 Bug #3265],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6152 MR #6152])
* Mirror paths LPE can now handle Multipage documents ([https://gitlab.com/inkscape/inkscape/-/issues/5321 Bug #5321],[https://gitlab.com/inkscape/inkscape/-/issues/3648 Bug #3648],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6817 MR #6817])
* Missing parameters in Perspective LPE have been restored ([https://gitlab.com/inkscape/inkscape/-/issues/5297 Bug #5297], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6759 MR #6759])

=== Extensions ===
====New extensions====

* Initial support for import of '''Vectornator / Linearity Curve''' files. The import extensions is under active development. Please report all issues you encounter to [https://gitlab.com/inkscape/extras/extension-curve the repository of the subproject].
* An extension to '''Clean up paths''' was added. The extension removes duplicate nodes and nodes closer than a given threshold. There is also an option to close paths and join subpaths if the nodes are separated by less than given thresholds. The extension can be found in '''Modify Path -> Clean up path'''. Try it out! (MR [https://gitlab.com/inkscape/extensions/-/merge_requests/499 extensions!499])

====Improvements in particular extensions====

* Many new features supported for the import of proprietary '''Affinity Designer''' files, such as:
** more complex vector masks (vector masks of vector masks, vector masks with transparency, multiple vector masks)
** linked and embedded images, including stroke on images
** less nested groups, more natural editing of imported objects
** read additional shapes: Pie, Ring, Polygon (incl. curvature), Cloud, Double star, Square star, Star (rounded tips, curved sides), Crescent, Segment, Heart, Tear
** Invert adjustment
** Symbols
* Various improvements to the '''DXF12 export''': Colors are now included when saving DXF12 files (MR [https://gitlab.com/inkscape/extensions/-/merge_requests/669 extensions!669]) and DXF12 output now supports closed paths (MR [https://gitlab.com/inkscape/extensions/-/merge_requests/673 extensions!673]).
* When loading '''DXF''' files, Inkscape will preserve color in POLYLINE objects. (MR [https://gitlab.com/inkscape/extensions/-/merge_requests/672 extensions!672])
* The '''Printing Marks''' extension now supports negative bleed values. It's useful to specify negative bleed when for example importing an image into inkscape that's prepared with some bleed margin in mind, but without printing marks. You can then specify negative bleed margin so it "cuts in" into the imported image, reflecting its intended bleed margin. (MR [https://gitlab.com/inkscape/extensions/-/merge_requests/666 extensions!666])

* The '''typst formula''' extension was updated to work better with <code>typst>=0.12</code> (MR [https://gitlab.com/inkscape/extensions/-/merge_requests/659 extensions!659])

====Improvements and fixes for all extensions====

* The <code>text-decoration</code> CSS shorthand is now correctly parsed (MR [https://gitlab.com/inkscape/extensions/-/merge_requests/657 extensions!657])
* Fixed a problem with argument parsing on Python 3.14 (MR [https://gitlab.com/inkscape/extensions/-/merge_requests/668 extensions!668])

====Extension Development====

* Added documentation on how to set the icon of an extension in the extension gallery (MR [https://gitlab.com/inkscape/extensions/-/merge_requests/660 extensions!660])
* 3rd-party extension authors can now use inkex's type information more easily (MR [https://gitlab.com/inkscape/extensions/-/merge_requests/674 extensions!674])
* inkex now works with Numpy 2 (MR [https://gitlab.com/inkscape/extensions/-/merge_requests/661 extensions!661])

===Command Line===

* Shell --export-page=all now correctly exports all pages ([https://gitlab.com/inkscape/inkscape/-/issues/4850 Bug #4850], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6833 MR #6833])

===Linux-specific Fixes===

*Printing from Snap Package no longer crashes ([https://gitlab.com/inkscape/inkscape/-/issues/1734 Bug #1734],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6947 MR #6947]).
*Export dialog behaves properly (Snap version) ([https://gitlab.com/inkscape/inkscape/-/issues/3648 Bug #3648], [https://gitlab.com/inkscape/inkscape/-/issues/4015 Bug #4015], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6893 MR #6893]).

=== Windows-specific Fixes===

*Scrolling through fonts with certain fonts installed no longer crashes Inkscape ([https://gitlab.com/inkscape/inkscape/-/issues/4224 Bug inkscape#4224], [https://gitlab.gnome.org/GNOME/pango/-/merge_requests/794 Pango MR #794]).
*The Windows MSI Installer has been upgraded to WiX v4, fixing several issues ([https://gitlab.com/inkscape/inkscape/-/issues/1617 Bug #1617], [https://gitlab.com/inkscape/inkscape/-/issues/1618 Bug #1618], [https://gitlab.com/inkscape/inkscape/-/issues/4679, Bug #4679], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6582 MR #6582], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6576 MR #6576]).
*Page size can now be edited without freezes ([https://gitlab.com/inkscape/inkscape/-/issues/5391 Bug #5391],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6824 MR #6824]).

===macOS-specific Fixes===

*Inkscape doesn't crash when preferences is invoked after closing window ([https://gitlab.com/inkscape/inkscape/-/issues/5484 Bug #5484],[https://gitlab.com/inkscape/inkscape/-/merge_requests/6943 MR #6943]).

===Improvements for development / deployment / testing===

*Failing '''snap package''' builds have been fixed ([https://gitlab.com/inkscape/inkscape/-/merge_requests/6819 MR #6819])

== Translations ==

Several parts of the UI are now translatable now have better context ([https://gitlab.com/inkscape/inkscape/-/merge_requests/6941 MR #6941], [https://gitlab.com/inkscape/inkscape/-/merge_requests/6950 MR #6950]).

The following UI translations received updates:

*Belarusian
*Chinese - simplified
*German
*Polish
*French
*Dutch
*Slovak

The following documentation translations received updates:

*

===Contributing to interface translations===

Want to help with translations? [https://inkscape.org/contribute/translations/ Learn how to help!]

==Documentation==

===Contributing to documentation and documentation translation===

Contributions to the documentation translations, as well as improvements to its contents, are welcome at [https://gitlab.com/inkscape/inkscape-docs/documentation the inkscape-docs repository].

==Other releases==

{{:Release notes}}

Inkscape Summit 2025 Nuremberg

2025-03-28T06:24:31Z

Ltlnx:

[[File:Inksummit2025.png|left|thumb|150x150px]]
This page details the planning of Inkscape's 2025 summit in Nuremberg, Germany. The hackfest will take place on '''May 24–28, 2025'''. We are looking to bring together a group of '''17 attendees'''. We are fully booked and the number of participants is final now.

This summit takes place directly before the 2025 Libre Graphics Meeting.

Previous events: [[Hackfest2023 Bensberg]], [[Hackfest2019 Saarbrücken]], [[Hackfest2019 SCALE]], [[Hackfest2018 Kiel]], [[Hackfest2018 LGM]], [[Hackfest2018]], [[Hackfest2017]], [[Hackfest2016]], [[Hackfest2015]].
[[Category:Hackfest]]

= Agenda =

=== Add your ideas here! ===

* Bug triaging
** Issue filtering (useful application for AI?)
** Feature requests: how to collect into actionable projects
* Development
** LPE refactoring
** 1.5
*** Selection cues
*** Status bar
** 1.4.1 (1.4.2?)
*** Add Interface test cases (replay certain steps to create an artwork) to check for feature breakage
*** Canvas performance
* Documentation
** Cleaning up documentation (wiki, dev docs, user docs, extension docs)
* Extensions
** "Using Inkscape to make physical things"
*** Have a look at Hatch Embroidery (paid software that has a cool preview feature and thousands of advanced options that are hard to understand)
** svgpie and inkex
*** Separation of concerns? (svgpie for SVG wrangling, inkex for an API to the Inkscape interface)
** async extensions (new extension type in development, enables extensions to receive updated info from the document while running)
* Organization
** Foundation/organization setup (what needs actions/help?)
**Relationship between Inkscape and commercial actors (e.g. advertising companies / developers available for contract work, support contracts)
**Grants program
** Long-term goal setting
* UX
** Charter & policy
** Design discussion
*** Object properties (for text, for multi-selection)
*** new settings (we have tools, but need all other categories)
*** LPEs and their panels
*** CMYK export workflow
*** Swatches dialog
*** Text tab of Text and Font dialog. What is it's purpose? Can spell-checking be moved completely on-canvas? (There is on-canvas spell checking via the Check Spelling dialog but misspelled words aren't shown unless this dialog is called.)
* Website
** Infrastructure update (less 502s)
** Library update (django 5)
** Design/UX overhaul
** Separate funding page? (Blender, Krita, Thunderbird and KDE have it)

=== Non-Inkscape stuff ===

Ideas for socializing and getting away from screens

* Movies
* Card games
* Pub
* Take a group picture
* ?

Inkscape Summit 2025 Nuremberg

2025-03-24T15:29:50Z

Ltlnx:

[[File:Inksummit2025.png|left|thumb|150x150px]]
This page details the planning of Inkscape's 2025 summit in Nuremberg, Germany. The hackfest will take place on '''May 24–28, 2025'''. We are looking to bring together a group of '''17 attendees'''. We are fully booked and the number of participants is final now.

This summit takes place directly before the 2025 Libre Graphics Meeting.

Previous events: [[Hackfest2023 Bensberg]], [[Hackfest2019 Saarbrücken]], [[Hackfest2019 SCALE]], [[Hackfest2018 Kiel]], [[Hackfest2018 LGM]], [[Hackfest2018]], [[Hackfest2017]], [[Hackfest2016]], [[Hackfest2015]].
[[Category:Hackfest]]

= Agenda =

=== Add your ideas here! ===

* Bug triaging
** Issue filtering (useful application for AI?)
** Feature requests: how to collect into actionable projects
* Development
** LPE refactoring
** 1.5
*** Selection cues
*** Status bar
** 1.4.1 (1.4.2?)
*** Add Interface test cases (replay certain steps to create an artwork) to check for feature breakage
*** Canvas performance
* Documentation
** Cleaning up documentation (wiki, dev docs, user docs, extension docs)
* Extensions
** "Using Inkscape to make physical things"
*** Have a look at Hatch Embroidery (paid software that has a cool preview feature and thousands of advanced options that are hard to understand)
** svgpie and inkex
*** Separation of concerns? (svgpie for SVG wrangling, inkex for an API to the Inkscape interface)
** async extensions (new extension type in development, enables extensions to receive updated info from the document while running)
* Organization
** Foundation/organization setup (what needs actions/help?)
**Relationship between Inkscape and commercial actors (e.g. advertising companies / developers available for contract work, support contracts)
**Grants program
* UX
** Charter & policy
** Design discussion
*** Object properties (for text, for multi-selection)
*** new settings (we have tools, but need all other categories)
*** LPEs and their panels
*** CMYK export workflow
*** Swatches dialog
*** Text tab of Text and Font dialog. What is it's purpose? Can spell-checking be moved completely on-canvas? (There is on-canvas spell checking via the Check Spelling dialog but misspelled words aren't shown unless this dialog is called.)
* Website
** Infrastructure update (less 502s)
** Library update (django 5)
** Design/UX overhaul
** Separate funding page? (Blender, Krita, Thunderbird and KDE have it)

=== Non-Inkscape stuff ===

Ideas for socializing and getting away from screens

* Movies
* Card games
* Pub
* Take a group picture
* ?

Inkscape Summit 2025 Nuremberg

2025-03-10T06:59:29Z

Ltlnx: Add async extensions item

[[File:Inksummit2025.png|left|thumb|150x150px]]
This page details the planning of Inkscape's 2025 summit in Nuremberg, Germany. The hackfest will take place on '''May 24–28, 2025'''. We are looking to bring together a group of '''17 attendees'''. We are fully booked and the number of participants is final now.

This summit takes place directly before the 2025 Libre Graphics Meeting.

Previous events: [[Hackfest2023 Bensberg]], [[Hackfest2019 Saarbrücken]], [[Hackfest2019 SCALE]], [[Hackfest2018 Kiel]], [[Hackfest2018 LGM]], [[Hackfest2018]], [[Hackfest2017]], [[Hackfest2016]], [[Hackfest2015]].
[[Category:Hackfest]]

= Agenda =

=== Add your ideas here! ===

* Bug triaging
** Issue filtering (useful application for AI?)
** Feature requests: how to collect into actionable projects
* Development
** LPE refactoring
** 1.5
*** Selection cues
*** Status bar
** 1.4.1 (1.4.2?)
*** Add Interface test cases (replay certain steps to create an artwork) to check for feature breakage
*** Canvas performance
* Documentation
** Cleaning up documentation (wiki, dev docs, user docs, extension docs)
* Extensions
** "Using Inkscape to make physical things"
*** Have a look at Hatch Embroidery (paid software that has a cool preview feature and thousands of advanced options that are hard to understand)
** svgpie and inkex
*** Separation of concerns? (svgpie for SVG wrangling, inkex for an API to the Inkscape interface)
** async extensions (new extension type in development, enables extensions to receive updated info from the document while running)
* Organization
** Foundation/organization setup (what needs actions/help?)
**Relationship between Inkscape and commercial actors (e.g. advertising companies / developers available for contract work, support contracts)
**Grants program
* UX
** Charter & policy
** Design discussion
*** Object properties (for text, for multi-selection)
*** new settings (we have tools, but need all other categories)
*** LPEs and their panels
*** CMYK export workflow
*** Swatches dialog
* Website
** Infrastructure update (less 502s)
** Library update (django 5)
** Design/UX overhaul
** Separate funding page? (Blender, Krita, Thunderbird and KDE have it)

Inkscape Summit 2025 Nuremberg

2025-03-07T16:12:53Z

Ltlnx:

[[File:Inksummit2025.png|left|thumb|150x150px]]
This page details the planning of Inkscape's 2025 summit in Nuremberg, Germany. The hackfest will take place on '''May 24–28, 2025'''. We are looking to bring together a group of '''17 attendees'''. We are fully booked and the number of participants is final now.

This summit takes place directly before the 2025 Libre Graphics Meeting.

Previous events: [[Hackfest2023 Bensberg]], [[Hackfest2019 Saarbrücken]], [[Hackfest2019 SCALE]], [[Hackfest2018 Kiel]], [[Hackfest2018 LGM]], [[Hackfest2018]], [[Hackfest2017]], [[Hackfest2016]], [[Hackfest2015]].
[[Category:Hackfest]]

= Agenda =

=== Add your ideas here! ===

* Bug triaging
** Issue filtering (useful application for AI?)
** Feature requests: how to collect into actionable projects
* Development
** LPE refactoring
** 1.5
*** Selection cues
*** Status bar
** 1.4.1 (1.4.2?)
*** Add Interface test cases (replay certain steps to create an artwork) to check for feature breakage
*** Canvas performance
* Documentation
** Cleaning up documentation (wiki, dev docs, user docs, extension docs)
* Extensions
** "Using Inkscape to make physical things"
*** Have a look at Hatch Embroidery (paid software that has a cool preview feature and thousands of advanced options that are hard to understand)
** svgpie and inkex
*** Separation of concerns? (svgpie for SVG wrangling, inkex for an API to the Inkscape interface)
* Organization
** Foundation/organization setup (what needs actions/help?)
**Relationship between Inkscape and commercial actors (e.g. advertising companies / developers available for contract work, support contracts)
**Grants program
* UX
** Charter & policy
** Design discussion
*** Object properties (for text, for multi-selection)
*** new settings (we have tools, but need all other categories)
*** LPEs and their panels
*** CMYK export workflow
*** Swatches dialog
* Website
** Infrastructure update (less 502s)
** Library update (django 5)
** Design/UX overhaul
** Separate funding page? (Blender, Krita, Thunderbird and KDE have it)

Inkscape Summit 2025 Nuremberg

2025-03-07T15:17:27Z

Ltlnx:

[[File:Inksummit2025.png|left|thumb|150x150px]]
This page details the planning of Inkscape's 2025 summit in Nuremberg, Germany. The hackfest will take place on '''May 24–28, 2025'''. We are looking to bring together a group of '''17 attendees'''. We are fully booked and the number of participants is final now.

This summit takes place directly before the 2025 Libre Graphics Meeting.

Previous events: [[Hackfest2023 Bensberg]], [[Hackfest2019 Saarbrücken]], [[Hackfest2019 SCALE]], [[Hackfest2018 Kiel]], [[Hackfest2018 LGM]], [[Hackfest2018]], [[Hackfest2017]], [[Hackfest2016]], [[Hackfest2015]].
[[Category:Hackfest]]

= Agenda =

=== Add your ideas here! ===

* Bug triaging
** Issue filtering (useful application for AI?)
** Feature requests: how to collect into actionable projects
* Development
** 1.5
*** Selection cues
*** Status bar
** 1.4.1 (1.4.2?)
*** Add Interface test cases (replay certain steps to create an artwork) to check for feature breakage
*** Canvas performance
* Documentation
** Cleaning up documentation (wiki, dev docs, user docs, extension docs)
* Extensions
** "Using Inkscape to make physical things"
*** Have a look at Hatch Embroidery (paid software that has a cool preview feature and thousands of advanced options that are hard to understand)
** svgpie and inkex
*** Separation of concerns? (svgpie for SVG wrangling, inkex for an API to the Inkscape interface)
* Organization
** Foundation/organization setup (what needs actions/help?)
**Relationship between Inkscape and commercial actors (e.g. advertising companies / developers available for contract work, support contracts)
**Grants program
* UX
** Charter & policy
** Design discussion
*** Object properties (for text, for multi-selection)
*** new settings (we have tools, but need all other categories)
*** LPEs and their panels
*** CMYK export workflow
*** Swatches dialog
* Website
** Infrastructure update (less 502s)
** Library update (django 5)
** Design/UX overhaul
** Separate funding page? (Blender, Krita, Thunderbird and KDE have it)

Inkscape Summit 2025 Nuremberg

2025-03-06T12:26:35Z

Ltlnx:

[[File:Inksummit2025.png|left|thumb|150x150px]]
This page details the planning of Inkscape's 2025 summit in Nuremberg, Germany. The hackfest will take place on '''May 24–28, 2025'''. We are looking to bring together a group of '''16 attendees'''. We are fully booked and the number of participants is final now.

This summit takes place directly before the 2025 Libre Graphics Meeting.

Previous events: [[Hackfest2023 Bensberg]], [[Hackfest2019 Saarbrücken]], [[Hackfest2019 SCALE]], [[Hackfest2018 Kiel]], [[Hackfest2018 LGM]], [[Hackfest2018]], [[Hackfest2017]], [[Hackfest2016]], [[Hackfest2015]].
[[Category:Hackfest]]

= Agenda =

=== Add your ideas here! ===

* Bug triaging
** Issue filtering (useful application for AI?)
** Feature requests: how to collect into actionable projects
* Development
** 1.5
*** Selection cues
*** Status bar
** 1.4.1 (1.4.2?)
*** Add Interface test cases (replay certain steps to create an artwork) to check for feature breakage
*** Canvas performance
* Documentation
** Cleaning up documentation (wiki, dev docs, user docs, extension docs)
* Extensions
** "Using Inkscape to make physical things"
*** Have a look at Hatch Embroidery (paid software that has a cool preview feature and thousands of advanced options that are hard to understand)
** svgpie and inkex
*** Separation of concerns? (svgpie for SVG wrangling, inkex for an API to the Inkscape interface)
* Organization
** Foundation/organization setup (what needs actions/help?)
**Relationship between Inkscape and commercial actors (e.g. advertising companies / developers available for contract work, support contracts)
**Grants program
* UX
** Charter & policy
** Design discussion
*** Object properties (for text, for multi-selection)
*** new settings (we have tools, but need all other categories)
*** LPEs and their panels
*** CMYK export workflow
*** Swatches dialog
* Website
** Infrastructure update (less 502s)
** Library update (django 5)
** Design/UX overhaul
** Separate funding page? (Blender, Krita, Thunderbird and KDE have it)

Inkscape Summit 2025 Nuremberg

2025-03-05T20:59:12Z

Ltlnx: /* Add your ideas here! */

[[File:Inksummit2025.png|left|thumb|150x150px]]
This page details the planning of Inkscape's 2025 summit in Nuremberg, Germany. The hackfest will take place on '''May 24–28, 2025'''. We are looking to bring together a group of '''16 attendees'''. We are fully booked and the number of participants is final now.

This summit takes place directly before the 2025 Libre Graphics Meeting.

Previous events: [[Hackfest2023 Bensberg]], [[Hackfest2019 Saarbrücken]], [[Hackfest2019 SCALE]], [[Hackfest2018 Kiel]], [[Hackfest2018 LGM]], [[Hackfest2018]], [[Hackfest2017]], [[Hackfest2016]], [[Hackfest2015]].
[[Category:Hackfest]]

= Agenda =

=== Add your ideas here! ===

* Bug triaging
** Issue filtering (useful application for AI?)
* Development
** 1.5
*** Selection cues
*** Status bar
** 1.4.1 (1.4.2?)
*** Add Interface test cases (replay certain steps to create an artwork) to check for feature breakage
*** Canvas performance
* Documentation
** Cleaning up documentation (wiki, dev docs, user docs, extension docs)
* Extensions
** "Using Inkscape to make physical things"
*** Have a look at Hatch Embroidery (paid software that has a cool preview feature and thousands of advanced options that are hard to understand)
** svgpie and inkex
*** Separation of concerns? (svgpie for SVG wrangling, inkex for an API to the Inkscape interface)
* Organization
** Foundation/organization setup (what needs actions/help?)
**Relationship between Inkscape and commercial actors (e.g. advertising companies / developers available for contract work, support contracts)
**Grants program
* UX
** Charter & policy
** Design discussion
*** Object properties (for text, for multi-selection)
*** new settings (we have tools, but need all other categories)
*** LPEs and their panels
*** CMYK export workflow
*** Swatches dialog
* Website
** Infrastructure update (less 502s)
** Library update (django 5)
** Design/UX overhaul
** Separate funding page? (Blender, Krita, Thunderbird and KDE have it)

Inkscape

2025-03-05T19:25:55Z

Ltlnx: Make the hackfests list items

This is a freeform area for Inkscape development and discussion. Curious about [[wiki syntax]]?

{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 33%; background: #EEE; padding: 1em;" |
== Project Info ==
* [http://www.inkscape.org/ Inkscape Homepage]
* [[About Inkscape]]
* [[Features of Inkscape|Features]]
* [[FAQ]] — Frequently Asked Questions
* [[Supported operating systems]]
* [[Tools]] — Supporting Tools and Applications
* [[Galleries]]
* [[Inkscape coverage|Coverage]] — Awards, articles, presentations, books about Inkscape
* [[Inkscape popularity|Popularity]]
* [[Inkscape invariants|Inkscape's Mission]]
* [https://inkscape.org/en/community/ Communication] — How to reach us
* [[Announcement to Sodipodi]] — This started it all
* [[Branding]]
* [[Travel Reimbursement Policy]]
* [[Funded Project System Development]]
* [[:Category:Hackfest|Hackfests]]
** upcoming/proposed events:
*** [[Inkscape Summit 2025 Nuremberg|2025 Nuremberg]]
** past events:
*** [[Hackfest2023_Bensberg|2023 Bensberg]]
*** [[Hackfest2019 SCALE|2019 Pasadena (SCALE)]], [[Hackfest2019 Saarbrücken|2019 Saarbrücken (LGM)]]
*** [[Hackfest2018|2018 Boston]], [[Hackfest2018 LGM|2018 Seville (LGM)]], [[Hackfest2018 Kiel|2018 Kiel]]
*** [[Hackfest2017|2017 Paris]]
*** [[Hackfest2016|2016 Leeds (LGM)]]
*** [[Hackfest2015|2015 Toronto (LGM)]]

| style="width: 33%; padding: 1em;" |

== User Documentation ==
* [[Installing Inkscape|Installation]]
* [[International and Local Communities]]
* [[Inkscape glossary]]
* [[User manual information]] — Where to find the free Inkscape manual and how to contribute to it
* [http://inkscape.org/en/learn/tutorials/ Tutorials]
* [[Inkscape SVG vs. plain SVG]]
* [[Output format requirements]] — What's needed to save in some formats
* [[Extension requirements]] — What's needed to use some extensions (slightly outdated)
* [[Extension reference]] — What each extension does (slightly outdated)
* [[Connector tool tutorial]]
* [[Installing fonts]]
* [[Emergency save]] — Recovery in case Inkscape crashed
* [[Release notes]]
** ''[[Release notes/1.5|Inkscape 1.5]] — development branch''
** '''[[Release notes/1.4|Inkscape 1.4]]''' — ''current stable release branch''
* [[Announcing Releases]] (slightly outdated)
* [[Release Process Debrief]] (slightly outdated)
* [[Tricks and tips]] — Miscellaneous advice, may be slightly outdated
*[[Customizing Inkscape]] – Change icons, shortcuts, menus, toolbars and other parts of the user interface

| style="width: 33%; background: #EEE; padding: 1em;" |

== Help Inkscape Without Coding ==
* [[Help wanted]]
* [[Bug management]]
** [[Projects#Bug_Triage]]
* [[Testing]]
** [[macOS alpha]]
* [[Translation information]]
* [[WebSite]]
* [[Inkscape Classes]]
* [[Conferences]]
* [[Fundraising Ideas]]
* [[Creating Inkscape distributions]] — How to build packages
* [[Updating tracker items]]
* [[Tutorials and help]]
* [[How to start a page]] — How to use the wiki
* [[Creating screencasts]]
* [[About-Screen contest]]
* [[social media|Participate in social media]]
|}

<div style="margin-top: 1em; padding: .5em 1em 1em; border: 1px solid #62C012;">

== Developer Documentation ==
{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 50%; padding-right: 1em;" |
=== First Steps ===
* [[Working with Git]] — How to obtain the source code. A quick start on how to use our version control system.
* [[Compiling Inkscape]]
* [[Developer manual]] — Various important information, be sure to read this before coding
* [[Debugging Inkscape|Debugging]] — Random tips to help debug problems
* [[Janitorial tasks]] — Small tasks that need doing
* [[Doxygen documentation]]
* [[Working with CMake]] — Getting started with CMake coding for configuring and building Inkscape

=== Developer tutorials ===
* [[Architectural overview]] — A high-level look at Inkscape
* [[Preferences subsystem]] — Creating and using preference values

* Extensions
** [[Extension subsystem]] — An overview of the functionality provided by extensions and the possible implementations
** [[Script extensions]] — Extend Inkscape easily using scripting languages (Python, Perl, …)
** [[Python modules for extensions]] — Some helpful routines for use in Python script extensions
** [[INX extension descriptor format]]
* [[Creating Live Path Effects]]
* [[Using libsigc++ signals]]
*[[Windows development on Linux]]

=== User Interface Discussion===
*[[Interface translation]]
* [[Adding interface verbs]]
*[[Accessible graphics]]
*[[Dialogs reorganization]]
*[[Modal interfaces]]
*[[Text usability]] — Text tool and dialog
*[[KeyboardShortcutsToDo]]
**[[Keyboard profiles]] — How you can help
*[[Statusbar API]]
* [[Animation-(Timeline)]]
*[[Free Desktop Graphic Suite]]
*[[Skeletal Strokes]] — Brushes, Strokes, Pressure Sensibility...

| style="width: 50%;" |

===Development Discussion ===
*[[Roadmap]] — Outdated
*[[Tracking Dependencies|Dependencies]] — What libs are needed to build Inkscape
*[[C++20]] — Which C++20 features can be used
*[[New feature proposals]]
* [[Extension architecture proposals]]
*[[Coding Style|Coding Style Discussion]]
*[[File types]]
*[[Creating a multicolor icon|Icons]]
*[[Color management]]
*[[Printing subsystem]]
*[[SVG Tiny Compliance]]
* [[SVG Test Suite Compliance]] — [[W3C]] full test suite
*[[CSS Support]]
*[[Google Summer of Code]]
* [[Improved Media Management]]
*[[UI Mockup Screenshots]]
* [[Swatch Book]]
*[[Tablet Dialog]]
*[[ViewBoxToDo]] — View box support info
* [[Caching]]
*[[Canvas Rendering Profiling]]
*[[UI and Document coordinates‎]]
* [[GtkMMification]] — Replace C boilerplate with gtkmm objects
*[[CMake Tasks]] — Converting the Inkscape build system to CMake
*[[Bug Reporting Workflow]] — Options for improving Inkscape bug workflow from user to developer

===Miscellaneous===
*[[Inkscape-specific XML attributes]] — Documentation of attributes from Inkscape's XML namespace
*[[Environment variables]] — Overview of important environment variables that modify the behavior of Inkscape and its dependencies.
*[[Extension repository]] — An Internet central for Inkscape extensions
*[[Related programs]]
*[[Sponsors list]]
*[[Contracting Process]]
*[[Wiki Playground]]

===[[Lib2geom]]===
*[[Lib2geom]]
*[[Working with 2Geom FAQ]] — Real-life questions answered about using 2Geom in real code
*[[Lib2geom py2geom]] — Python bindings to 2geom. With this you can use the power of 2geom in Python scripts.

===Historical pages===
These pages are outdated, but linked here for posterity.

*[[Working with Bazaar]] — Our former control version system, no longer used. See [[Working with Git]] for current instructions.
* [[Creating a new SPObject]]

|}
</div>

==See also==
*
[[:Category:Wiki Attic|Wiki Attic]] — Pages that are no longer relevant but kept for historical value

__NOTOC__

[[Category:Top level categories]]

Inkscape

2025-03-05T19:18:32Z

Ltlnx: Add Nuremberg link

This is a freeform area for Inkscape development and discussion. Curious about [[wiki syntax]]?

{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 33%; background: #EEE; padding: 1em;" |
== Project Info ==
* [http://www.inkscape.org/ Inkscape Homepage]
* [[About Inkscape]]
* [[Features of Inkscape|Features]]
* [[FAQ]] — Frequently Asked Questions
* [[Supported operating systems]]
* [[Tools]] — Supporting Tools and Applications
* [[Galleries]]
* [[Inkscape coverage|Coverage]] — Awards, articles, presentations, books about Inkscape
* [[Inkscape popularity|Popularity]]
* [[Inkscape invariants|Inkscape's Mission]]
* [https://inkscape.org/en/community/ Communication] — How to reach us
* [[Announcement to Sodipodi]] — This started it all
* [[Branding]]
* [[Travel Reimbursement Policy]]
* [[Funded Project System Development]]
* [[:Category:Hackfest|Hackfests]]
** upcoming/proposed events:
::: [[Inkscape Summit 2025 Nuremberg|2025 Nuremberg]]
** past events:
::: [[Hackfest2023_Bensberg|2023 Bensberg]]
::: [[Hackfest2019 SCALE|2019 Pasadena (SCALE)]], [[Hackfest2019 Saarbrücken|2019 Saarbrücken (LGM)]]
::: [[Hackfest2018|2018 Boston]], [[Hackfest2018 LGM|2018 Seville (LGM)]], [[Hackfest2018 Kiel|2018 Kiel]]
::: [[Hackfest2017|2017 Paris]]
::: [[Hackfest2016|2016 Leeds (LGM)]]
::: [[Hackfest2015|2015 Toronto (LGM)]]

| style="width: 33%; padding: 1em;" |

== User Documentation ==
* [[Installing Inkscape|Installation]]
* [[International and Local Communities]]
* [[Inkscape glossary]]
* [[User manual information]] — Where to find the free Inkscape manual and how to contribute to it
* [http://inkscape.org/en/learn/tutorials/ Tutorials]
* [[Inkscape SVG vs. plain SVG]]
* [[Output format requirements]] — What's needed to save in some formats
* [[Extension requirements]] — What's needed to use some extensions (slightly outdated)
* [[Extension reference]] — What each extension does (slightly outdated)
* [[Connector tool tutorial]]
* [[Installing fonts]]
* [[Emergency save]] — Recovery in case Inkscape crashed
* [[Release notes]]
** ''[[Release notes/1.5|Inkscape 1.5]] — development branch''
** '''[[Release notes/1.4|Inkscape 1.4]]''' — ''current stable release branch''
* [[Announcing Releases]] (slightly outdated)
* [[Release Process Debrief]] (slightly outdated)
* [[Tricks and tips]] — Miscellaneous advice, may be slightly outdated
*[[Customizing Inkscape]] – Change icons, shortcuts, menus, toolbars and other parts of the user interface

| style="width: 33%; background: #EEE; padding: 1em;" |

== Help Inkscape Without Coding ==
* [[Help wanted]]
* [[Bug management]]
** [[Projects#Bug_Triage]]
* [[Testing]]
** [[macOS alpha]]
* [[Translation information]]
* [[WebSite]]
* [[Inkscape Classes]]
* [[Conferences]]
* [[Fundraising Ideas]]
* [[Creating Inkscape distributions]] — How to build packages
* [[Updating tracker items]]
* [[Tutorials and help]]
* [[How to start a page]] — How to use the wiki
* [[Creating screencasts]]
* [[About-Screen contest]]
* [[social media|Participate in social media]]
|}

<div style="margin-top: 1em; padding: .5em 1em 1em; border: 1px solid #62C012;">

== Developer Documentation ==
{| style="width: 100%;"
|- style="vertical-align: top;"
| style="width: 50%; padding-right: 1em;" |
=== First Steps ===
* [[Working with Git]] — How to obtain the source code. A quick start on how to use our version control system.
* [[Compiling Inkscape]]
* [[Developer manual]] — Various important information, be sure to read this before coding
* [[Debugging Inkscape|Debugging]] — Random tips to help debug problems
* [[Janitorial tasks]] — Small tasks that need doing
* [[Doxygen documentation]]
* [[Working with CMake]] — Getting started with CMake coding for configuring and building Inkscape

=== Developer tutorials ===
* [[Architectural overview]] — A high-level look at Inkscape
* [[Preferences subsystem]] — Creating and using preference values

* Extensions
** [[Extension subsystem]] — An overview of the functionality provided by extensions and the possible implementations
** [[Script extensions]] — Extend Inkscape easily using scripting languages (Python, Perl, …)
** [[Python modules for extensions]] — Some helpful routines for use in Python script extensions
** [[INX extension descriptor format]]
* [[Creating Live Path Effects]]
* [[Using libsigc++ signals]]
*[[Windows development on Linux]]

=== User Interface Discussion===
*[[Interface translation]]
* [[Adding interface verbs]]
*[[Accessible graphics]]
*[[Dialogs reorganization]]
*[[Modal interfaces]]
*[[Text usability]] — Text tool and dialog
*[[KeyboardShortcutsToDo]]
**[[Keyboard profiles]] — How you can help
*[[Statusbar API]]
* [[Animation-(Timeline)]]
*[[Free Desktop Graphic Suite]]
*[[Skeletal Strokes]] — Brushes, Strokes, Pressure Sensibility...

| style="width: 50%;" |

===Development Discussion ===
*[[Roadmap]] — Outdated
*[[Tracking Dependencies|Dependencies]] — What libs are needed to build Inkscape
*[[C++20]] — Which C++20 features can be used
*[[New feature proposals]]
* [[Extension architecture proposals]]
*[[Coding Style|Coding Style Discussion]]
*[[File types]]
*[[Creating a multicolor icon|Icons]]
*[[Color management]]
*[[Printing subsystem]]
*[[SVG Tiny Compliance]]
* [[SVG Test Suite Compliance]] — [[W3C]] full test suite
*[[CSS Support]]
*[[Google Summer of Code]]
* [[Improved Media Management]]
*[[UI Mockup Screenshots]]
* [[Swatch Book]]
*[[Tablet Dialog]]
*[[ViewBoxToDo]] — View box support info
* [[Caching]]
*[[Canvas Rendering Profiling]]
*[[UI and Document coordinates‎]]
* [[GtkMMification]] — Replace C boilerplate with gtkmm objects
*[[CMake Tasks]] — Converting the Inkscape build system to CMake
*[[Bug Reporting Workflow]] — Options for improving Inkscape bug workflow from user to developer

===Miscellaneous===
*[[Inkscape-specific XML attributes]] — Documentation of attributes from Inkscape's XML namespace
*[[Environment variables]] — Overview of important environment variables that modify the behavior of Inkscape and its dependencies.
*[[Extension repository]] — An Internet central for Inkscape extensions
*[[Related programs]]
*[[Sponsors list]]
*[[Contracting Process]]
*[[Wiki Playground]]

===[[Lib2geom]]===
*[[Lib2geom]]
*[[Working with 2Geom FAQ]] — Real-life questions answered about using 2Geom in real code
*[[Lib2geom py2geom]] — Python bindings to 2geom. With this you can use the power of 2geom in Python scripts.

===Historical pages===
These pages are outdated, but linked here for posterity.

*[[Working with Bazaar]] — Our former control version system, no longer used. See [[Working with Git]] for current instructions.
* [[Creating a new SPObject]]

|}
</div>

==See also==
*
[[:Category:Wiki Attic|Wiki Attic]] — Pages that are no longer relevant but kept for historical value

__NOTOC__

[[Category:Top level categories]]

Inkscape Summit 2025 Nuremberg

2025-03-05T19:16:59Z

Ltlnx: Create Inkscape summit 2025 page along with basic info

File:Inksummit2025.png

2025-03-05T18:55:06Z

Ltlnx:

Inkscape Summit 2025 placeholder logo

User:Ltlnx

2025-03-05T18:25:01Z

Ltlnx: Add basic info about ltlnx (that's me)

Hi! I'm Wen-Wei Kao, going by the web handle ''ltlnx'' (''litelinux'' at times). You can call me Willy.

I'm from Taichung, Taiwan, and I speak Chinese, English and a little Spanish. I'm an ordinary university student that happen to like graphic design, Linux administration and playing the drums.

Currently I dabble in all areas of Inkscape, though I'm mainly a translator (for Traditional Chinese) and bug triager. I'm also in the process of updating [https://inkscape-manuals.readthedocs.io/ the Beginner's Guide].

Nice to meet you!

Installing Inkscape

2024-09-12T01:04:06Z

Ltlnx: Add a paragraph stating that beta versions can be downloaded from the website

{{Other languages|en=Installing Inkscape}}

This page explains how to install Inkscape, either the stable or the development version. For instructions on how to compile Inkscape from the source code, see [[Compiling Inkscape]].

The latest stable version can always be found on the [https://inkscape.org/release/ Download page]. The latest development versions are available from [https://gitlab.com/inkscape/inkscape/-/commits/master GitLab].
== Installing the stable version ==
=== '''macOS''' ===
DMG files can be downloaded from the [https://inkscape.org/release/ Download page]. Click the box labelled macOS and choose Intel or arm64 architecture. Once the download is complete, installation is the same as for any other DMG.

See also the [https://inkscape.org/learn/faq/#mac-os-x-specific-issues section dedicated to macOS in our FAQ], and the [https://inkscape-manuals.readthedocs.io/en/latest/installing-on-mac.html readthedocs] page for installation on macOS.
=== Linux ===

On most Linux systems, you can use the software installer provided with your system (look for "software" in your start menu) to install Inkscape.

Visit the [https://inkscape.org/release/ Download page] to see a list of other available options and installation methods for each available version.

==== Ubuntu or Debian ====
Probably the easiest way to install on Debian/Ubuntu is to use the <code>apt</code> command.

Open a terminal and type:
sudo apt-get update
sudo apt-get install inkscape

If your Ubuntu version does not have the most recent Inkscape version in its repositories (yet), the next section describes how to use the [https://launchpad.net/~inkscape.dev/+archive/ubuntu/stable stable PPA] to get it.

==== Ubuntu (new stable versions) ====

The most recent version (slightly newer than what is available directly from Ubuntu) is available from our [https://launchpad.net/~inkscape.dev/+archive/ubuntu/stable/ stable PPA] for Ubuntu and derivative Linux distributions:

<pre>
sudo add-apt-repository universe
sudo add-apt-repository ppa:inkscape.dev/stable
sudo apt-get update
sudo apt install inkscape
</pre>

==== openSUSE ====

openSUSE includes Inkscape in the Gnome repositories. The newest version of Inkscape is in Gnome:Apps.
=== Windows ===
You can find the installer on the [http://www.inkscape.org/release/ Download page]. Normally you want to choose "64-bit architecture" and "Windows Installer Package (msi)". Installing should be an easy step-by-step (next-next-finish) process.

== Installing the development version ==
First be warned. Unstable and development mean you likely will encounter crashes, usability problems and sometimes lose data. Ctrl+S will become your friend. If you cannot take this risk, please use the stable version instead.

If you are still reading, you are probably one of the brave ones who wants to be on the bleeding edge. If so, follow the steps below.

'''Don't forget:''' Please help Inkscape by reporting bugs, encouraging developers or fixing bugs yourself. If you find bugs, make sure to include the debug information which can be found in <code>Help > About</code>.

'''Tip:''' If you're looking for a beta release, those can be downloaded from the [https://inkscape.org/release/ Download page]. Find the "Next version preview" option in the Download tab, and proceed like you would with a stable release.

=== '''macOS''' ===
See [[Installing Inkscape#Finding development versions on GitLab|Finding development versions on GitLab]] below for instructions to download the development version, then install it in the same way as the stable version.

=== Linux ===
You can run an [https://appimage.org/ AppImage] of the latest development version on any Linux distribution. See [[Installing Inkscape#Finding development versions on GitLab|Finding development versions on GitLab]] below for instructions on how to download. To run, extract the zip and run the executable inside.

'''Tip:''' If you don't want to trust our executable, you can run it with sandboxing using [https://wiki.archlinux.org/title/Firejail firejail]: <code>firejail --appimage ...</code>.

==== Ubuntu ====
Development versions (inkscape-trunk) are also available from our [https://launchpad.net/~inkscape.dev/+archive/ubuntu/trunk trunk PPA] for Ubuntu and derivative Linux distributions. Follow the commands at https://inkscape.org/release/inkscape-dev/gnulinux/ubuntu/ppa/dl/ .

=== Windows ===

=== 1. Download the latest build ===
Follow the instructions on [https://inkscape.org/release/inkscape-dev/windows/ the inkscape-dev Download page] to download a 7zip file of the latest development build. Save the file (<code>inkscape-....7z</code>) to your Downloads folder.

==== 2. Extract the .7z archive ====
Extract the archive using the [http://www.7-zip.org/ 7zip unpacker]: Open the Downloads folder in Explorer, right-click on the 7zip file and choose 7-Zip → Extract to "inkscape-....".

You will get a directory which contains several files including <code>inkscape.exe</code>.

==== 3. Run inkscape ====
Run the <code>inkscape.exe</code> file by double clicking it. That's it. You can also drag files to <code>inkscape.exe</code> to have these opened.

==== Multiple versions for testing ====
For testing purposes it is good to be able to test multiple versions of Inkscape to find when and where some problem first appeared. For this reason you are able to store and use as many parallel versions of Inkscape as your disk has room for.
== Finding development versions on GitLab ==
Recent development builds can be found using the GitLab CI infrastructure. They do however require clicking through several pages to find:

# Visit https://gitlab.com/inkscape/inkscape/-/commits/master.
# On the the top row of the table, click the green tick on the right. (Lower rows correspond to older versions.)
# On the next page, click the left green tick under stages, and choose the version appropriate for your platform.
# On the next page, click the Download button.

This allows testing not just the latest development version but any earlier version, allowing bugs to be pinpointed to the version that introduced them.

[[File:Gitlab-download-instructions-1.png|alt=Click the green tick with alt text "Pipeline: passed/failed"|none|thumb|Step 2]]
[[File:Gitlab-download-instructions-2.png|alt=Click the leftmost green tick under "stages" with alt text "build passed:failed"|none|thumb|Step 3]]
[[File:Gitlab-download-instructions-3.png|alt=Click the download button|none||thumb|Step 4]]
[[Category:User Documentation]]

WebSite

2024-05-05T07:56:21Z

Ltlnx: Clarify that all pages need republishing

The Inkscape project welcomes contributions to its website at https://inkscape.org/. Your help is valuable in different areas, and this page provides info to guide you.

We always need editors, translators, testers, designers and developers — and if you think you can help in any of those areas, please contact us by sending a mail to the translators' mailing list (for translations) or the documentation mailing list (for website development and contents).

== Editing ==

If you would like to help keep the website up-to-date and constantly look for ways to improve it, by collecting information from various sources and presenting it on the web site, join us in the chat for the [https://chat.inkscape.org/channel/documentation documentation], the [marketing https://chat.inkscape.org/channel/team_vectors] and/or the [https://chat.inkscape.org/channel/team_website website team]. You can support us in various ways: suggest improvements or corrections, write contents about topics that are missing, write news articles and help with ‘marketing’, or join us long-term and help with contents maintenance.

=== General Rules ===

* All content on the website is licensed '''CC-BY-SA and GPLv2 or later'''. You will be required to agree to this license when you first edit a page.
* Don't disrupt existing pages. If you don't know what you want to do yet, then draft the page here on the wiki, Etherpad or in a separate page first.
* No page is precious to any one person. All pages can be edited by any editor and disputes about drafting changes should be brought to the inkscape-docs mailing list or website editor in chief.
* The website's content is usually very flexible to updates, but final decisions by the webmaster must be accepted by all editors.
* Page language in English or translated should keep to the contributors rules. No swearing, no aggressive content and on website pages there should be no opinion.
* Translations should be strictly a translation of the English versions of pages. If there is new content, it should be added to the English page first to keep all versions of the page in sync.
* When you have made a change to the English website that changes the contents (i.e. not correcting grammar or a typo), and thus requires translation, please kindly inform website translators via translators' mailing list of the change you made. Try to finalize your changes to a page, before you call out to them to do their work.

=== User Account ===


Please [https://inkscape.org/user/register/ register] an account using your email address and activate the account. Once active and logged in, please '''subscribe''' to the corresponding mailing list and email either the [https://inkscape.org/community/mailing-lists/ inkscape-docs or the inkscape-translators mailing list] to get more information. For translations, please add some more info to your email, and additionally open a request to join the website translators' team (see Translation section below) and start by contributing to the website's .po file for your language.

If you're approved, your account will then be enabled with the right permissions to add and edit any of the pages on the website. Please take care not to disrupt other content as you edit the website. As before, don't hesitate to ask other website editors on their mailing list if you need help.

If anything goes wrong while you are editing — for example, you encounter a bug, or you accidentally delete something you did not intend to delete, or something weird happens, and you don't know why —, please ask for help on one of the mailing lists — either translators, or inkscape-docs. You can also contact your team admin directly or file a bug report for the website at the [https://gitlab.com/inkscape/inkscape-web/-/issues bug tracker].

=== Using the Website Editor ===

Editors and translators can visit the Inkscape website, log in as themselves and edit and add content to the django content management system (cms). This does not require any code access but does require knowledge of html and staff access plus that you be in the Editors or Translators group to give you all the required permissions.

When you want to edit a page for the first time after the update, you will be asked to agree to publish your work under the website's licence. This will ensure that your work can be built upon by others in a safe manner.

REMEMBER: Your changes are NOT published until you press the publish button on the tool bar! Once a change is published, there is NO WAY TO UNDO it, so check carefully before publishing.

[[File:Toolbar live mode django-cms 3.2.0.png|600px|thumb|center|The toolbar in live mode]]

From the tool bar at the top of the web page you can turn editing on for any cms page you are visiting and edit the content therein. Ask for help if you get lost editing the various sections of the website.

[[File:Double-click.png|130px|thumb|right|Editing the inkscape.org website]]

The screenshot to the right shows a page with the editor mode switched on. As you can see, when your mouse hovers above an editable section of a web page, you are prompted to double-click to edit that page. This allows you to add new content blocks as well as edit existing blocks. Most pages will only have one such section, but the front page has several. If you need a page with a new design that has multiple blocks, please see website development below.

[[File:Toolbar edit mode changes django-cms 3.2.0.png|600px|thumb|center|The toolbar after you have saved your changes]]

The toolbar will indicate when there are changes on a page that can be published. Click on '''Publish changes''' to publish your (or another person's) changes, and / or click on '''View published''' to leave the edit mode.

To learn how to edit and tweak the front page, you can watch this video on YouTube (note: the video shows how this works on an older version of the website's cms, so icons and toolbar will look different):

[[File:Front-page-video.jpg|Watch the video!|thumb|center|link=https://www.youtube.com/watch?v=Rq2EFX9Aw70|[https://www.youtube.com/watch?v=Rq2EFX9Aw70 Click here to watch the video!] (12:36)]]

==== Specific Instructions ====

{| style="float: right;"
|-
| [[File:Create internal link.png|120px|thumb|center|Creating an internal link]] || [[File:Add external link.png|120px|thumb|center|Creating a link to an external page]]
|-
| || [[File:Add an image to website.png‎|120px|thumb|center|Dialog for adding pictures to the website]]
|-
| [[File:TOC icon.png|75px|thumb|center|A TOC plugin in edit mode]] || [[File:Inline TOC.png|120px|thumb|center|An inline TOC (can also be added as a ’sidebar’ on the right)]]
|}

'''Texts''': When you save a text plugin, you will be asked to fill in a short description of your changes at the bottom of the editor window. This little summary will be used for updating others about your changes. Please provide a meaningful message.

[[File:CMS Editor describe changes.png|600px|thumb|center|Add a description of your changes before saving]]

'''External tools''': If you decide to do your translations using your favourite editor, be sure to use a plain text editor for this. Office suites and other word processing tools that support formatting are unsuitable, because they might add additional formatting automatically, which can accidentally end up on the website and break the actual formatting.

'''Links''': To insert a link, use the small chain icon in the editor. The dialog that opens supports looking up pages on the Inkscape website, when you enter a part of the url. Urls on the Inkscape website should always be specified as relative urls, i.e. leave out the 'https://inkscape.org' part, and only use, for example, '/learn/faq/'. You may need to select '<other>' in the protocol dropdown, to not have to insert https etc. We're still trying to figure out how language redirects will work. In the meantime, if you want to add a link to your own language's version of the website, use the language code in the urls, and add the English url after, i.e. '/fr/learn/faq' for the previous example.

'''Images''': Images are plugins. They cannot be copied directly from one page to the other, unless one chooses ‘Copy all plugins from English’ to make a whole new page. To insert an image (raster images only, svg is not supported by our current plugin), choose ‘Picture’ from the plugin dropdown list and fill in the dialog with the necessary info. Don't forget to add licence and attribution info, if applicable. If you want to use a picture that is already used on a different page (e.g. when editing a translation), download that picture to your computer (use your browser's right-click menu for that) and upload it again using the picture plugin dialog.

'''TOC''': The TOC (Table of Contents) plugin can be inserted into pages with long texts to make navigating them easier for users. It will also add little anchor symbols behind all headings on that page, that other people can directly link to.

'''Other plugins''': The CMS widgets come in a number of types. File and Video widgets do as you would expect and allow you to add those media elements.

'''Spell Checking''': Your browser's spell checker will work when editing text. To change the language or access suggested replacements, hold Ctrl down while right-clicking into the text.

==== Known Issues ====

* '''IMPORTANT''': When you click on ‘Publish’ for a page, it may sometimes seem as if nothing happens for a few seconds. Don't click on ‘Publish’ twice, just wait until it starts by itself. Every click on this will send a mail to all subscribers, and add to the server load. Also, incomplete saves have been seen as a result.
* There's a ‘Create’ button now available in the top left. If you are a translator, you will never need this button. It is for creating new, non-translation pages.
* Copy-pasting any plugins, e.g. images or tables of contents (and changing them after this) will result in the plugin source page (i.e. the English page in most cases) being altered. Never copy plugins! Only copy contents using a detour via a '''plain text editor''', i.e. copy the text from a web page, then paste it into, say, Notepad, then copy it from there back into your translation and adjust the formatting manually.
* Hitting ‘Enter’ while editing a plugin in a pop-up dialog may lose previous page edits.
* Sometimes, the ‘Edit’ button is not available. Then you can still edit the page by going to ‘Page -> Edit this Page’ in the toolbar, or add ‘?edit’ to the URL.
* Sometimes, your edits will not be visible in the preview after you clicked on save. In this case, go to 'view published', then switch back to Edit mode. You should be able to see the changes now.
* Sometimes, ‘Publish’ is not available, even if you made changes to some plugins. In this case, go to ‘Page -> Unpublish Page’ in the toolbar, and when it has been unpublished, click on the big blue ‘Publish now’ button to publish.
* On pages with a table of contents plugin, publishing may result in the TOC title being added a second time. The duplicate title can usually just be edited out, and will not be duplicated again the next time you publish. Make sure to not delete the plugin, but just the duplicated heading.

== Translations ==

If you are fluent in a language different from English, please consider joining our [https://inkscape.org/*translator website translators' team]. We strive to make Inkscape accessible for as many people as possible, and internationalization is important to reach this goal.

For being able to translate the CMS contents and the news, you will first need to understand how [[#Editing|editing the website]] works.

=== Translating CMS contents ===

==== Adding a new translation ====

To '''add''' a translation of a page which does not yet exist:

* Navigate to the English page that you want to translate.
* Switch to Edit mode by clicking on the '''Edit''' button ([[Media:CMS toolbar Page Edit.png|Image 1]]).
* Now use the language chooser to switch to your language ([[Media:Select language.png|Image 2]]).
* You should now see a blue '''Page Settings''' button at the right. Click on it. (If there's a button that says 'Create', '''go back to the English page''' and switch to Edit mode. 'Create' will create a new page, not a translation.) ([[Media:CMS toolbar Page Settings button.png|Image 3]]).
* In the '''Page settings''', enter a title for your new translation and click on '''Save''' ([[Media:Add a language 2.png|Image 4]]).
* At first, the new page will be empty. We must now fill it with a copy of the English content. Start by toggling the structure mode view ([[Media:Toggle structure mode website.png|Image 5]]).
* Next, click on the topmost hamburger icon in the structure panel (next to the name of the template that is being used), and select '''Copy from English''' ([[Media:Copy plugins from English.png|Image 6]]).
* The page will now contain the same texts and widgets as the English version does. You can click on the structure toggle icon again to hide the structure overview. To start translating, double-click on a text ([[Media:Double-click to edit.png|Image 7]]).
* An editor window will pop up and you can translate the text ([[Media:Editor window.png|Image 8]]).
* If something does not look correct (for example, because you accidentally deleted a certain html tag), you can choose to edit the html source, too ([[Media:Editor window source.png|Image 9]]).
* When you are done, click on '''Save''' to save your work. Don't forget to leave a comment about your changes ([[Media:Save Edit with comment.png|Image 10]]).
* You can now take a look at your translation and if you are happy with your work, click on the '''Publish''' button at the top of the page. Only this will make your translation available to the site's visitors ([[Media:Publish page.png|Image 11]]).

<gallery>
File:CMS toolbar Page Edit.png|1 — Switch to edit mode in English
File:Select language.png|2 — Switch to your language
File:CMS toolbar Page Settings button.png|3 — Select Page Settings
File:Add_a_language_2.png|4 — Enter title
File:Toggle structure mode website.png|5 — Show page structure
File:Copy plugins from English.png|6 — Copy from English
File:Double-click to edit.png|7 — Double-click to edit plugin
File:Editor_window.png|8 — The editor window in WYSIWYG mode
File:Editor_window_source.png|9 — Editing the html source
File:Save Edit with comment.png|10 — Save your edit
File:Publish page.png|11 — Publish changes
</gallery>

Please note:

* Take extra care to '''always check''' if the language you are editing is the one you actually want to edit. Please '''DO NOT''' translate a piece of text while under English or another language as you will cause trouble for that language.
* Menu entries are translated separately at [https://inkscape.org/admin/el_menu/menuitem/] , and they update with a delay, so don't be surprised if your changes aren't visible right away.

==== Edit an existing translation ====

Many existing translations at inkscape.org are outdated, or contain a copy of an outdated English version. Please, before you start translating, make sure that you actually translate from the '''current''' English version. If the page is very outdated, consider deleting the blocks and copying all plugins from English, as described above in '''Adding a new translation'''.

To '''edit''' an existing translation, just go to the page in your language, toggle the ‘draft’ mode by clicking on the '''Edit''' button in the top bar and double-click on the widget you would like to translate.

If you edit an existing translation, because the English original has changed, you can do the following:

* Open the published English page, and also, in a second tab, your translation, in draft mode.
* Copy the new parts from English by selecting them with the mouse and hitting Ctrl+C.
* If they contain any pictures or other content that is a plugin:
** Paste them '''into a simple text editor''' (Ctrl+V), to remove the formatting and prevent plugins from being used on two different pages at the same time. Copy the clean text from the editor to the clipboard (Ctrl+C). If there are no plugins, you can also paste directly into the editor window.
** Insert this into your existing translation, in the correct place (Ctrl+V).
** Then translate the text and fix the formatting.
** Save.
** Continue with translation :)
* If there are no images, tables of contents or other plugins in the text you want to copy-paste:
** feel free to copy-paste it as a whole into your translation, and to translate in place.

==== Unpublishing ====
If a translated page contains outdated information, you might consider unpublishing it. Before you unpublish, please make sure to send a message to the inkscape-translators mailing list or the chat, to seek approval from other editors.
[[File:Empty all.png|alt=Screenshot of the website with the "Empty all" button highlighted|thumb|The "Empty all" button]]
After you got an approval, you can move on to unpublish the page. To do this:

* Check if the page you're about to unpublish is saved on the [https://web.archive.org Web Archive], to preserve the contents (as we're clearing them in later steps).
*Check if you've switched to the desired language you want to unpublish. You may unpublish pages in other languages if you didn't make sure, so please be extra careful.
*Enter edit mode by going to Page > Edit this page.
* Click Page > Unpublish. This would unpublish the page, but keep the contents.
* Clear the contents by going to the sidebar, and clicking the topmost hamburger menu > Empty all. Click on "Yes, I'm sure" to confirm.
* Re-publish the page by clicking the blue "Publish page" button. '''Make sure to do this''' to ensure that the page contents falls back to English, and in the case of root pages (e.g. [https://inkscape.org/learn/ Learn], [https://inkscape.org/contribute/ Contribute]), that its subpages keep working. Otherwise the page and every subpage of it will become 404 (Page not found).

=== Translating News ===

News are a special case on the Inkscape website. To translate a news article, visit it in your own language, then select ‘News -> Translate News’ in the toolbar at the top.

[[File:Translate news dropdown-fs8.png|600px|thumb|center|News app: Dropdown for translating news. Note that the language you will translate to is the one displayed in your URL.]]

Then a window pops up where you can fill in your translation of the news. The text editor boxes for the excerpt and the news article contents will be pre-filled with the English version. You can also always see the English original when you click on ‘Show’ below the editor box.

Text can be formatted by using the text editor's buttons, links can be added by marking some text and clicking on the link symbol. Edit links by right-clicking on the link, then select ‘Edit link’ from the context menu. Save your translation when you're done.

[[File:Translate news-fs8.png|600px|thumb|center|News app: Translating a news article on the Inkscape website. The slug (last part of the url) must be unique.]]

[[File:Edit news link-fs8.png|300px|thumb|right|News app: Right-click to edit a link]]

==== Known Issues ====

* When you double-click on a link in the news editor, you'll get a popup dialog where you cannot click on anything. If this happens, click on ‘Save’ in the parent dialog to not lose any translated work. Continue editing after this.
* When you save your translation for the first time, you may be redirected to a non-existent page (404 error). To return to the article to continue editing, just remove everything after the last slash in the url, and hit enter. Then select your article on the page where this brought you, and edit it again.
* Always make sure you're on the correct page - always check the language abbreviation in the URL! Do not translate English articles, even if a redirect accidentally brings you there.

=== Translating Download contents ===

You can add translations of [[Release notes]] on this wiki. For this you need an account on the wiki: ask the inkscape-translator mailing list for it if you don't have one. When you're done with your translation, tell the translation administrator by sending an email to inkscape-translator and they'll publish your translation on the website.

The platform names and descriptions as well as the installation instructions for some platforms are translatable from the CMS administration pages. You may or may not have access rights to translate them.

* If you have access rights: go to [https://inkscape.org/admin/releases/platform/ Releases > Platforms]. You'll see a table listing all the nodes of the platform tree. To see the tree more clearly, you can sort the table depending on the codename. From this table, choose the platform you want to translate, and type your translation in a new ‘Platform translation’ at the bottom.
* If you don't have access rights: you can send a text file to the inkscape-translator mailing list containing all your translations, and an authorized translator will set them for you.

=== Translating Menu contents ===

The menu items are translatable from the CMS administration pages.

* If you have access rights: go to [https://inkscape.org/admin/el_menu/menuitem/ EL_MENU > Menu items]. All menu items are listed here, you can use the "FILTER" on the right panel and select "Main Menu" under "By category". Select the menu you want to translate, then in the last row under "MENU TRANSLATIONS" (the last row is blank), choose the language and type the URL and your translation. Save to finish this translation.
* If you don't have access rights: you can send your translation in a text file to the inkscape-translator mailing list, and an authorized translator will set them for you. Please prepare the text file with a list of the following format:

<code>English menu entry, url, translated menu entry</code> 
(one line per entry)

e.g.

<pre>
Forums, /forums, Foren
Overview, /about/overview/, Übersicht
</pre>

=== Translating other parts of the website ===

There are a lot of other translatable sentences and phrases on the Inkscape website, which cannot be translated directly on the website itself. Those include words such as ‘Log in’, ‘Register’, ‘Confirm’ and ‘Save’.

If your language is not yet available on our website, you're still very welcome to help! In this case please file a [https://gitlab.com/inkscape/inkscape-web/-/issues bug report]. Then we can prepare the website for your changes and make the translation file available, so you can start working on it.

You can download the PO file for your language from the [https://gitlab.com/inkscape/inkscape-web-i18n website's translation repository]. See [[Translation information#PO translation files|here]] for info about how to deal with PO files.

When you are done, create a new issue [https://gitlab.com/inkscape/inkscape-web-i18n/-/issues in the repository at gitlab] and attach your changed file to it, or make a merge request, if you are familiar with git / gitlab.

== Website Development ==

The Inkscape project has a side project — inkscape-web — which produces the website seen by users and used by everyone to find resources.

You can support the website development with things as easy as reporting bugs, or focused testing, or you can volunteer to test the web site more systematically before a new release. Other important areas where you can help us are website design, and website development. If you would like to help, contact Martin Owens (doctormo@gmail.com).

These are the most important links:
* The published website: https://inkscape.org/
* The staging website (testing): http://staging.inkscape.org/ (currently unavailable)
* The project on gitlab (code repository and bug reports created since February 2017): https://gitlab.com/inkscape/inkscape-web

The guide below is for helping with the website development and to get a running version of the website for design work. The code is available on Gitlab in a [https://gitlab.com/inkscape/inkscape-web git repository].

=== Django and Python ===

The website is written in Python using the Django framework. It is a good idea to have a familiarity with Django and a fairly healthy experience with Python before starting code development on the website:
* To learn Python, attend these online classes: http://www.codecademy.com/en/tracks/python
* To get to know Django, see this tutorial: http://tutorial.djangogirls.org/

=== Local Development ===

You can start an instance of the website locally if you wish to work on the code or design.

Needed dependencies (on Fedora): python-virtualenv and python-dev.

==== Getting the Website Code ====

* Option A: <code>$ git clone https://gitlab.com/inkscape/inkscape-web.git</code>

* Option B (better):
** Create an ssh key if you don't have one yet, and upload your public ssh key to gitlab (instructions: https://docs.gitlab.com/ee/user/ssh.html).
** <code>$ git clone git@gitlab.com:inkscape/inkscape-web.git</code>

==== Running the website locally ====

The following should download the code, set up the Python environment, set up your test database, download all the CMS data from the main website and run the server, showing its address (default is 127.0.0.1:8000):

# <code>$ ./utils/init</code>
# <code>$ ./utils/manage runserver [<domain>:<port>]</code>
# Open http://localhost:8000/ in your web browser (recommendation: Firefox or Chrome).
# Log in as the almighty admin user with username "admin" and password "123456".

You can also run the Django manage.py manually using:

<code>$ ./utils/manage <command></code>

The website's database is a local SQLite file in ./data/ as are all the uploaded files. These are not committed to the branch.

To sync the CMS contents with live again, use the refresh-cms command:

<code>$ ./utils/refresh-cms</code>

==== Updating your development version to the current trunk version ====

To get the latest changes for your branch, run:

<code>$ git pull</code>

To update your branch after a pull that introduces changes to the database structure or the installed applications, run:

<code>$ ./utils/update</code>

==== Troubleshooting ====

* Make sure your path to your local copy of inkscape-web only contains ASCII characters.
* If you have any other issues setting up your local environment, email doctormo@gmail.com, send a message to the docs mailing list or create a bug report in the bug tracker for inkscape-web.


==== Bug Reports ====

We use Gitlab's bug tracker to report and track progress on bug reports. Please see https://gitlab.com/inkscape/inkscape-web/-/issues for possible things to fix.

==== Making changes ====

Once you have made your modifications, please commit back and push to your own fork of inkscape-web for review unless otherwise granted permission to commit to the master branch.

See https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html for more info on forking a project on gitlab and making merge requests.

To set the origin of your local copy of inkscape-web to a personal fork on gitlab, you can do the following:
<code>$ git remote set-url origin https://gitlab.com/USERNAME/OTHERREPOSITORY.git</code>

This will allow you to share your modifications on gitlab.

If you have '''developer access''' to the project, you can also create branches within the original inkscape-web repository.
One easy way to do so is via the button "New Branch" on any issue.

On the commandline, you'll need to do the following, after creating a new branch for your issue on gitlab:

# <code>$ git fetch</code>
# <code>$ git checkout branch_name</code>
# Work on code...
# <code>$ git commit -m "I fixed that annoying bug"</code>
# <code>$ git push origin branch_name</code>

You can add "Fixes #<issue number on gitlab>" to the commit message to tie together code and the bug report, if you didn't create the branch directly from the issue on gitlab.

=== When will your changes be available on inkscape.org? ===

The master branch is open to commits by members of the Inkscape group on gitlab. There is one other branch for live that is used to control deployment. For separate features and WIP, you're welcome to create your own branches in the inkscape-web repo on gitlab.

Deployment of branches should happen automatically by cron script on the server. If your commit is stuck, please ask for help on the inkscape-docs mailing list and we can sort out any clogs.

The idea of the automatic deployment is that we can control the website via all the mechanisms we use to control code commits. This includes permissions, reversions, etc. Large changes can be held for review on staging while smaller changes can be merged into live without fuss.

[[Category:Translation]]

WebSite

2024-05-05T07:51:39Z

Ltlnx: /* Unpublishing */ Add saving to the web archive as a suggestion

The Inkscape project welcomes contributions to its website at https://inkscape.org/. Your help is valuable in different areas, and this page provides info to guide you.

We always need editors, translators, testers, designers and developers — and if you think you can help in any of those areas, please contact us by sending a mail to the translators' mailing list (for translations) or the documentation mailing list (for website development and contents).

== Editing ==

If you would like to help keep the website up-to-date and constantly look for ways to improve it, by collecting information from various sources and presenting it on the web site, join us in the chat for the [https://chat.inkscape.org/channel/documentation documentation], the [marketing https://chat.inkscape.org/channel/team_vectors] and/or the [https://chat.inkscape.org/channel/team_website website team]. You can support us in various ways: suggest improvements or corrections, write contents about topics that are missing, write news articles and help with ‘marketing’, or join us long-term and help with contents maintenance.

=== General Rules ===

* All content on the website is licensed '''CC-BY-SA and GPLv2 or later'''. You will be required to agree to this license when you first edit a page.
* Don't disrupt existing pages. If you don't know what you want to do yet, then draft the page here on the wiki, Etherpad or in a separate page first.
* No page is precious to any one person. All pages can be edited by any editor and disputes about drafting changes should be brought to the inkscape-docs mailing list or website editor in chief.
* The website's content is usually very flexible to updates, but final decisions by the webmaster must be accepted by all editors.
* Page language in English or translated should keep to the contributors rules. No swearing, no aggressive content and on website pages there should be no opinion.
* Translations should be strictly a translation of the English versions of pages. If there is new content, it should be added to the English page first to keep all versions of the page in sync.
* When you have made a change to the English website that changes the contents (i.e. not correcting grammar or a typo), and thus requires translation, please kindly inform website translators via translators' mailing list of the change you made. Try to finalize your changes to a page, before you call out to them to do their work.

=== User Account ===


Please [https://inkscape.org/user/register/ register] an account using your email address and activate the account. Once active and logged in, please '''subscribe''' to the corresponding mailing list and email either the [https://inkscape.org/community/mailing-lists/ inkscape-docs or the inkscape-translators mailing list] to get more information. For translations, please add some more info to your email, and additionally open a request to join the website translators' team (see Translation section below) and start by contributing to the website's .po file for your language.

If you're approved, your account will then be enabled with the right permissions to add and edit any of the pages on the website. Please take care not to disrupt other content as you edit the website. As before, don't hesitate to ask other website editors on their mailing list if you need help.

If anything goes wrong while you are editing — for example, you encounter a bug, or you accidentally delete something you did not intend to delete, or something weird happens, and you don't know why —, please ask for help on one of the mailing lists — either translators, or inkscape-docs. You can also contact your team admin directly or file a bug report for the website at the [https://gitlab.com/inkscape/inkscape-web/-/issues bug tracker].

=== Using the Website Editor ===

Editors and translators can visit the Inkscape website, log in as themselves and edit and add content to the django content management system (cms). This does not require any code access but does require knowledge of html and staff access plus that you be in the Editors or Translators group to give you all the required permissions.

When you want to edit a page for the first time after the update, you will be asked to agree to publish your work under the website's licence. This will ensure that your work can be built upon by others in a safe manner.

REMEMBER: Your changes are NOT published until you press the publish button on the tool bar! Once a change is published, there is NO WAY TO UNDO it, so check carefully before publishing.

[[File:Toolbar live mode django-cms 3.2.0.png|600px|thumb|center|The toolbar in live mode]]

From the tool bar at the top of the web page you can turn editing on for any cms page you are visiting and edit the content therein. Ask for help if you get lost editing the various sections of the website.

[[File:Double-click.png|130px|thumb|right|Editing the inkscape.org website]]

The screenshot to the right shows a page with the editor mode switched on. As you can see, when your mouse hovers above an editable section of a web page, you are prompted to double-click to edit that page. This allows you to add new content blocks as well as edit existing blocks. Most pages will only have one such section, but the front page has several. If you need a page with a new design that has multiple blocks, please see website development below.

[[File:Toolbar edit mode changes django-cms 3.2.0.png|600px|thumb|center|The toolbar after you have saved your changes]]

The toolbar will indicate when there are changes on a page that can be published. Click on '''Publish changes''' to publish your (or another person's) changes, and / or click on '''View published''' to leave the edit mode.

To learn how to edit and tweak the front page, you can watch this video on YouTube (note: the video shows how this works on an older version of the website's cms, so icons and toolbar will look different):

[[File:Front-page-video.jpg|Watch the video!|thumb|center|link=https://www.youtube.com/watch?v=Rq2EFX9Aw70|[https://www.youtube.com/watch?v=Rq2EFX9Aw70 Click here to watch the video!] (12:36)]]

==== Specific Instructions ====

{| style="float: right;"
|-
| [[File:Create internal link.png|120px|thumb|center|Creating an internal link]] || [[File:Add external link.png|120px|thumb|center|Creating a link to an external page]]
|-
| || [[File:Add an image to website.png‎|120px|thumb|center|Dialog for adding pictures to the website]]
|-
| [[File:TOC icon.png|75px|thumb|center|A TOC plugin in edit mode]] || [[File:Inline TOC.png|120px|thumb|center|An inline TOC (can also be added as a ’sidebar’ on the right)]]
|}

'''Texts''': When you save a text plugin, you will be asked to fill in a short description of your changes at the bottom of the editor window. This little summary will be used for updating others about your changes. Please provide a meaningful message.

[[File:CMS Editor describe changes.png|600px|thumb|center|Add a description of your changes before saving]]

'''External tools''': If you decide to do your translations using your favourite editor, be sure to use a plain text editor for this. Office suites and other word processing tools that support formatting are unsuitable, because they might add additional formatting automatically, which can accidentally end up on the website and break the actual formatting.

'''Links''': To insert a link, use the small chain icon in the editor. The dialog that opens supports looking up pages on the Inkscape website, when you enter a part of the url. Urls on the Inkscape website should always be specified as relative urls, i.e. leave out the 'https://inkscape.org' part, and only use, for example, '/learn/faq/'. You may need to select '<other>' in the protocol dropdown, to not have to insert https etc. We're still trying to figure out how language redirects will work. In the meantime, if you want to add a link to your own language's version of the website, use the language code in the urls, and add the English url after, i.e. '/fr/learn/faq' for the previous example.

'''Images''': Images are plugins. They cannot be copied directly from one page to the other, unless one chooses ‘Copy all plugins from English’ to make a whole new page. To insert an image (raster images only, svg is not supported by our current plugin), choose ‘Picture’ from the plugin dropdown list and fill in the dialog with the necessary info. Don't forget to add licence and attribution info, if applicable. If you want to use a picture that is already used on a different page (e.g. when editing a translation), download that picture to your computer (use your browser's right-click menu for that) and upload it again using the picture plugin dialog.

'''TOC''': The TOC (Table of Contents) plugin can be inserted into pages with long texts to make navigating them easier for users. It will also add little anchor symbols behind all headings on that page, that other people can directly link to.

'''Other plugins''': The CMS widgets come in a number of types. File and Video widgets do as you would expect and allow you to add those media elements.

'''Spell Checking''': Your browser's spell checker will work when editing text. To change the language or access suggested replacements, hold Ctrl down while right-clicking into the text.

==== Known Issues ====

* '''IMPORTANT''': When you click on ‘Publish’ for a page, it may sometimes seem as if nothing happens for a few seconds. Don't click on ‘Publish’ twice, just wait until it starts by itself. Every click on this will send a mail to all subscribers, and add to the server load. Also, incomplete saves have been seen as a result.
* There's a ‘Create’ button now available in the top left. If you are a translator, you will never need this button. It is for creating new, non-translation pages.
* Copy-pasting any plugins, e.g. images or tables of contents (and changing them after this) will result in the plugin source page (i.e. the English page in most cases) being altered. Never copy plugins! Only copy contents using a detour via a '''plain text editor''', i.e. copy the text from a web page, then paste it into, say, Notepad, then copy it from there back into your translation and adjust the formatting manually.
* Hitting ‘Enter’ while editing a plugin in a pop-up dialog may lose previous page edits.
* Sometimes, the ‘Edit’ button is not available. Then you can still edit the page by going to ‘Page -> Edit this Page’ in the toolbar, or add ‘?edit’ to the URL.
* Sometimes, your edits will not be visible in the preview after you clicked on save. In this case, go to 'view published', then switch back to Edit mode. You should be able to see the changes now.
* Sometimes, ‘Publish’ is not available, even if you made changes to some plugins. In this case, go to ‘Page -> Unpublish Page’ in the toolbar, and when it has been unpublished, click on the big blue ‘Publish now’ button to publish.
* On pages with a table of contents plugin, publishing may result in the TOC title being added a second time. The duplicate title can usually just be edited out, and will not be duplicated again the next time you publish. Make sure to not delete the plugin, but just the duplicated heading.

== Translations ==

If you are fluent in a language different from English, please consider joining our [https://inkscape.org/*translator website translators' team]. We strive to make Inkscape accessible for as many people as possible, and internationalization is important to reach this goal.

For being able to translate the CMS contents and the news, you will first need to understand how [[#Editing|editing the website]] works.

=== Translating CMS contents ===

==== Adding a new translation ====

To '''add''' a translation of a page which does not yet exist:

* Navigate to the English page that you want to translate.
* Switch to Edit mode by clicking on the '''Edit''' button ([[Media:CMS toolbar Page Edit.png|Image 1]]).
* Now use the language chooser to switch to your language ([[Media:Select language.png|Image 2]]).
* You should now see a blue '''Page Settings''' button at the right. Click on it. (If there's a button that says 'Create', '''go back to the English page''' and switch to Edit mode. 'Create' will create a new page, not a translation.) ([[Media:CMS toolbar Page Settings button.png|Image 3]]).
* In the '''Page settings''', enter a title for your new translation and click on '''Save''' ([[Media:Add a language 2.png|Image 4]]).
* At first, the new page will be empty. We must now fill it with a copy of the English content. Start by toggling the structure mode view ([[Media:Toggle structure mode website.png|Image 5]]).
* Next, click on the topmost hamburger icon in the structure panel (next to the name of the template that is being used), and select '''Copy from English''' ([[Media:Copy plugins from English.png|Image 6]]).
* The page will now contain the same texts and widgets as the English version does. You can click on the structure toggle icon again to hide the structure overview. To start translating, double-click on a text ([[Media:Double-click to edit.png|Image 7]]).
* An editor window will pop up and you can translate the text ([[Media:Editor window.png|Image 8]]).
* If something does not look correct (for example, because you accidentally deleted a certain html tag), you can choose to edit the html source, too ([[Media:Editor window source.png|Image 9]]).
* When you are done, click on '''Save''' to save your work. Don't forget to leave a comment about your changes ([[Media:Save Edit with comment.png|Image 10]]).
* You can now take a look at your translation and if you are happy with your work, click on the '''Publish''' button at the top of the page. Only this will make your translation available to the site's visitors ([[Media:Publish page.png|Image 11]]).

<gallery>
File:CMS toolbar Page Edit.png|1 — Switch to edit mode in English
File:Select language.png|2 — Switch to your language
File:CMS toolbar Page Settings button.png|3 — Select Page Settings
File:Add_a_language_2.png|4 — Enter title
File:Toggle structure mode website.png|5 — Show page structure
File:Copy plugins from English.png|6 — Copy from English
File:Double-click to edit.png|7 — Double-click to edit plugin
File:Editor_window.png|8 — The editor window in WYSIWYG mode
File:Editor_window_source.png|9 — Editing the html source
File:Save Edit with comment.png|10 — Save your edit
File:Publish page.png|11 — Publish changes
</gallery>

Please note:

* Take extra care to '''always check''' if the language you are editing is the one you actually want to edit. Please '''DO NOT''' translate a piece of text while under English or another language as you will cause trouble for that language.
* Menu entries are translated separately at [https://inkscape.org/admin/el_menu/menuitem/] , and they update with a delay, so don't be surprised if your changes aren't visible right away.

==== Edit an existing translation ====

Many existing translations at inkscape.org are outdated, or contain a copy of an outdated English version. Please, before you start translating, make sure that you actually translate from the '''current''' English version. If the page is very outdated, consider deleting the blocks and copying all plugins from English, as described above in '''Adding a new translation'''.

To '''edit''' an existing translation, just go to the page in your language, toggle the ‘draft’ mode by clicking on the '''Edit''' button in the top bar and double-click on the widget you would like to translate.

If you edit an existing translation, because the English original has changed, you can do the following:

* Open the published English page, and also, in a second tab, your translation, in draft mode.
* Copy the new parts from English by selecting them with the mouse and hitting Ctrl+C.
* If they contain any pictures or other content that is a plugin:
** Paste them '''into a simple text editor''' (Ctrl+V), to remove the formatting and prevent plugins from being used on two different pages at the same time. Copy the clean text from the editor to the clipboard (Ctrl+C). If there are no plugins, you can also paste directly into the editor window.
** Insert this into your existing translation, in the correct place (Ctrl+V).
** Then translate the text and fix the formatting.
** Save.
** Continue with translation :)
* If there are no images, tables of contents or other plugins in the text you want to copy-paste:
** feel free to copy-paste it as a whole into your translation, and to translate in place.

==== Unpublishing ====
If a translated page contains outdated information, you might consider unpublishing it. Before you unpublish, please make sure to send a message to the inkscape-translators mailing list or the chat, to seek approval from other editors.
[[File:Empty all.png|alt=Screenshot of the website with the "Empty all" button highlighted|thumb|The "Empty all" button]]
After you got an approval, you can move on to unpublish the page. To do this:

* Check if the page you're about to unpublish is saved on the [https://web.archive.org Web Archive], to preserve the contents (as we're clearing them in later steps).
*Check if you've switched to the desired language you want to unpublish. You may unpublish pages in other languages if you didn't make sure, so please be extra careful.
*Enter edit mode by going to Page > Edit this page.
* Click Page > Unpublish. This would unpublish the page, but keep the contents.
* Clear the contents by going to the sidebar, and clicking the topmost hamburger menu > Empty all. Click on "Yes, I'm sure" to confirm.
* Re-publish the page by clicking the blue "Publish page" button. '''Make sure to do this''' to ensure that only the page itself is unpublished, and its subpages keep working. Otherwise every subpage of it will become 404 (Page not found).

=== Translating News ===

News are a special case on the Inkscape website. To translate a news article, visit it in your own language, then select ‘News -> Translate News’ in the toolbar at the top.

[[File:Translate news dropdown-fs8.png|600px|thumb|center|News app: Dropdown for translating news. Note that the language you will translate to is the one displayed in your URL.]]

Then a window pops up where you can fill in your translation of the news. The text editor boxes for the excerpt and the news article contents will be pre-filled with the English version. You can also always see the English original when you click on ‘Show’ below the editor box.

Text can be formatted by using the text editor's buttons, links can be added by marking some text and clicking on the link symbol. Edit links by right-clicking on the link, then select ‘Edit link’ from the context menu. Save your translation when you're done.

[[File:Translate news-fs8.png|600px|thumb|center|News app: Translating a news article on the Inkscape website. The slug (last part of the url) must be unique.]]

[[File:Edit news link-fs8.png|300px|thumb|right|News app: Right-click to edit a link]]

==== Known Issues ====

* When you double-click on a link in the news editor, you'll get a popup dialog where you cannot click on anything. If this happens, click on ‘Save’ in the parent dialog to not lose any translated work. Continue editing after this.
* When you save your translation for the first time, you may be redirected to a non-existent page (404 error). To return to the article to continue editing, just remove everything after the last slash in the url, and hit enter. Then select your article on the page where this brought you, and edit it again.
* Always make sure you're on the correct page - always check the language abbreviation in the URL! Do not translate English articles, even if a redirect accidentally brings you there.

=== Translating Download contents ===

You can add translations of [[Release notes]] on this wiki. For this you need an account on the wiki: ask the inkscape-translator mailing list for it if you don't have one. When you're done with your translation, tell the translation administrator by sending an email to inkscape-translator and they'll publish your translation on the website.

The platform names and descriptions as well as the installation instructions for some platforms are translatable from the CMS administration pages. You may or may not have access rights to translate them.

* If you have access rights: go to [https://inkscape.org/admin/releases/platform/ Releases > Platforms]. You'll see a table listing all the nodes of the platform tree. To see the tree more clearly, you can sort the table depending on the codename. From this table, choose the platform you want to translate, and type your translation in a new ‘Platform translation’ at the bottom.
* If you don't have access rights: you can send a text file to the inkscape-translator mailing list containing all your translations, and an authorized translator will set them for you.

=== Translating Menu contents ===

The menu items are translatable from the CMS administration pages.

* If you have access rights: go to [https://inkscape.org/admin/el_menu/menuitem/ EL_MENU > Menu items]. All menu items are listed here, you can use the "FILTER" on the right panel and select "Main Menu" under "By category". Select the menu you want to translate, then in the last row under "MENU TRANSLATIONS" (the last row is blank), choose the language and type the URL and your translation. Save to finish this translation.
* If you don't have access rights: you can send your translation in a text file to the inkscape-translator mailing list, and an authorized translator will set them for you. Please prepare the text file with a list of the following format:

<code>English menu entry, url, translated menu entry</code> 
(one line per entry)

e.g.

<pre>
Forums, /forums, Foren
Overview, /about/overview/, Übersicht
</pre>

=== Translating other parts of the website ===

There are a lot of other translatable sentences and phrases on the Inkscape website, which cannot be translated directly on the website itself. Those include words such as ‘Log in’, ‘Register’, ‘Confirm’ and ‘Save’.

If your language is not yet available on our website, you're still very welcome to help! In this case please file a [https://gitlab.com/inkscape/inkscape-web/-/issues bug report]. Then we can prepare the website for your changes and make the translation file available, so you can start working on it.

You can download the PO file for your language from the [https://gitlab.com/inkscape/inkscape-web-i18n website's translation repository]. See [[Translation information#PO translation files|here]] for info about how to deal with PO files.

When you are done, create a new issue [https://gitlab.com/inkscape/inkscape-web-i18n/-/issues in the repository at gitlab] and attach your changed file to it, or make a merge request, if you are familiar with git / gitlab.

== Website Development ==

The Inkscape project has a side project — inkscape-web — which produces the website seen by users and used by everyone to find resources.

You can support the website development with things as easy as reporting bugs, or focused testing, or you can volunteer to test the web site more systematically before a new release. Other important areas where you can help us are website design, and website development. If you would like to help, contact Martin Owens (doctormo@gmail.com).

These are the most important links:
* The published website: https://inkscape.org/
* The staging website (testing): http://staging.inkscape.org/ (currently unavailable)
* The project on gitlab (code repository and bug reports created since February 2017): https://gitlab.com/inkscape/inkscape-web

The guide below is for helping with the website development and to get a running version of the website for design work. The code is available on Gitlab in a [https://gitlab.com/inkscape/inkscape-web git repository].

=== Django and Python ===

The website is written in Python using the Django framework. It is a good idea to have a familiarity with Django and a fairly healthy experience with Python before starting code development on the website:
* To learn Python, attend these online classes: http://www.codecademy.com/en/tracks/python
* To get to know Django, see this tutorial: http://tutorial.djangogirls.org/

=== Local Development ===

You can start an instance of the website locally if you wish to work on the code or design.

Needed dependencies (on Fedora): python-virtualenv and python-dev.

==== Getting the Website Code ====

* Option A: <code>$ git clone https://gitlab.com/inkscape/inkscape-web.git</code>

* Option B (better):
** Create an ssh key if you don't have one yet, and upload your public ssh key to gitlab (instructions: https://docs.gitlab.com/ee/user/ssh.html).
** <code>$ git clone git@gitlab.com:inkscape/inkscape-web.git</code>

==== Running the website locally ====

The following should download the code, set up the Python environment, set up your test database, download all the CMS data from the main website and run the server, showing its address (default is 127.0.0.1:8000):

# <code>$ ./utils/init</code>
# <code>$ ./utils/manage runserver [<domain>:<port>]</code>
# Open http://localhost:8000/ in your web browser (recommendation: Firefox or Chrome).
# Log in as the almighty admin user with username "admin" and password "123456".

You can also run the Django manage.py manually using:

<code>$ ./utils/manage <command></code>

The website's database is a local SQLite file in ./data/ as are all the uploaded files. These are not committed to the branch.

To sync the CMS contents with live again, use the refresh-cms command:

<code>$ ./utils/refresh-cms</code>

==== Updating your development version to the current trunk version ====

To get the latest changes for your branch, run:

<code>$ git pull</code>

To update your branch after a pull that introduces changes to the database structure or the installed applications, run:

<code>$ ./utils/update</code>

==== Troubleshooting ====

* Make sure your path to your local copy of inkscape-web only contains ASCII characters.
* If you have any other issues setting up your local environment, email doctormo@gmail.com, send a message to the docs mailing list or create a bug report in the bug tracker for inkscape-web.


==== Bug Reports ====

We use Gitlab's bug tracker to report and track progress on bug reports. Please see https://gitlab.com/inkscape/inkscape-web/-/issues for possible things to fix.

==== Making changes ====

Once you have made your modifications, please commit back and push to your own fork of inkscape-web for review unless otherwise granted permission to commit to the master branch.

See https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html for more info on forking a project on gitlab and making merge requests.

To set the origin of your local copy of inkscape-web to a personal fork on gitlab, you can do the following:
<code>$ git remote set-url origin https://gitlab.com/USERNAME/OTHERREPOSITORY.git</code>

This will allow you to share your modifications on gitlab.

If you have '''developer access''' to the project, you can also create branches within the original inkscape-web repository.
One easy way to do so is via the button "New Branch" on any issue.

On the commandline, you'll need to do the following, after creating a new branch for your issue on gitlab:

# <code>$ git fetch</code>
# <code>$ git checkout branch_name</code>
# Work on code...
# <code>$ git commit -m "I fixed that annoying bug"</code>
# <code>$ git push origin branch_name</code>

You can add "Fixes #<issue number on gitlab>" to the commit message to tie together code and the bug report, if you didn't create the branch directly from the issue on gitlab.

=== When will your changes be available on inkscape.org? ===

The master branch is open to commits by members of the Inkscape group on gitlab. There is one other branch for live that is used to control deployment. For separate features and WIP, you're welcome to create your own branches in the inkscape-web repo on gitlab.

Deployment of branches should happen automatically by cron script on the server. If your commit is stuck, please ask for help on the inkscape-docs mailing list and we can sort out any clogs.

The idea of the automatic deployment is that we can control the website via all the mechanisms we use to control code commits. This includes permissions, reversions, etc. Large changes can be held for review on staging while smaller changes can be merged into live without fuss.

[[Category:Translation]]

WebSite

2024-04-21T16:31:56Z

Ltlnx: Grammar and clarification

The Inkscape project welcomes contributions to its website at https://inkscape.org/. Your help is valuable in different areas, and this page provides info to guide you.

We always need editors, translators, testers, designers and developers — and if you think you can help in any of those areas, please contact us by sending a mail to the translators' mailing list (for translations) or the documentation mailing list (for website development and contents).

== Editing ==

We have a [https://inkscape.org/*editor small team of people] who look after the web site contents, keep it up-to-date and constantly look for ways to improve it, by collecting information from various sources and presenting it on the web site. You can support us in various ways: suggest improvements or corrections, write contents about topics that are missing, write news articles and help with ‘marketing’, or join us long-term and help with contents maintenance.

=== General Rules ===

* All content on the website is licensed '''CC-BY-SA and GPLv2 or later'''. You will be required to agree to this license when you first edit a page.
* Don't disrupt existing pages. If you don't know what you want to do yet, then draft the page here on the wiki, Etherpad or in a separate page first.
* No page is precious to any one person. All pages can be edited by any editor and disputes about drafting changes should be brought to the inkscape-docs mailing list or website editor in chief.
* The website's content is usually very flexible to updates, but final decisions by the webmaster must be accepted by all editors.
* Page language in English or translated should keep to the contributors rules. No swearing, no aggressive content and on website pages there should be no opinion.
* Translations should be strictly a translation of the English versions of pages. If there is new content, it should be added to the English page first to keep all versions of the page in sync.
* When you have made a change to the English website that changes the contents (i.e. not correcting grammar or a typo), and thus requires translation, please kindly inform website translators via translators' mailing list of the change you made. Try to finalize your changes to a page, before you call out to them to do their work.

=== User Account ===


Please [https://inkscape.org/user/register/ register] an account using your email address and activate the account. Once active and logged in, please '''subscribe''' to the corresponding mailing list and email either the [https://inkscape.org/community/mailing-lists/ inkscape-docs or the inkscape-translators mailing list] to get more information. For translations, please add some more info to your email, and additionally open a request to join the website translators' team (see Translation section below) and start by contributing to the website's .po file for your language.

If you're approved, your account will then be enabled with the right permissions to add and edit any of the pages on the website. Please take care not to disrupt other content as you edit the website. As before, don't hesitate to ask other website editors on their mailing list if you need help.

If anything goes wrong while you are editing — for example, you encounter a bug, or you accidentally delete something you did not intend to delete, or something weird happens, and you don't know why —, please ask for help on one of the mailing lists — either translators, or inkscape-docs. You can also contact your team admin directly or file a bug report for the website at the [https://gitlab.com/inkscape/inkscape-web/-/issues bug tracker].

=== Using the Website Editor ===

Editors and translators can visit the Inkscape website, log in as themselves and edit and add content to the django content management system (cms). This does not require any code access but does require knowledge of html and staff access plus that you be in the Editors or Translators group to give you all the required permissions.

When you want to edit a page for the first time after the update, you will be asked to agree to publish your work under the website's licence. This will ensure that your work can be built upon by others in a safe manner.

REMEMBER: Your changes are NOT published until you press the publish button on the tool bar! Once a change is published, there is NO WAY TO UNDO it, so check carefully before publishing.

[[File:Toolbar live mode django-cms 3.2.0.png|600px|thumb|center|The toolbar in live mode]]

From the tool bar at the top of the web page you can turn editing on for any cms page you are visiting and edit the content therein. Ask for help if you get lost editing the various sections of the website.

[[File:Double-click.png|130px|thumb|right|Editing the inkscape.org website]]

The screenshot to the right shows a page with the editor mode switched on. As you can see, when your mouse hovers above an editable section of a web page, you are prompted to double-click to edit that page. This allows you to add new content blocks as well as edit existing blocks. Most pages will only have one such section, but the front page has several. If you need a page with a new design that has multiple blocks, please see website development below.

[[File:Toolbar edit mode changes django-cms 3.2.0.png|600px|thumb|center|The toolbar after you have saved your changes]]

The toolbar will indicate when there are changes on a page that can be published. Click on '''Publish changes''' to publish your (or another person's) changes, and / or click on '''View published''' to leave the edit mode.

To learn how to edit and tweak the front page, you can watch this video on YouTube (note: the video shows how this works on an older version of the website's cms, so icons and toolbar will look different):

[[File:Front-page-video.jpg|Watch the video!|thumb|center|link=https://www.youtube.com/watch?v=Rq2EFX9Aw70|[https://www.youtube.com/watch?v=Rq2EFX9Aw70 Click here to watch the video!] (12:36)]]

==== Specific Instructions ====

{| style="float: right;"
|-
| [[File:Create internal link.png|120px|thumb|center|Creating an internal link]] || [[File:Add external link.png|120px|thumb|center|Creating a link to an external page]]
|-
| || [[File:Add an image to website.png‎|120px|thumb|center|Dialog for adding pictures to the website]]
|-
| [[File:TOC icon.png|75px|thumb|center|A TOC plugin in edit mode]] || [[File:Inline TOC.png|120px|thumb|center|An inline TOC (can also be added as a ’sidebar’ on the right)]]
|}

'''Texts''': When you save a text plugin, you will be asked to fill in a short description of your changes at the bottom of the editor window. This little summary will be used for updating others about your changes. Please provide a meaningful message.

[[File:CMS Editor describe changes.png|600px|thumb|center|Add a description of your changes before saving]]

'''External tools''': If you decide to do your translations using your favourite editor, be sure to use a plain text editor for this. Office suites and other word processing tools that support formatting are unsuitable, because they might add additional formatting automatically, which can accidentally end up on the website and break the actual formatting.

'''Links''': To insert a link, use the small chain icon in the editor. The dialog that opens supports looking up pages on the Inkscape website, when you enter a part of the url. Urls on the Inkscape website should always be specified as relative urls, i.e. leave out the 'https://inkscape.org' part, and only use, for example, '/learn/faq/'. You may need to select '<other>' in the protocol dropdown, to not have to insert https etc. We're still trying to figure out how language redirects will work. In the meantime, if you want to add a link to your own language's version of the website, use the language code in the urls, and add the English url after, i.e. '/fr/learn/faq' for the previous example.

'''Images''': Images are plugins. They cannot be copied directly from one page to the other, unless one chooses ‘Copy all plugins from English’ to make a whole new page. To insert an image (raster images only, svg is not supported by our current plugin), choose ‘Picture’ from the plugin dropdown list and fill in the dialog with the necessary info. Don't forget to add licence and attribution info, if applicable. If you want to use a picture that is already used on a different page (e.g. when editing a translation), download that picture to your computer (use your browser's right-click menu for that) and upload it again using the picture plugin dialog.

'''TOC''': The TOC (Table of Contents) plugin can be inserted into pages with long texts to make navigating them easier for users. It will also add little anchor symbols behind all headings on that page, that other people can directly link to.

'''Other plugins''': The CMS widgets come in a number of types. File and Video widgets do as you would expect and allow you to add those media elements.

'''Spell Checking''': Your browser's spell checker will work when editing text. To change the language or access suggested replacements, hold Ctrl down while right-clicking into the text.

==== Known Issues ====

* '''IMPORTANT''': When you click on ‘Publish’ for a page, it may sometimes seem as if nothing happens for a few seconds. Don't click on ‘Publish’ twice, just wait until it starts by itself. Every click on this will send a mail to all subscribers, and add to the server load. Also, incomplete saves have been seen as a result.
* There's a ‘Create’ button now available in the top left. If you are a translator, you will never need this button. It is for creating new, non-translation pages.
* Copy-pasting any plugins, e.g. images or tables of contents (and changing them after this) will result in the plugin source page (i.e. the English page in most cases) being altered. Never copy plugins! Only copy contents using a detour via a '''plain text editor''', i.e. copy the text from a web page, then paste it into, say, Notepad, then copy it from there back into your translation and adjust the formatting manually.
* Hitting ‘Enter’ while editing a plugin in a pop-up dialog may lose previous page edits.
* Sometimes, the ‘Edit’ button is not available. Then you can still edit the page by going to ‘Page -> Edit this Page’ in the toolbar, or add ‘?edit’ to the URL.
* Sometimes, your edits will not be visible in the preview after you clicked on save. In this case, go to 'view published', then switch back to Edit mode. You should be able to see the changes now.
* Sometimes, ‘Publish’ is not available, even if you made changes to some plugins. In this case, go to ‘Page -> Unpublish Page’ in the toolbar, and when it has been unpublished, click on the big blue ‘Publish now’ button to publish.
* On pages with a table of contents plugin, publishing may result in the TOC title being added a second time. The duplicate title can usually just be edited out, and will not be duplicated again the next time you publish. Make sure to not delete the plugin, but just the duplicated heading.

== Translations ==

If you are fluent in a language different from English, please consider joining our [https://inkscape.org/*translator website translators' team]. We strive to make Inkscape accessible for as many people as possible, and internationalization is important to reach this goal.

For being able to translate the CMS contents and the news, you will first need to understand how [[#Editing|editing the website]] works.

=== Translating CMS contents ===

==== Adding a new translation ====

To '''add''' a translation of a page which does not yet exist:

* Navigate to the English page that you want to translate.
* Switch to Edit mode by clicking on the '''Edit''' button ([[Media:CMS toolbar Page Edit.png|Image 1]]).
* Now use the language chooser to switch to your language ([[Media:Select language.png|Image 2]]).
* You should now see a blue '''Page Settings''' button at the right. Click on it. (If there's a button that says 'Create', '''go back to the English page''' and switch to Edit mode. 'Create' will create a new page, not a translation.) ([[Media:CMS toolbar Page Settings button.png|Image 3]]).
* In the '''Page settings''', enter a title for your new translation and click on '''Save''' ([[Media:Add a language 2.png|Image 4]]).
* At first, the new page will be empty. We must now fill it with a copy of the English content. Start by toggling the structure mode view ([[Media:Toggle structure mode website.png|Image 5]]).
* Next, click on the topmost hamburger icon in the structure panel (next to the name of the template that is being used), and select '''Copy from English''' ([[Media:Copy plugins from English.png|Image 6]]).
* The page will now contain the same texts and widgets as the English version does. You can click on the structure toggle icon again to hide the structure overview. To start translating, double-click on a text ([[Media:Double-click to edit.png|Image 7]]).
* An editor window will pop up and you can translate the text ([[Media:Editor window.png|Image 8]]).
* If something does not look correct (for example, because you accidentally deleted a certain html tag), you can choose to edit the html source, too ([[Media:Editor window source.png|Image 9]]).
* When you are done, click on '''Save''' to save your work. Don't forget to leave a comment about your changes ([[Media:Save Edit with comment.png|Image 10]]).
* You can now take a look at your translation and if you are happy with your work, click on the '''Publish''' button at the top of the page. Only this will make your translation available to the site's visitors ([[Media:Publish page.png|Image 11]]).

<gallery>
File:CMS toolbar Page Edit.png|1 — Switch to edit mode in English
File:Select language.png|2 — Switch to your language
File:CMS toolbar Page Settings button.png|3 — Select Page Settings
File:Add_a_language_2.png|4 — Enter title
File:Toggle structure mode website.png|5 — Show page structure
File:Copy plugins from English.png|6 — Copy from English
File:Double-click to edit.png|7 — Double-click to edit plugin
File:Editor_window.png|8 — The editor window in WYSIWYG mode
File:Editor_window_source.png|9 — Editing the html source
File:Save Edit with comment.png|10 — Save your edit
File:Publish page.png|11 — Publish changes
</gallery>

Please note:

* Take extra care to '''always check''' if the language you are editing is the one you actually want to edit. Please '''DO NOT''' translate a piece of text while under English or another language as you will cause trouble for that language.
* Menu entries are translated separately at [https://inkscape.org/admin/el_menu/menuitem/] , and they update with a delay, so don't be surprised if your changes aren't visible right away.

==== Edit an existing translation ====

Many existing translations at inkscape.org are outdated, or contain a copy of an outdated English version. Please, before you start translating, make sure that you actually translate from the '''current''' English version. If the page is very outdated, consider deleting the blocks and copying all plugins from English, as described above in '''Adding a new translation'''.

To '''edit''' an existing translation, just go to the page in your language, toggle the ‘draft’ mode by clicking on the '''Edit''' button in the top bar and double-click on the widget you would like to translate.

If you edit an existing translation, because the English original has changed, you can do the following:

* Open the published English page, and also, in a second tab, your translation, in draft mode.
* Copy the new parts from English by selecting them with the mouse and hitting Ctrl+C.
* If they contain any pictures or other content that is a plugin:
** Paste them '''into a simple text editor''' (Ctrl+V), to remove the formatting and prevent plugins from being used on two different pages at the same time. Copy the clean text from the editor to the clipboard (Ctrl+C). If there are no plugins, you can also paste directly into the editor window.
** Insert this into your existing translation, in the correct place (Ctrl+V).
** Then translate the text and fix the formatting.
** Save.
** Continue with translation :)
* If there are no images, tables of contents or other plugins in the text you want to copy-paste:
** feel free to copy-paste it as a whole into your translation, and to translate in place.

==== Unpublishing ====
If a translated page contains outdated information, you might consider unpublishing it. Before you unpublish, please make sure to send a message to the inkscape-translators mailing list or the chat, to seek approval from other editors.
[[File:Empty all.png|alt=Screenshot of the website with the "Empty all" button highlighted|thumb|The "Empty all" button]]
After you got an approval, you can move on to unpublish the page. To do this:

* Check if you've switched to the desired language you want to unpublish. You may unpublish pages in other languages if you didn't make sure, so please be extra careful.
*Enter edit mode by going to Page > Edit this page.
* Click Page > Unpublish. This would unpublish the page, but keep the contents.
* Clear the contents by going to the sidebar, and clicking the topmost hamburger menu > Empty all. Click on "Yes, I'm sure" to confirm.
* Re-publish the page by clicking the blue "Publish page" button. '''Make sure to do this''' to ensure that only the page itself is unpublished, and its subpages keep working. Otherwise every subpage of it will become 404 (Page not found).

=== Translating News ===

News are a special case on the Inkscape website. To translate a news article, visit it in your own language, then select ‘News -> Translate News’ in the toolbar at the top.

[[File:Translate news dropdown-fs8.png|600px|thumb|center|News app: Dropdown for translating news. Note that the language you will translate to is the one displayed in your URL.]]

Then a window pops up where you can fill in your translation of the news. The text editor boxes for the excerpt and the news article contents will be pre-filled with the English version. You can also always see the English original when you click on ‘Show’ below the editor box.

Text can be formatted by using the text editor's buttons, links can be added by marking some text and clicking on the link symbol. Edit links by right-clicking on the link, then select ‘Edit link’ from the context menu. Save your translation when you're done.

[[File:Translate news-fs8.png|600px|thumb|center|News app: Translating a news article on the Inkscape website. The slug (last part of the url) must be unique.]]

[[File:Edit news link-fs8.png|300px|thumb|right|News app: Right-click to edit a link]]

==== Known Issues ====

* When you double-click on a link in the news editor, you'll get a popup dialog where you cannot click on anything. If this happens, click on ‘Save’ in the parent dialog to not lose any translated work. Continue editing after this.
* When you save your translation for the first time, you may be redirected to a non-existent page (404 error). To return to the article to continue editing, just remove everything after the last slash in the url, and hit enter. Then select your article on the page where this brought you, and edit it again.
* Always make sure you're on the correct page - always check the language abbreviation in the URL! Do not translate English articles, even if a redirect accidentally brings you there.

=== Translating Download contents ===

You can add translations of [[Release notes]] on this wiki. For this you need an account on the wiki: ask the inkscape-translator mailing list for it if you don't have one. When you're done with your translation, tell the translation administrator by sending an email to inkscape-translator and they'll publish your translation on the website.

The platform names and descriptions as well as the installation instructions for some platforms are translatable from the CMS administration pages. You may or may not have access rights to translate them.

* If you have access rights: go to [https://inkscape.org/admin/releases/platform/ Releases > Platforms]. You'll see a table listing all the nodes of the platform tree. To see the tree more clearly, you can sort the table depending on the codename. From this table, choose the platform you want to translate, and type your translation in a new ‘Platform translation’ at the bottom.
* If you don't have access rights: you can send a text file to the inkscape-translator mailing list containing all your translations, and an authorized translator will set them for you.

=== Translating Menu contents ===

The menu items are translatable from the CMS administration pages.

* If you have access rights: go to [https://inkscape.org/admin/el_menu/menuitem/ EL_MENU > Menu items]. All menu items are listed here, you can use the "FILTER" on the right panel and select "Main Menu" under "By category". Select the menu you want to translate, then in the last row under "MENU TRANSLATIONS" (the last row is blank), choose the language and type the URL and your translation. Save to finish this translation.
* If you don't have access rights: you can send your translation in a text file to the inkscape-translator mailing list, and an authorized translator will set them for you. Please prepare the text file with a list of the following format:

<code>English menu entry, url, translated menu entry</code> 
(one line per entry)

e.g.

<pre>
Forums, /forums, Foren
Overview, /about/overview/, Übersicht
</pre>

=== Translating other parts of the website ===

There are a lot of other translatable sentences and phrases on the Inkscape website, which cannot be translated directly on the website itself. Those include words such as ‘Log in’, ‘Register’, ‘Confirm’ and ‘Save’.

If your language is not yet available on our website, you're still very welcome to help! In this case please file a [https://gitlab.com/inkscape/inkscape-web/-/issues bug report]. Then we can prepare the website for your changes and make the translation file available, so you can start working on it.

You can download the PO file for your language from the [https://gitlab.com/inkscape/inkscape-web-i18n website's translation repository]. See [[Translation information#PO translation files|here]] for info about how to deal with PO files.

When you are done, create a new issue [https://gitlab.com/inkscape/inkscape-web-i18n/-/issues in the repository at gitlab] and attach your changed file to it, or make a merge request, if you are familiar with git / gitlab.

== Website Development ==

The Inkscape project has a side project — inkscape-web — which produces the website seen by users and used by everyone to find resources.

You can support the website development with things as easy as reporting bugs, or focused testing, or you can volunteer to test the web site more systematically before a new release. Other important areas where you can help us are website design, and website development. If you would like to help, contact Martin Owens (doctormo@gmail.com).

These are the most important links:
* The published website: https://inkscape.org/
* The staging website (testing): http://staging.inkscape.org/ (currently unavailable)
* The project on Launchpad (only bug reports created before February 2017): https://launchpad.net/inkscape-web/bugs
* The project on gitlab (code repository and bug reports created since February 2017): https://gitlab.com/inkscape/inkscape-web

The guide below is for helping with the website development and to get a running version of the website for design work. The code is available on Gitlab in a [https://gitlab.com/inkscape/inkscape-web git repository].

=== Django and Python ===

The website is written in Python using the Django framework. It is a good idea to have a familiarity with Django and a fairly healthy experience with Python before starting code development on the website:
* To learn Python, attend these online classes: http://www.codecademy.com/en/tracks/python
* To get to know Django, see this tutorial: http://tutorial.djangogirls.org/

=== Local Development ===

You can start an instance of the website locally if you wish to work on the code or design.

Needed dependencies (on Fedora): python-virtualenv and python-dev.

==== Getting the Website Code ====

* Option A: <code>$ git clone https://gitlab.com/inkscape/inkscape-web.git</code>

* Option B (better):
** Create an ssh key if you don't have one yet, and upload your public ssh key to gitlab (instructions: https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html).
** <code>$ git clone git@gitlab.com:inkscape/inkscape-web.git</code>

==== Running the website locally ====

The following should download the code, set up the Python environment, set up your test database, download all the CMS data from the main website and run the server, showing its address (default is 127.0.0.1:8000):

# <code>$ ./utils/init</code>
# <code>$ ./utils/manage runserver [<domain>:<port>]</code>
# Open http://localhost:8000/ in your web browser (recommendation: Firefox or Chrome).
# Log in as the almighty admin user with username "admin" and password "123456".

You can also run the Django manage.py manually using:

<code>$ ./utils/manage <command></code>

The website's database is a local SQLite file in ./data/ as are all the uploaded files. These are not committed to the branch.

To sync the CMS contents with live again, use the refresh-cms command:

<code>$ ./utils/refresh-cms</code>

==== Updating your development version to the current trunk version ====

To get the latest changes for your branch, run:

<code>$ git pull</code>

To update your branch after a pull that introduces changes to the database structure or the installed applications, run:

<code>$ ./utils/update</code>

==== Troubleshooting ====

* Make sure your path to your local copy of inkscape-web only contains ASCII characters.
* If you have any other issues setting up your local environment, email doctormo@gmail.com, send a message to the docs mailing list or create a bug report in the bug tracker for inkscape-web.


==== Bug Reports ====

We use Gitlab's bug tracker to report and track progress on bug reports. Please see https://gitlab.com/inkscape/inkscape-web/-/issues for possible things to fix.

==== Making changes ====

Once you have made your modifications, please commit back and push to your own fork of inkscape-web for review unless otherwise granted permission to commit to the master branch.

See https://docs.gitlab.com/ce/workflow/forking_workflow.html for more info on forking a project on gitlab and making merge requests.

To set the origin of your local copy of inkscape-web to a personal fork on gitlab, you can do the following:
<code>$ git remote set-url origin https://gitlab.com/USERNAME/OTHERREPOSITORY.git</code>

This will allow you to share your modifications on gitlab.

If you have '''developer access''' to the project, you can also create branches within the original inkscape-web repository.
One easy way to do so is via the button "New Branch" on any issue.

On the commandline, you'll need to do the following, after creating a new branch for your issue on gitlab:

# <code>$ git fetch</code>
# <code>$ git checkout branch_name</code>
# Work on code...
# <code>$ git commit -m "I fixed that annoying bug"</code>
# <code>$ git push origin branch_name</code>

You can add "Fixes #<issue number on gitlab>" to the commit message to tie together code and the bug report, if you didn't create the branch directly from the issue on gitlab.

=== When will your changes be available on inkscape.org? ===

The master branch is open to commits by members of the Inkscape group on gitlab. There is one other branch for live that is used to control deployment. For separate features and WIP, you're welcome to create your own branches in the inkscape-web repo on gitlab.

Deployment of branches should happen automatically by cron script on the server. If your commit is stuck, please ask for help on the inkscape-docs mailing list and we can sort out any clogs.

The idea of the automatic deployment is that we can control the website via all the mechanisms we use to control code commits. This includes permissions, reversions, etc. Large changes can be held for review on staging while smaller changes can be merged into live without fuss.

[[Category:Translation]]

WebSite

2024-04-21T16:28:02Z

Ltlnx: Grammar fix

The Inkscape project welcomes contributions to its website at https://inkscape.org/. Your help is valuable in different areas, and this page provides info to guide you.

We always need editors, translators, testers, designers and developers — and if you think you can help in any of those areas, please contact us by sending a mail to the translators' mailing list (for translations) or the documentation mailing list (for website development and contents).

== Editing ==

We have a [https://inkscape.org/*editor small team of people] who look after the web site contents, keep it up-to-date and constantly look for ways to improve it, by collecting information from various sources and presenting it on the web site. You can support us in various ways: suggest improvements or corrections, write contents about topics that are missing, write news articles and help with ‘marketing’, or join us long-term and help with contents maintenance.

=== General Rules ===

* All content on the website is licensed '''CC-BY-SA and GPLv2 or later'''. You will be required to agree to this license when you first edit a page.
* Don't disrupt existing pages. If you don't know what you want to do yet, then draft the page here on the wiki, Etherpad or in a separate page first.
* No page is precious to any one person. All pages can be edited by any editor and disputes about drafting changes should be brought to the inkscape-docs mailing list or website editor in chief.
* The website's content is usually very flexible to updates, but final decisions by the webmaster must be accepted by all editors.
* Page language in English or translated should keep to the contributors rules. No swearing, no aggressive content and on website pages there should be no opinion.
* Translations should be strictly a translation of the English versions of pages. If there is new content, it should be added to the English page first to keep all versions of the page in sync.
* When you have made a change to the English website that changes the contents (i.e. not correcting grammar or a typo), and thus requires translation, please kindly inform website translators via translators' mailing list of the change you made. Try to finalize your changes to a page, before you call out to them to do their work.

=== User Account ===


Please [https://inkscape.org/user/register/ register] an account using your email address and activate the account. Once active and logged in, please '''subscribe''' to the corresponding mailing list and email either the [https://inkscape.org/community/mailing-lists/ inkscape-docs or the inkscape-translators mailing list] to get more information. For translations, please add some more info to your email, and additionally open a request to join the website translators' team (see Translation section below) and start by contributing to the website's .po file for your language.

If you're approved, your account will then be enabled with the right permissions to add and edit any of the pages on the website. Please take care not to disrupt other content as you edit the website. As before, don't hesitate to ask other website editors on their mailing list if you need help.

If anything goes wrong while you are editing — for example, you encounter a bug, or you accidentally delete something you did not intend to delete, or something weird happens, and you don't know why —, please ask for help on one of the mailing lists — either translators, or inkscape-docs. You can also contact your team admin directly or file a bug report for the website at the [https://gitlab.com/inkscape/inkscape-web/-/issues bug tracker].

=== Using the Website Editor ===

Editors and translators can visit the Inkscape website, log in as themselves and edit and add content to the django content management system (cms). This does not require any code access but does require knowledge of html and staff access plus that you be in the Editors or Translators group to give you all the required permissions.

When you want to edit a page for the first time after the update, you will be asked to agree to publish your work under the website's licence. This will ensure that your work can be built upon by others in a safe manner.

REMEMBER: Your changes are NOT published until you press the publish button on the tool bar! Once a change is published, there is NO WAY TO UNDO it, so check carefully before publishing.

[[File:Toolbar live mode django-cms 3.2.0.png|600px|thumb|center|The toolbar in live mode]]

From the tool bar at the top of the web page you can turn editing on for any cms page you are visiting and edit the content therein. Ask for help if you get lost editing the various sections of the website.

[[File:Double-click.png|130px|thumb|right|Editing the inkscape.org website]]

The screenshot to the right shows a page with the editor mode switched on. As you can see, when your mouse hovers above an editable section of a web page, you are prompted to double-click to edit that page. This allows you to add new content blocks as well as edit existing blocks. Most pages will only have one such section, but the front page has several. If you need a page with a new design that has multiple blocks, please see website development below.

[[File:Toolbar edit mode changes django-cms 3.2.0.png|600px|thumb|center|The toolbar after you have saved your changes]]

The toolbar will indicate when there are changes on a page that can be published. Click on '''Publish changes''' to publish your (or another person's) changes, and / or click on '''View published''' to leave the edit mode.

To learn how to edit and tweak the front page, you can watch this video on YouTube (note: the video shows how this works on an older version of the website's cms, so icons and toolbar will look different):

[[File:Front-page-video.jpg|Watch the video!|thumb|center|link=https://www.youtube.com/watch?v=Rq2EFX9Aw70|[https://www.youtube.com/watch?v=Rq2EFX9Aw70 Click here to watch the video!] (12:36)]]

==== Specific Instructions ====

{| style="float: right;"
|-
| [[File:Create internal link.png|120px|thumb|center|Creating an internal link]] || [[File:Add external link.png|120px|thumb|center|Creating a link to an external page]]
|-
| || [[File:Add an image to website.png‎|120px|thumb|center|Dialog for adding pictures to the website]]
|-
| [[File:TOC icon.png|75px|thumb|center|A TOC plugin in edit mode]] || [[File:Inline TOC.png|120px|thumb|center|An inline TOC (can also be added as a ’sidebar’ on the right)]]
|}

'''Texts''': When you save a text plugin, you will be asked to fill in a short description of your changes at the bottom of the editor window. This little summary will be used for updating others about your changes. Please provide a meaningful message.

[[File:CMS Editor describe changes.png|600px|thumb|center|Add a description of your changes before saving]]

'''External tools''': If you decide to do your translations using your favourite editor, be sure to use a plain text editor for this. Office suites and other word processing tools that support formatting are unsuitable, because they might add additional formatting automatically, which can accidentally end up on the website and break the actual formatting.

'''Links''': To insert a link, use the small chain icon in the editor. The dialog that opens supports looking up pages on the Inkscape website, when you enter a part of the url. Urls on the Inkscape website should always be specified as relative urls, i.e. leave out the 'https://inkscape.org' part, and only use, for example, '/learn/faq/'. You may need to select '<other>' in the protocol dropdown, to not have to insert https etc. We're still trying to figure out how language redirects will work. In the meantime, if you want to add a link to your own language's version of the website, use the language code in the urls, and add the English url after, i.e. '/fr/learn/faq' for the previous example.

'''Images''': Images are plugins. They cannot be copied directly from one page to the other, unless one chooses ‘Copy all plugins from English’ to make a whole new page. To insert an image (raster images only, svg is not supported by our current plugin), choose ‘Picture’ from the plugin dropdown list and fill in the dialog with the necessary info. Don't forget to add licence and attribution info, if applicable. If you want to use a picture that is already used on a different page (e.g. when editing a translation), download that picture to your computer (use your browser's right-click menu for that) and upload it again using the picture plugin dialog.

'''TOC''': The TOC (Table of Contents) plugin can be inserted into pages with long texts to make navigating them easier for users. It will also add little anchor symbols behind all headings on that page, that other people can directly link to.

'''Other plugins''': The CMS widgets come in a number of types. File and Video widgets do as you would expect and allow you to add those media elements.

'''Spell Checking''': Your browser's spell checker will work when editing text. To change the language or access suggested replacements, hold Ctrl down while right-clicking into the text.

==== Known Issues ====

* '''IMPORTANT''': When you click on ‘Publish’ for a page, it may sometimes seem as if nothing happens for a few seconds. Don't click on ‘Publish’ twice, just wait until it starts by itself. Every click on this will send a mail to all subscribers, and add to the server load. Also, incomplete saves have been seen as a result.
* There's a ‘Create’ button now available in the top left. If you are a translator, you will never need this button. It is for creating new, non-translation pages.
* Copy-pasting any plugins, e.g. images or tables of contents (and changing them after this) will result in the plugin source page (i.e. the English page in most cases) being altered. Never copy plugins! Only copy contents using a detour via a '''plain text editor''', i.e. copy the text from a web page, then paste it into, say, Notepad, then copy it from there back into your translation and adjust the formatting manually.
* Hitting ‘Enter’ while editing a plugin in a pop-up dialog may lose previous page edits.
* Sometimes, the ‘Edit’ button is not available. Then you can still edit the page by going to ‘Page -> Edit this Page’ in the toolbar, or add ‘?edit’ to the URL.
* Sometimes, your edits will not be visible in the preview after you clicked on save. In this case, go to 'view published', then switch back to Edit mode. You should be able to see the changes now.
* Sometimes, ‘Publish’ is not available, even if you made changes to some plugins. In this case, go to ‘Page -> Unpublish Page’ in the toolbar, and when it has been unpublished, click on the big blue ‘Publish now’ button to publish.
* On pages with a table of contents plugin, publishing may result in the TOC title being added a second time. The duplicate title can usually just be edited out, and will not be duplicated again the next time you publish. Make sure to not delete the plugin, but just the duplicated heading.

== Translations ==

If you are fluent in a language different from English, please consider joining our [https://inkscape.org/*translator website translators' team]. We strive to make Inkscape accessible for as many people as possible, and internationalization is important to reach this goal.

For being able to translate the CMS contents and the news, you will first need to understand how [[#Editing|editing the website]] works.

=== Translating CMS contents ===

==== Adding a new translation ====

To '''add''' a translation of a page which does not yet exist:

* Navigate to the English page that you want to translate.
* Switch to Edit mode by clicking on the '''Edit''' button ([[Media:CMS toolbar Page Edit.png|Image 1]]).
* Now use the language chooser to switch to your language ([[Media:Select language.png|Image 2]]).
* You should now see a blue '''Page Settings''' button at the right. Click on it. (If there's a button that says 'Create', '''go back to the English page''' and switch to Edit mode. 'Create' will create a new page, not a translation.) ([[Media:CMS toolbar Page Settings button.png|Image 3]]).
* In the '''Page settings''', enter a title for your new translation and click on '''Save''' ([[Media:Add a language 2.png|Image 4]]).
* At first, the new page will be empty. We must now fill it with a copy of the English content. Start by toggling the structure mode view ([[Media:Toggle structure mode website.png|Image 5]]).
* Next, click on the topmost hamburger icon in the structure panel (next to the name of the template that is being used), and select '''Copy from English''' ([[Media:Copy plugins from English.png|Image 6]]).
* The page will now contain the same texts and widgets as the English version does. You can click on the structure toggle icon again to hide the structure overview. To start translating, double-click on a text ([[Media:Double-click to edit.png|Image 7]]).
* An editor window will pop up and you can translate the text ([[Media:Editor window.png|Image 8]]).
* If something does not look correct (for example, because you accidentally deleted a certain html tag), you can choose to edit the html source, too ([[Media:Editor window source.png|Image 9]]).
* When you are done, click on '''Save''' to save your work. Don't forget to leave a comment about your changes ([[Media:Save Edit with comment.png|Image 10]]).
* You can now take a look at your translation and if you are happy with your work, click on the '''Publish''' button at the top of the page. Only this will make your translation available to the site's visitors ([[Media:Publish page.png|Image 11]]).

<gallery>
File:CMS toolbar Page Edit.png|1 — Switch to edit mode in English
File:Select language.png|2 — Switch to your language
File:CMS toolbar Page Settings button.png|3 — Select Page Settings
File:Add_a_language_2.png|4 — Enter title
File:Toggle structure mode website.png|5 — Show page structure
File:Copy plugins from English.png|6 — Copy from English
File:Double-click to edit.png|7 — Double-click to edit plugin
File:Editor_window.png|8 — The editor window in WYSIWYG mode
File:Editor_window_source.png|9 — Editing the html source
File:Save Edit with comment.png|10 — Save your edit
File:Publish page.png|11 — Publish changes
</gallery>

Please note:

* Take extra care to '''always check''' if the language you are editing is the one you actually want to edit. Please '''DO NOT''' translate a piece of text while under English or another language as you will cause trouble for that language.
* Menu entries are translated separately at [https://inkscape.org/admin/el_menu/menuitem/] , and they update with a delay, so don't be surprised if your changes aren't visible right away.

==== Edit an existing translation ====

Many existing translations at inkscape.org are outdated, or contain a copy of an outdated English version. Please, before you start translating, make sure that you actually translate from the '''current''' English version. If the page is very outdated, consider deleting the blocks and copying all plugins from English, as described above in '''Adding a new translation'''.

To '''edit''' an existing translation, just go to the page in your language, toggle the ‘draft’ mode by clicking on the '''Edit''' button in the top bar and double-click on the widget you would like to translate.

If you edit an existing translation, because the English original has changed, you can do the following:

* Open the published English page, and also, in a second tab, your translation, in draft mode.
* Copy the new parts from English by selecting them with the mouse and hitting Ctrl+C.
* If they contain any pictures or other content that is a plugin:
** Paste them '''into a simple text editor''' (Ctrl+V), to remove the formatting and prevent plugins from being used on two different pages at the same time. Copy the clean text from the editor to the clipboard (Ctrl+C). If there are no plugins, you can also paste directly into the editor window.
** Insert this into your existing translation, in the correct place (Ctrl+V).
** Then translate the text and fix the formatting.
** Save.
** Continue with translation :)
* If there are no images, tables of contents or other plugins in the text you want to copy-paste:
** feel free to copy-paste it as a whole into your translation, and to translate in place.

==== Unpublishing ====
If a translated page contains outdated information, you might consider unpublishing it. Before you unpublish, please make sure to send a message to the inkscape-translators mailing list or the chat, to seek approval from other editors.
[[File:Empty all.png|alt=Screenshot of the website with the "Empty all" button highlighted|thumb|The "Empty all" button]]
After you got an approval, you can move on to unpublish the page. To do this:

* Check if you've switched to the desired language you want to unpublish. You may unpublish pages in other languages if you didn't make sure, so please be extra careful.
*Enter edit mode by going to Page > Edit this page.
* Click Page > Unpublish. This would unpublish the page, but keep the contents.
* Clear the contents by going to the sidebar, and clicking the topmost hamburger menu > Empty all. Click on "Yes, I'm sure" to confirm.
* Re-publish the page by clicking the blue "Publish page" button. '''Make sure to do this''' to ensure that only the page itself is unpublished, and keep its subpages working. Otherwise all subpages will become 404 (Page not found).

=== Translating News ===

News are a special case on the Inkscape website. To translate a news article, visit it in your own language, then select ‘News -> Translate News’ in the toolbar at the top.

[[File:Translate news dropdown-fs8.png|600px|thumb|center|News app: Dropdown for translating news. Note that the language you will translate to is the one displayed in your URL.]]

Then a window pops up where you can fill in your translation of the news. The text editor boxes for the excerpt and the news article contents will be pre-filled with the English version. You can also always see the English original when you click on ‘Show’ below the editor box.

Text can be formatted by using the text editor's buttons, links can be added by marking some text and clicking on the link symbol. Edit links by right-clicking on the link, then select ‘Edit link’ from the context menu. Save your translation when you're done.

[[File:Translate news-fs8.png|600px|thumb|center|News app: Translating a news article on the Inkscape website. The slug (last part of the url) must be unique.]]

[[File:Edit news link-fs8.png|300px|thumb|right|News app: Right-click to edit a link]]

==== Known Issues ====

* When you double-click on a link in the news editor, you'll get a popup dialog where you cannot click on anything. If this happens, click on ‘Save’ in the parent dialog to not lose any translated work. Continue editing after this.
* When you save your translation for the first time, you may be redirected to a non-existent page (404 error). To return to the article to continue editing, just remove everything after the last slash in the url, and hit enter. Then select your article on the page where this brought you, and edit it again.
* Always make sure you're on the correct page - always check the language abbreviation in the URL! Do not translate English articles, even if a redirect accidentally brings you there.

=== Translating Download contents ===

You can add translations of [[Release notes]] on this wiki. For this you need an account on the wiki: ask the inkscape-translator mailing list for it if you don't have one. When you're done with your translation, tell the translation administrator by sending an email to inkscape-translator and they'll publish your translation on the website.

The platform names and descriptions as well as the installation instructions for some platforms are translatable from the CMS administration pages. You may or may not have access rights to translate them.

* If you have access rights: go to [https://inkscape.org/admin/releases/platform/ Releases > Platforms]. You'll see a table listing all the nodes of the platform tree. To see the tree more clearly, you can sort the table depending on the codename. From this table, choose the platform you want to translate, and type your translation in a new ‘Platform translation’ at the bottom.
* If you don't have access rights: you can send a text file to the inkscape-translator mailing list containing all your translations, and an authorized translator will set them for you.

=== Translating Menu contents ===

The menu items are translatable from the CMS administration pages.

* If you have access rights: go to [https://inkscape.org/admin/el_menu/menuitem/ EL_MENU > Menu items]. All menu items are listed here, you can use the "FILTER" on the right panel and select "Main Menu" under "By category". Select the menu you want to translate, then in the last row under "MENU TRANSLATIONS" (the last row is blank), choose the language and type the URL and your translation. Save to finish this translation.
* If you don't have access rights: you can send your translation in a text file to the inkscape-translator mailing list, and an authorized translator will set them for you. Please prepare the text file with a list of the following format:

<code>English menu entry, url, translated menu entry</code> 
(one line per entry)

e.g.

<pre>
Forums, /forums, Foren
Overview, /about/overview/, Übersicht
</pre>

=== Translating other parts of the website ===

There are a lot of other translatable sentences and phrases on the Inkscape website, which cannot be translated directly on the website itself. Those include words such as ‘Log in’, ‘Register’, ‘Confirm’ and ‘Save’.

If your language is not yet available on our website, you're still very welcome to help! In this case please file a [https://gitlab.com/inkscape/inkscape-web/-/issues bug report]. Then we can prepare the website for your changes and make the translation file available, so you can start working on it.

You can download the PO file for your language from the [https://gitlab.com/inkscape/inkscape-web-i18n website's translation repository]. See [[Translation information#PO translation files|here]] for info about how to deal with PO files.

When you are done, create a new issue [https://gitlab.com/inkscape/inkscape-web-i18n/-/issues in the repository at gitlab] and attach your changed file to it, or make a merge request, if you are familiar with git / gitlab.

== Website Development ==

The Inkscape project has a side project — inkscape-web — which produces the website seen by users and used by everyone to find resources.

You can support the website development with things as easy as reporting bugs, or focused testing, or you can volunteer to test the web site more systematically before a new release. Other important areas where you can help us are website design, and website development. If you would like to help, contact Martin Owens (doctormo@gmail.com).

These are the most important links:
* The published website: https://inkscape.org/
* The staging website (testing): http://staging.inkscape.org/ (currently unavailable)
* The project on Launchpad (only bug reports created before February 2017): https://launchpad.net/inkscape-web/bugs
* The project on gitlab (code repository and bug reports created since February 2017): https://gitlab.com/inkscape/inkscape-web

The guide below is for helping with the website development and to get a running version of the website for design work. The code is available on Gitlab in a [https://gitlab.com/inkscape/inkscape-web git repository].

=== Django and Python ===

The website is written in Python using the Django framework. It is a good idea to have a familiarity with Django and a fairly healthy experience with Python before starting code development on the website:
* To learn Python, attend these online classes: http://www.codecademy.com/en/tracks/python
* To get to know Django, see this tutorial: http://tutorial.djangogirls.org/

=== Local Development ===

You can start an instance of the website locally if you wish to work on the code or design.

Needed dependencies (on Fedora): python-virtualenv and python-dev.

==== Getting the Website Code ====

* Option A: <code>$ git clone https://gitlab.com/inkscape/inkscape-web.git</code>

* Option B (better):
** Create an ssh key if you don't have one yet, and upload your public ssh key to gitlab (instructions: https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html).
** <code>$ git clone git@gitlab.com:inkscape/inkscape-web.git</code>

==== Running the website locally ====

The following should download the code, set up the Python environment, set up your test database, download all the CMS data from the main website and run the server, showing its address (default is 127.0.0.1:8000):

# <code>$ ./utils/init</code>
# <code>$ ./utils/manage runserver [<domain>:<port>]</code>
# Open http://localhost:8000/ in your web browser (recommendation: Firefox or Chrome).
# Log in as the almighty admin user with username "admin" and password "123456".

You can also run the Django manage.py manually using:

<code>$ ./utils/manage <command></code>

The website's database is a local SQLite file in ./data/ as are all the uploaded files. These are not committed to the branch.

To sync the CMS contents with live again, use the refresh-cms command:

<code>$ ./utils/refresh-cms</code>

==== Updating your development version to the current trunk version ====

To get the latest changes for your branch, run:

<code>$ git pull</code>

To update your branch after a pull that introduces changes to the database structure or the installed applications, run:

<code>$ ./utils/update</code>

==== Troubleshooting ====

* Make sure your path to your local copy of inkscape-web only contains ASCII characters.
* If you have any other issues setting up your local environment, email doctormo@gmail.com, send a message to the docs mailing list or create a bug report in the bug tracker for inkscape-web.


==== Bug Reports ====

We use Gitlab's bug tracker to report and track progress on bug reports. Please see https://gitlab.com/inkscape/inkscape-web/-/issues for possible things to fix.

==== Making changes ====

Once you have made your modifications, please commit back and push to your own fork of inkscape-web for review unless otherwise granted permission to commit to the master branch.

See https://docs.gitlab.com/ce/workflow/forking_workflow.html for more info on forking a project on gitlab and making merge requests.

To set the origin of your local copy of inkscape-web to a personal fork on gitlab, you can do the following:
<code>$ git remote set-url origin https://gitlab.com/USERNAME/OTHERREPOSITORY.git</code>

This will allow you to share your modifications on gitlab.

If you have '''developer access''' to the project, you can also create branches within the original inkscape-web repository.
One easy way to do so is via the button "New Branch" on any issue.

On the commandline, you'll need to do the following, after creating a new branch for your issue on gitlab:

# <code>$ git fetch</code>
# <code>$ git checkout branch_name</code>
# Work on code...
# <code>$ git commit -m "I fixed that annoying bug"</code>
# <code>$ git push origin branch_name</code>

You can add "Fixes #<issue number on gitlab>" to the commit message to tie together code and the bug report, if you didn't create the branch directly from the issue on gitlab.

=== When will your changes be available on inkscape.org? ===

The master branch is open to commits by members of the Inkscape group on gitlab. There is one other branch for live that is used to control deployment. For separate features and WIP, you're welcome to create your own branches in the inkscape-web repo on gitlab.

Deployment of branches should happen automatically by cron script on the server. If your commit is stuck, please ask for help on the inkscape-docs mailing list and we can sort out any clogs.

The idea of the automatic deployment is that we can control the website via all the mechanisms we use to control code commits. This includes permissions, reversions, etc. Large changes can be held for review on staging while smaller changes can be merged into live without fuss.

[[Category:Translation]]

WebSite

2024-04-21T16:22:47Z

Ltlnx: Remove links to Launchpad (outdated)

The Inkscape project welcomes contributions to its website at https://inkscape.org/. Your help is valuable in different areas, and this page provides info to guide you.

We always need editors, translators, testers, designers and developers — and if you think you can help in any of those areas, please contact us by sending a mail to the translators' mailing list (for translations) or the documentation mailing list (for website development and contents).

== Editing ==

We have a [https://inkscape.org/*editor small team of people] who look after the web site contents, keep it up-to-date and constantly look for ways to improve it, by collecting information from various sources and presenting it on the web site. You can support us in various ways: suggest improvements or corrections, write contents about topics that are missing, write news articles and help with ‘marketing’, or join us long-term and help with contents maintenance.

=== General Rules ===

* All content on the website is licensed '''CC-BY-SA and GPLv2 or later'''. You will be required to agree to this license when you first edit a page.
* Don't disrupt existing pages. If you don't know what you want to do yet, then draft the page here on the wiki, Etherpad or in a separate page first.
* No page is precious to any one person. All pages can be edited by any editor and disputes about drafting changes should be brought to the inkscape-docs mailing list or website editor in chief.
* The website's content is usually very flexible to updates, but final decisions by the webmaster must be accepted by all editors.
* Page language in English or translated should keep to the contributors rules. No swearing, no aggressive content and on website pages there should be no opinion.
* Translations should be strictly a translation of the English versions of pages. If there is new content, it should be added to the English page first to keep all versions of the page in sync.
* When you have made a change to the English website that changes the contents (i.e. not correcting grammar or a typo), and thus requires translation, please kindly inform website translators via translators' mailing list of the change you made. Try to finalize your changes to a page, before you call out to them to do their work.

=== User Account ===


Please [https://inkscape.org/user/register/ register] an account using your email address and activate the account. Once active and logged in, please '''subscribe''' to the corresponding mailing list and email either the [https://inkscape.org/community/mailing-lists/ inkscape-docs or the inkscape-translators mailing list] to get more information. For translations, please add some more info to your email, and additionally open a request to join the website translators' team (see Translation section below) and start by contributing to the website's .po file for your language.

If you're approved, your account will then be enabled with the right permissions to add and edit any of the pages on the website. Please take care not to disrupt other content as you edit the website. As before, don't hesitate to ask other website editors on their mailing list if you need help.

If anything goes wrong while you are editing — for example, you encounter a bug, or you accidentally delete something you did not intend to delete, or something weird happens, and you don't know why —, please ask for help on one of the mailing lists — either translators, or inkscape-docs. You can also contact your team admin directly or file a bug report for the website at the [https://gitlab.com/inkscape/inkscape-web/-/issues bug tracker].

=== Using the Website Editor ===

Editors and translators can visit the Inkscape website, log in as themselves and edit and add content to the django content management system (cms). This does not require any code access but does require knowledge of html and staff access plus that you be in the Editors or Translators group to give you all the required permissions.

When you want to edit a page for the first time after the update, you will be asked to agree to publish your work under the website's licence. This will ensure that your work can be built upon by others in a safe manner.

REMEMBER: Your changes are NOT published until you press the publish button on the tool bar! Once a change is published, there is NO WAY TO UNDO it, so check carefully before publishing.

[[File:Toolbar live mode django-cms 3.2.0.png|600px|thumb|center|The toolbar in live mode]]

From the tool bar at the top of the web page you can turn editing on for any cms page you are visiting and edit the content therein. Ask for help if you get lost editing the various sections of the website.

[[File:Double-click.png|130px|thumb|right|Editing the inkscape.org website]]

The screenshot to the right shows a page with the editor mode switched on. As you can see, when your mouse hovers above an editable section of a web page, you are prompted to double-click to edit that page. This allows you to add new content blocks as well as edit existing blocks. Most pages will only have one such section, but the front page has several. If you need a page with a new design that has multiple blocks, please see website development below.

[[File:Toolbar edit mode changes django-cms 3.2.0.png|600px|thumb|center|The toolbar after you have saved your changes]]

The toolbar will indicate when there are changes on a page that can be published. Click on '''Publish changes''' to publish your (or another person's) changes, and / or click on '''View published''' to leave the edit mode.

To learn how to edit and tweak the front page, you can watch this video on YouTube (note: the video shows how this works on an older version of the website's cms, so icons and toolbar will look different):

[[File:Front-page-video.jpg|Watch the video!|thumb|center|link=https://www.youtube.com/watch?v=Rq2EFX9Aw70|[https://www.youtube.com/watch?v=Rq2EFX9Aw70 Click here to watch the video!] (12:36)]]

==== Specific Instructions ====

{| style="float: right;"
|-
| [[File:Create internal link.png|120px|thumb|center|Creating an internal link]] || [[File:Add external link.png|120px|thumb|center|Creating a link to an external page]]
|-
| || [[File:Add an image to website.png‎|120px|thumb|center|Dialog for adding pictures to the website]]
|-
| [[File:TOC icon.png|75px|thumb|center|A TOC plugin in edit mode]] || [[File:Inline TOC.png|120px|thumb|center|An inline TOC (can also be added as a ’sidebar’ on the right)]]
|}

'''Texts''': When you save a text plugin, you will be asked to fill in a short description of your changes at the bottom of the editor window. This little summary will be used for updating others about your changes. Please provide a meaningful message.

[[File:CMS Editor describe changes.png|600px|thumb|center|Add a description of your changes before saving]]

'''External tools''': If you decide to do your translations using your favourite editor, be sure to use a plain text editor for this. Office suites and other word processing tools that support formatting are unsuitable, because they might add additional formatting automatically, which can accidentally end up on the website and break the actual formatting.

'''Links''': To insert a link, use the small chain icon in the editor. The dialog that opens supports looking up pages on the Inkscape website, when you enter a part of the url. Urls on the Inkscape website should always be specified as relative urls, i.e. leave out the 'https://inkscape.org' part, and only use, for example, '/learn/faq/'. You may need to select '<other>' in the protocol dropdown, to not have to insert https etc. We're still trying to figure out how language redirects will work. In the meantime, if you want to add a link to your own language's version of the website, use the language code in the urls, and add the English url after, i.e. '/fr/learn/faq' for the previous example.

'''Images''': Images are plugins. They cannot be copied directly from one page to the other, unless one chooses ‘Copy all plugins from English’ to make a whole new page. To insert an image (raster images only, svg is not supported by our current plugin), choose ‘Picture’ from the plugin dropdown list and fill in the dialog with the necessary info. Don't forget to add licence and attribution info, if applicable. If you want to use a picture that is already used on a different page (e.g. when editing a translation), download that picture to your computer (use your browser's right-click menu for that) and upload it again using the picture plugin dialog.

'''TOC''': The TOC (Table of Contents) plugin can be inserted into pages with long texts to make navigating them easier for users. It will also add little anchor symbols behind all headings on that page, that other people can directly link to.

'''Other plugins''': The CMS widgets come in a number of types. File and Video widgets do as you would expect and allow you to add those media elements.

'''Spell Checking''': Your browser's spell checker will work when editing text. To change the language or access suggested replacements, hold Ctrl down while right-clicking into the text.

==== Known Issues ====

* '''IMPORTANT''': When you click on ‘Publish’ for a page, it may sometimes seem as if nothing happens for a few seconds. Don't click on ‘Publish’ twice, just wait until it starts by itself. Every click on this will send a mail to all subscribers, and add to the server load. Also, incomplete saves have been seen as a result.
* There's a ‘Create’ button now available in the top left. If you are a translator, you will never need this button. It is for creating new, non-translation pages.
* Copy-pasting any plugins, e.g. images or tables of contents (and changing them after this) will result in the plugin source page (i.e. the English page in most cases) being altered. Never copy plugins! Only copy contents using a detour via a '''plain text editor''', i.e. copy the text from a web page, then paste it into, say, Notepad, then copy it from there back into your translation and adjust the formatting manually.
* Hitting ‘Enter’ while editing a plugin in a pop-up dialog may lose previous page edits.
* Sometimes, the ‘Edit’ button is not available. Then you can still edit the page by going to ‘Page -> Edit this Page’ in the toolbar, or add ‘?edit’ to the URL.
* Sometimes, your edits will not be visible in the preview after you clicked on save. In this case, go to 'view published', then switch back to Edit mode. You should be able to see the changes now.
* Sometimes, ‘Publish’ is not available, even if you made changes to some plugins. In this case, go to ‘Page -> Unpublish Page’ in the toolbar, and when it has been unpublished, click on the big blue ‘Publish now’ button to publish.
* On pages with a table of contents plugin, publishing may result in the TOC title being added a second time. The duplicate title can usually just be edited out, and will not be duplicated again the next time you publish. Make sure to not delete the plugin, but just the duplicated heading.

== Translations ==

If you are fluent in a language different from English, please consider joining our [https://inkscape.org/*translator website translators' team]. We strive to make Inkscape accessible for as many people as possible, and internationalization is important to reach this goal.

For being able to translate the CMS contents and the news, you will first need to understand how [[#Editing|editing the website]] works.

=== Translating CMS contents ===

==== Adding a new translation ====

To '''add''' a translation of a page which does not yet exist:

* Navigate to the English page that you want to translate.
* Switch to Edit mode by clicking on the '''Edit''' button ([[Media:CMS toolbar Page Edit.png|Image 1]]).
* Now use the language chooser to switch to your language ([[Media:Select language.png|Image 2]]).
* You should now see a blue '''Page Settings''' button at the right. Click on it. (If there's a button that says 'Create', '''go back to the English page''' and switch to Edit mode. 'Create' will create a new page, not a translation.) ([[Media:CMS toolbar Page Settings button.png|Image 3]]).
* In the '''Page settings''', enter a title for your new translation and click on '''Save''' ([[Media:Add a language 2.png|Image 4]]).
* At first, the new page will be empty. We must now fill it with a copy of the English content. Start by toggling the structure mode view ([[Media:Toggle structure mode website.png|Image 5]]).
* Next, click on the topmost hamburger icon in the structure panel (next to the name of the template that is being used), and select '''Copy from English''' ([[Media:Copy plugins from English.png|Image 6]]).
* The page will now contain the same texts and widgets as the English version does. You can click on the structure toggle icon again to hide the structure overview. To start translating, double-click on a text ([[Media:Double-click to edit.png|Image 7]]).
* An editor window will pop up and you can translate the text ([[Media:Editor window.png|Image 8]]).
* If something does not look correct (for example, because you accidentally deleted a certain html tag), you can choose to edit the html source, too ([[Media:Editor window source.png|Image 9]]).
* When you are done, click on '''Save''' to save your work. Don't forget to leave a comment about your changes ([[Media:Save Edit with comment.png|Image 10]]).
* You can now take a look at your translation and if you are happy with your work, click on the '''Publish''' button at the top of the page. Only this will make your translation available to the site's visitors ([[Media:Publish page.png|Image 11]]).

<gallery>
File:CMS toolbar Page Edit.png|1 — Switch to edit mode in English
File:Select language.png|2 — Switch to your language
File:CMS toolbar Page Settings button.png|3 — Select Page Settings
File:Add_a_language_2.png|4 — Enter title
File:Toggle structure mode website.png|5 — Show page structure
File:Copy plugins from English.png|6 — Copy from English
File:Double-click to edit.png|7 — Double-click to edit plugin
File:Editor_window.png|8 — The editor window in WYSIWYG mode
File:Editor_window_source.png|9 — Editing the html source
File:Save Edit with comment.png|10 — Save your edit
File:Publish page.png|11 — Publish changes
</gallery>

Please note:

* Take extra care to '''always check''' if the language you are editing is the one you actually want to edit. Please '''DO NOT''' translate a piece of text while under English or another language as you will cause trouble for that language.
* Menu entries are translated separately at [https://inkscape.org/admin/el_menu/menuitem/] , and they update with a delay, so don't be surprised if your changes aren't visible right away.

==== Edit an existing translation ====

Many existing translations at inkscape.org are outdated, or contain a copy of an outdated English version. Please, before you start translating, make sure that you actually translate from the '''current''' English version. If the page is very outdated, consider deleting the blocks and copying all plugins from English, as described above in '''Adding a new translation'''.

To '''edit''' an existing translation, just go to the page in your language, toggle the ‘draft’ mode by clicking on the '''Edit''' button in the top bar and double-click on the widget you would like to translate.

If you edit an existing translation, because the English original has changed, you can do the following:

* Open the published English page, and also, in a second tab, your translation, in draft mode.
* Copy the new parts from English by selecting them with the mouse and hitting Ctrl+C.
* If they contain any pictures or other content that is a plugin:
** Paste them '''into a simple text editor''' (Ctrl+V), to remove the formatting and prevent plugins from being used on two different pages at the same time. Copy the clean text from the editor to the clipboard (Ctrl+C). If there are no plugins, you can also paste directly into the editor window.
** Insert this into your existing translation, in the correct place (Ctrl+V).
** Then translate the text and fix the formatting.
** Save.
** Continue with translation :)
* If there are no images, tables of contents or other plugins in the text you want to copy-paste:
** feel free to copy-paste it as a whole into your translation, and to translate in place.

==== Unpublishing ====
If a translated page contains outdated information, you might consider unpublishing it. Before you unpublish, please make sure to send a message to the inkscape-translators mailing list or the chat, to seek approval from other editors.
[[File:Empty all.png|alt=Screenshot of the website with the "Empty all" button highlighted|thumb|The "Empty all" button]]
After you got an approval, you can move on to unpublish the page. To do this:

* Check if you've switched to the desired language you want to unpublish. You may unpublish pages in other languages if you didn't make sure, so please be extra careful.
*Enter edit mode by going to Page > Edit this page.
* Click Page > Unpublish. This would unpublish the page, but keep the contents.
* Clear the contents by going to the sidebar, and clicking the topmost hamburger menu > Empty all. Click on "Yes, I'm sure" to confirm.
* Re-publish the page by clicking the blue "Publish page" button. '''Make sure to do this''' to ensure that only the page itself is unpublished, and its subpages will keep working. Otherwise all subpages will become 404 (Page not found).

=== Translating News ===

News are a special case on the Inkscape website. To translate a news article, visit it in your own language, then select ‘News -> Translate News’ in the toolbar at the top.

[[File:Translate news dropdown-fs8.png|600px|thumb|center|News app: Dropdown for translating news. Note that the language you will translate to is the one displayed in your URL.]]

Then a window pops up where you can fill in your translation of the news. The text editor boxes for the excerpt and the news article contents will be pre-filled with the English version. You can also always see the English original when you click on ‘Show’ below the editor box.

Text can be formatted by using the text editor's buttons, links can be added by marking some text and clicking on the link symbol. Edit links by right-clicking on the link, then select ‘Edit link’ from the context menu. Save your translation when you're done.

[[File:Translate news-fs8.png|600px|thumb|center|News app: Translating a news article on the Inkscape website. The slug (last part of the url) must be unique.]]

[[File:Edit news link-fs8.png|300px|thumb|right|News app: Right-click to edit a link]]

==== Known Issues ====

* When you double-click on a link in the news editor, you'll get a popup dialog where you cannot click on anything. If this happens, click on ‘Save’ in the parent dialog to not lose any translated work. Continue editing after this.
* When you save your translation for the first time, you may be redirected to a non-existent page (404 error). To return to the article to continue editing, just remove everything after the last slash in the url, and hit enter. Then select your article on the page where this brought you, and edit it again.
* Always make sure you're on the correct page - always check the language abbreviation in the URL! Do not translate English articles, even if a redirect accidentally brings you there.

=== Translating Download contents ===

You can add translations of [[Release notes]] on this wiki. For this you need an account on the wiki: ask the inkscape-translator mailing list for it if you don't have one. When you're done with your translation, tell the translation administrator by sending an email to inkscape-translator and they'll publish your translation on the website.

The platform names and descriptions as well as the installation instructions for some platforms are translatable from the CMS administration pages. You may or may not have access rights to translate them.

* If you have access rights: go to [https://inkscape.org/admin/releases/platform/ Releases > Platforms]. You'll see a table listing all the nodes of the platform tree. To see the tree more clearly, you can sort the table depending on the codename. From this table, choose the platform you want to translate, and type your translation in a new ‘Platform translation’ at the bottom.
* If you don't have access rights: you can send a text file to the inkscape-translator mailing list containing all your translations, and an authorized translator will set them for you.

=== Translating Menu contents ===

The menu items are translatable from the CMS administration pages.

* If you have access rights: go to [https://inkscape.org/admin/el_menu/menuitem/ EL_MENU > Menu items]. All menu items are listed here, you can use the "FILTER" on the right panel and select "Main Menu" under "By category". Select the menu you want to translate, then in the last row under "MENU TRANSLATIONS" (the last row is blank), choose the language and type the URL and your translation. Save to finish this translation.
* If you don't have access rights: you can send your translation in a text file to the inkscape-translator mailing list, and an authorized translator will set them for you. Please prepare the text file with a list of the following format:

<code>English menu entry, url, translated menu entry</code> 
(one line per entry)

e.g.

<pre>
Forums, /forums, Foren
Overview, /about/overview/, Übersicht
</pre>

=== Translating other parts of the website ===

There are a lot of other translatable sentences and phrases on the Inkscape website, which cannot be translated directly on the website itself. Those include words such as ‘Log in’, ‘Register’, ‘Confirm’ and ‘Save’.

If your language is not yet available on our website, you're still very welcome to help! In this case please file a [https://gitlab.com/inkscape/inkscape-web/-/issues bug report]. Then we can prepare the website for your changes and make the translation file available, so you can start working on it.

You can download the PO file for your language from the [https://gitlab.com/inkscape/inkscape-web-i18n website's translation repository]. See [[Translation information#PO translation files|here]] for info about how to deal with PO files.

When you are done, create a new issue [https://gitlab.com/inkscape/inkscape-web-i18n/-/issues in the repository at gitlab] and attach your changed file to it, or make a merge request, if you are familiar with git / gitlab.

== Website Development ==

The Inkscape project has a side project — inkscape-web — which produces the website seen by users and used by everyone to find resources.

You can support the website development with things as easy as reporting bugs, or focused testing, or you can volunteer to test the web site more systematically before a new release. Other important areas where you can help us are website design, and website development. If you would like to help, contact Martin Owens (doctormo@gmail.com).

These are the most important links:
* The published website: https://inkscape.org/
* The staging website (testing): http://staging.inkscape.org/ (currently unavailable)
* The project on Launchpad (only bug reports created before February 2017): https://launchpad.net/inkscape-web/bugs
* The project on gitlab (code repository and bug reports created since February 2017): https://gitlab.com/inkscape/inkscape-web

The guide below is for helping with the website development and to get a running version of the website for design work. The code is available on Gitlab in a [https://gitlab.com/inkscape/inkscape-web git repository].

=== Django and Python ===

The website is written in Python using the Django framework. It is a good idea to have a familiarity with Django and a fairly healthy experience with Python before starting code development on the website:
* To learn Python, attend these online classes: http://www.codecademy.com/en/tracks/python
* To get to know Django, see this tutorial: http://tutorial.djangogirls.org/

=== Local Development ===

You can start an instance of the website locally if you wish to work on the code or design.

Needed dependencies (on Fedora): python-virtualenv and python-dev.

==== Getting the Website Code ====

* Option A: <code>$ git clone https://gitlab.com/inkscape/inkscape-web.git</code>

* Option B (better):
** Create an ssh key if you don't have one yet, and upload your public ssh key to gitlab (instructions: https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html).
** <code>$ git clone git@gitlab.com:inkscape/inkscape-web.git</code>

==== Running the website locally ====

The following should download the code, set up the Python environment, set up your test database, download all the CMS data from the main website and run the server, showing its address (default is 127.0.0.1:8000):

# <code>$ ./utils/init</code>
# <code>$ ./utils/manage runserver [<domain>:<port>]</code>
# Open http://localhost:8000/ in your web browser (recommendation: Firefox or Chrome).
# Log in as the almighty admin user with username "admin" and password "123456".

You can also run the Django manage.py manually using:

<code>$ ./utils/manage <command></code>

The website's database is a local SQLite file in ./data/ as are all the uploaded files. These are not committed to the branch.

To sync the CMS contents with live again, use the refresh-cms command:

<code>$ ./utils/refresh-cms</code>

==== Updating your development version to the current trunk version ====

To get the latest changes for your branch, run:

<code>$ git pull</code>

To update your branch after a pull that introduces changes to the database structure or the installed applications, run:

<code>$ ./utils/update</code>

==== Troubleshooting ====

* Make sure your path to your local copy of inkscape-web only contains ASCII characters.
* If you have any other issues setting up your local environment, email doctormo@gmail.com, send a message to the docs mailing list or create a bug report in the bug tracker for inkscape-web.


==== Bug Reports ====

We use Gitlab's bug tracker to report and track progress on bug reports. Please see https://gitlab.com/inkscape/inkscape-web/-/issues for possible things to fix.

==== Making changes ====

Once you have made your modifications, please commit back and push to your own fork of inkscape-web for review unless otherwise granted permission to commit to the master branch.

See https://docs.gitlab.com/ce/workflow/forking_workflow.html for more info on forking a project on gitlab and making merge requests.

To set the origin of your local copy of inkscape-web to a personal fork on gitlab, you can do the following:
<code>$ git remote set-url origin https://gitlab.com/USERNAME/OTHERREPOSITORY.git</code>

This will allow you to share your modifications on gitlab.

If you have '''developer access''' to the project, you can also create branches within the original inkscape-web repository.
One easy way to do so is via the button "New Branch" on any issue.

On the commandline, you'll need to do the following, after creating a new branch for your issue on gitlab:

# <code>$ git fetch</code>
# <code>$ git checkout branch_name</code>
# Work on code...
# <code>$ git commit -m "I fixed that annoying bug"</code>
# <code>$ git push origin branch_name</code>

You can add "Fixes #<issue number on gitlab>" to the commit message to tie together code and the bug report, if you didn't create the branch directly from the issue on gitlab.

=== When will your changes be available on inkscape.org? ===

The master branch is open to commits by members of the Inkscape group on gitlab. There is one other branch for live that is used to control deployment. For separate features and WIP, you're welcome to create your own branches in the inkscape-web repo on gitlab.

Deployment of branches should happen automatically by cron script on the server. If your commit is stuck, please ask for help on the inkscape-docs mailing list and we can sort out any clogs.

The idea of the automatic deployment is that we can control the website via all the mechanisms we use to control code commits. This includes permissions, reversions, etc. Large changes can be held for review on staging while smaller changes can be merged into live without fuss.

[[Category:Translation]]

WebSite

2024-04-21T16:20:05Z

Ltlnx: Add an instruction to check the language the editor's in

The Inkscape project welcomes contributions to its website at https://inkscape.org/. Your help is valuable in different areas, and this page provides info to guide you.

We always need editors, translators, testers, designers and developers — and if you think you can help in any of those areas, please contact us by sending a mail to the translators' mailing list (for translations) or the documentation mailing list (for website development and contents).

== Editing ==

We have a [https://inkscape.org/*editor small team of people] who look after the web site contents, keep it up-to-date and constantly look for ways to improve it, by collecting information from various sources and presenting it on the web site. You can support us in various ways: suggest improvements or corrections, write contents about topics that are missing, write news articles and help with ‘marketing’, or join us long-term and help with contents maintenance.

=== General Rules ===

* All content on the website is licensed '''CC-BY-SA and GPLv2 or later'''. You will be required to agree to this license when you first edit a page.
* Don't disrupt existing pages. If you don't know what you want to do yet, then draft the page here on the wiki, Etherpad or in a separate page first.
* No page is precious to any one person. All pages can be edited by any editor and disputes about drafting changes should be brought to the inkscape-docs mailing list or website editor in chief.
* The website's content is usually very flexible to updates, but final decisions by the webmaster must be accepted by all editors.
* Page language in English or translated should keep to the contributors rules. No swearing, no aggressive content and on website pages there should be no opinion.
* Translations should be strictly a translation of the English versions of pages. If there is new content, it should be added to the English page first to keep all versions of the page in sync.
* When you have made a change to the English website that changes the contents (i.e. not correcting grammar or a typo), and thus requires translation, please kindly inform website translators via translators' mailing list of the change you made. Try to finalize your changes to a page, before you call out to them to do their work.

=== User Account ===


Please [https://inkscape.org/user/register/ register] an account using your email address and activate the account. Once active and logged in, please '''subscribe''' to the corresponding mailing list and email either the [https://inkscape.org/community/mailing-lists/ inkscape-docs or the inkscape-translators mailing list] to get more information. For translations, please add some more info to your email, and additionally open a request to join the website translators' team (see Translation section below) and start by contributing to the website's .po file for your language.

If you're approved, your account will then be enabled with the right permissions to add and edit any of the pages on the website. Please take care not to disrupt other content as you edit the website. As before, don't hesitate to ask other website editors on their mailing list if you need help.

If anything goes wrong while you are editing — for example, you encounter a bug, or you accidentally delete something you did not intend to delete, or something weird happens, and you don't know why —, please ask for help on one of the mailing lists — either translators, or inkscape-docs. You can also contact your team admin directly or file a bug report for the website at the [https://gitlab.com/inkscape/inkscape-web/-/issues bug tracker].

=== Using the Website Editor ===

Editors and translators can visit the Inkscape website, log in as themselves and edit and add content to the django content management system (cms). This does not require any code access but does require knowledge of html and staff access plus that you be in the Editors or Translators group to give you all the required permissions.

When you want to edit a page for the first time after the update, you will be asked to agree to publish your work under the website's licence. This will ensure that your work can be built upon by others in a safe manner.

REMEMBER: Your changes are NOT published until you press the publish button on the tool bar! Once a change is published, there is NO WAY TO UNDO it, so check carefully before publishing.

[[File:Toolbar live mode django-cms 3.2.0.png|600px|thumb|center|The toolbar in live mode]]

From the tool bar at the top of the web page you can turn editing on for any cms page you are visiting and edit the content therein. Ask for help if you get lost editing the various sections of the website.

[[File:Double-click.png|130px|thumb|right|Editing the inkscape.org website]]

The screenshot to the right shows a page with the editor mode switched on. As you can see, when your mouse hovers above an editable section of a web page, you are prompted to double-click to edit that page. This allows you to add new content blocks as well as edit existing blocks. Most pages will only have one such section, but the front page has several. If you need a page with a new design that has multiple blocks, please see website development below.

[[File:Toolbar edit mode changes django-cms 3.2.0.png|600px|thumb|center|The toolbar after you have saved your changes]]

The toolbar will indicate when there are changes on a page that can be published. Click on '''Publish changes''' to publish your (or another person's) changes, and / or click on '''View published''' to leave the edit mode.

To learn how to edit and tweak the front page, you can watch this video on YouTube (note: the video shows how this works on an older version of the website's cms, so icons and toolbar will look different):

[[File:Front-page-video.jpg|Watch the video!|thumb|center|link=https://www.youtube.com/watch?v=Rq2EFX9Aw70|[https://www.youtube.com/watch?v=Rq2EFX9Aw70 Click here to watch the video!] (12:36)]]

==== Specific Instructions ====

{| style="float: right;"
|-
| [[File:Create internal link.png|120px|thumb|center|Creating an internal link]] || [[File:Add external link.png|120px|thumb|center|Creating a link to an external page]]
|-
| || [[File:Add an image to website.png‎|120px|thumb|center|Dialog for adding pictures to the website]]
|-
| [[File:TOC icon.png|75px|thumb|center|A TOC plugin in edit mode]] || [[File:Inline TOC.png|120px|thumb|center|An inline TOC (can also be added as a ’sidebar’ on the right)]]
|}

'''Texts''': When you save a text plugin, you will be asked to fill in a short description of your changes at the bottom of the editor window. This little summary will be used for updating others about your changes. Please provide a meaningful message.

[[File:CMS Editor describe changes.png|600px|thumb|center|Add a description of your changes before saving]]

'''External tools''': If you decide to do your translations using your favourite editor, be sure to use a plain text editor for this. Office suites and other word processing tools that support formatting are unsuitable, because they might add additional formatting automatically, which can accidentally end up on the website and break the actual formatting.

'''Links''': To insert a link, use the small chain icon in the editor. The dialog that opens supports looking up pages on the Inkscape website, when you enter a part of the url. Urls on the Inkscape website should always be specified as relative urls, i.e. leave out the 'https://inkscape.org' part, and only use, for example, '/learn/faq/'. You may need to select '<other>' in the protocol dropdown, to not have to insert https etc. We're still trying to figure out how language redirects will work. In the meantime, if you want to add a link to your own language's version of the website, use the language code in the urls, and add the English url after, i.e. '/fr/learn/faq' for the previous example.

'''Images''': Images are plugins. They cannot be copied directly from one page to the other, unless one chooses ‘Copy all plugins from English’ to make a whole new page. To insert an image (raster images only, svg is not supported by our current plugin), choose ‘Picture’ from the plugin dropdown list and fill in the dialog with the necessary info. Don't forget to add licence and attribution info, if applicable. If you want to use a picture that is already used on a different page (e.g. when editing a translation), download that picture to your computer (use your browser's right-click menu for that) and upload it again using the picture plugin dialog.

'''TOC''': The TOC (Table of Contents) plugin can be inserted into pages with long texts to make navigating them easier for users. It will also add little anchor symbols behind all headings on that page, that other people can directly link to.

'''Other plugins''': The CMS widgets come in a number of types. File and Video widgets do as you would expect and allow you to add those media elements.

'''Spell Checking''': Your browser's spell checker will work when editing text. To change the language or access suggested replacements, hold Ctrl down while right-clicking into the text.

==== Known Issues ====

* '''IMPORTANT''': When you click on ‘Publish’ for a page, it may sometimes seem as if nothing happens for a few seconds. Don't click on ‘Publish’ twice, just wait until it starts by itself. Every click on this will send a mail to all subscribers, and add to the server load. Also, incomplete saves have been seen as a result.
* There's a ‘Create’ button now available in the top left. If you are a translator, you will never need this button. It is for creating new, non-translation pages.
* Copy-pasting any plugins, e.g. images or tables of contents (and changing them after this) will result in the plugin source page (i.e. the English page in most cases) being altered. Never copy plugins! Only copy contents using a detour via a '''plain text editor''', i.e. copy the text from a web page, then paste it into, say, Notepad, then copy it from there back into your translation and adjust the formatting manually.
* Hitting ‘Enter’ while editing a plugin in a pop-up dialog may lose previous page edits.
* Sometimes, the ‘Edit’ button is not available. Then you can still edit the page by going to ‘Page -> Edit this Page’ in the toolbar, or add ‘?edit’ to the URL.
* Sometimes, your edits will not be visible in the preview after you clicked on save. In this case, go to 'view published', then switch back to Edit mode. You should be able to see the changes now.
* Sometimes, ‘Publish’ is not available, even if you made changes to some plugins. In this case, go to ‘Page -> Unpublish Page’ in the toolbar, and when it has been unpublished, click on the big blue ‘Publish now’ button to publish.
* On pages with a table of contents plugin, publishing may result in the TOC title being added a second time. The duplicate title can usually just be edited out, and will not be duplicated again the next time you publish. Make sure to not delete the plugin, but just the duplicated heading.

== Translations ==

If you are fluent in a language different from English, please consider joining our [https://inkscape.org/*translator website translators' team]. We strive to make Inkscape accessible for as many people as possible, and internationalization is important to reach this goal.

For being able to translate the CMS contents and the news, you will first need to understand how [[#Editing|editing the website]] works.

=== Translating CMS contents ===

==== Adding a new translation ====

To '''add''' a translation of a page which does not yet exist:

* Navigate to the English page that you want to translate.
* Switch to Edit mode by clicking on the '''Edit''' button ([[Media:CMS toolbar Page Edit.png|Image 1]]).
* Now use the language chooser to switch to your language ([[Media:Select language.png|Image 2]]).
* You should now see a blue '''Page Settings''' button at the right. Click on it. (If there's a button that says 'Create', '''go back to the English page''' and switch to Edit mode. 'Create' will create a new page, not a translation.) ([[Media:CMS toolbar Page Settings button.png|Image 3]]).
* In the '''Page settings''', enter a title for your new translation and click on '''Save''' ([[Media:Add a language 2.png|Image 4]]).
* At first, the new page will be empty. We must now fill it with a copy of the English content. Start by toggling the structure mode view ([[Media:Toggle structure mode website.png|Image 5]]).
* Next, click on the topmost hamburger icon in the structure panel (next to the name of the template that is being used), and select '''Copy from English''' ([[Media:Copy plugins from English.png|Image 6]]).
* The page will now contain the same texts and widgets as the English version does. You can click on the structure toggle icon again to hide the structure overview. To start translating, double-click on a text ([[Media:Double-click to edit.png|Image 7]]).
* An editor window will pop up and you can translate the text ([[Media:Editor window.png|Image 8]]).
* If something does not look correct (for example, because you accidentally deleted a certain html tag), you can choose to edit the html source, too ([[Media:Editor window source.png|Image 9]]).
* When you are done, click on '''Save''' to save your work. Don't forget to leave a comment about your changes ([[Media:Save Edit with comment.png|Image 10]]).
* You can now take a look at your translation and if you are happy with your work, click on the '''Publish''' button at the top of the page. Only this will make your translation available to the site's visitors ([[Media:Publish page.png|Image 11]]).

<gallery>
File:CMS toolbar Page Edit.png|1 — Switch to edit mode in English
File:Select language.png|2 — Switch to your language
File:CMS toolbar Page Settings button.png|3 — Select Page Settings
File:Add_a_language_2.png|4 — Enter title
File:Toggle structure mode website.png|5 — Show page structure
File:Copy plugins from English.png|6 — Copy from English
File:Double-click to edit.png|7 — Double-click to edit plugin
File:Editor_window.png|8 — The editor window in WYSIWYG mode
File:Editor_window_source.png|9 — Editing the html source
File:Save Edit with comment.png|10 — Save your edit
File:Publish page.png|11 — Publish changes
</gallery>

Please note:

* Take extra care to '''always check''' if the language you are editing is the one you actually want to edit. Please '''DO NOT''' translate a piece of text while under English or another language as you will cause trouble for that language.
* Menu entries are translated separately at [https://inkscape.org/admin/el_menu/menuitem/] , and they update with a delay, so don't be surprised if your changes aren't visible right away.

==== Edit an existing translation ====

Many existing translations at inkscape.org are outdated, or contain a copy of an outdated English version. Please, before you start translating, make sure that you actually translate from the '''current''' English version. If the page is very outdated, consider deleting the blocks and copying all plugins from English, as described above in '''Adding a new translation'''.

To '''edit''' an existing translation, just go to the page in your language, toggle the ‘draft’ mode by clicking on the '''Edit''' button in the top bar and double-click on the widget you would like to translate.

If you edit an existing translation, because the English original has changed, you can do the following:

* Open the published English page, and also, in a second tab, your translation, in draft mode.
* Copy the new parts from English by selecting them with the mouse and hitting Ctrl+C.
* If they contain any pictures or other content that is a plugin:
** Paste them '''into a simple text editor''' (Ctrl+V), to remove the formatting and prevent plugins from being used on two different pages at the same time. Copy the clean text from the editor to the clipboard (Ctrl+C). If there are no plugins, you can also paste directly into the editor window.
** Insert this into your existing translation, in the correct place (Ctrl+V).
** Then translate the text and fix the formatting.
** Save.
** Continue with translation :)
* If there are no images, tables of contents or other plugins in the text you want to copy-paste:
** feel free to copy-paste it as a whole into your translation, and to translate in place.

==== Unpublishing ====
If a translated page contains outdated information, you might consider unpublishing it. Before you unpublish, please make sure to send a message to the inkscape-translators mailing list or the chat, to seek approval from other editors.
[[File:Empty all.png|alt=Screenshot of the website with the "Empty all" button highlighted|thumb|The "Empty all" button]]
After you got an approval, you can move on to unpublish the page. To do this:

* Check if you've switched to the desired language you want to unpublish. You may unpublish pages in other languages if you didn't make sure, so please be extra careful.
*Enter edit mode by going to Page > Edit this page.
* Click Page > Unpublish. This would unpublish the page, but keep the contents.
* Clear the contents by going to the sidebar, and clicking the topmost hamburger menu > Empty all. Click on "Yes, I'm sure" to confirm.
* Re-publish the page by clicking the blue "Publish page" button. '''Make sure to do this''' to ensure that only the page itself is unpublished, and its subpages will keep working. Otherwise all subpages will become 404 (Page not found).

=== Translating News ===

News are a special case on the Inkscape website. To translate a news article, visit it in your own language, then select ‘News -> Translate News’ in the toolbar at the top.

[[File:Translate news dropdown-fs8.png|600px|thumb|center|News app: Dropdown for translating news. Note that the language you will translate to is the one displayed in your URL.]]

Then a window pops up where you can fill in your translation of the news. The text editor boxes for the excerpt and the news article contents will be pre-filled with the English version. You can also always see the English original when you click on ‘Show’ below the editor box.

Text can be formatted by using the text editor's buttons, links can be added by marking some text and clicking on the link symbol. Edit links by right-clicking on the link, then select ‘Edit link’ from the context menu. Save your translation when you're done.

[[File:Translate news-fs8.png|600px|thumb|center|News app: Translating a news article on the Inkscape website. The slug (last part of the url) must be unique.]]

[[File:Edit news link-fs8.png|300px|thumb|right|News app: Right-click to edit a link]]

==== Known Issues ====

* When you double-click on a link in the news editor, you'll get a popup dialog where you cannot click on anything. If this happens, click on ‘Save’ in the parent dialog to not lose any translated work. Continue editing after this.
* When you save your translation for the first time, you may be redirected to a non-existent page (404 error). To return to the article to continue editing, just remove everything after the last slash in the url, and hit enter. Then select your article on the page where this brought you, and edit it again.
* Always make sure you're on the correct page - always check the language abbreviation in the URL! Do not translate English articles, even if a redirect accidentally brings you there.

=== Translating Download contents ===

You can add translations of [[Release notes]] on this wiki. For this you need an account on the wiki: ask the inkscape-translator mailing list for it if you don't have one. When you're done with your translation, tell the translation administrator by sending an email to inkscape-translator and they'll publish your translation on the website.

The platform names and descriptions as well as the installation instructions for some platforms are translatable from the CMS administration pages. You may or may not have access rights to translate them.

* If you have access rights: go to [https://inkscape.org/admin/releases/platform/ Releases > Platforms]. You'll see a table listing all the nodes of the platform tree. To see the tree more clearly, you can sort the table depending on the codename. From this table, choose the platform you want to translate, and type your translation in a new ‘Platform translation’ at the bottom.
* If you don't have access rights: you can send a text file to the inkscape-translator mailing list containing all your translations, and an authorized translator will set them for you.

=== Translating Menu contents ===

The menu items are translatable from the CMS administration pages.

* If you have access rights: go to [https://inkscape.org/admin/el_menu/menuitem/ EL_MENU > Menu items]. All menu items are listed here, you can use the "FILTER" on the right panel and select "Main Menu" under "By category". Select the menu you want to translate, then in the last row under "MENU TRANSLATIONS" (the last row is blank), choose the language and type the URL and your translation. Save to finish this translation.
* If you don't have access rights: you can send your translation in a text file to the inkscape-translator mailing list, and an authorized translator will set them for you. Please prepare the text file with a list of the following format:

<code>English menu entry, url, translated menu entry</code> 
(one line per entry)

e.g.

<pre>
Forums, /forums, Foren
Overview, /about/overview/, Übersicht
</pre>

=== Translating other parts of the website ===

There are a lot of other translatable sentences and phrases on the Inkscape website, which cannot be translated directly on the website itself. Those include words such as ‘Log in’, ‘Register’, ‘Confirm’ and ‘Save’.

If your language is not yet available on our website, you're still very welcome to help! In this case please file a [https://gitlab.com/inkscape/inkscape-web/-/issues bug report]. Then we can prepare the website for your changes and make the translation file available, so you can start working on it.

You can download the PO file for your language from the [https://gitlab.com/inkscape/inkscape-web-i18n website's translation repository]. See [[Translation information#PO translation files|here]] for info about how to deal with PO files.

When you are done, create a new issue [https://gitlab.com/inkscape/inkscape-web-i18n/-/issues in the repository at gitlab] and attach your changed file to it, or make a merge request, if you are familiar with git / gitlab.

== Website Development ==

The Inkscape project has a side project — inkscape-web — which produces the website seen by users and used by everyone to find resources.

You can support the website development with things as easy as reporting bugs, or focused testing, or you can volunteer to test the web site more systematically before a new release. Other important areas where you can help us are website design, and website development. If you would like to help, contact Martin Owens (doctormo@gmail.com).

These are the most important links:
* The published website: https://inkscape.org/
* The staging website (testing): http://staging.inkscape.org/ (currently unavailable)
* The project on Launchpad (only bug reports created before February 2017): https://launchpad.net/inkscape-web/bugs
* The project on gitlab (code repository and bug reports created since February 2017): https://gitlab.com/inkscape/inkscape-web

The guide below is for helping with the website development and to get a running version of the website for design work. The code is available on Gitlab in a [https://gitlab.com/inkscape/inkscape-web git repository].

=== Django and Python ===

The website is written in Python using the Django framework. It is a good idea to have a familiarity with Django and a fairly healthy experience with Python before starting code development on the website:
* To learn Python, attend these online classes: http://www.codecademy.com/en/tracks/python
* To get to know Django, see this tutorial: http://tutorial.djangogirls.org/

=== Local Development ===

You can start an instance of the website locally if you wish to work on the code or design.

Needed dependencies (on Fedora): python-virtualenv and python-dev.

==== Getting the Website Code ====

* Option A: <code>$ git clone https://gitlab.com/inkscape/inkscape-web.git</code>

* Option B (better):
** Create an ssh key if you don't have one yet, and upload your public ssh key to gitlab (instructions: https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html).
** <code>$ git clone git@gitlab.com:inkscape/inkscape-web.git</code>

==== Running the website locally ====

The following should download the code, set up the Python environment, set up your test database, download all the CMS data from the main website and run the server, showing its address (default is 127.0.0.1:8000):

# <code>$ ./utils/init</code>
# <code>$ ./utils/manage runserver [<domain>:<port>]</code>
# Open http://localhost:8000/ in your web browser (recommendation: Firefox or Chrome).
# Log in as the almighty admin user with username "admin" and password "123456".

You can also run the Django manage.py manually using:

<code>$ ./utils/manage <command></code>

The website's database is a local SQLite file in ./data/ as are all the uploaded files. These are not committed to the branch.

To sync the CMS contents with live again, use the refresh-cms command:

<code>$ ./utils/refresh-cms</code>

==== Updating your development version to the current trunk version ====

To get the latest changes for your branch, run:

<code>$ git pull</code>

To update your branch after a pull that introduces changes to the database structure or the installed applications, run:

<code>$ ./utils/update</code>

==== Troubleshooting ====

* Make sure your path to your local copy of inkscape-web only contains ASCII characters.
* If you have any other issues setting up your local environment, email doctormo@gmail.com, send a message to the docs mailing list or create a bug report in the bug tracker for inkscape-web.


==== Bug Reports ====

We use Launchpad's and Gitlab's bug tracker to report and track progress on bug reports. Please see https://bugs.launchpad.net/inkscape-web and https://gitlab.com/inkscape/inkscape-web/-/issues for possible things to fix.

==== Making changes ====

Once you have made your modifications, please commit back and push to your own fork of inkscape-web for review unless otherwise granted permission to commit to the master branch.

See https://docs.gitlab.com/ce/workflow/forking_workflow.html for more info on forking a project on gitlab and making merge requests.

To set the origin of your local copy of inkscape-web to a personal fork on gitlab, you can do the following:
<code>$ git remote set-url origin https://gitlab.com/USERNAME/OTHERREPOSITORY.git</code>

This will allow you to share your modifications on gitlab.

If you have '''developer access''' to the project, you can also create branches within the original inkscape-web repository.
One easy way to do so is via the button "New Branch" on any issue.

On the commandline, you'll need to do the following, after creating a new branch for your issue on gitlab:

# <code>$ git fetch</code>
# <code>$ git checkout branch_name</code>
# Work on code...
# <code>$ git commit -m "I fixed that annoying bug"</code>
# <code>$ git push origin branch_name</code>

You can add "Fixes #<issue number on gitlab>" to the commit message to tie together code and the bug report, if you didn't create the branch directly from the issue on gitlab.

=== When will your changes be available on inkscape.org? ===

The master branch is open to commits by members of the Inkscape group on gitlab. There is one other branch for live that is used to control deployment. For separate features and WIP, you're welcome to create your own branches in the inkscape-web repo on gitlab.

Deployment of branches should happen automatically by cron script on the server. If your commit is stuck, please ask for help on the inkscape-docs mailing list and we can sort out any clogs.

The idea of the automatic deployment is that we can control the website via all the mechanisms we use to control code commits. This includes permissions, reversions, etc. Large changes can be held for review on staging while smaller changes can be merged into live without fuss.

[[Category:Translation]]

WebSite

2024-04-21T16:14:56Z

Ltlnx: Add guide for unpublishing pages

The Inkscape project welcomes contributions to its website at https://inkscape.org/. Your help is valuable in different areas, and this page provides info to guide you.

We always need editors, translators, testers, designers and developers — and if you think you can help in any of those areas, please contact us by sending a mail to the translators' mailing list (for translations) or the documentation mailing list (for website development and contents).

== Editing ==

We have a [https://inkscape.org/*editor small team of people] who look after the web site contents, keep it up-to-date and constantly look for ways to improve it, by collecting information from various sources and presenting it on the web site. You can support us in various ways: suggest improvements or corrections, write contents about topics that are missing, write news articles and help with ‘marketing’, or join us long-term and help with contents maintenance.

=== General Rules ===

* All content on the website is licensed '''CC-BY-SA and GPLv2 or later'''. You will be required to agree to this license when you first edit a page.
* Don't disrupt existing pages. If you don't know what you want to do yet, then draft the page here on the wiki, Etherpad or in a separate page first.
* No page is precious to any one person. All pages can be edited by any editor and disputes about drafting changes should be brought to the inkscape-docs mailing list or website editor in chief.
* The website's content is usually very flexible to updates, but final decisions by the webmaster must be accepted by all editors.
* Page language in English or translated should keep to the contributors rules. No swearing, no aggressive content and on website pages there should be no opinion.
* Translations should be strictly a translation of the English versions of pages. If there is new content, it should be added to the English page first to keep all versions of the page in sync.
* When you have made a change to the English website that changes the contents (i.e. not correcting grammar or a typo), and thus requires translation, please kindly inform website translators via translators' mailing list of the change you made. Try to finalize your changes to a page, before you call out to them to do their work.

=== User Account ===


Please [https://inkscape.org/user/register/ register] an account using your email address and activate the account. Once active and logged in, please '''subscribe''' to the corresponding mailing list and email either the [https://inkscape.org/community/mailing-lists/ inkscape-docs or the inkscape-translators mailing list] to get more information. For translations, please add some more info to your email, and additionally open a request to join the website translators' team (see Translation section below) and start by contributing to the website's .po file for your language.

If you're approved, your account will then be enabled with the right permissions to add and edit any of the pages on the website. Please take care not to disrupt other content as you edit the website. As before, don't hesitate to ask other website editors on their mailing list if you need help.

If anything goes wrong while you are editing — for example, you encounter a bug, or you accidentally delete something you did not intend to delete, or something weird happens, and you don't know why —, please ask for help on one of the mailing lists — either translators, or inkscape-docs. You can also contact your team admin directly or file a bug report for the website at the [https://gitlab.com/inkscape/inkscape-web/-/issues bug tracker].

=== Using the Website Editor ===

Editors and translators can visit the Inkscape website, log in as themselves and edit and add content to the django content management system (cms). This does not require any code access but does require knowledge of html and staff access plus that you be in the Editors or Translators group to give you all the required permissions.

When you want to edit a page for the first time after the update, you will be asked to agree to publish your work under the website's licence. This will ensure that your work can be built upon by others in a safe manner.

REMEMBER: Your changes are NOT published until you press the publish button on the tool bar! Once a change is published, there is NO WAY TO UNDO it, so check carefully before publishing.

[[File:Toolbar live mode django-cms 3.2.0.png|600px|thumb|center|The toolbar in live mode]]

From the tool bar at the top of the web page you can turn editing on for any cms page you are visiting and edit the content therein. Ask for help if you get lost editing the various sections of the website.

[[File:Double-click.png|130px|thumb|right|Editing the inkscape.org website]]

The screenshot to the right shows a page with the editor mode switched on. As you can see, when your mouse hovers above an editable section of a web page, you are prompted to double-click to edit that page. This allows you to add new content blocks as well as edit existing blocks. Most pages will only have one such section, but the front page has several. If you need a page with a new design that has multiple blocks, please see website development below.

[[File:Toolbar edit mode changes django-cms 3.2.0.png|600px|thumb|center|The toolbar after you have saved your changes]]

The toolbar will indicate when there are changes on a page that can be published. Click on '''Publish changes''' to publish your (or another person's) changes, and / or click on '''View published''' to leave the edit mode.

To learn how to edit and tweak the front page, you can watch this video on YouTube (note: the video shows how this works on an older version of the website's cms, so icons and toolbar will look different):

[[File:Front-page-video.jpg|Watch the video!|thumb|center|link=https://www.youtube.com/watch?v=Rq2EFX9Aw70|[https://www.youtube.com/watch?v=Rq2EFX9Aw70 Click here to watch the video!] (12:36)]]

==== Specific Instructions ====

{| style="float: right;"
|-
| [[File:Create internal link.png|120px|thumb|center|Creating an internal link]] || [[File:Add external link.png|120px|thumb|center|Creating a link to an external page]]
|-
| || [[File:Add an image to website.png‎|120px|thumb|center|Dialog for adding pictures to the website]]
|-
| [[File:TOC icon.png|75px|thumb|center|A TOC plugin in edit mode]] || [[File:Inline TOC.png|120px|thumb|center|An inline TOC (can also be added as a ’sidebar’ on the right)]]
|}

'''Texts''': When you save a text plugin, you will be asked to fill in a short description of your changes at the bottom of the editor window. This little summary will be used for updating others about your changes. Please provide a meaningful message.

[[File:CMS Editor describe changes.png|600px|thumb|center|Add a description of your changes before saving]]

'''External tools''': If you decide to do your translations using your favourite editor, be sure to use a plain text editor for this. Office suites and other word processing tools that support formatting are unsuitable, because they might add additional formatting automatically, which can accidentally end up on the website and break the actual formatting.

'''Links''': To insert a link, use the small chain icon in the editor. The dialog that opens supports looking up pages on the Inkscape website, when you enter a part of the url. Urls on the Inkscape website should always be specified as relative urls, i.e. leave out the 'https://inkscape.org' part, and only use, for example, '/learn/faq/'. You may need to select '<other>' in the protocol dropdown, to not have to insert https etc. We're still trying to figure out how language redirects will work. In the meantime, if you want to add a link to your own language's version of the website, use the language code in the urls, and add the English url after, i.e. '/fr/learn/faq' for the previous example.

'''Images''': Images are plugins. They cannot be copied directly from one page to the other, unless one chooses ‘Copy all plugins from English’ to make a whole new page. To insert an image (raster images only, svg is not supported by our current plugin), choose ‘Picture’ from the plugin dropdown list and fill in the dialog with the necessary info. Don't forget to add licence and attribution info, if applicable. If you want to use a picture that is already used on a different page (e.g. when editing a translation), download that picture to your computer (use your browser's right-click menu for that) and upload it again using the picture plugin dialog.

'''TOC''': The TOC (Table of Contents) plugin can be inserted into pages with long texts to make navigating them easier for users. It will also add little anchor symbols behind all headings on that page, that other people can directly link to.

'''Other plugins''': The CMS widgets come in a number of types. File and Video widgets do as you would expect and allow you to add those media elements.

'''Spell Checking''': Your browser's spell checker will work when editing text. To change the language or access suggested replacements, hold Ctrl down while right-clicking into the text.

==== Known Issues ====

* '''IMPORTANT''': When you click on ‘Publish’ for a page, it may sometimes seem as if nothing happens for a few seconds. Don't click on ‘Publish’ twice, just wait until it starts by itself. Every click on this will send a mail to all subscribers, and add to the server load. Also, incomplete saves have been seen as a result.
* There's a ‘Create’ button now available in the top left. If you are a translator, you will never need this button. It is for creating new, non-translation pages.
* Copy-pasting any plugins, e.g. images or tables of contents (and changing them after this) will result in the plugin source page (i.e. the English page in most cases) being altered. Never copy plugins! Only copy contents using a detour via a '''plain text editor''', i.e. copy the text from a web page, then paste it into, say, Notepad, then copy it from there back into your translation and adjust the formatting manually.
* Hitting ‘Enter’ while editing a plugin in a pop-up dialog may lose previous page edits.
* Sometimes, the ‘Edit’ button is not available. Then you can still edit the page by going to ‘Page -> Edit this Page’ in the toolbar, or add ‘?edit’ to the URL.
* Sometimes, your edits will not be visible in the preview after you clicked on save. In this case, go to 'view published', then switch back to Edit mode. You should be able to see the changes now.
* Sometimes, ‘Publish’ is not available, even if you made changes to some plugins. In this case, go to ‘Page -> Unpublish Page’ in the toolbar, and when it has been unpublished, click on the big blue ‘Publish now’ button to publish.
* On pages with a table of contents plugin, publishing may result in the TOC title being added a second time. The duplicate title can usually just be edited out, and will not be duplicated again the next time you publish. Make sure to not delete the plugin, but just the duplicated heading.

== Translations ==

If you are fluent in a language different from English, please consider joining our [https://inkscape.org/*translator website translators' team]. We strive to make Inkscape accessible for as many people as possible, and internationalization is important to reach this goal.

For being able to translate the CMS contents and the news, you will first need to understand how [[#Editing|editing the website]] works.

=== Translating CMS contents ===

==== Adding a new translation ====

To '''add''' a translation of a page which does not yet exist:

* Navigate to the English page that you want to translate.
* Switch to Edit mode by clicking on the '''Edit''' button ([[Media:CMS toolbar Page Edit.png|Image 1]]).
* Now use the language chooser to switch to your language ([[Media:Select language.png|Image 2]]).
* You should now see a blue '''Page Settings''' button at the right. Click on it. (If there's a button that says 'Create', '''go back to the English page''' and switch to Edit mode. 'Create' will create a new page, not a translation.) ([[Media:CMS toolbar Page Settings button.png|Image 3]]).
* In the '''Page settings''', enter a title for your new translation and click on '''Save''' ([[Media:Add a language 2.png|Image 4]]).
* At first, the new page will be empty. We must now fill it with a copy of the English content. Start by toggling the structure mode view ([[Media:Toggle structure mode website.png|Image 5]]).
* Next, click on the topmost hamburger icon in the structure panel (next to the name of the template that is being used), and select '''Copy from English''' ([[Media:Copy plugins from English.png|Image 6]]).
* The page will now contain the same texts and widgets as the English version does. You can click on the structure toggle icon again to hide the structure overview. To start translating, double-click on a text ([[Media:Double-click to edit.png|Image 7]]).
* An editor window will pop up and you can translate the text ([[Media:Editor window.png|Image 8]]).
* If something does not look correct (for example, because you accidentally deleted a certain html tag), you can choose to edit the html source, too ([[Media:Editor window source.png|Image 9]]).
* When you are done, click on '''Save''' to save your work. Don't forget to leave a comment about your changes ([[Media:Save Edit with comment.png|Image 10]]).
* You can now take a look at your translation and if you are happy with your work, click on the '''Publish''' button at the top of the page. Only this will make your translation available to the site's visitors ([[Media:Publish page.png|Image 11]]).

<gallery>
File:CMS toolbar Page Edit.png|1 — Switch to edit mode in English
File:Select language.png|2 — Switch to your language
File:CMS toolbar Page Settings button.png|3 — Select Page Settings
File:Add_a_language_2.png|4 — Enter title
File:Toggle structure mode website.png|5 — Show page structure
File:Copy plugins from English.png|6 — Copy from English
File:Double-click to edit.png|7 — Double-click to edit plugin
File:Editor_window.png|8 — The editor window in WYSIWYG mode
File:Editor_window_source.png|9 — Editing the html source
File:Save Edit with comment.png|10 — Save your edit
File:Publish page.png|11 — Publish changes
</gallery>

Please note:

* Take extra care to '''always check''' if the language you are editing is the one you actually want to edit. Please '''DO NOT''' translate a piece of text while under English or another language as you will cause trouble for that language.
* Menu entries are translated separately at [https://inkscape.org/admin/el_menu/menuitem/] , and they update with a delay, so don't be surprised if your changes aren't visible right away.

==== Edit an existing translation ====

Many existing translations at inkscape.org are outdated, or contain a copy of an outdated English version. Please, before you start translating, make sure that you actually translate from the '''current''' English version. If the page is very outdated, consider deleting the blocks and copying all plugins from English, as described above in '''Adding a new translation'''.

To '''edit''' an existing translation, just go to the page in your language, toggle the ‘draft’ mode by clicking on the '''Edit''' button in the top bar and double-click on the widget you would like to translate.

If you edit an existing translation, because the English original has changed, you can do the following:

* Open the published English page, and also, in a second tab, your translation, in draft mode.
* Copy the new parts from English by selecting them with the mouse and hitting Ctrl+C.
* If they contain any pictures or other content that is a plugin:
** Paste them '''into a simple text editor''' (Ctrl+V), to remove the formatting and prevent plugins from being used on two different pages at the same time. Copy the clean text from the editor to the clipboard (Ctrl+C). If there are no plugins, you can also paste directly into the editor window.
** Insert this into your existing translation, in the correct place (Ctrl+V).
** Then translate the text and fix the formatting.
** Save.
** Continue with translation :)
* If there are no images, tables of contents or other plugins in the text you want to copy-paste:
** feel free to copy-paste it as a whole into your translation, and to translate in place.

==== Unpublishing ====
If a translated page contains outdated information, you might consider unpublishing it. Before you unpublish, please make sure to send a message to the inkscape-translators mailing list or the chat, to seek approval from other editors.
[[File:Empty all.png|alt=Screenshot of the website with the "Empty all" button highlighted|thumb|The "Empty all" button]]
After you got an approval, you can move on to unpublish the page. To do this:

* Enter edit mode by going to Page > Edit this page.
* Click Page > Unpublish. This would unpublish the page, but keep the contents.
* Clear the contents by going to the sidebar, and clicking the topmost hamburger menu > Empty all. Click on "Yes, I'm sure" to confirm.
* Re-publish the page by clicking the blue "Publish page" button. '''Make sure to do this''' to ensure that only the page itself is unpublished, and its subpages will keep working. Otherwise all subpages will become 404 (Page not found).

=== Translating News ===

News are a special case on the Inkscape website. To translate a news article, visit it in your own language, then select ‘News -> Translate News’ in the toolbar at the top.

[[File:Translate news dropdown-fs8.png|600px|thumb|center|News app: Dropdown for translating news. Note that the language you will translate to is the one displayed in your URL.]]

Then a window pops up where you can fill in your translation of the news. The text editor boxes for the excerpt and the news article contents will be pre-filled with the English version. You can also always see the English original when you click on ‘Show’ below the editor box.

Text can be formatted by using the text editor's buttons, links can be added by marking some text and clicking on the link symbol. Edit links by right-clicking on the link, then select ‘Edit link’ from the context menu. Save your translation when you're done.

[[File:Translate news-fs8.png|600px|thumb|center|News app: Translating a news article on the Inkscape website. The slug (last part of the url) must be unique.]]

[[File:Edit news link-fs8.png|300px|thumb|right|News app: Right-click to edit a link]]

==== Known Issues ====

* When you double-click on a link in the news editor, you'll get a popup dialog where you cannot click on anything. If this happens, click on ‘Save’ in the parent dialog to not lose any translated work. Continue editing after this.
* When you save your translation for the first time, you may be redirected to a non-existent page (404 error). To return to the article to continue editing, just remove everything after the last slash in the url, and hit enter. Then select your article on the page where this brought you, and edit it again.
* Always make sure you're on the correct page - always check the language abbreviation in the URL! Do not translate English articles, even if a redirect accidentally brings you there.

=== Translating Download contents ===

You can add translations of [[Release notes]] on this wiki. For this you need an account on the wiki: ask the inkscape-translator mailing list for it if you don't have one. When you're done with your translation, tell the translation administrator by sending an email to inkscape-translator and they'll publish your translation on the website.

The platform names and descriptions as well as the installation instructions for some platforms are translatable from the CMS administration pages. You may or may not have access rights to translate them.

* If you have access rights: go to [https://inkscape.org/admin/releases/platform/ Releases > Platforms]. You'll see a table listing all the nodes of the platform tree. To see the tree more clearly, you can sort the table depending on the codename. From this table, choose the platform you want to translate, and type your translation in a new ‘Platform translation’ at the bottom.
* If you don't have access rights: you can send a text file to the inkscape-translator mailing list containing all your translations, and an authorized translator will set them for you.

=== Translating Menu contents ===

The menu items are translatable from the CMS administration pages.

* If you have access rights: go to [https://inkscape.org/admin/el_menu/menuitem/ EL_MENU > Menu items]. All menu items are listed here, you can use the "FILTER" on the right panel and select "Main Menu" under "By category". Select the menu you want to translate, then in the last row under "MENU TRANSLATIONS" (the last row is blank), choose the language and type the URL and your translation. Save to finish this translation.
* If you don't have access rights: you can send your translation in a text file to the inkscape-translator mailing list, and an authorized translator will set them for you. Please prepare the text file with a list of the following format:

<code>English menu entry, url, translated menu entry</code> 
(one line per entry)

e.g.

<pre>
Forums, /forums, Foren
Overview, /about/overview/, Übersicht
</pre>

=== Translating other parts of the website ===

There are a lot of other translatable sentences and phrases on the Inkscape website, which cannot be translated directly on the website itself. Those include words such as ‘Log in’, ‘Register’, ‘Confirm’ and ‘Save’.

If your language is not yet available on our website, you're still very welcome to help! In this case please file a [https://gitlab.com/inkscape/inkscape-web/-/issues bug report]. Then we can prepare the website for your changes and make the translation file available, so you can start working on it.

You can download the PO file for your language from the [https://gitlab.com/inkscape/inkscape-web-i18n website's translation repository]. See [[Translation information#PO translation files|here]] for info about how to deal with PO files.

When you are done, create a new issue [https://gitlab.com/inkscape/inkscape-web-i18n/-/issues in the repository at gitlab] and attach your changed file to it, or make a merge request, if you are familiar with git / gitlab.

== Website Development ==

The Inkscape project has a side project — inkscape-web — which produces the website seen by users and used by everyone to find resources.

You can support the website development with things as easy as reporting bugs, or focused testing, or you can volunteer to test the web site more systematically before a new release. Other important areas where you can help us are website design, and website development. If you would like to help, contact Martin Owens (doctormo@gmail.com).

These are the most important links:
* The published website: https://inkscape.org/
* The staging website (testing): http://staging.inkscape.org/ (currently unavailable)
* The project on Launchpad (only bug reports created before February 2017): https://launchpad.net/inkscape-web/bugs
* The project on gitlab (code repository and bug reports created since February 2017): https://gitlab.com/inkscape/inkscape-web

The guide below is for helping with the website development and to get a running version of the website for design work. The code is available on Gitlab in a [https://gitlab.com/inkscape/inkscape-web git repository].

=== Django and Python ===

The website is written in Python using the Django framework. It is a good idea to have a familiarity with Django and a fairly healthy experience with Python before starting code development on the website:
* To learn Python, attend these online classes: http://www.codecademy.com/en/tracks/python
* To get to know Django, see this tutorial: http://tutorial.djangogirls.org/

=== Local Development ===

You can start an instance of the website locally if you wish to work on the code or design.

Needed dependencies (on Fedora): python-virtualenv and python-dev.

==== Getting the Website Code ====

* Option A: <code>$ git clone https://gitlab.com/inkscape/inkscape-web.git</code>

* Option B (better):
** Create an ssh key if you don't have one yet, and upload your public ssh key to gitlab (instructions: https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html).
** <code>$ git clone git@gitlab.com:inkscape/inkscape-web.git</code>

==== Running the website locally ====

The following should download the code, set up the Python environment, set up your test database, download all the CMS data from the main website and run the server, showing its address (default is 127.0.0.1:8000):

# <code>$ ./utils/init</code>
# <code>$ ./utils/manage runserver [<domain>:<port>]</code>
# Open http://localhost:8000/ in your web browser (recommendation: Firefox or Chrome).
# Log in as the almighty admin user with username "admin" and password "123456".

You can also run the Django manage.py manually using:

<code>$ ./utils/manage <command></code>

The website's database is a local SQLite file in ./data/ as are all the uploaded files. These are not committed to the branch.

To sync the CMS contents with live again, use the refresh-cms command:

<code>$ ./utils/refresh-cms</code>

==== Updating your development version to the current trunk version ====

To get the latest changes for your branch, run:

<code>$ git pull</code>

To update your branch after a pull that introduces changes to the database structure or the installed applications, run:

<code>$ ./utils/update</code>

==== Troubleshooting ====

* Make sure your path to your local copy of inkscape-web only contains ASCII characters.
* If you have any other issues setting up your local environment, email doctormo@gmail.com, send a message to the docs mailing list or create a bug report in the bug tracker for inkscape-web.


==== Bug Reports ====

We use Launchpad's and Gitlab's bug tracker to report and track progress on bug reports. Please see https://bugs.launchpad.net/inkscape-web and https://gitlab.com/inkscape/inkscape-web/-/issues for possible things to fix.

==== Making changes ====

Once you have made your modifications, please commit back and push to your own fork of inkscape-web for review unless otherwise granted permission to commit to the master branch.

See https://docs.gitlab.com/ce/workflow/forking_workflow.html for more info on forking a project on gitlab and making merge requests.

To set the origin of your local copy of inkscape-web to a personal fork on gitlab, you can do the following:
<code>$ git remote set-url origin https://gitlab.com/USERNAME/OTHERREPOSITORY.git</code>

This will allow you to share your modifications on gitlab.

If you have '''developer access''' to the project, you can also create branches within the original inkscape-web repository.
One easy way to do so is via the button "New Branch" on any issue.

On the commandline, you'll need to do the following, after creating a new branch for your issue on gitlab:

# <code>$ git fetch</code>
# <code>$ git checkout branch_name</code>
# Work on code...
# <code>$ git commit -m "I fixed that annoying bug"</code>
# <code>$ git push origin branch_name</code>

You can add "Fixes #<issue number on gitlab>" to the commit message to tie together code and the bug report, if you didn't create the branch directly from the issue on gitlab.

=== When will your changes be available on inkscape.org? ===

The master branch is open to commits by members of the Inkscape group on gitlab. There is one other branch for live that is used to control deployment. For separate features and WIP, you're welcome to create your own branches in the inkscape-web repo on gitlab.

Deployment of branches should happen automatically by cron script on the server. If your commit is stuck, please ask for help on the inkscape-docs mailing list and we can sort out any clogs.

The idea of the automatic deployment is that we can control the website via all the mechanisms we use to control code commits. This includes permissions, reversions, etc. Large changes can be held for review on staging while smaller changes can be merged into live without fuss.

[[Category:Translation]]

File:Empty all.png

2024-04-21T16:06:44Z

Ltlnx:

Screenshot of the website, showing the sidebar with the hambueger menu open, with the cursor pointing at a list item named "Empty all".

Google Season of Docs 2024

2024-03-29T16:13:44Z

Ltlnx: Corrected current version, typo fix

GSoD is a Google program to connect professional technical writers with open source projects.

https://developers.google.com/season-of-docs?hl=de

On this page, we can collect ideas for our participation in the 2024 round of GSoD. Add your ideas by creating a new proposal!
==About your organisation==

Inkscape (current version 1.3.2, first released in 2003) is a GPL-licensed program for creating artwork using SVG as its native format. Inkscape is widely used to create artwork (web graphics, logos, book illustrations, comics, games, and scientific publications) that require scalability. It is available for Linux, Windows and MacOS with millions of users.

Inkscape is a member of the Software Freedom Conservancy.
==About your project: Update INKSCAPE – Guide to a Vector Drawing Program==
===Your project's problem===
Inkscape is a very large and complex program. Many books, on-line tutorials, and videos are available to help people to learn to use Inkscape. What is missing, though, is an up-to-date, complete manual that covers all parts of Inkscape. The most complete on-line manual, [http://tavmjong.free.fr/INKSCAPE/MANUAL/html/index.html Inkscape: Guide to a Vector Drawing Program] (freely available on the web and linked to from Inkscape itself), is woefully out-of-date. The last complete update of this manual was done in 2011, with a partial update in 2017. Despite that, Inkscape users still find it quite useful (as documented by the number of times users are directed to it on social media).
Your project's scope.

This project will bring the on-line manual up-to-date:
*Update the tutorials.
*Update chapters on each part of Inkscape's interface.
*Create new chapters for new tools (The Shape Builder and Pages).
*Create new sections for new dialogs.
*Move the on-line website from the Author's personal site to Inkscape's official site. (Apart from looking more official, this would enable use of https, making indexing by Google easier, as well as provide more reliable hosting).

Out-of-scope work:
*Update or include tutorials reserved under contract to the publisher of the printed book.
As a side benefit, revising the manual will probably uncover regressions and bugs with newer Inkscape versions, which we can then track and fix.

The author of the original manual is available to write the update with review by volunteers.

===Measuring your project's success===
The number of times that users access the on-line book would be an indication of the success of the project, however, Inkscape's long term commitment to user's privacy makes this difficult. A simpler measure of the success of the project would be the number of sections updated.

===Timeline===
Updating the full manual is a year-long part-time project, however, Inkscape would still benefit greatly if a significant fraction of the manual was updated. The target for this program would be to update half the book, focusing on the most pressing parts.

===Dates===
{| class="wikitable"
!Dates
!Action Items
|-
|May
|Preliminary work (Gitlab site, continue with DocBook or switch to another source format, update tooling, etc.)
|-
|June-July
|Update introductory text and tutorials.
|-
|August
|Create new chapters for Shape tool and Page tool.
|-
|September-November
|Update individual chapters, prioritized by the Inkscape community.
|}

=== Project Budget ===
{| class="wikitable"
!Budget item
!Amount
!Running Total
!Notes/justifications
|-
|Technical writer, manual update.
|12500.00
|12500.00
|
|-
|Volunteer stipends
|500.00
|13500.00
|2 volunteer stipends x 500 each
|-
|Software Freedom Conservancy fee
|1500.00
|15000.00
|Inkscape is a member of SFC (as suggested also on the [https://developers.google.com/season-of-docs/docs/org-payments GSoD documentation]), and due to our fiscal sponsorship agreement, the SFC takes a 10% cut of the gross income of the project.
|-
|TOTAL
|
|15000.00
|
|}

=== Additional information ===

* '''Previous experience with technical writers or documentation:''' Inkscape maintains a [https://inkscape.org website] with user and developer documentation. Keeping this website current is a one of the most difficult problems we face. All contributions have been made by volunteers.
* '''Previous participation in Google Season of Docs, Google Summer of Code or others:''' Inkscape has participated in Google Summer of Code every year except for one, since its inception. GSoC students have made significant contributions to Inkscape.
* '''Disclosure:''' The manual’s author is a long-time Inkscape contributor and is a member of Inkscape's Project Leadership Committee.

{| class="wikitable"
|+
|}

==About your project: Update Inkscape's Beginners' guide==
Inkscape has an official user manual hosted at [https://inkscape-manuals.readthedocs.io/en/latest/ ReadTheDocs], which covers basic usage of Inkscape, with guides on drawing tools, colors, text, etc. However the manual is currently targeting Inkscape 1.1, while the latest version is 1.3.2. In between, there are a number of undocumented changes, such as the new Live Path Effects dialog, on-canvas pattern editing, spiro and BSpline path support, multiple pages support, shape builder and more. Other parts of the manual (shortcuts, icons, etc.) also need updating to reflect the current user interface. These missing functionalities and outdated instructions confuse newcomers, which the manual primarily targets. Additionally, the manual lacks consistency in the colors and resolutions used in figures and the comprehensiveness of tool descriptions. The manual also lacks a contribution guide, including how to contribute translations, which makes it difficult for new contributors to help with user-facing documentation.

===Your project's scope===
The Inkscape Beginner’s Guide update project will:

*Review the current guide and mark all places that needs an update within a Gitlab issue (with sub-issues if needed).
*Add pages and paragraphs for new tools in appropriate locations, such as the Pages tool and the Measure tool under 'Useful Techniques', the filter editor dialog in the 'Filters' page, the new color wheel in the 'Fill and Stroke' page, etc.
*Update parts of the guide according to the aforementioned issue.
*Create a 'style guide' in the README documenting the tone of voice of the guide, colors and proportions used for figures. Include information about the translation process in the contributors guide, and document language-specific details (such as the use of “you” and “we” in English).
*Re-capture screenshots of the current interface and redraw figures according to the style guide.
*Edit the guide to make wording and grammar consistent.
*Work with the inkscape-docs team to update the documentation on the ReadTheDocs site.

Work that is out-of-scope for this project:

*This project will not create tutorial pages that incorporates multiple tools. (This comes after the project ends)

===Measuring your project's success===
The Inkscape forum and chatroom currently recieves a number of questions per day, some of which are related to new features, therefore we aren’t able to refer them to the manual. The improved documentation would give people a definitive source to point to when answering questions, and we hope it helps people understand the tools further in addition to solving the problem. We also think that the contribution guide would help aspiring manual writers and translators make their first contribution, which hopefully makes them stick around and contribute further.

We will track the number of total visitors monthly, and the amount of merge requests and issues opened quarterly after the manual is updated.

We will consider the project successful if, after publication of the new manual:

*The number of individual visitors (indicated by ReadTheDocs) increases by 15%
*Translations for at least one additional language is being worked on
*The number of contributors who have made >3 contributions increases by 10% (beginning the quarter after the documentation is published)

===Timeline===
The project will take approximately 6 months to complete. We’ll spend a month creating the style guide and documenting required changes and additions, 4 months editing and creating pages, and 1 month revising all aspects of the manual adhering to the style guide.
{| class="wikitable"
!Dates
!Action Items
|-
|May
|Create style guide and document required changes and additions
|-
|June - September
|Edit and create pages
|-
|October
|Revise the text and figures
|-
|November
|Project completion
|}

===Project Budget===
{| class="wikitable"
!Budget item
!Amount
!Running Total
!Notes/justifications
|-
|Technical writer, manual update.
|12500.00
|12500.00
|
|-
|Volunteer stipends
|500.00
|13500.00
|2 volunteer stipends x 500 each
|-
|Software Freedom Conservancy fee
|1500.00
|15000.00
|Inkscape is a member of SFC (as suggested also on the [https://developers.google.com/season-of-docs/docs/org-payments GSoD documentation]), and due to our fiscal sponsorship agreement, the SFC takes a 10% cut of the gross income of the project.
|-
|TOTAL
|
|15000.00
|
|}

===Additional information===
*'''Previous experience with technical writers or documentation:''' Inkscape maintains a [https://inkscape.org website] with user and developer documentation. Keeping this website current is a one of the most difficult problems we face. All contributions have been made by volunteers.
*'''Previous participation in Google Season of Docs, Google Summer of Code or others:''' Inkscape has participated in Google Summer of Code every year except for one, since its inception. GSoC students have made significant contributions to Inkscape.