[Development] Qt CS 2013 Documentation Session

[Liang Qi]

On 17 July 2013 09:51, Oswald Buddenhagen wrote:
>
> On Tue, Jul 16, 2013 at 02:38:19PM +0000, Pasion Jerome wrote:
> > Some ideas, wishes, and proposals brought up in the session:
> >
> a recurring topic is translatability of the documentation.
>
> this encompasses extraction (paragraph-wise, though further segmentation
> into sentences may be advantageous as well) and back-merging of
> translated strings (either into a separate document (in particular when
> apidocs are being translated), or an "on-the-fly" integration, where
> qdoc takes the original sources and a translation (.ts) file, and
> directly outputs translated html).
>
> qdoc (just like doxygen) is a rather terrible format in this regard -
> one needs to do quite some semantic processing of the markup before it's
> clear what a "paragraph" actually is. therefore it's likely that the
> string extraction/replacement needs to be a special mode of qdoc itself.
>
n Qt 4, we support the separate .qdoc files way for translations,
please check zh_CN and
ja_JP folders in https://github.com/qtproject/qt/tree/4.8/doc/src .
And we still missing support
for the docs in source code, task as
https://bugreports.qt-project.org/browse/QTBUG-12919

Maybe the original .qdoc + .ts solution is also ok, but we can imagine
what should be done
when .qdoc was updated and .ts not, how to sync them? Is it easy to be
fixed in some way?

Then I still prefer the separate doc files solution, but we could add
a tag for the translation,
mention the original doc's information, like sha1 and etc.

Regards,
Liang

--
http://www.qiliang.net