Change-Id: I8ebd08019541a22acfe763330c2579b9b5c4c7bf
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/137638
Tested-by: Jenkins
Reviewed-by: Julien Nabet <serval2412@yahoo.fr>
This commit is contained in:
Andrea Gelmini 2022-07-30 21:42:51 +02:00 committed by Julien Nabet
parent 10a213572b
commit c3ac0f80b7

View file

@ -2,11 +2,11 @@
LibreOffice can build three kinds of help output from helpcontent2: LibreOffice can build three kinds of help output from helpcontent2:
* XML (local, bundeled with LibreOffice < 6.0) * XML (local, bundled with LibreOffice < 6.0)
* HTML (local, bundeled with LibreOffice >= 6.0) * HTML (local, bundled with LibreOffice >= 6.0)
* HTML (online) * HTML (online)
Both local help variants can be included in help-packs, which might be bundeled Both local help variants can be included in help-packs, which might be bundled
with the installer or provided as separate packages. They are supposed to be with the installer or provided as separate packages. They are supposed to be
installed by a user to provide localized help. Both HTML-based help types are installed by a user to provide localized help. Both HTML-based help types are
displayed in a browser, while the XML help uses an internal viewer component. displayed in a browser, while the XML help uses an internal viewer component.
@ -22,9 +22,9 @@ The XML help is the only one supported in extensions.
Also see `configure --help`. Also see `configure --help`.
## XML help, bundeled ## XML help, bundled
This type was bundeled per-default until LibreOffice 6.0. This type was bundled per-default until LibreOffice 6.0.
This help output is generated by using two tools: HelpIndexer and HelpLinker. This help output is generated by using two tools: HelpIndexer and HelpLinker.
It uses an internal viewer component. Extensions still use this help type to It uses an internal viewer component. Extensions still use this help type to
@ -40,17 +40,17 @@ Most code is "marked" by HAVE_FEATURE_XMLHELP precompiler blocks or conditioned
by the XMLHELP flag in the $BUILD_TYPE variable. by the XMLHELP flag in the $BUILD_TYPE variable.
Interestingly the HelpIndexer and HelpLinker are used by gbuild to build the Interestingly the HelpIndexer and HelpLinker are used by gbuild to build the
help inside bundeled extensions, but both are not part of the LibreOffice SDK. help inside bundled extensions, but both are not part of the LibreOffice SDK.
## HTML help, bundeled ## HTML help, bundled
This type is bundeled per-default since LibreOffice 6.0 and displayed in a This type is bundled per-default since LibreOffice 6.0 and displayed in a
browser. browser.
## HTML help, online ## HTML help, online
This help is the external one, currently provided by help.libreoffice.org. It This help is the external one, currently provided by help.libreoffice.org. It
differs from the bundeled HTML help in three main aspects: differs from the bundled HTML help in three main aspects:
* has a language chooser widget * has a language chooser widget
* provides an additional Xapian Omega, CGI- / server-based search index * provides an additional Xapian Omega, CGI- / server-based search index