Re: Requirements for Documentation System
| From: | Paul M Jones | Date: | Tue, 13 Apr 2004 14:34:22 +0000 |
| Subject: | Re: Requirements for Documentation System | ||
| References: | 1 2 3 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3318@lists.php.net to get a copy of this message | ||
Setoyama-san,
Add new requirement: Make the translator's job as easy as possible.Here is a random page from the French manual:As one of translators, translation of API docs is vary boring. That of tutorials is not so. So I want a system that make easy to translate API docs.http://pear.php.net/manual/fr/package.networking.net-ping.ping.phpThere's a hell of a lot of English on that page.
It is nice to edit a lot of functions at once in a form that is not XML.Well, we're not talking about specific technologies at this point, but ... I feel your pain. :-)
And I want to read immature, still in progress, manual in 'en' branch, because PEAR users rely on pear.php.net/manual/, and translators can not judge when they should start. The fast turnaround is nice, but I need separate finished one and others.Add new requirement: Ability to mark a document as "ready for translation." Add new requirement: Ability to mark a document as the primary-source to be used for translation (i.e., if docs are written originally in Japanese, mark the Japanese version as the primary-source). Thanks, Haruki, these are good ideas. -- Paul M. Jones Savant: the simple alternative to Smarty. http://phpsavant.com/