UserManualOutline

2008-07-15T13:16:49Z

Relsi.ramone: /* Future manual outline */

== Future manual outline ==

'''Introduction to Inkscape'''
* About SVG
* State of available SVG software
* Inkscape Goals

'''Basics''' (already outlined, needs some refinement)
* Interface ''(no real depth here - just a basic overview of how these things work, where they are, what they look like...)''
** Menus
** Command Bar
** Toolbars
** Tool Options
** Working with the Canvas
** Rulers, Guides and Grids
** Palette
** Information Bar
** Dialogs (at least the difference between floating/docked)

'''Documents'''
* Document properties
* Creating templates
* Metadata

'''Toolbox'''
* Selector
* Navigation tools
* Drawing tools
* Transformation tools
* Color tools
* Text
* Connector

'''Objects'''
* copying and pasting (+ styles)
* transformations
* grouping
* cloning
* whatever else

'''Layers'''
* layers
* working with layers in Inkscape

'''Paths'''

'''Colors'''
* fill'n'stroke
* swatches
* color management
* link to gradient tool
* probably "clean up defs"

'''Patterns'''

'''Effects'''
* modification effects
* raster effects
* Live Path Effects
* SVG filters
* creating new effects (i.e. Python scripts tutorial)

'''Setting up Inkscape (Preferences)'''

'''Additional help resources'''
* everything from Help menu
* copy of the page that links to international sites
* mailing lists

User manual information

2008-07-15T12:37:25Z

Relsi.ramone: /* People */

We need to work now on an update of this Manual and have a specific version for Inkscape.

* Queries about Manual can be added here or sent to <cedric@le-radar.com>

== Work in progress ==

[[User Manual Work in Progress]] reflects current work on the guide.

We track ongoing work for various languages right on FM website:

* [http://en.flossmanuals.net/bin/view/Inkscape/WebHome Status for English version]

== Translations of the manual ==

* [http://wiki.inkscape-forum.de/handbuch German] started by [[User:FZap]] - will need to be merged once we are ready

== Getting the latest version ==
* If you want to contribute, download the USER_MANUAL part of SVN (http://inkscape.svn.sourceforge.net/viewvc/inkscape/user_manual/trunk/)
svn co https://inkscape.svn.sourceforge.net/svnroot/inkscape/user_manual/trunk user_manual
* If you just want to browse to find a subject, go to http://www.le-radar.com/?mm/inkscape_inkscape.rss and choose your language. It is the most up-to-date version
* Also, see [http://oerks.net/~colin/alltutorials/inkscapeUTFen.pdf inkscapeUTFen.pdf] and [http://oerks.net/~colin/alltutorials/inkscapeUTFfr.pdf inkscapeUTFfr.pdf] for the manual processed with [http://dblatex.sf.net dblatex]
* An alternative, in-progress, unofficial version can be found at http://www.usinginkscape.com/usermanual

== How to Help ==

* [http://lists.sourceforge.net/mailman/listinfo/inkscape-docs Subscribe] to the inkscape-docs mailing list and tell us what you are planning to do so that no work is duplicated
* Adding new information to the manual: write your files in docbook or in plain text that we'll convert (please follow the [[User Manual Guidelines]])
* translating pages
* contact a contributor or add your name in the list below and have a look at the [[User Manual Work in Progress]]

* To view the current state in HTML, type "make fr" or "make en" (xsltproc is needed). See the Makefile for other targets.
* For pictures, you may use the "images/sshot_yourlanguage" directory or create it if necessary".
* Don't translate anything yet, we are working on the [[French Version]], which will then be translated into English, and that will become the basis for translation work. You will get a PO file for translating later.

== People ==
* '''[[User:Relsi.ramone|Relsi Ramone]]''' - Contributor for Brazilian Portuguese - ''relsi.ramone at gmail.com''
* '''[[User:Cedric|Cedric Gemy]]''' - main contributor - ''cedric at le-radar.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, DocBook/XML nerd :)

== Misc ==
* automated screenshot taking: maybe via [http://people.redhat.com/zcerza/dogtail/ Dogtail] (see [http://www.redhat.com/magazine/020jun06/features/dogtail/] and [http://www.redhat.com/magazine/021jul06/features/dogtail/]) or [http://ldtp.freedesktop.org/ LDTP]?
:: see http://live.gnome.org/autoshot, http://osdir.com/ml/gnome.documentation/2006-08/msg00045.html

* the [http://inkscape.org/doc/inkscape-man.html Inscape "man page"]

* [[VectorAndBitmap]]
* [[Inkscape for Adobe Illustrator users]]
* [[TricksAndTips]]
* [[KeyboardShortcuts]]
* [[InkscapeColor]]

* [[DocumentationReferences]] for us who don't know anything about DocBook, etc.

==TODO==
* rename the files to e.g. user_manual.fr.xml
* add Makefile target that uploads a manual snapshot to the Inkscape website
* Create a new [[userManualOutline]]
* Determine [[DocumentationStandards]]
[[Category:User Documentation]]
[[Category:Needs Work]]

Inkscape Wiki - User contributions [en]

UserManualOutline

User manual information