Manual lists in AllLangHelp_*.mk?

Is there a documentation for the build of help repo ?

For example, seems there are manually maintain lists of the .xhp files that are in the directory structure.
Legacy or real use ?

AllLangHelp_schart.mk
AllLangHelp_sdatabase.mk
AllLangHelp_smath.mk
AllLangHelp_sdraw.mk
AllLangHelp_sbasic.mk
AllLangHelp_simpress.mk
AllLangHelp_scalc.mk
AllLangHelp_swriter.mk
AllLangHelp_shared.mk

These are real use. These files have the list of files to build. If a file is not listed there, it will not be built and released. Each new XHP deletion/addition/move must be reflected in the proper .mk file.

There is no way to build the Help without a full LO build. For quick rendering you can use the XHP online editor at LibreOffice Help XHP Editor . This editor has limitations but can speed up the work.

Olivier
Olivier

In addition to what Olivier said, there is some documentation for editing the Help pages on the wiki. E.g.

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

  • that may be of some help. You can also access the XML reference under the “Help” menu option in the XHP editor.

Edit: Whoops. Looks like the links didn’t post when I responded by email.

my question was about maintaining them manually.
they just wrap/reflect their corresponding sub directory ? (sth like : find xx -name *.xhp )

thanks.
I can’t see any mention of the .mk … ?

Sorry, I may have misunderstood your question. I thought you were asking about documentation on editing and building the help module.

This has a little bit of information on the AllLangHelp files:
https://wiki.documentfoundation.org/Development/Gbuild#AllLangHelp_(ALH)

  • Although there appear to be some gaps in it.

The AllLangHelp repositories are, as far as I know, maintained manually. We normally just add a new file to the list.

So if you are adding:

libreoffice/helpcontent2/source/text/shared/01/new_file.xhp

You would add a new line to AllLangHelp_shared.mk as:

helpcontent2/source/text/shared/01/new_file \

That’s the extent of my technical knowledge.

great.
loved especially : image

from word of mouth, or anything recorded / documented ?

from word of mouth, or anything recorded / documented ?

Word of mouth and experience. I’m not sure exactly what document or information you are looking for, but other than what’s in the wiki, there isn’t a comprehensive manual or set of procedures for the help submodule.

thanks. that’s why I’m trying to update/cleanup the wiki along the way.
and hopefully put some relevant integrity check in the build …

for a glimpse of gory details, see the fresh tdf#162587 :expressionless:
you may have seen already this comment as well 120200 – (Help-Changes-Features) [META] Update or correct help for features

Thanks for pointing this. Of course it was burried in a comment rather than a documentation bug of itself.

So here is the bug : tdf#162607 .

I cannot stress enough that this is a task that requires very good knowledge of the application modules, as there are ambiguities to address.

Olivier

burried in 200+ ? :wink:

is there any on these ?