Help Authoring Extension

Hi,

I've spent some time today fixing the HelpAuthoring extension, and
together with the Regina's fix (thank you, Regina!), I think it got to a
usable state :slight_smile:

  https://wiki.documentfoundation.org/Documentation/Help

describes where to get it, and the basic usage. More detailed user
manual can be found here:

  https://wiki.documentfoundation.org/HelpContent

The .xhp's generated by the extension are now nicely formatted, which
means that when you save a .xhp in the help repository, it will likely
be a big diff the first time (due to the changed formatting - strings
should be preserved); but from then on, the changes should be tiny, as
the format will be much better defined.

Also the editing directly in LibreOffice seems to be neat & usable.
There might be rough edges still - but I hope no blocker any more.

In other words - *no excuses* for not writing help any more :wink:

Please do use it, and if you experience trouble, either fix it yourself:

  http://cgit.freedesktop.org/libreoffice/contrib/dev-tools/tree/helpauthoring/README

or let me know - the xslt that implements the export filter is trivial.

Would be good to start thinking of a workflow between the developers and
the documentation team - I imagine developers could stub help for things
they are developing, and the documentation team members would then
finalize and de-hackerize that, but ideas how to grow the community of
help authors much appreciated.

[BTW - if you are wondering about the editable wikihelp: no, I'm not
abandoning the idea; but that is a long-term quest, and the help needs
improving _now_.]

All the best,
Kendy

Hi Alex, *,

[...]
  https://wiki.documentfoundation.org/Documentation/Help

When I go to that page, there is a link to the extension:

https://dev-www.libreoffice.org/helpauthoring/

Not true - it links to http://… (not https - that is your browser's
plugin at work)

which leads to an error message in Firefox that the page can not be loaded.

That domain is not setup for https - you http to access it.

ciao
Christian

Hi Jan,

Jan Holesovsky schrieb:

Hi,

I've spent some time today fixing the HelpAuthoring extension, and
together with the Regina's fix (thank you, Regina!), I think it got to a
usable state :slight_smile:

   https://wiki.documentfoundation.org/Documentation/Help

describes where to get it, and the basic usage.

There are some problems. You get the message "The File ... is outside of your Document Root" although that is not the case. Because the program faulty thinks this, it generates full absolute paths where they should be relative.

From step by step execution I see, that the underlying reason is, that the program uses the property DisplayDirectory of the file picker and uses this value in writing paths in the configuration file helpauthoring.cfg and uses this values later on for some comparisons and for the test, whether it is a subdirectory. The problems are not in HelpAuthoring but it is bug https://bugs.documentfoundation.org/show_bug.cgi?id=70843 and for AOO https://bz.apache.org/ooo/show_bug.cgi?id=123544 or https://bz.apache.org/ooo/show_bug.cgi?id=110141.

SetTitle of the file picker does not work too. But that has no consequences for HelpAuthoring.

Kind regards
Regina