Re: [libreoffice-l10n] Amending and enhancing the help files

Hi,

we need definitely to go this way, so this activity is highly appreciated.

I would add one more point: currently, a lot of extended tooltips (maybe
most of them) are directly part of the help text. Therefore, if we excluded
the tips, we would have strings doubled, once in help and once in tips -
and it makes no sense to manage and translate them separately.

Together with technical solution, I think we should also have a general
discussion about help and how it should look like: for instance, do we want
pictures and screenshots in it? Or any example files, external links...
etc. etc.

Best regards,
Stanislav




2014-07-01 11:32 GMT+02:00 Sophie <gautier.sophie@gmail.com>:

> Hi all,
>
> It is a secret for nobody that the help is a nightmare to maintain for
> developers and contributors. However it's an important part for the
> quality of our product and we need to find a way that is acceptable for
> all of us working on it.
>
> During the last Hackfest in Paris, I discussed with Moggi and Kendy how
> we could organize the workflow to enhance and maintain the help and keep
> the translation easy for l10n team.
>
> So here is a proposal to discuss about using the wikihelp to maintain it:
> - the existing translations would be migrated, so no work is lost (one
> of the most important requirement :)
>
> - the translation project is split in 3 parts:
> * UI as we have it today
> * Extended tooltips - currently in help files, are extracted and get its
> own .po project
> * Help content, managed in the wiki
>
> - review of the added/modified part on the wiki:
> * random people can contribute but *not* directly
> * there will be an approval process, like in Pootle or Git
>
> - there is one point that is not optimal, because wiki syntax is
> difficult to manipulate via .po files, it would be much safer to use
> media wiki to translate, with the help of the translate toolkit (where
> you have context, extended syntax, memories).
> Note: translating via .po still would be possible, but really at own
> risks.
> The disadvantage that it has too is that we need two tools:
> - Pootle for UI + extended tooltips,
> - mediawiki for help.
>
> So, this is how we can present the pros and cons maintaining our help
> files via the wiki to reach more contributors and quality. Nothing is
> set yet, but we need to find a consensus to have our help amended and
> maintained, reach a good quality and really serves our users.
>
> Feedback and ideas welcome :)
> Cheers
> Sophie
>
> --
> To unsubscribe e-mail to: l10n+unsubscribe@global.libreoffice.org
> Problems?
> http://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
> Posting guidelines + more: http://wiki.documentfoundation.org/Netiquette
> List archive: http://listarchives.libreoffice.org/global/l10n/
> All messages sent to this list will be publicly archived and cannot be
> deleted

-- 
To unsubscribe e-mail to: l10n+unsubscribe@global.libreoffice.org
Problems? http://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
Posting guidelines + more: http://wiki.documentfoundation.org/Netiquette
List archive: http://listarchives.libreoffice.org/global/l10n/
All messages sent to this list will be publicly archived and cannot be deleted