Thread: pgAdmin3 help system

pgAdmin3 help system

From
Andreas Pflug
Date:
Hi Dave,

I revised the help file and entry point generation, I believe it's
consistent now. The windows version can now use pgadmin3.chm, if it's
present. I believe we should remove the coloured background, reverting
to plain white.

The content still needs more work to be done for pgsql, but this could
be postponed until we have the 7.4 doc.

Regards,
Andreas





Re: pgAdmin3 help system

From
"Dave Page"
Date:

> -----Original Message-----
> From: Andreas Pflug [mailto:pgadmin@pse-consulting.de]
> Sent: 07 August 2003 19:25
> To: Dave Page
> Cc: pgadmin-hackers
> Subject: pgAdmin3 help system
>
>
> Hi Dave,
>
> I revised the help file and entry point generation, I believe it's
> consistent now. The windows version can now use pgadmin3.chm, if it's
> present. I believe we should remove the coloured background,
> reverting
> to plain white.

Don't you like the blue? Any other opinions?

> The content still needs more work to be done for pgsql, but
> this could
> be postponed until we have the 7.4 doc.

In what way? I would have said pgsql was OK, but we need more pgAdmin
content if anything.

Regards, Dave.

Re: pgAdmin3 help system

From
Andreas Pflug
Date:
Dave Page wrote:

>
>Don't you like the blue? Any other opinions?
>
>
The CHM doesn't look as programmer's help usually looks like. And
wxHtmlHelpController can't cope with it either.

>>The content still needs more work to be done for pgsql, but
>>this could
>>be postponed until we have the 7.4 doc.
>>
>>
>
>In what way?
>
All pages should have their own contents entry so they can be located by
CHM if "sync" is pressed.

> I would have said pgsql was OK, but we need more pgAdmin content if anything.
>
Some more lyrics... :-)

An index would be fine too. But this is an awful lot of work.

Regards,
Andreas



Re: pgAdmin3 help system

From
"Dave Page"
Date:

> -----Original Message-----
> From: Andreas Pflug [mailto:pgadmin@pse-consulting.de]
> Sent: 08 August 2003 10:07
> To: Dave Page
> Cc: pgadmin-hackers
> Subject: Re: [pgadmin-hackers] pgAdmin3 help system
>
>
> Dave Page wrote:
>
> >
> >Don't you like the blue? Any other opinions?
> >
> >
> The CHM doesn't look as programmer's help usually looks like. And
> wxHtmlHelpController can't cope with it either.

'k

> >>The content still needs more work to be done for pgsql, but
> >>this could
> >>be postponed until we have the 7.4 doc.
> >>
> >>
> >
> >In what way?
> >
> All pages should have their own contents entry so they can be
> located by
> CHM if "sync" is pressed.
>
> > I would have said pgsql was OK, but we need more pgAdmin content if
> > anything.
> >
> Some more lyrics... :-)
>
> An index would be fine too. But this is an awful lot of work.

Hmm, yes. It's searchable, and can all be browsed though. I think it's
already far more usable than plain HTML.

Regards, Dave.

Re: pgAdmin3 help system

From
Andreas Pflug
Date:
Dave Page wrote:

>
>Hmm, yes. It's searchable, and can all be browsed though. I think it's
>already far more usable than plain HTML.
>
Being good isn't an excuse for not trying to become even better :-)

Regards,
Andreas





Re: pgAdmin3 help system

From
"Dave Page"
Date:

> -----Original Message-----
> From: Andreas Pflug [mailto:pgadmin@pse-consulting.de]
> Sent: 08 August 2003 10:34
> To: Dave Page
> Cc: pgadmin-hackers
> Subject: Re: [pgadmin-hackers] pgAdmin3 help system
>
>
> Dave Page wrote:
>
> >
> >Hmm, yes. It's searchable, and can all be browsed though. I
> think it's
> >already far more usable than plain HTML.
> >
> Being good isn't an excuse for not trying to become even better :-)

No, but is the significant extra work worth the end result?

Re: pgAdmin3 help system

From
Andreas Pflug
Date:
Dave Page wrote:

>
>
>>-----Original Message-----
>>From: Andreas Pflug [mailto:pgadmin@pse-consulting.de]
>>Sent: 08 August 2003 10:34
>>To: Dave Page
>>Cc: pgadmin-hackers
>>Subject: Re: [pgadmin-hackers] pgAdmin3 help system
>>
>>
>>Dave Page wrote:
>>
>>
>>
>>>Hmm, yes. It's searchable, and can all be browsed though. I
>>>
>>>
>>think it's
>>
>>
>>>already far more usable than plain HTML.
>>>
>>>
>>>
>>Being good isn't an excuse for not trying to become even better :-)
>>
>>
>
>No, but is the significant extra work worth the end result?
>

IMHO we should have a complete contents, but identifying keywords for an
index might be too much work for too few benefit.

Regards,
Andreas


Re: pgAdmin3 help system

From
Darko Prenosil
Date:
On Friday 08 August 2003 10:55, Dave Page wrote:
> > -----Original Message-----
> > From: Andreas Pflug [mailto:pgadmin@pse-consulting.de]
> > Sent: 07 August 2003 19:25
> > To: Dave Page
> > Cc: pgadmin-hackers
> > Subject: pgAdmin3 help system
> >
> >
> > Hi Dave,
> >
> > I revised the help file and entry point generation, I believe it's
> > consistent now. The windows version can now use pgadmin3.chm, if it's
> > present. I believe we should remove the coloured background,
> > reverting
> > to plain white.
>
> Don't you like the blue? Any other opinions?
>
> > The content still needs more work to be done for pgsql, but
> > this could
> > be postponed until we have the 7.4 doc.
>
> In what way? I would have said pgsql was OK, but we need more pgAdmin
> content if anything.
>
pgsql content was done acording content html page (Not even one item more or
less).

Regards, Darko.

Re: pgAdmin3 help system

From
Andreas Pflug
Date:
Darko Prenosil wrote:

>>
>>
>pgsql content was done acording content html page (Not even one item more or
>less).
>
Darko,
it was only the first-level content. There is a second level and often
also a third level. They all fit smoothly in the contents tree, each
addressing a single html file (no tags). So far, I added the sql-xxx
pages, so there are about 450 entries left.

Regards,
Andreas


Re: pgAdmin3 help system

From
"Darko Prenosil"
Date:
----- Original Message -----
From: "Andreas Pflug" <pgadmin@pse-consulting.de>
To: "Darko Prenosil" <darko.prenosil@finteh.hr>
Cc: "pgadmin-hackers" <pgadmin-hackers@postgresql.org>
Sent: Friday, August 08, 2003 5:49 PM
Subject: Re: [pgadmin-hackers] pgAdmin3 help system


> Darko Prenosil wrote:
>
> >>
> >>
> >pgsql content was done acording content html page (Not even one item more
or
> >less).
> >
> Darko,
> it was only the first-level content. There is a second level and often
> also a third level. They all fit smoothly in the contents tree, each
> addressing a single html file (no tags). So far, I added the sql-xxx
> pages, so there are about 450 entries left.
>
> Regards,
> Andreas
>
OK, I see what you meant. I can do the job if You find it useful.
However, a real cool thing would be generate it from sgml ...

Regards !