Hi,
Members of Russian community asked a question about how they can contribute to
LibreOffice help. They do not ask about translation from English to Russian.
They want to contribute to English version, for example, function description.
Could anybody explain for me, what the procedure exists to start, please?
Best regards,
Lera
Hi Lera,
Hi,
Members of Russian community asked a question about how they can contribute to
LibreOffice help. They do not ask about translation from English to Russian.
They want to contribute to English version, for example, function description.
Could anybody explain for me, what the procedure exists to start, please?
Thanks a lot! Currently, there is an extension that allows to write help
parts.
you can find explanation to download the extension here:
https://wiki.documentfoundation.org/Documentation/Help
and some information to use it here:
https://wiki.documentfoundation.org/HelpContent
There are some issues with the extension, see the detailed mail from
Regina about it here:
http://nabble.documentfoundation.org/Ease-maintenance-of-build-in-help-td4156107.html
As you can see the situation at the moment is not optimal, but it's a
work in progress.
I've added Olivier in copy of this mail, maybe he will be able to help
you to start as he already works with the extension.
Again, thanks to your team for wanting to work on this, we really need
more people here 
Cheers
Sophie
Hi Sophie,
you can find explanation to download the extension here:
https://wiki.documentfoundation.org/Documentation/Help
and some information to use it here:
https://wiki.documentfoundation.org/HelpContent
I have begun to see into the explanation
https://wiki.documentfoundation.org/HelpContent and have faced some
difficulties. This explanation is not full. I was able to understand where
xmlhelptemplate.ott file is located in fact. But I had no idea where I am
supposed to find maintransform.xml and allfiles.tree files.
I know that these files are not required. But as far as I understand, it should
make the work with help files easier.
Could you explain this issue to me, please?
Is there any possibility compile only help files without compiling the whole
program in order to check how they would look like in the end ?
Thank you in advance.
Best regards,
Lera
Hi Lera
Hi Sophie,
you can find explanation to download the extension here:
https://wiki.documentfoundation.org/Documentation/Help
and some information to use it here:
https://wiki.documentfoundation.org/HelpContentI have begun to see into the explanation
https://wiki.documentfoundation.org/HelpContent and have faced some
difficulties. This explanation is not full.
Right. Time is short for us to write a better documentation
I was able to understand where
xmlhelptemplate.ott file is located in fact. But I had no idea where I am
supposed to find maintransform.xml and allfiles.tree files.
If, as indicated, you get the extension from
http://dev-www.libreoffice.org/helpauthoring/
Then all you need is to install the extension and all filters and
templates will be at hand. You will get a new menu entry on the main
menu bar.
But as we aleady know, the extension has some glitches that requires an
inspection in the xml.
I know that these files are not required. But as far as I understand, it should
make the work with help files easier.
Could you explain this issue to me, please?
Is there any possibility compile only help files without compiling the whole
program in order to check how they would look like in the end ?
If you have your build working with the Helpcontent, all you need is to
issue the command make in the helpcontent2/ folder
once finished, you just invoke soffice from instdir/program anf press F1.
Thank you in advance.
Best regards,
Lera
I know I am
- --
Olivier Hallot
Founding Member,The Document Foundation
The Document Foundation, Kurfürstendamm 188, 10707 - Berlin, Germany
Gemeinnützige rechtsfähige Stiftung des bürgerlichen Rechts
Legal details: http://www.documentfoundation.org/imprint
LibreOffice translation leader for Brazilian Portuguese
+55-21-9-8822-8812
Hi Olivier
If, as indicated, you get the extension from
http://dev-www.libreoffice.org/helpauthoring/
Yes, I downloaded this version.
Then all you need is to install the extension and all filters and
templates will be at hand. You will get a new menu entry on the main
menu bar.
Yes, the menu entry on the main menu bar appears.
Does it mean that we no longer use maintransform.xml and allfiles.tree files and
I can remove the mentioning about them on wiki?
But as we aleady know, the extension has some glitches that requires an
inspection in the xml.
Yes, I heard about it. But I try to understand how can a community member
start to work with expansion.
If a member of the Russian team will want to help, it is likely that I will
answer questions first.
If you have your build working with the Helpcontent, all you need is to
issue the command make in the helpcontent2/ folderonce finished, you just invoke soffice from instdir/program anf press F1.
It is understood. Thank you.
Best regards,
Lera
Hi Lera,
Lera schrieb:
Hi Sophie,
you can find explanation to download the extension here:
https://wiki.documentfoundation.org/Documentation/Help
and some information to use it here:
https://wiki.documentfoundation.org/HelpContentI have begun to see into the explanation
https://wiki.documentfoundation.org/HelpContent and have faced some
difficulties.
Yes, it needs some improvements.
This explanation is not full. I was able to understand where
xmlhelptemplate.ott file is located in fact. But I had no idea where I am
supposed to find maintransform.xml and allfiles.tree files.
I'm not sure, but I think that there exists no current version of the file allfiles.tree, but only the old one, generated for OpenOffice.org. You find this old one attached to https://bz.apache.org/ooo/show_bug.cgi?id=56321. That file was surely generated be a script in times of Sun, but I don't know where it is and whether it still exists at all.
The file gives you access to the help files in the local help viewer with the same structure as the files are arranged in the source. It adds a new section in the Contents tab of the built-in help.
In the same old bug report, you find the files maintransform.xml and default.css. Here the same, I don't know whether a current version for LibreOffice has ever been produced. Nevertheless they can be applied on the built-in help.
I know that these files are not required. But as far as I understand, it should
make the work with help files easier.
Could you explain this issue to me, please?
These files help to locate the exact place in the source, when you see an error in the built-in help. They were used by translators to help Sun developers to fix the errors.
But here in LibreOffice you need a local copy of the help files anyway to generate a patch for Gerrit. So these helpers are indeed not necessary. Nevertheless I have used them from time to time to make embedding and sections visible, before the extension was available.
Read more about it in https://wiki.openoffice.org/wiki/Pootle_User_Guide/Technical_Helpers#Make_Your_Installation_Verbose, which also explains how to set the environment variable.
Kind regards
Regina
Hi Regina,
I am sorry for the late reply. Thank you a lot for the detailed answer. I will
try to move further.
Best regards,
Lera
Lera schrieb:
Hi Sophie,
you can find explanation to download the extension here:
https://wiki.documentfoundation.org/Documentation/Help
and some information to use it here:
https://wiki.documentfoundation.org/HelpContentI have begun to see into the explanation
https://wiki.documentfoundation.org/HelpContent and have faced some
difficulties.Yes, it needs some improvements.
Is there a wiki somewhere with "tasks that need done" for documentation?
I think it would be great to have one and tasks like this could be added
- tracking the areas that need attention is the first step to addressing
the problems.
Best,
Joel
Hi Joel,
Joel Madero schrieb:
[..]
Is there a wiki somewhere with "tasks that need done" for documentation?
I think it would be great to have one and tasks like this could be added
- tracking the areas that need attention is the first step to addressing
the problems.
A meta issue for errors in the documentation itself: tdf#80430
An issue about problems with the helpauthoring extension: tdf#93580
I have started a dashboard for myself, feel free to add things there. https://wiki.documentfoundation.org/User:Regina/HelpAuthoringDashboard.
I have suggested helpauthoring as topic for the hackfest in Hamburg.
https://wiki.documentfoundation.org/Hackfest/Hamburg2015#Topics
Producing an overview and structure, and consolidating the informations might be a task for that weekend. Perhaps others are interested.
Problems with a special Wiki page can be discussed on its "Discussion" page.
Kind regards
Regina
You're the best Regina
Thanks!
Best,
Joel