[Gimp-user] Gimp Documentation in the future... (from Re: Complaint)

2010-01-22 Thread Jay Smith
On 01/22/2010 10:57 AM, Alexandre Prokoudine wrote:
 On 1/22/10, Jay Smith wrote:
 SNIP 
 As an aside, I really think that the documentation issue is going to
 become critical in the next couple of years.  As I understand it (and
 please correct me if I am wrong), anybody can contribute to the
 documentation effort, but it takes significant training and skills in
 the special process involved with maintaining documentation versioning,
 etc., etc., etc.  I don't begin to understand all of that and I DON'T
 WANT TO have to become an expert in all that stuff -- I just want to
 help improve the documentation.
 SNIP
 
 I understand your feelings, but GIMP documentation is a single-source
 effort that isn't well supported by current wiki engines.
 
 Alexandre

On 01/22/2010 10:44 AM, Alexandre Prokoudine wrote:
 On 1/22/10, Jay Smith wrote:
 SNIP

 It has been said by GIMP developers in public several times that
 tutorials at gimp.org are out of date and need reworking. There is no
 problem accepting the fact, see? There is a problem of people not
 having spare time to work on that. It's really *that* simple. There's
 no conspiracy.

 Alexandre


I'm breaking this out into a new thread.

In a couple of his responses Alexandre said:

but GIMP documentation is a single-source effort that isn't well
supported by current wiki engines.

and

There is a problem of people not having spare time to work on [updating
documentation].


Alexandre's second point can be solved by a Wiki.  A Wiki would allow
and encourage more people to become involved.

However, I am ignorant of exactly what the input / output requirements
of the single-source effort are exactly.  If possible, can somebody
point me to a reference which describes how the documentation
project/work itself is being done and what the inputs/outputs are and
where they live?

For example, are the docs such as
http://docs.gimp.org/2.6/en/gimp-concepts-usage.html
buried inside Gimp itself as comments (as some programs do)?

For example, are the multiple languages offered here
http://docs.gimp.org/
all maintained in single multi-language documents or database records
(for each respective topic page)?  And how are they kept in sync and
annotated as to what new/changed/removed text needs translating, etc.

Sorry if this is a newbie kind of question, but I have not previously
run into a discussion of it.

I agree that Wikis are _not_ good at:
- Multi-language versions maintenance of the same subject page
- Output to print
- Output to structured documents
- Databases as Wikis (but I don't think that applies here, but it is a
subject of extreme interest to me if anybody else is interested)

Jay
___
Gimp-user mailing list
Gimp-user@lists.XCF.Berkeley.EDU
https://lists.XCF.Berkeley.EDU/mailman/listinfo/gimp-user


Re: [Gimp-user] Gimp Documentation in the future... (from Re: Complaint)

2010-01-22 Thread Alexandre Prokoudine
On 1/22/10, Jay Smith wrote:

 Alexandre's second point can be solved by a Wiki.  A Wiki would allow
 and encourage more people to become involved.

 However, I am ignorant of exactly what the input / output requirements
 of the single-source effort are exactly.  If possible, can somebody
 point me to a reference which describes how the documentation
 project/work itself is being done and what the inputs/outputs are and
 where they live?

IIRC wiki is offline now (that ism the potential documentation host
:-P), so I can't point you to the page.

We use DocBook/XML for storing original content in English and PO
files for storing translation. This is great for translating, because
you don't need to manually look for updated pages or watch them all
the time. You just see what messages in a PO file are marked as fuzzy
(changed) and edit them.

The workflow is:

Someone edits the original XML file. Translators run a command that
updates their translations (in PO files). Then they look at changes
(easy to do in any PO editor), apply changes and commit them to Git
repository.

As a side remark, I'm genuinely not impressed by wiki based
documentations. They are not exactly as manageable as I'd like them to
be. I'm judging by wiki.scribus.net for example.

FLOSS manuals is another example: we actually have a problem figuring
out who does what in the Inkscape manual, because despite of being
told to people silently edit something somewhere and never introduce
themselves or tell about their plans, so clashes are inevitable.

Alexandre
___
Gimp-user mailing list
Gimp-user@lists.XCF.Berkeley.EDU
https://lists.XCF.Berkeley.EDU/mailman/listinfo/gimp-user