Opened 12 years ago

#274 new bug

lib2doc: TeX-commands need to be quoted in info-string for libraries

Reported by: gorzel Owned by: hannes
Priority: minor Milestone: 3-1-2 and higher
Component: singular-lib-doc Version: 3-1-1
Keywords: Cc:

Description

There are two problems with lid2doc:

1.) TeX-commands in @texinfo or @math needs to be quoted by backslash

within the info-string (OVERVIEW) of the library. In the help string of an individual proc this is not needed.

It seems that pl2doc.pl works as follows: For the help string of procs pl2doc.pl first doubles the backslash for @texinfo and @math commands, then it removes the doubled backslash.

Since the program does not double those backslashes in the info-string, there will finally no backslahes for the TeX-commands in the info-string, if not the author of the library adds these quotes him/her-self.

(Or was is never considered to use TeX-commands in the OVERVIEW-part?)

Try the lib2doc for the enclosed library bugtexinfo.lib

Call make bugtexinfo.dvi and take a look at the *.tex file.

2.) If the library calls another library, then lib2doc (pl2oc.pl)

needs a white space after "LIB", which is not necessary for loading the libray.

Without a blank, no output will produced but the following Error messages pop up.

libparse -i bugtexinfo.lib > bugtexinfo.perl
perl ./pl2doc.pl -doc -o bugtexinfo.doc bugtexinfo.perl
Bareword found where operator expected at bugtexinfo.perl line 31, near "]ERROR"
  (Might be a runaway multi-line << string starting on line 6)
        (Missing operator before ERROR?)
Bareword found where operator expected at bugtexinfo.perl line 31, near "] cannot"
        (Missing operator before cannot?)
String found where operator expected at bugtexinfo.perl line 31, near "character ''"
        (Do you need to predeclare character?)
Bareword found where operator expected at bugtexinfo.perl line 31, near "'' in"
        (Missing operator before in?)
Bareword found where operator expected at bugtexinfo.perl line 31, near "1080979772 to"
        (Missing operator before to?)
syntax error at bugtexinfo.perl line 31, near "]ERROR occured"
Compilation failed in require at ./pl2doc.pl line 37.
make: *** [bugtexinfo.doc] Fehler 9

--------------------- In case that it these are not considered as a bug, put a remark into STYLEGUIDE4libdocs at least.

Attachments (2)

bugtexinfo.lib (3.2 KB) - added by gorzel 12 years ago.
bugtexinfo.pdf (32.5 KB) - added by gorzel 12 years ago.

Download all attachments as: .zip

Change History (2)

Changed 12 years ago by gorzel

Attachment: bugtexinfo.lib added

Changed 12 years ago by gorzel

Attachment: bugtexinfo.pdf added
Note: See TracTickets for help on using tickets.