R devel - Nov 1999 - bug in Rdconvlib.pl converting to latex (PR#311)

If .../<pkg>/man/ contains a filename beginning with [, such as
[.datetimes, Rdconvlib.pl cannot convert that help file into latex at
INSTALL time.  [Using --no-latex is a workaround.]

The error given is:

# R INSTALL ssCatalogues
:
 help
 >>> Building/Updating help pages for package `ssCatalogues'
     Formats: text html latex example
/^[.datetimes$/: unmatched [] in regexp at /vol/R/etc/Rdconvlib.pl line
1322, <rdfile> chunk 36.
:

Unfortunately the script stops at that point, so none of the following
help files are installed.

Ray Brownrigg


-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To:
r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._

>>>>> "Ray" == Ray Brownrigg
<Ray.Brownrigg@mcs.vuw.ac.nz> writes:
    Ray> If .../<pkg>/man/ contains a filename beginning with [, such
as
    Ray> [.datetimes, Rdconvlib.pl cannot convert that help file into latex
at
    Ray> INSTALL time.  [Using --no-latex is a workaround.]

    Ray> The error given is:

    Ray> # R INSTALL ssCatalogues
    Ray> :
    Ray> help
    >>>> Building/Updating help pages for package `ssCatalogues'
    Ray> Formats: text html latex example
    Ray> /^[.datetimes$/: unmatched [] in regexp at /vol/R/etc/Rdconvlib.pl
line
    Ray> 1322, <rdfile> chunk 36.
    Ray> :

    Ray> Unfortunately the script stops at that point, so none of the
following
    Ray> help files are installed.

Well, the bug is more that of documentation of what is allowed for *.Rd
file names.

For portability, we even had to give up having e.g., 
both
	Alias.Rd 
and	alias.Rd

I'd say the rule must contain
>>>> |  For portability reasons, R source files must start with  |
>>>> |     [a-zA-Z]						 |
>>>> |  and should be unique within a package if lowercased.	 |
Maybe we even have to consider more restrictions..

Should this be put into the 
       FAQ,  ?library (...base/man/library.Rd), and/or
       doc/manual/writing-Rd.tex
?

Martin Maechler <maechler@stat.math.ethz.ch>
http://stat.ethz.ch/~maechler/
Seminar fuer Statistik, ETH-Zentrum  LEO D10	Leonhardstr. 27
ETH (Federal Inst. Technology)	8092 Zurich	SWITZERLAND
phone: x-41-1-632-3408		fax: ...-1228			<><

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To:
r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._

>>>>> "Saikat" == Saikat DebRoy
<saikat@stat.wisc.edu> writes:
>>>>> "maechler" == maechler 
<maechler@stat.math.ethz.ch> writes:
>>>>> "Ray" == Ray Brownrigg
<Ray.Brownrigg@mcs.vuw.ac.nz> writes:
    Ray> If .../<pkg>/man/ contains a filename beginning with [, such
as
    Ray> [.datetimes, Rdconvlib.pl cannot convert that help file into
    Ray> latex at INSTALL time.  [Using --no-latex is a workaround.]

    maechler> Well, the bug is more that of documentation of what is
    maechler> allowed for *.Rd file names.

    Saikat> I do not think that the problem is with the file names here. It
    Saikat> occurs in line 1335 of Rdconvlib.pl (0.90.0 development
    Saikat> version). You can get around it by escaping the spacial
    Saikat> characters in $blocks{"name"}.

I see, sounds plausible.  We don't have  \name{..}s  with funny chars in
them till now (even though we do have \alias{}es).


    Saikat> The following patch does just that.

    Saikat> ===========================================================   
Saikat> --- Rdconvlib.pl Thu Nov  4 07:45:11 1999
    Saikat> +++ Rdconvlib.pl Thu Nov  4 09:57:43 1999
    Saikat> @@ -1332,7 +1332,7 @@
    Saikat> print STDERR "rdoc2l: alias='$_',
code2l(.)='$c', latex_c_a(.)='$a'\n"
    Saikat> if $debug;
    Saikat> printf latexout "\\alias\{%s\}\{%s\}\n", $a,
$blocks{"name"}
    Saikat> -       unless /^$blocks{"name"}$/;
    Saikat> +       unless /^\Q$blocks{"name"}$/;
    Saikat> }
    Saikat> foreach (@keywords) {
    Saikat> printf latexout "\\keyword\{%s\}\{%s\}\n", $_,
$blocks{"name"}

Good idea to use Perl's \Q feature,
but my  perl online help says

     \Q		quote regexp metacharacters till \E
					    -------
so, you probably should also add a delimiting \E,  shouldn't you ?

Thanks again, Saikat !

Martin

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To:
r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._

>>>>> "Martin" == Martin Maechler
<maechler@stat.math.ethz.ch> writes:
  Martin> Good idea to use Perl's \Q feature, but my perl online help
  Martin> says

  Martin>      \Q quote regexp metacharacters till \E
  Martin>                                     -------
  Martin> so, you probably should also add a delimiting \E, shouldn't you
?

Yes - you are correct. So that line should be changed to

        unless /^\Q$blocks{"name"}\E$/;

Thanks for spotting that.

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To:
r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._