There are several aspects to this question. One is the maintenance and I18N of the raw help texts. I know projects that maintain their help texts in .po files, using qooxdoo's usual this.tr() and friends. An absolute necessity here is to use artificial, short message id's that will be used in this.tr(), so that a .po entry looks like
msgid "ABC_123" msgstr "This is a lenghty help text that contains lots and lots of words ..." Otherwise the message id's in the .po files blow up and .po processing becomes unbearably slow. Links to pictures can be embedded, also HTML or other markup. It's good for feeding different (human) translators, it's just not nice to edit. HTH, T. On 06/23/2010 10:53 AM, panyasan wrote: > > Hi everybody, > > Finalizing my qooxdoo-App, I am confronting the problem how to best present > and maintain the end-user documentation, i.e. the help texts that have to be > prepared for the non-technical actual user of the web app. Currently, I am > using google sites (see > https://sites.google.com/a/qxtransformer.org/bibliograph), which is very > convenient, since it is online, has a nice and intuitive editor which needs > no wiki-markup, allows the easy upload and integration of screenshots. > Another plus is that google offers the online translation for pages into > languages that one would not possibly be able to create documentation for. > > On the other hand, I really am not comfortable with this as the final way to > maintain my end-user-documentation. Other than automatic translation, the > google site is very unfriendly towards i18n - there is no way separate > translations can be stored and shown according to browser preferences - one > has to create separate sites. Also, I don't want to have to rely on google > too much. > > So my question: How do you manage end-user-docs for your qooxdoo web app? > Has anyone written a "Help-Widget" which would allow to manage different > language versions of the same documentation, indexing, search, etc. -- just > like a Help-Widget shipped with an OS like Windows or Mac. I assume that > nobody has - since it is a very complex task, one that would definitely > deserve a separate contrib. > > I am curious as to how you do it. Thanks, > Christian ------------------------------------------------------------------------------ ThinkGeek and WIRED's GeekDad team up for the Ultimate GeekDad Father's Day Giveaway. ONE MASSIVE PRIZE to the lucky parental unit. See the prize list and enter to win: http://p.sf.net/sfu/thinkgeek-promo _______________________________________________ qooxdoo-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
