[maemo-developers] [ISSUE] Maemo Help framework

[From: Aniello Del Sorbo]

Hi,

looks like the on-line documentation needs a lot of work on it.
the Maemo Help Framework howto is outdated, so is the maemopad package.

while waiting before the lesson i decided to go read other pieces of
the on-line documentation.

the
How to Write New Applications in maemo 4.0

document states I should use the ossohelp_show function and even
redirects me to the former help framework howto!!

I will check later if this helps.

--
anidel

On 4/16/08, Aniello Del Sorbo <anidel at gmail.com> wrote:
> Hi,
>
> I am again bugging the list with another issue I am going to solve.
> This time with the help framework.
>
> I did write my xournal.xml help file, here is an excerpt of interest for the issue I am describing:
>
> <?xml version="1.0" encoding="utf-8"?>
> <ossohelpsource>
>         <folder>
>                 <title>Xournal</title>
>                 <topic>
>                         <topictitle>1. Introduction</topictitle>
>                          <context contextUID="help_introduction"/>
>                         <para>Xournal is an application for notetaking, sketching, keeping a journal using a stylus. It is free software (GNU GPL) and runs on Maemo, desktop Linux (recent distributions) and other GTK+/Gnome platforms. It is similar to Microsoft Windows Journal or to other alternatives such as Jarnal  and Gournal.</para>
>                  </topic>
>         </folder>
> </ossohelpsource>
>
> This xournal.xml file is stored correctly into /usr/share/osso-help/en_GB and en_US
> (the tablet is set as en_US)
>
> main function:
>
>   osso_context_t *ctx;
>
>   ctx = osso_initialize (PACKAGE, VERSION, TRUE, NULL);
>   g_assert (ctx);
>
>   g_signal_connect (GTK_OBJECT(xournalHelp), "activate",
>                     G_CALLBACK (on_HildonHelp_activate),
>                      "help_introduction");
> ...
> This is the code in the callback function (it is correctly called) on_HildonHelp_activate:
>
> on_HildonHelp_activate (GtkWidget *widget, gchar *help_id) {
>  ..
>   retval = hildon_help_show(ctx,     /* global osso_context */
>                   help_id,                           /* topic id */
>                   HILDON_HELP_SHOW_DIALOG);
> ..
> }
>
> where "help_id" is correctly passed as "help_introduction" from the menu item signal
>  and the ctx is a global osso_context_t * pointer (the one returned by osso_initialize);
>
> Guess what ?
> No help widget is shown.
>
> Yeah, I know.. this is very similar to the Help Framework HOWTO, is it ? :)
>
> One more thing. I did also check the maemopad example, but its Makefile stores
> the help file in the /usr/share/hildon-help folder rather than osso-help, thus I guess
> that help is wrong or outdated.
> Anyway when the MaemoPad.xml was stored in the hildon-help folder, it behaved as
>  Xournal. Click on the menu item and it doesn't show anything at all.
> If I copy the MaemoPad.xml file to the correct folder in osso-help (en_GB and en_US
> to be sure) a balloon appears telling me that that topic does not exist (even if it does, I checked).
>
> What's wrong ?
>
> --
> anidel



-- 
anidel