Re: [Gretl-devel] gfn/zip packaging: help file ref not honored
On Sun, Apr 29, 2018 at 12:49 PM, Sven Schreiber <svetosch(a)gmx.net> wrote:
Hi,
I'm trying to put together a package, and the corresponding entry in the gfn
file correctly says:
<help>
pdfdoc:CSD_panel_help.pdf
</help>
This referenced file exists. But when I test the package, the "info" window
(after right-clicking on the package in the package chooser window) has the
wrong reference "CSD_panel.pdf". Consequently the pdf help cannot be
launched.
Apparently somewhere it's hardwired that the pdf help file has the same name
as the package, only a different extension?
There is indeed a requirement that the PDF help file have the same basename
as the package; see section 3.2.3 of the Gretl Function Package Guide. The
relevant text reads thus:
"To be included with your package, the PDF file must (a) be in the same location
as the gfn file, and (b) have the same "basename" (for example mypkg.pdf if the
package is called mypkg). Nonetheless, you can select a PDF file of any name
from any location, and gretl will take care of copying it into place
under the correct
name."
But it sounds as if there's a bug here: if you specified
"CSD_panel_help.pdf" it
seems that should have been converted to "CSD_panel.pdf" when the package
was built -- at least, if you built the package via the GUI.
I want to maintain the requirement that PDF help files are named as stated
above -- the package name with ".pdf" in place of ".gfn" -- since
there's no
need for any degrees of freedom here, but I also want to make sure that we're
doing what is stated in the Guide.
Allin