Bug 10810 - Fix synopsis for -html option to overdue_notices.pl
authorMagnus Enger <magnus@enger.priv.no>
Sat, 31 Aug 2013 13:33:24 +0000 (15:33 +0200)
committerGalen Charlton <gmc@esilibrary.com>
Mon, 16 Sep 2013 15:40:30 +0000 (15:40 +0000)
The synopsis for the -html option used to be:
  -html <filename> Output html to file
but the argument to this option should actually be a directory,
not a filename. This patch fixes the synopsis.

To test:
- Run perldoc misc/cronjobs/overdue_notices.pl
- Check that the synopsis is as shown above
- Apply this patch
- Run perldoc misc/cronjobs/overdue_notices.pl
- Check that
  - the synopsis asks for a directory, not a filename
  - that the description of the -html option further down in the
    perldoc now mentions the filename that the HTML file will be
    created with.

Signed-off-by: Bernardo Gonzalez Kriegel <bgkriegel@gmail.com>
Works as described. No koha-qa errors.

If feeded with a filename -html option fails with many messages like
print() on closed filehandle $html_fh at misc/cronjobs/overdue_notices.pl line 384.
Perhaps it could be improved, but that was the old behavior.

Signed-off-by: Katrin Fischer <Katrin.Fischer.83@web.de>
Improves documentation, no negative side effects found.

Signed-off-by: Galen Charlton <gmc@esilibrary.com>
misc/cronjobs/overdue_notices.pl

index 0f263c4..598f922 100755 (executable)
@@ -60,7 +60,7 @@ overdue_notices.pl
    -max          <days>           maximum days overdue to deal with
    -library      <branchname>     only deal with overdues from this library (repeatable : several libraries can be given)
    -csv          <filename>       populate CSV file
-   -html         <filename>       Output html to file
+   -html         <directory>      Output html to a file in the given directory
    -itemscontent <list of fields> item information in templates
    -borcat       <categorycode>   category code that must be included
    -borcatout    <categorycode>   category code that must be excluded
@@ -113,6 +113,8 @@ overdues that could not be emailed are sent in CSV format to the admin.
 Produces html data. if patron does not have a mail address or
 -n (no mail) flag is set, an html file is generated in the specified
 directory. This can be downloaded or futher processed by library staff.
+The file will be called notices-YYYY-MM-DD.html and placed in the directory
+specified.
 
 =item B<-itemscontent>