summaryrefslogtreecommitdiff
path: root/helpauthoring/README
blob: 5b17292ad04f97d26df133a6fb2583e224d3a66f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
Help Authoring Extension

This extension adds a new menu to the Writer's menubar, and allows easy
editing of the LibreOffice Help.  Usage info is here:

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

== Hacking it ==

If you want to improve the extension itself, get the sources here:

  $ git clone https://git.libreoffice.org/dev-tools

and start hacking it.  Most probably you'll want to do improvements to the
.xhp export filter:

  helpauthoring/filter/soffice2xmlhelp.xsl

To do that the most effectively, choose a reasonably complicated .xhp file,
like:

  help/source/text/schart/01/type_stock.xhp

if you did an independent
git clone https://git.libreoffice.org/help
as suggested in https://wiki.documentfoundation.org/Documentation/Help

or if you are in the developers' work tree with submodules

  helpcontent2/source/text/schart/01/type_stock.xhp

convert it to .fodt (Save As... in Writer), and then use:

  xsltproc helpauthoring/filter/soffice2xmlhelp.xsl help/source/text/schart/01/type_stock.fodt > out

When you are happy with the improved output in 'out', commit & push the
improved soffice2xmlhelp.xsl via gerrit.

== Releasing it ==

Increase the version number both in:

  helpauthoring/HelpAuthoring/_Main.xba
  helpauthoring/description.xml

and then:

  cd helpauthoring && make

The new version will be created in the dist/ directory.

Upload it to:

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

and announce.