Help updated

[LAfricain]

Now you have two folders, the doc/site with the converted mallard to html help. And a help folder with the mallard help. In the Xiphos project the menu code for using mallard is something like that:

#if GTK_CHECK_VERSION(3, 22, 0)
    gtk_show_uri_on_window(NULL, "help:xiphos", gtk_get_current_event_time(),
                   &error);
#else
    gtk_show_uri(NULL, "help:xiphos", gtk_get_current_event_time(),
             &error);

#endif /* GTK_CHECK_VERSION */

For now I just changesite/home.html tosite/index.html I compiled the help branch it works well on Ubuntu 18.04.

I updated also the shortcut, it will probably solved #111.

[postiffm]

Thank you for all of this work. I have to carefully consider how to include the pull request, because in a later development branch (gtk3), I have removed the doc directory entirely. I had put all the information I felt was still relevant at https://github.com/postiffm/bibledit-desktop/wiki.

[LAfricain]

OK, Probably it will better to use the new help directory. But please wait a little bit. Probably all the *page file need to be move in a C folder in the help folder (I don't know why but I read it in the gnome help for Mallard). Now I just move the old html help to the new format. But I red it also, and suppress some non relevant parts. I will continue to update it when I will translate it (work in progress). Any proposition of what is not relevant will be helpful. But probably you will not have time to do this job ;)

[rluzynski]

This pull request renames bibledit-gtk.desktop to bibledit-desktop.desktop. For gtk3 port @postiffm has agreed to rename it to org.bibleditdesktop.desktop instead.

As a result, the commit 2201a5a2086a772ab19bbb186074ff2b60f72e50 in this pull request currently conflicts with the commit fcb2df4 in my pull request #121. Either the commit in this pull request should be rejected or it should be accepted before my pull request and then I will have to rework my pull request. Otherwise we will have merge conflicts in the future.

[postiffm]

I will be rejecting 0b2d1f1 and 2201a5a. @LAfricain could you remove these from the pull request? Thanks.

[LAfricain]

@LAfricain could you remove these from the pull request? Thanks.

Ok, but I don't know how to do it, please wait a little bit.

[LAfricain]

Done... I reverted my commits, is it Okay?

[postiffm]

I believe this will work.

[postiffm]

Now...about the help. Remember I said that I had deleted the doc/ directory in the gtk3 branch? That is because I put everything into the github Wiki...or at least I tried to do that. I don't want to abandon the work you have done here, but if we add it in here, I think there could be tons of difficult conflicts to resolve with the gtk3 branch.

I am trying to think about how to do that. Perhaps I take your pull request as a whole and merge it into the gtk3 branch as a new documentation folder.

By the way, I merged webkit2 branch into gtk3 branch last night. It is sufficiently stable that I thought it would work to do that. It simplifies the development part of our git tree.

[LAfricain]

I have put the new documentation in a new folder, called help, therefore I believe you won't have any issue when merging. If needed I can delete the old folder called doc to remove it from the pull request.

[postiffm]

Let us leave the doc/ folder alone. If you delete it in the master branch, there may be a conflict with the deletion of it in the gtk3 branch. I will try add the help folder from your PR and see what happens.

Am I correct that to access the help, all I need do is navigate to help/index.html in my browser?

Would it be possible to open a "help" window inside of Bibledit-Desktop..since it supports html content via webkit? Then all the help could be shown inside a window in the program?

[postiffm]

I noticed that there are some help-related commits in #118. Are these duplicated in #114?

[LAfricain]

Am I correct that to access the help, all I need do is navigate to help/index.html in my browser?

Yes, and no. If we want to do this, we just need to generate the html files in the help folder. Currently I did it in the doc folder. But it is very easy. I you want to change the directory to help from doc, you need also to change the help path in src/mainwindow.cpp and src/help.cpp.

Would it be possible to open a "help" window inside of Bibledit-Desktop..since it supports html content via webkit? Then all the help could be shown inside a window in the program?

If you change the src/help.cpp and src/mainwindow.cpp the behaviour will be the same. On Linux you can use yelp. It is the official help project of Gnome (mallard).

[LAfricain]

I noticed that there are some help-related commits in #118. Are these duplicated in #114?

Yes, I did a mistake. Please use cherry-pick for #118.

[postiffm]

With both this PR and #118, I got an error:

error: The following untracked working tree files would be overwritten by merge: doc/Makefile.in

I did not understand this error. Any ideas?

But I just did get fetch and then cherry-picked the parts I needed.

[postiffm]

I cherry-picked the first three commits here. I really like how yelp help/index.page looks. It does need some further updating about the functionality of bibledit-desktop, but it is a great start.

@LAfricain Do I understand correctly: the information in help/ is duplicated in doc/site/ just in a different format?

[postiffm]

@LAfricain I am going to close this PR now. If there is anything missing from PR #118, please open a new pull request with those changes for the help system, and I will add them.

[postiffm]

Unfortunately, I now find out that this PR does not compile. It is missing doc/Makefile.am. So it cannot build in the doc/ folder.

@LAfricain any ideas?

[postiffm]

I'm going to remove doc/ from the toplevel Makefile.am because we will not need to "build" documentation after this point anyway.

[postiffm]

@LAfricain Please pull in the new master branch and fix the problems I've mentioned above. Until you do, the master branch is broken. It will compile but it doesn't work properly. 1) doc/site? 2) Help | Contents does not open on Linux. It gives an error about site/index.html not being found in /usr/share/bibledit-desktop/site/index.html

[LAfricain]

Unfortunately, I now find out that this PR does not compile. It is missing doc/Makefile.am. So it cannot build in the doc/ folder.

Yes I experienced this issue to.

we will not need to "build" documentation after this point anyway.

Are you sure about this?

doc/site? Help | Contents does not open on Linux. It gives an error about site/index.html not being found in /usr/share/bibledit-desktop/site/index.html

Because bibledit is looking for help in the doc folder. If you remove the doc folder, you need first to change the path in the files mentioned before. Then generate new html folder in the help folder. I will try to do it, but I'm very very busy this days.

[LAfricain]

If you merge the pull request #122 I will close this one.

[postiffm]

we will not need to "build" documentation after this point anyway.

Are you sure about this?

I am not sure. I thought the build process was to convert some html into another format suitable for the old website...or the reverse. I don't see the need to maintain two separate help systems. If it is totally automatic that changes to one are reflected in the other, then that is great. If we have to maintain both, then we need to choose one and get rid of the other one.

The problem is I don't understand what we had, nor do I understand what you guys are putting into place. I need some tutorial...

[LAfricain]

I thought the build process was to convert some html into another format suitable for the old website...or the reverse

You are right, no need to build again. Now all the help is currently in the help/site folder and works like before, nothing changed,except the doc folder becomes the help folder and the documentation is up to date in the new folder. In the future we can just perform the help on linux using yelp.

[LAfricain]

The work of Matthieu solve this pull request. I close it.