[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[libreoffice-l10n] Re: Proposed XHP extensions


Hi all concerned in writing Help pages!

I patched the LibreOffice Help submodule code with the following
extensions to XHP

Class Paragraph-like

<h1> ... <h6>

<note>, <tip> and <warning>

Class Character-like

<keycode>, <menuitem>, <input>, <literal>, <widget>

All these extensions above are documented in the XHP reference page in

https://wiki.documentfoundation.org/Documentation/Understanding,_Authoring_and_Editing_Openoffice.org_Help/3

Patch is

https://gerrit.libreoffice.org/#/c/63954/

IMPORTANT

In any case these extensions break the existing markup and contents.

Please do not change existing contents based on these extensions, it
will force a useless re-translation.

However, it is OK when updating contents,  and use the opportunity to
also apply the extended markup.

Kind regards

Olivier

Em 22/10/2018 07:55, Olivier Hallot escreveu:
> Hello everyone concerned on writing Help pages
>
> After significant amount of time spent writing and fixing Help pages
> (XHP), I came to conclusion that the Help XML (XHP) is a powerful markup
> but a bit too hard to master for newcomers and easy to have errors and
> mistakes slipped in files. Some of its complexity are not absolutely
> required so I wrote a wiki page suggesting the implementation of XHP
> extensions, aiming to make life simpler for adding and reading XHP
> contents textually (markup).
>
> Please note that in any case the current markup is affected, so it will
> preserve the legacy contents as well as the current translations.
>
> For example, the new markup for 'tip' paragraph should be
>
> <tip id="123456" xml-lang="en-US" localize="true">
>
> so it can replace
> <paragraph role="tip" id="123456" xml-lang="en-US" localize="true">
>
> Yes, it is a trivial change but I hope it will make reading easier for all.
>
> Handling of the XHP extensions will be in the XSLT transformation and it
> will be patched accordingly, as well as the DTD, wiki documentation on
> XHP, and string extractors for Pootle.
>
> The wiki page is
>
> https://wiki.documentfoundation.org/Documentation/Proposed_Extensions_for_XHP
>
> And comments are welcome, do's dont's, thumbs up or thumbs down.
>
> regards

--
Olivier Hallot
LibreOffice Documentation Coordinator
Comunidade LibreOffice
Rio de Janeiro - Brasil - Local Time: UTC-03:00
http://tdf.io/joinus


--
To unsubscribe e-mail to: l10n+unsubscribe@global.libreoffice.org
Problems? https://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
Posting guidelines + more: https://wiki.documentfoundation.org/Netiquette
List archive: https://listarchives.libreoffice.org/global/l10n/
Privacy Policy: https://www.documentfoundation.org/privacy

References:
[libreoffice-l10n] Proposed XHP extensionsOlivier Hallot <olivier.hallot@libreoffice.org>
Privacy Policy | Impressum (Legal Info) | Copyright information: Unless otherwise specified, all text and images on this website are licensed under the Creative Commons Attribution-Share Alike 3.0 License. This does not include the source code of LibreOffice, which is licensed under the Mozilla Public License (MPLv2). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.