[scribus-dev] online docs

[OM]

* Christoph Schäfer <christoph-schaefer at gmx.de> [2009-09-09 05:21:56 +0200]:

> > 1. We have the application and we should have a basic online doc that would
> > describe how the various functionnality actually work. We coudl of course
> > discuss what should go in there and how we could organise the translation
> > and update processes so this work would actually reflect the evolution of
> > the application. The online doc would be a minimum but would be helpful to
> > coders and users as well to keep everything up-to-date.
> 
> Agreed, except that we may need a little more than a "minimum", but 
> if "minimum" means "everything you need get up to speed with Scribus" without 
> inflating the size of the installers, I will also agree with "minimum" :)

The translation issue could potentially be solved by using Drupal's i18n
module (internationalization) plus its friends that supposedly allow
fool-proof translation of html pages. I've not looked at it for a while, but
it has probably matured enough for a stable system with Drupal 6 we are
running. The issue with it would be pulling all the text out to put into the
help browser in Scribus. I'm not sure how easy that could be, yet.

> > Out of the onine doc, one would have to work hard to create a competitor to
> > the "official" manual. And out of the "official" manual, one would find no
> > interest at creating the already existing online docs...
> >
> > We can clarify the content and tone and approach to the online docs. This
> > would also include the licence under which we would release it, of course.
> > We should think ahead about translation issues, and updating issues.

Since there is now a printed book I would urge everyone on the team who has a
stake in the docs to consider applying a DFSG-free license to the "simplified"
online/help browser docs, so they could be included into Debian/Ubuntu main
archive.

> Absolutely, and that's why I think we should focus on documentation that's 
> really necessary. Additional info can be added to the Wiki, if required, and 
> there is already a menu entry that links to the Wiki.
> 
> >
> > But definitely, we need an online doc that reflects what Scribus is, at
> > each step of its life. This online doc should be translatable whithout too
> > many formalities. 
> 
> Even the manual can be translated and distributed without even asking us, as 
> long as it isn't published as a book.
> 
> > The teaser for the users would be "You like the online 
> > help, you’ll love the book!".
> 
> Ya betcha ;)
> 
> 
> Cheers,
> 
> Christoph
> 
> _______________________________________________
> scribus-dev mailing list
> scribus-dev at lists.scribus.net
> http://lists.scribus.net/mailman/listinfo/scribus-dev