Difference between revisions of "User manual information"

From Inkscape Wiki
Jump to navigation Jump to search
 
 
(91 intermediate revisions by 25 users not shown)
Line 1: Line 1:
This is mainly a scratchpad to begin working out the UserManual. We can post ideas and fragments of text up here, but the real deal will be in CVS so that it can be checked out and worked on.
== Read ==


: Why not write the manual here? Use wiki as a versioning & collaboration tool -- that's what it's for :) You can then use a script to turn raw wiki pages into whatever format you need for the distribution
There exist a number of comprehensive manuals for Inkscape:
*[http://tavmjong.free.fr/INKSCAPE/MANUAL/html/ Inkscape: Guide to a Vector Drawing Program] by Tavmjong Bah
*[https://inkscape-manuals.readthedocs.io/en/latest/ Inkscape Beginner's Guide]


Currently in CVS there is a manual (or beginnings of a manual) that was written in French for SodiPodi. Has anyone looked at it? What are your thoughts?
An always up-to-date list is available at [https://inkscape.org/en/learn/books/ the main Inkscape website].


* VectorAndBitmap
== Contribute ==
* [IllustratorUsers Inkscape for Illustrator Converts]
* TricksAndTips
* KeyboardShortcuts
* InkscapeColor


#Join [https://chat.inkscape.org/channel/documentation Documenation Chat]
# Familiarize yourself with lates up to date [https://inkscape.org/en/learn/books/ manuals]
# Introduce yourself on chat and tell us what you want to do so we can avoid duplicating work
# Ask on the list how you can start to contribute.


We need to work now on an update of this Manual and have a specific version for Inkscape.
Here is a hint: we try to use as much content from release notes as possible, since last 5-6 ones were written in a very much verbose way.


* Wishs about Manual can be added here or sent to cedric@le-radar.com
<!-- '''Outdated!''' Here is how you translate:


== WHERE MAY I FIND THE LAST UPDATE ==
# In your translation zone you will see contents of the book. For each chapter there are "Edit" and "Translate" links and a status combobox that reveals various options. Start with those chapters which are marked as "Untranslated".
* If you want to contribute, downlad the CVS
# Click "Translate"
* If you just want to browse to find a subject, you can go to http://www.le-radar.com/?mm/inkscape. It is the most up2date.
# In the newly opened copy'n'paste contents of the most recent revision of chapter fromthe left editing field to the right one. A sequence of Ctrl+C and Ctrl+C should do the trick
# Translate
# Choose a new status of the newly created translation. '''Untranslated''' — if you just copy'n'pasted original text in English. '''Unpublished''' — if you translated the text, but want to review and improve it before it goes live.  '''Published''' — if your translation is '''really''' ready to go live and visible for everybody else.
# Click 'Save'


== HOW TO HELP ==
You can still do further revision of that chapter anytime by clicking 'Edit' from the Contents table.
* adding new infos to the manual : write your files in docbook or in plain text that we'll convert (please follow [[Manualguidelines.html|guidelines]])
* translating pages
* contact a contributor or add your name in the follow list and have a look at the [[Manualwip.Html|WIP]]


PEOPLE
Reading [http://en.flossmanuals.net/bin/view/Inkscape/WritingConventions writing conventions] is strictly recommended for better understanding of markup rules and use of styles.
*Cedric : main contributor : cedric at le-radar.com
 
*John : author and fr/gb translation :
You can also track revisions in the translation zone by clicking "Subscribe" link in the translation zone index page. This will enable mailing you list of changes (to the address with which you registered in the system). -->
*Ernesto : spanish translation : celise at prodigy.net.mx
An old To-Do list for the manual is available [[User Manual Work in Progress|here]].
*Antonio : italian translation : antonio.angelo at poste.it
 
*Bryce: english translation/editing : bryce at bryceharrington.com
== Translate ==
 
We very much welcome translations of the manual. Please [http://lists.sourceforge.net/mailman/listinfo/inkscape-docs join] the inkscape-docs mailing list and tell us about yourself.
 
So far we have established the following translations “zones”:
 
* [http://fr.flossmanuals.net/ French]
<!-- '''Outdated!''' Here is how you translate:
 
# In your translation zone you will see contents of the book. For each chapter there are "Edit" and "Translate" links and a status combobox that reveals various options. Start with those chapters which are marked as "Untranslated".
# Click "Translate"
# In the newly opened copy'n'paste contents of the most recent revision of chapter fromthe left editing field to the right one. A sequence of Ctrl+C and Ctrl+C should do the trick
# Translate
# Choose a new status of the newly created translation. '''Untranslated''' — if you just copy'n'pasted original text in English. '''Unpublished''' — if you translated the text, but want to review and improve it before it goes live.  '''Published''' — if your translation is '''really''' ready to go live and visible for everybody else.
# Click 'Save'
 
You can still do further revision of that chapter anytime by clicking 'Edit' from the Contents table.
 
Reading [http://en.flossmanuals.net/bin/view/Inkscape/WritingConventions writing conventions] is strictly recommended for better understanding of markup rules and use of styles.
 
You can also track revisions in the translation zone by clicking "Subscribe" link in the translation zone index page. This will enable mailing you list of changes (to the address with which you registered in the system). -->
 
It's best to team up with several people and coordinate your efforts.
 
We still haven't decided how to provide source SVG files in most comfortable way to make localization of illustrations easy. Ideas are welcome.
 
Note that French translation is placed in a different zone, because it's mostly ready. As soon as each translation is close to completeness, it is moved to its own subdomain too.
 
== People ==
A few of these are no longer active on the Inkscape project.
 
* '''[[User:Relsi.ramone|Relsi Ramone]]''' — Contributor for Brazilian Portuguese — ''relsi.ramone at gmail.com''
* '''[[User:Cedric|Cedric Gemy]]''' — Contributor in French — ''cedric.gemy at gmail.com''
* '''[[User:Elisa-yemanja|Elisa]]''' — Contributor in French — ''elisa at ec.yemanja.net''
* '''John''' — Author and French/British translation  
* '''Ernesto''' — Spanish translation — ''celise at prodigy.net.mx''
* '''Antonio''' — Italian translation — ''antonio.angelo at poste.it''
* '''Bryce''' — English translation/editing — ''bryce at bryceharrington.com''
* '''Kevin''' — English translation/editing — ''inkscape.docs at wixsonit.com''
* '''[[User:Colin Marquardt|Colin Marquardt]]''' — Volunteer for a German translation from English, help with xml2po if needed; especially interested in [[Embedded Help]].
* '''[[User:vonHalenbach|vonHalenbach-de]]''' — Volunteer for a translation of pygmees manual from English to German
* '''[[User:Prokoudine|Alexandre Prokoudine]]''' — Volunteer for a translation into Russian
* '''[[User:Frigory|Sylvain Chiron]]''' — Volunteer for a translation into French
 
== Misc ==
 
* The [https://inkscape.org/doc/inkscape-man.html Inscape “man page”]
 
* [[Vector and bitmap]]
* [[Inkscape for Adobe Illustrator users]]
* [[Tricks and tips]]
* [[Keyboard shortcuts]]
* [[Color management]]
 
[[Category:User Documentation]]
[[Category:Needs Work]]

Latest revision as of 08:03, 7 April 2025

Read

There exist a number of comprehensive manuals for Inkscape:

An always up-to-date list is available at the main Inkscape website.

Contribute

  1. Join Documenation Chat
  2. Familiarize yourself with lates up to date manuals
  3. Introduce yourself on chat and tell us what you want to do so we can avoid duplicating work
  4. Ask on the list how you can start to contribute.

Here is a hint: we try to use as much content from release notes as possible, since last 5-6 ones were written in a very much verbose way.

An old To-Do list for the manual is available here.

Translate

We very much welcome translations of the manual. Please join the inkscape-docs mailing list and tell us about yourself.

So far we have established the following translations “zones”:

It's best to team up with several people and coordinate your efforts.

We still haven't decided how to provide source SVG files in most comfortable way to make localization of illustrations easy. Ideas are welcome.

Note that French translation is placed in a different zone, because it's mostly ready. As soon as each translation is close to completeness, it is moved to its own subdomain too.

People

A few of these are no longer active on the Inkscape project.

  • Relsi Ramone — Contributor for Brazilian Portuguese — relsi.ramone at gmail.com
  • Cedric Gemy — Contributor in French — cedric.gemy at gmail.com
  • Elisa — Contributor in French — elisa at ec.yemanja.net
  • John — Author and French/British translation
  • Ernesto — Spanish translation — celise at prodigy.net.mx
  • Antonio — Italian translation — antonio.angelo at poste.it
  • Bryce — English translation/editing — bryce at bryceharrington.com
  • Kevin — English translation/editing — inkscape.docs at wixsonit.com
  • Colin Marquardt — Volunteer for a German translation from English, help with xml2po if needed; especially interested in Embedded Help.
  • vonHalenbach-de — Volunteer for a translation of pygmees manual from English to German
  • Alexandre Prokoudine — Volunteer for a translation into Russian
  • Sylvain Chiron — Volunteer for a translation into French

Misc

Retrieved from "https://wiki.inkscape.org/wiki/index.php?title=User_manual_information&oldid=123164"