Re: [Inkscape-devel] Snap Control
Technically, while it's in the user manual, the user manual is in French, and the English translation is very incomplete. Also note that the manual was written for Sodipodi rather than Inkscape, so does not yet address the new user interface, etc.
I think it would be easier just to start over using Wiki. Whenever anyone has got a good idea (not necessarily 100% complete or even correct) of how some command, tool, dialog etc works, just take a couple minutes to visit Wiki and share your knowledge (on a page under User Documentation Scratchpad). Or when you have nothing better to do, edit and unify other's notes, add screenshots, etc.
_________________________________________________________________ The new MSN 8: advanced junk mail protection and 2 months FREE* http://join.msn.com/?page=dept/bcomm&pgmarket=en-ca&RU=http%3a%2f%2f...
I agree. This is part of the entire help system, which I have not laid a hand on yet, but I know we need to address in a major way in the coming releases. I will look into a plan more and report back soon.
I haven't looked at the manual yet, but I'm gonna probably think we need a new one completely. It would be good as well to develop some tutorials for the website. Maybe DEFENDGUIN could help me out with this task on down the road?
Jon
On Wed, 2004-01-14 at 10:10, bulia byak wrote:
Technically, while it's in the user manual, the user manual is in French, and the English translation is very incomplete. Also note that the manual was written for Sodipodi rather than Inkscape, so does not yet address the new user interface, etc.
I think it would be easier just to start over using Wiki. Whenever anyone has got a good idea (not necessarily 100% complete or even correct) of how some command, tool, dialog etc works, just take a couple minutes to visit Wiki and share your knowledge (on a page under User Documentation Scratchpad). Or when you have nothing better to do, edit and unify other's notes, add screenshots, etc.
The new MSN 8: advanced junk mail protection and 2 months FREE* http://join.msn.com/?page=dept/bcomm&pgmarket=en-ca&RU=http%3a%2f%2f...
This SF.net email is sponsored by: Perforce Software. Perforce is the Fast Software Configuration Management System offering advanced branching capabilities and atomic changes on 50+ platforms. Free Eval! http://www.perforce.com/perforce/loadprog.html _______________________________________________ Inkscape-devel mailing list Inkscape-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/inkscape-devel
On Wed, 14 Jan 2004, bulia byak wrote:
Date: Wed, 14 Jan 2004 18:10:27 +0000 From: bulia byak <archiver_1@...19...> To: bryce@...1..., vellum@...68... Cc: inkscape-devel@lists.sourceforge.net Subject: Re: [Inkscape-devel] Snap Control
Technically, while it's in the user manual, the user manual is in French, and the English translation is very incomplete. Also note that the manual was written for Sodipodi rather than Inkscape, so does not yet address the new user interface, etc.
I think it would be easier just to start over using Wiki. Whenever anyone has got a good idea (not necessarily 100% complete or even correct) of how some command, tool, dialog etc works, just take a couple minutes to visit Wiki and share your knowledge (on a page under User Documentation Scratchpad). Or when you have nothing better to do, edit and unify other's notes, add screenshots, etc.
The major downside of Wiki is exporting the content (say for example to something like HTML or Docbook) and shipping documentation with the software. Wiki is fine for FAQ and also useful for starting documentation. When the documentation has progressed substantially if you are willing to then gather the content from Wiki and move it and reformat it for use in a more convential HTML/Docbook way and make sure it gets shipped with Inkscape then it should work out well but the extra step could be time consuming.
Just trying to explain my reservations about Wiki without too much prejudice. Hopefully that made sense.
Sincerely
Alan Horkan http://advogato.org/person/AlanHorkan/
On Wed, 14 Jan 2004, Alan Horkan wrote:
The major downside of Wiki is exporting the content (say for example to something like HTML or Docbook) and shipping documentation with the software. Wiki is fine for FAQ and also useful for starting documentation. When the documentation has progressed substantially if you are willing to then gather the content from Wiki and move it and reformat it for use in a more convential HTML/Docbook way and make sure it gets shipped with Inkscape then it should work out well but the extra step could be time consuming.
Yes, that's the strategy we have been following. Wiki is great for the initial brainstorming of the documentation and is convenient for entering content but it is difficult to publish from.
In other projects we had explored trying to find ways to tie in Wiki to better export formats, such as automatic wiki->docbook rendering or a DocBook-based Wiki, etc. but found it got pretty complicated and cumbersome, especially when you want to do something beyond just plain text (tables, formulae, etc.)
So, my advice is to rough out the documentation in Wiki, but move it into DocBook when it has matured sufficiently, and maintain it there.
Bryce
Alan Horkan wrote:
The major downside of Wiki is exporting the content (say for example to something like HTML or Docbook) and shipping documentation with the software. Wiki is fine for FAQ and also useful for starting documentation. When the documentation has progressed substantially if you are willing to then gather the content from Wiki and move it and reformat it for use in a more convential HTML/Docbook way and make sure it gets shipped with Inkscape then it should work out well but the extra step could be time consuming.
Just trying to explain my reservations about Wiki without too much prejudice. Hopefully that made sense.
We've just had this same discussion on lilypond. Listen, if a section of the wiki gets to the point where it is good enough to be made into a manual, I personally will make the effort to convert it to docbook. But it needs to be written first, and I think that that is the hard part, not fussing over formats.
njh
participants (6)
-
Alan Horkan -
Bryce Harrington -
bulia byak -
Jon A. Cruz -
Jonathan Phillips -
Nathan Hurst