Thread: pga3: Help file locations

pga3: Help file locations

From
"Dave Page"
Date:
I'm having serious trouble getting the helpfiles to be found in pgAdmin
III as the code used to find pages seems to be different for virtually
every help menu option.

I have started sorting this out by moving bugreport.html into the main
doc directory. I haven't modified the code to display it, but have added
it to the index page.

Currently, the Help menu contains these options:

Help...
pgAdmin III FAQ
SQL Help
PostgreSQL Help
Tip of the Day...
-------
Bugreport
About...

I think we should have:

pgAdmin Help    (docs/en_US/index.html)
SQL Help        (docs/en_US/pg/sql-commands.html | xxx.html)
PostgreSQL Help   (docs/en_US/pg/index.html)
pgAdmin FAQ       (http://www.pgadmin.org/pgadmin3/faq/)
Tip of the Day
-------
Bug Reporting     (docs/en_US/pg/bugreport.html)
About

Now, on Windows, the docs are in $INSTALLDIR/docs/en_US/ and
$INSTALLDIR/docs/en_US/. The binaries live in $INSTALLDIR.

On Unix, the docs are (normally) in
$INSTALLDIR/share/pgadmin3/docs/en_US/ and
$INSTALLDIR/share/pgadmin3/docs/en_US/pg/. The binaries live in
$INSTALLDIR/bin/

I'm pretty tired right now, so am not going to try to figure out how to
tidy all this up at the moment, but will think it over. Any other
thoughts or suggestions would be very useful.

Regards, Dave.


Re: pga3: Help file locations

From
Andreas Pflug
Date:
Dave Page wrote:

>I'm having serious trouble getting the helpfiles to be found in pgAdmin
>III as the code used to find pages seems to be different for virtually
>every help menu option.
>
>I have started sorting this out by moving bugreport.html into the main
>doc directory. I haven't modified the code to display it, but have added
>it to the index page.
>
>Currently, the Help menu contains these options:
>
>Help...
>pgAdmin III FAQ
>SQL Help
>PostgreSQL Help
>Tip of the Day...
>-------
>Bugreport
>About...
>
>I think we should have:
>
>pgAdmin Help    (docs/en_US/index.html)
>SQL Help        (docs/en_US/pg/sql-commands.html | xxx.html)
>PostgreSQL Help   (docs/en_US/pg/index.html)
>pgAdmin FAQ       (http://www.pgadmin.org/pgadmin3/faq/)
>Tip of the Day
>-------
>Bug Reporting     (docs/en_US/pg/bugreport.html)
>About
>
>Now, on Windows, the docs are in $INSTALLDIR/docs/en_US/ and
>$INSTALLDIR/docs/en_US/. The binaries live in $INSTALLDIR.
>
>On Unix, the docs are (normally) in
>$INSTALLDIR/share/pgadmin3/docs/en_US/ and
>$INSTALLDIR/share/pgadmin3/docs/en_US/pg/. The binaries live in
>$INSTALLDIR/bin/
>
>
>
So the only problem is bug report? It was just a quick-and-dirty page,
(which shouldn't reside under .../pg, but only en_US), should we include
an official bugreport dialog?

Regards,
Andreas



Re: pga3: Help file locations

From
"Dave Page"
Date:

> -----Original Message-----
> From: Andreas Pflug [mailto:pgadmin@pse-consulting.de]
> Sent: 13 July 2003 22:12
> To: Dave Page
> Cc: pgadmin-hackers@postgresql.org
> Subject: Re: pga3: Help file locations
>
> So the only problem is bug report? It was just a
> quick-and-dirty page,

No, none of them work here. Sometimes I get an error message, sometimes
I don't and just get a blank screen. I have removed all registry
settings and started afresh, and manually set the locations. It just
seems broken.

I beleive we need 2 functions. One that takes a pgadmin helpfile name
and displays it, and the same for postgresql files. Both should error if
they cannot load the file. These functions should be called by the event
handlers for the menu options/F1 key.

On windows, the default doc location should be $EXEDIR/docs/en_US, and
on Unix it should be $BINDIR/../share/pgadmin3/docs/en_US. Currently it
seems that these paths are built in different ways depending on the
function called.

> (which shouldn't reside under .../pg, but only en_US),

It does - that's where I moved it to.

> should
> we include
> an official bugreport dialog?

pgAdmin I had one of those, but no-one used it. Ever. pgAdmin II now has
an 'email error' option on the error dialogue, but we now get regular
error reports for user SQL syntax errors and connect errors (Frank has
had to remove the email button from errors from those forms).

So, no, I think the HTML file & mailling list is fine.

Regards, Dave.