Login | Register For Free | Help
Search for: (Advanced)

Mailing List Archive: Maemo: Developers

[ISSUE] Maemo Help framework

 

 

Maemo developers RSS feed   Index | Next | Previous | View Threaded


anidel at gmail

Apr 16, 2008, 4:01 AM

Post #1 of 4 (387 views)
Permalink
[ISSUE] Maemo Help framework

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 at gmail

Apr 16, 2008, 7:09 AM

Post #2 of 4 (359 views)
Permalink
Re: [ISSUE] Maemo Help framework [In reply to]

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> 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
_______________________________________________
maemo-developers mailing list
maemo-developers [at] maemo
https://lists.maemo.org/mailman/listinfo/maemo-developers


anidel at gmail

Apr 16, 2008, 10:53 AM

Post #3 of 4 (355 views)
Permalink
Re: [ISSUE] Maemo Help framework [In reply to]

Hi,

I am back home and playing with the Help framework again.
Forget the second mail. Osso help is old stuff (and is still in the How To
write new application howto!).
I only have hildon-help.h and no osso help.

So playing with it now...
But, now one here that knows how to hint me ?

--
anidel

On Wed, Apr 16, 2008 at 4:09 PM, Aniello Del Sorbo <anidel [at] gmail> wrote:

> 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> 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
>



--
anidel


anidel at gmail

Apr 16, 2008, 11:40 AM

Post #4 of 4 (350 views)
Permalink
Re: [ISSUE] Maemo Help framework [In reply to]

Hi,

damn me!

"The context string is defined by the attribute contextUID and must follow
the format xxx_filename_yyy, where filename must be exactly the name of the
XML file (without the extension)."

Works.
Sorry to bother :)

--
anidel

On Wed, Apr 16, 2008 at 7:53 PM, Aniello Del Sorbo <anidel [at] gmail> wrote:

> Hi,
>
> I am back home and playing with the Help framework again.
> Forget the second mail. Osso help is old stuff (and is still in the How To
> write new application howto!).
> I only have hildon-help.h and no osso help.
>
> So playing with it now...
> But, now one here that knows how to hint me ?
>
> --
> anidel
>
>
> On Wed, Apr 16, 2008 at 4:09 PM, Aniello Del Sorbo <anidel [at] gmail>
> wrote:
>
> > 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> 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
> >
>
>
>
> --
> anidel




--
anidel

Maemo developers RSS feed   Index | Next | Previous | View Threaded
 
 


Interested in having your list archived? Contact Gossamer Threads
 
  Web Applications & Managed Hosting Powered by Gossamer Threads Inc.