[Koha-patches] [PATCH] [SIGNED-OFF 1/2] Bug 5385: POD Cleanups (part 1)
Galen Charlton
gmcharlt at gmail.com
Thu Nov 11 14:18:46 CET 2010
From: Andrew Elwell <andrew.elwell at gmail.com>
working through the master branch to eliminate all
podchecker warnings/errors
Actual improvement to the quality of the POD will
come later (hopefully with assistance of others)
Signed-off-by: Andrew Elwell <Andrew.Elwell at gmail.com>
Signed-off-by: Galen Charlton <gmcharlt at gmail.com>
---
C4/AuthoritiesMarc/MARC21.pm | 18 +-
C4/AuthoritiesMarc/UNIMARC.pm | 12 +-
C4/Barcodes/PrinterConfig.pm | 50 ++--
C4/Barcodes/incremental.pm | 2 +-
C4/Cache/Memcached.pm | 8 +-
C4/Cache/Memoize/Memcached.pm | 6 +-
C4/Creators/Lib.pm | 127 ++++-----
C4/External/Amazon.pm | 2 +
C4/External/BakerTaylor.pm | 11 +-
C4/External/Syndetics.pm | 8 +-
C4/Heading/MARC21.pm | 6 +-
C4/ILSDI/Services.pm | 316 ++++++++++----------
C4/Members/AttributeTypes.pm | 148 +++-------
C4/Members/Attributes.pm | 55 +---
C4/Reports/Guided.pm | 30 +-
C4/SIP/ILS/Item.pm | 6 +-
C4/SIP/ILS/Patron.pm | 160 +++++-----
C4/Search/PazPar2.pm | 2 +
C4/VirtualShelves/Page.pm | 22 +-
Makefile.PL | 1 +
acqui/addorder.pl | 6 +-
acqui/check_budget_total.pl | 2 +-
acqui/fetch_sort_dropbox.pl | 4 +-
acqui/neworderempty.pl | 5 +-
acqui/orderreceive.pl | 4 +
acqui/parcel.pl | 4 +
acqui/supplier.pl | 2 +
acqui/updatesupplier.pl | 8 +-
admin/branches.pl | 4 +-
admin/check_budget_parent.pl | 2 +-
admin/check_parent_total.pl | 2 +-
authorities/authorities.pl | 16 +-
cataloguing/value_builder/barcode.pl | 2 +
cataloguing/value_builder/dateaccessioned.pl | 2 +
cataloguing/value_builder/macles.pl | 1 +
cataloguing/value_builder/marc21_field_003.pl | 2 +
cataloguing/value_builder/marc21_field_005.pl | 1 +
cataloguing/value_builder/marc21_leader.pl | 1 +
.../value_builder/marc21_leader_authorities.pl | 1 +
cataloguing/value_builder/marc21_leader_book.pl | 1 +
.../value_builder/marc21_leader_computerfile.pl | 1 +
cataloguing/value_builder/marc21_leader_video.pl | 1 +
cataloguing/value_builder/stocknumber.pl | 10 +-
installer/data/mysql/update22to30.pl | 18 +-
kohaversion.pl | 20 +-
labels/label-create-csv.pl | 4 -
labels/label-create-xml.pl | 4 -
members/patronimage.pl | 2 -
misc/cronjobs/check-url.pl | 2 +-
tools/letter.pl | 1 +
50 files changed, 525 insertions(+), 598 deletions(-)
diff --git a/C4/AuthoritiesMarc/MARC21.pm b/C4/AuthoritiesMarc/MARC21.pm
index bd0eb2e..a148bbb 100644
--- a/C4/AuthoritiesMarc/MARC21.pm
+++ b/C4/AuthoritiesMarc/MARC21.pm
@@ -48,11 +48,7 @@ function based on the marcflavour system preference.
=head2 get_heading_type_from_marc
-=over 4
-
-my $auth_type = get_auth_type_from_marc($marc);
-
-=back
+ my $auth_type = get_auth_type_from_marc($marc);
Given a MARC::Record object containing an authority record,
determine its heading type (e.g., personal name, topical term,
@@ -62,11 +58,7 @@ etc.).
=head2 default_auth_type_location
-=over 4
-
-my ($tag, $subfield) = default_auth_type_location();
-
-=back
+ my ($tag, $subfield) = default_auth_type_location();
Get the tag and subfield used to store the heading type
if not specified in the MARC framework. For MARC21,
@@ -80,11 +72,7 @@ sub default_auth_type_location {
=head2 fix_marc21_auth_type_location
-=over 4
-
-fix_marc21_auth_type_location($auth_marc, $auth_type_tag, $auth_type_subfield);
-
-=back
+ fix_marc21_auth_type_location($auth_marc, $auth_type_tag, $auth_type_subfield);
If the incoming C<MARC::Record> object has a 152$b, remove it. If no
field already exists that contains the specified C<$auth_type_tag>
diff --git a/C4/AuthoritiesMarc/UNIMARC.pm b/C4/AuthoritiesMarc/UNIMARC.pm
index a7af735..b089ec9 100644
--- a/C4/AuthoritiesMarc/UNIMARC.pm
+++ b/C4/AuthoritiesMarc/UNIMARC.pm
@@ -47,11 +47,7 @@ function based on the marcflavour system preference.
=head2 get_heading_type_from_marc
-=over 4
-
-my $auth_type = get_auth_type_from_marc($marc);
-
-=back
+ my $auth_type = get_auth_type_from_marc($marc);
Given a MARC::Record object containing an authority record,
determine its heading type (e.g., personal name, topical term,
@@ -61,11 +57,7 @@ etc.).
=head2 default_auth_type_location
-=over 4
-
-my ($tag, $subfield) = default_auth_type_location();
-
-=back
+ my ($tag, $subfield) = default_auth_type_location();
Get the tag and subfield used to store the heading type
if not specified in the MARC framework. For UNIMARC,
diff --git a/C4/Barcodes/PrinterConfig.pm b/C4/Barcodes/PrinterConfig.pm
index 183d4e4..28854df 100644
--- a/C4/Barcodes/PrinterConfig.pm
+++ b/C4/Barcodes/PrinterConfig.pm
@@ -35,7 +35,7 @@ C4::Barcodes::PrinterConfig - Koha module dealing with labels in a PDF.
=head1 SYNOPSIS
- use C4::Barcodes::PrinterConfig;
+use C4::Barcodes::PrinterConfig;
=head1 DESCRIPTION
@@ -45,17 +45,21 @@ environment of the pdf file.
=head1 FUNCTIONS
-=over 2
+=head2 my @positionsForX;
-=cut
+Takes all the X positions of the pdf file.
+
+=head2 my @positionsForY;
+
+Takes all the Y positions of the pdf file.
-my @positionsForX; # Takes all the X positions of the pdf file.
-my @positionsForY; # Takes all the Y positions of the pdf file.
-my $firstLabel = 1; # Test if the label passed as a parameter is the first label to be printed into the pdf file.
+=head2 my $firstLabel = 1;
-=item setPositionsForX
+Test if the label passed as a parameter is the first label to be printed into the pdf file.
- C4::Barcodes::PrinterConfig::setPositionsForX($marginLeft, $labelWidth, $columns, $pageType);
+=head2 setPositionsForX
+
+ C4::Barcodes::PrinterConfig::setPositionsForX($marginLeft, $labelWidth, $columns, $pageType);
Calculate and stores all the X positions across the pdf page.
@@ -68,7 +72,7 @@ C<$columns> Indicates how many columns do you want in your page type.
C<$pageType> Page type to print (eg: a4, legal, etc).
=cut
-#'
+
sub setPositionsForX {
my ($marginLeft, $labelWidth, $columns, $pageType) = @_;
my $defaultDpi = 72/25.4; # By default we know 25.4 mm -> 1 inch -> 72 dots per inch
@@ -82,9 +86,9 @@ sub setPositionsForX {
@positionsForX = @positions;
}
-=item setPositionsForY
+=head2 setPositionsForY
- C4::Barcodes::PrinterConfig::setPositionsForY($marginBottom, $labelHeigth, $rows, $pageType);
+ C4::Barcodes::PrinterConfig::setPositionsForY($marginBottom, $labelHeigth, $rows, $pageType);
Calculate and stores all tha Y positions across the pdf page.
@@ -97,7 +101,7 @@ C<$rows> Indicates how many rows do you want in your page type.
C<$pageType> Page type to print (eg: a4, legal, etc).
=cut
-#'
+
sub setPositionsForY {
my ($marginBottom, $labelHeigth, $rows, $pageType) = @_;
my $defaultDpi = 72/25.4; # By default we know 25.4 mm -> 1 inch -> 72 dots per inch
@@ -111,16 +115,10 @@ sub setPositionsForY {
@positionsForY = @positions;
}
-=item getLabelPosition
+=head2 getLabelPosition
- (my $x, my $y, $pdfObject, $pageObject, $gfxObject, $textObject, $coreObject, $labelPosition) =
- C4::Barcodes::PrinterConfig::getLabelPosition($labelPosition,
- $pdfObject,
- $page,
- $gfx,
- $text,
- $fontObject,
- $pageType);
+ (my $x, my $y, $pdfObject, $pageObject, $gfxObject, $textObject, $coreObject, $labelPosition) =
+ C4::Barcodes::PrinterConfig::getLabelPosition($labelPosition, $pdfObject, $page, $gfx, $text, $fontObject, $pageType);
Return the (x,y) position of the label that you are going to print considering the environment.
@@ -139,7 +137,7 @@ C<$fontObject> The font object
C<$pageType> Page type to print (eg: a4, legal, etc).
=cut
-#'
+
sub getLabelPosition {
my ($labelNum, $pdf, $page, $gfxObject, $textObject, $fontObject, $pageType) = @_;
my $indexX = $labelNum % @positionsForX;
@@ -168,9 +166,9 @@ sub getLabelPosition {
return ($positionsForX[$indexX], $positionsForY[$indexY], $pdf, $page, $gfxObject, $textObject, $fontObject, $labelNum);
}
-=item labelsPage
+=head2 labelsPage
- my @labelTable = C4::Barcodes::PrinterConfig::labelsPage($rows, $columns);
+ my @labelTable = C4::Barcodes::PrinterConfig::labelsPage($rows, $columns);
This function will help you to build the labels panel, where you can choose
wich label position do you want to start the printer process.
@@ -180,7 +178,7 @@ C<$rows> Indicates how many rows do you want in your page type.
C<$columns> Indicates how many rows do you want in your page type.
=cut
-#'
+
sub labelsPage{
my ($rows, $columns) = @_;
my @pageType;
@@ -213,8 +211,6 @@ sub labelsPage{
__END__
-=back
-
=head1 AUTHOR
Koha Physics Library UNLP <matias_veleda at hotmail.com>
diff --git a/C4/Barcodes/incremental.pm b/C4/Barcodes/incremental.pm
index 1fae3c6..33b21bc 100644
--- a/C4/Barcodes/incremental.pm
+++ b/C4/Barcodes/incremental.pm
@@ -30,7 +30,7 @@ BEGIN {
1;
__END__
-=head2
+=head1 NOTES
Since incremental is the default in C4::Barcodes, we do not override anything here.
In fact, this file is more of a place holder.
diff --git a/C4/Cache/Memcached.pm b/C4/Cache/Memcached.pm
index 2f022d5..1233d41 100644
--- a/C4/Cache/Memcached.pm
+++ b/C4/Cache/Memcached.pm
@@ -69,8 +69,8 @@ sub flush_all {
1;
__END__
-=head1 NAME
-
- C4::Cache::Memcached - memcached subclass of C4::Cache
-
+=head1 NAME
+
+C4::Cache::Memcached - memcached subclass of C4::Cache
+
=cut
diff --git a/C4/Cache/Memoize/Memcached.pm b/C4/Cache/Memoize/Memcached.pm
index 927218c..c65e8a6 100644
--- a/C4/Cache/Memoize/Memcached.pm
+++ b/C4/Cache/Memoize/Memcached.pm
@@ -51,7 +51,7 @@ sub memcached_memoize {
__END__
=head1 NAME
-
- C4::Cache::Memoize::Memcached - subclass of C4::Cache
-
+
+C4::Cache::Memoize::Memcached - subclass of C4::Cache
+
=cut
diff --git a/C4/Creators/Lib.pm b/C4/Creators/Lib.pm
index 6e07847..ded0a5d 100644
--- a/C4/Creators/Lib.pm
+++ b/C4/Creators/Lib.pm
@@ -47,6 +47,16 @@ BEGIN {
);
}
+=head1 NAME
+
+C4::Creators::Lib
+
+=cut
+
+=head1 FUNCTIONS
+
+=cut
+
#=head2 C4::Creators::Lib::_SELECT()
#
# This function returns a recordset upon success and 1 upon failure. Errors are logged to the Apache log.
@@ -135,11 +145,9 @@ my $output_formats = [
=head2 C4::Creators::Lib::get_all_templates()
- This function returns a reference to a hash containing all templates upon success and 1 upon failure. Errors are logged to the Apache log.
-
- examples:
+ my $templates = get_all_templates();
- my $templates = get_all_templates();
+This function returns a reference to a hash containing all templates upon success and 1 upon failure. Errors are logged to the Apache log.
=cut
@@ -163,11 +171,9 @@ sub get_all_templates {
=head2 C4::Creators::Lib::get_all_layouts()
- This function returns a reference to a hash containing all layouts upon success and 1 upon failure. Errors are logged to the Apache log.
+ my $layouts = get_all_layouts();
- examples:
-
- my $layouts = get_all_layouts();
+This function returns a reference to a hash containing all layouts upon success and 1 upon failure. Errors are logged to the Apache log.
=cut
@@ -191,16 +197,15 @@ sub get_all_layouts {
=head2 C4::Creators::Lib::get_all_profiles()
- This function returns an arrayref whose elements are hashes containing all profiles upon success and 1 upon failure. Errors are logged
- to the Apache log. Two parameters are accepted. The first limits the field(s) returned. This parameter should be string of comma separted
- fields. ie. "field_1, field_2, ...field_n" The second limits the records returned based on a string containing a valud SQL 'WHERE' filter.
+ my $profiles = get_all_profiles();
- NOTE: Do not pass in the keyword 'WHERE.'
+ my $profiles = get_all_profiles(field_list => field_list, filter => filter_string);
- examples:
+This function returns an arrayref whose elements are hashes containing all profiles upon success and 1 upon failure. Errors are logged
+to the Apache log. Two parameters are accepted. The first limits the field(s) returned. This parameter should be string of comma separted
+fields. ie. "field_1, field_2, ...field_n" The second limits the records returned based on a string containing a valud SQL 'WHERE' filter.
- my $profiles = get_all_profiles();
- my $profiles = get_all_profiles(field_list => field_list, filter => filter_string);
+NOTE: Do not pass in the keyword 'WHERE.'
=cut
@@ -243,16 +248,15 @@ sub get_all_image_names {
=head2 C4::Creators::Lib::get_batch_summary()
- This function returns an arrayref whose elements are hashes containing the batch_ids of current batches along with the item count
- for each batch upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
- One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
+ my $batches = get_batch_summary();
- NOTE: Do not pass in the keyword 'WHERE.'
+ my $batches = get_batch_summary(filter => filter_string);
- examples:
+This function returns an arrayref whose elements are hashes containing the batch_ids of current batches along with the item count
+for each batch upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
+One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
- my $batches = get_batch_summary();
- my $batches = get_batch_summary(filter => filter_string);
+NOTE: Do not pass in the keyword 'WHERE.'
=cut
@@ -286,16 +290,15 @@ sub get_batch_summary {
=head2 C4::Creators::Lib::get_label_summary()
- This function returns an arrayref whose elements are hashes containing the label_ids of current labels along with the item count
- for each label upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
- One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
+ my $labels = get_label_summary();
- NOTE: Do not pass in the keyword 'WHERE.'
+ my $labels = get_label_summary(items => @item_list);
- examples:
+This function returns an arrayref whose elements are hashes containing the label_ids of current labels along with the item count
+for each label upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
+One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
- my $labels = get_label_summary();
- my $labels = get_label_summary(items => @item_list);
+NOTE: Do not pass in the keyword 'WHERE.'
=cut
@@ -337,16 +340,15 @@ sub get_label_summary {
=head2 C4::Creators::Lib::get_card_summary()
- This function returns an arrayref whose elements are hashes containing the label_ids of current cards along with the item count
- for each card upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
- One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
+ my $cards = get_card_summary();
- NOTE: Do not pass in the keyword 'WHERE.'
+ my $cards = get_card_summary(items => @item_list);
- examples:
+This function returns an arrayref whose elements are hashes containing the label_ids of current cards along with the item count
+for each card upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
+One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
- my $cards = get_card_summary();
- my $cards = get_card_summary(items => @item_list);
+NOTE: Do not pass in the keyword 'WHERE.'
=cut
@@ -375,11 +377,9 @@ sub get_card_summary {
=head2 C4::Creators::Lib::get_barcode_types()
- This function returns a reference to an array of hashes containing all barcode types along with their name and description.
-
- examples:
+ my $barcode_types = get_barcode_types();
- my $barcode_types = get_barcode_types();
+This function returns a reference to an array of hashes containing all barcode types along with their name and description.
=cut
@@ -389,11 +389,9 @@ sub get_barcode_types {
=head2 C4::Creators::Lib::get_label_types()
- This function returns a reference to an array of hashes containing all label types along with their name and description.
+ my $label_types = get_label_types();
- examples:
-
- my $label_types = get_label_types();
+This function returns a reference to an array of hashes containing all label types along with their name and description.
=cut
@@ -403,11 +401,9 @@ sub get_label_types {
=head2 C4::Creators::Lib::get_font_types()
- This function returns a reference to an array of hashes containing all font types along with their name and description.
-
- examples:
+ my $font_types = get_font_types();
- my $font_types = get_font_types();
+This function returns a reference to an array of hashes containing all font types along with their name and description.
=cut
@@ -417,11 +413,9 @@ sub get_font_types {
=head2 C4::Creators::Lib::get_text_justification_types()
- This function returns a reference to an array of hashes containing all text justification types along with their name and description.
+ my $text_justification_types = get_text_justification_types();
- examples:
-
- my $text_justification_types = get_text_justification_types();
+This function returns a reference to an array of hashes containing all text justification types along with their name and description.
=cut
@@ -431,12 +425,11 @@ sub get_text_justification_types {
=head2 C4::Creators::Lib::get_unit_values()
- This function returns a reference to an array of hashes containing all unit types along with their description and multiplier. NOTE: All units are relative to a PostScript Point.
- There are 72 PS points to the inch.
-
- examples:
+ my $unit_values = get_unit_values();
- my $unit_values = get_unit_values();
+This function returns a reference to an array of hashes containing all unit types along with their description and multiplier.
+NOTE: All units are relative to a PostScript Point.
+There are 72 PS points to the inch.
=cut
@@ -446,11 +439,9 @@ sub get_unit_values {
=head2 C4::Creators::Lib::get_output_formats()
- This function returns a reference to an array of hashes containing all label output formats along with their description.
+ my $label_output_formats = get_output_formats();
- examples:
-
- my $label_output_formats = get_output_formats();
+This function returns a reference to an array of hashes containing all label output formats along with their description.
=cut
@@ -494,15 +485,13 @@ sub get_table_names {
=head2 C4::Creators::Lib::html_table()
- This function returns an arrayref of an array of hashes contianing the supplied data formatted suitably to
- be passed off as a T::P template parameter and used to build an html table.
-
- examples:
+This function returns an arrayref of an array of hashes contianing the supplied data formatted suitably to
+be passed off as a T::P template parameter and used to build an html table.
- my $table = html_table(header_fields, array_of_row_data);
- $template->param(
- TABLE => $table,
- );
+ my $table = html_table(header_fields, array_of_row_data);
+ $template->param(
+ TABLE => $table,
+ );
html example:
diff --git a/C4/External/Amazon.pm b/C4/External/Amazon.pm
index 9e503b6..54141db 100644
--- a/C4/External/Amazon.pm
+++ b/C4/External/Amazon.pm
@@ -201,6 +201,8 @@ __END__
=head1 NOTES
+=cut
+
=head1 AUTHOR
Joshua Ferraro <jmf at liblime.com>
diff --git a/C4/External/BakerTaylor.pm b/C4/External/BakerTaylor.pm
index 39768b5..7845811 100644
--- a/C4/External/BakerTaylor.pm
+++ b/C4/External/BakerTaylor.pm
@@ -103,16 +103,21 @@ __END__
=head1 NAME
-C4::External::BakerTaylor - Functions for retrieving content from Baker and Taylor, inventory availability and "Content Cafe".
+C4::External::BakerTaylor
+
+=head1 DESCRIPTION
+
+Functions for retrieving content from Baker and Taylor, inventory availability and "Content Cafe".
+
The settings for this module are controlled by System Preferences:
These can be overridden for testing purposes using the initialize function.
=head1 FUNCTIONS
-=head1 availability($isbn);
+=head2 availability($isbn);
-=head2 $isbn is a isbn string
+$isbn is a isbn string
=head1 NOTES
diff --git a/C4/External/Syndetics.pm b/C4/External/Syndetics.pm
index 4a49379..f94345d 100644
--- a/C4/External/Syndetics.pm
+++ b/C4/External/Syndetics.pm
@@ -56,11 +56,7 @@ This module provides facilities for retrieving Syndetics.com content in Koha
=head2 get_syndetics_summary
-=over 4
-
-my $syndetics_summary= &get_syndetics_summary( $isbn );
-
-=back
+ my $syndetics_summary= &get_syndetics_summary( $isbn );
Get Summary data from Syndetics
@@ -275,6 +271,8 @@ __END__
=head1 NOTES
+=cut
+
=head1 AUTHOR
Joshua Ferraro <jmf at liblime.com>
diff --git a/C4/Heading/MARC21.pm b/C4/Heading/MARC21.pm
index 4867c4b..77cdac2 100644
--- a/C4/Heading/MARC21.pm
+++ b/C4/Heading/MARC21.pm
@@ -87,11 +87,7 @@ my %subdivisions = (
=head2 new
-=over 4
-
-my $marc_handler = C4::Heading::MARC21->new();
-
-=back
+ my $marc_handler = C4::Heading::MARC21->new();
=cut
diff --git a/C4/ILSDI/Services.pm b/C4/ILSDI/Services.pm
index be093f0..c99f2a9 100644
--- a/C4/ILSDI/Services.pm
+++ b/C4/ILSDI/Services.pm
@@ -40,9 +40,9 @@ C4::ILS-DI::Services - ILS-DI Services
=head1 DESCRIPTION
- Each function in this module represents an ILS-DI service.
- They all takes a CGI instance as argument and most of them return a
- hashref that will be printed by XML::Simple in opac/ilsdi.pl
+Each function in this module represents an ILS-DI service.
+They all takes a CGI instance as argument and most of them return a
+hashref that will be printed by XML::Simple in opac/ilsdi.pl
=head1 SYNOPSIS
@@ -65,28 +65,39 @@ C4::ILS-DI::Services - ILS-DI Services
=cut
+=head1 FUNCTIONS
+
=head2 GetAvailability
-
- Given a set of biblionumbers or itemnumbers, returns a list with
- availability of the items associated with the identifiers.
-
- Parameters :
-
- - id (Required)
- list of either biblionumbers or itemnumbers
- - id_type (Required)
- defines the type of record identifier being used in the request,
- possible values:
- - bib
- - item
- - return_type (Optional)
- requests a particular level of detail in reporting availability,
- possible values:
- - bib
- - item
- - return_fmt (Optional)
- requests a particular format or set of formats in reporting
- availability
+
+Given a set of biblionumbers or itemnumbers, returns a list with
+availability of the items associated with the identifiers.
+
+Parameters:
+
+=head3 id (Required)
+
+list of either biblionumbers or itemnumbers
+
+=head3 id_type (Required)
+
+defines the type of record identifier being used in the request,
+possible values:
+
+ - bib
+ - item
+
+=head3 return_type (Optional)
+
+requests a particular level of detail in reporting availability,
+possible values:
+
+ - bib
+ - item
+
+=head3 return_fmt (Optional)
+
+requests a particular format or set of formats in reporting
+availability
=cut
@@ -143,25 +154,26 @@ sub GetAvailability {
}
=head2 GetRecords
-
- Given a list of biblionumbers, returns a list of record objects that
- contain bibliographic information, as well as associated holdings and item
- information. The caller may request a specific metadata schema for the
- record objects to be returned.
- This function behaves similarly to HarvestBibliographicRecords and
- HarvestExpandedRecords in Data Aggregation, but allows quick, real time
- lookup by bibliographic identifier.
-
- You can use OAI-PMH ListRecords instead of this service.
-
- Parameters:
-
- - id (Required)
- list of system record identifiers
- - id_type (Optional)
- Defines the metadata schema in which the records are returned,
- possible values:
- - MARCXML
+
+Given a list of biblionumbers, returns a list of record objects that
+contain bibliographic information, as well as associated holdings and item
+information. The caller may request a specific metadata schema for the
+record objects to be returned.
+
+This function behaves similarly to HarvestBibliographicRecords and
+HarvestExpandedRecords in Data Aggregation, but allows quick, real time
+lookup by bibliographic identifier.
+
+You can use OAI-PMH ListRecords instead of this service.
+
+Parameters:
+
+ - id (Required)
+ list of system record identifiers
+ - id_type (Optional)
+ Defines the metadata schema in which the records are returned,
+ possible values:
+ - MARCXML
=cut
@@ -221,18 +233,18 @@ sub GetRecords {
}
=head2 GetAuthorityRecords
-
- Given a list of authority record identifiers, returns a list of record
- objects that contain the authority records. The function user may request
- a specific metadata schema for the record objects.
- Parameters:
+Given a list of authority record identifiers, returns a list of record
+objects that contain the authority records. The function user may request
+a specific metadata schema for the record objects.
+
+Parameters:
- - id (Required)
- list of authority record identifiers
- - schema (Optional)
- specifies the metadata schema of records to be returned, possible values:
- - MARCXML
+ - id (Required)
+ list of authority record identifiers
+ - schema (Optional)
+ specifies the metadata schema of records to be returned, possible values:
+ - MARCXML
=cut
@@ -259,19 +271,19 @@ sub GetAuthorityRecords {
}
=head2 LookupPatron
-
- Looks up a patron in the ILS by an identifier, and returns the borrowernumber.
-
- Parameters:
-
- - id (Required)
- an identifier used to look up the patron in Koha
- - id_type (Optional)
- the type of the identifier, possible values:
- - cardnumber
- - firstname
- - userid
- - borrowernumber
+
+Looks up a patron in the ILS by an identifier, and returns the borrowernumber.
+
+Parameters:
+
+ - id (Required)
+ an identifier used to look up the patron in Koha
+ - id_type (Optional)
+ the type of the identifier, possible values:
+ - cardnumber
+ - firstname
+ - userid
+ - borrowernumber
=cut
@@ -294,16 +306,16 @@ sub LookupPatron {
=head2 AuthenticatePatron
- Authenticates a user's login credentials and returns the identifier for
- the patron.
-
- Parameters:
+Authenticates a user's login credentials and returns the identifier for
+the patron.
+
+Parameters:
+
+ - username (Required)
+ user's login identifier
+ - password (Required)
+ user's password
- - username (Required)
- user's login identifier
- - password (Required)
- user's password
-
=cut
sub AuthenticatePatron {
@@ -326,23 +338,23 @@ sub AuthenticatePatron {
=head2 GetPatronInfo
- Returns specified information about the patron, based on options in the
- request. This function can optionally return patron's contact information,
- fine information, hold request information, and loan information.
-
- Parameters:
-
- - patron_id (Required)
- the borrowernumber
- - show_contact (Optional, default 1)
- whether or not to return patron's contact information in the response
- - show_fines (Optional, default 0)
- whether or not to return fine information in the response
- - show_holds (Optional, default 0)
- whether or not to return hold request information in the response
- - show_loans (Optional, default 0)
- whether or not to return loan information request information in the response
-
+Returns specified information about the patron, based on options in the
+request. This function can optionally return patron's contact information,
+fine information, hold request information, and loan information.
+
+Parameters:
+
+ - patron_id (Required)
+ the borrowernumber
+ - show_contact (Optional, default 1)
+ whether or not to return patron's contact information in the response
+ - show_fines (Optional, default 0)
+ whether or not to return fine information in the response
+ - show_holds (Optional, default 0)
+ whether or not to return hold request information in the response
+ - show_loans (Optional, default 0)
+ whether or not to return loan information request information in the response
+
=cut
sub GetPatronInfo {
@@ -421,12 +433,12 @@ sub GetPatronInfo {
=head2 GetPatronStatus
- Returns a patron's status information.
-
- Parameters:
+Returns a patron's status information.
- - patron_id (Required)
- the borrower ID
+Parameters:
+
+ - patron_id (Required)
+ the borrower ID
=cut
@@ -448,15 +460,15 @@ sub GetPatronStatus {
=head2 GetServices
- Returns information about the services available on a particular item for
- a particular patron.
-
- Parameters:
+Returns information about the services available on a particular item for
+a particular patron.
+
+Parameters:
- - patron_id (Required)
- a borrowernumber
- - item_id (Required)
- an itemnumber
+ - patron_id (Required)
+ a borrowernumber
+ - item_id (Required)
+ an itemnumber
=cut
sub GetServices {
@@ -518,16 +530,16 @@ sub GetServices {
=head2 RenewLoan
- Extends the due date for a borrower's existing issue.
-
- Parameters:
+Extends the due date for a borrower's existing issue.
- - patron_id (Required)
- a borrowernumber
- - item_id (Required)
- an itemnumber
- - desired_due_date (Required)
- the date the patron would like the item returned by
+Parameters:
+
+ - patron_id (Required)
+ a borrowernumber
+ - item_id (Required)
+ an itemnumber
+ - desired_due_date (Required)
+ the date the patron would like the item returned by
=cut
@@ -562,22 +574,22 @@ sub RenewLoan {
=head2 HoldTitle
- Creates, for a borrower, a biblio-level hold reserve.
-
- Parameters:
-
- - patron_id (Required)
- a borrowernumber
- - bib_id (Required)
- a biblionumber
- - request_location (Required)
- IP address where the end user request is being placed
- - pickup_location (Optional)
- a branch code indicating the location to which to deliver the item for pickup
- - needed_before_date (Optional)
- date after which hold request is no longer needed
- - pickup_expiry_date (Optional)
- date after which item returned to shelf if item is not picked up
+Creates, for a borrower, a biblio-level hold reserve.
+
+Parameters:
+
+ - patron_id (Required)
+ a borrowernumber
+ - bib_id (Required)
+ a biblionumber
+ - request_location (Required)
+ IP address where the end user request is being placed
+ - pickup_location (Optional)
+ a branch code indicating the location to which to deliver the item for pickup
+ - needed_before_date (Optional)
+ date after which hold request is no longer needed
+ - pickup_expiry_date (Optional)
+ date after which item returned to shelf if item is not picked up
=cut
@@ -626,23 +638,23 @@ sub HoldTitle {
=head2 HoldItem
- Creates, for a borrower, an item-level hold request on a specific item of
- a bibliographic record in Koha.
+Creates, for a borrower, an item-level hold request on a specific item of
+a bibliographic record in Koha.
- Parameters:
+Parameters:
- - patron_id (Required)
- a borrowernumber
- - bib_id (Required)
- a biblionumber
- - item_id (Required)
- an itemnumber
- - pickup_location (Optional)
- a branch code indicating the location to which to deliver the item for pickup
- - needed_before_date (Optional)
- date after which hold request is no longer needed
- - pickup_expiry_date (Optional)
- date after which item returned to shelf if item is not picked up
+ - patron_id (Required)
+ a borrowernumber
+ - bib_id (Required)
+ a biblionumber
+ - item_id (Required)
+ an itemnumber
+ - pickup_location (Optional)
+ a branch code indicating the location to which to deliver the item for pickup
+ - needed_before_date (Optional)
+ date after which hold request is no longer needed
+ - pickup_expiry_date (Optional)
+ date after which item returned to shelf if item is not picked up
=cut
@@ -709,14 +721,14 @@ sub HoldItem {
=head2 CancelHold
- Cancels an active reserve request for the borrower.
-
- Parameters:
+Cancels an active reserve request for the borrower.
+
+Parameters:
- - patron_id (Required)
- a borrowernumber
- - item_id (Required)
- an itemnumber
+ - patron_id (Required)
+ a borrowernumber
+ - item_id (Required)
+ an itemnumber
=cut
diff --git a/C4/Members/AttributeTypes.pm b/C4/Members/AttributeTypes.pm
index 9fb39e0..21d17eb 100644
--- a/C4/Members/AttributeTypes.pm
+++ b/C4/Members/AttributeTypes.pm
@@ -34,43 +34,35 @@ C4::Members::AttributeTypes - mananage extended patron attribute types
=head1 SYNOPSIS
-=over 4
-
-my @attribute_types = C4::Members::AttributeTypes::GetAttributeTypes();
-
-my $attr_type = C4::Members::AttributeTypes->new($code, $description);
-$attr_type->code($code);
-$attr_type->description($description);
-$attr_type->repeatable($repeatable);
-$attr_type->unique_id($unique_id);
-$attr_type->opac_display($opac_display);
-$attr_type->password_allowed($password_allowed);
-$attr_type->staff_searchable($staff_searchable);
-$attr_type->authorised_value_category($authorised_value_category);
-$attr_type->store();
-$attr_type->delete();
-
-my $attr_type = C4::Members::AttributeTypes->fetch($code);
-$attr_type = C4::Members::AttributeTypes->delete($code);
-
-=back
+ my @attribute_types = C4::Members::AttributeTypes::GetAttributeTypes();
+
+ my $attr_type = C4::Members::AttributeTypes->new($code, $description);
+ $attr_type->code($code);
+ $attr_type->description($description);
+ $attr_type->repeatable($repeatable);
+ $attr_type->unique_id($unique_id);
+ $attr_type->opac_display($opac_display);
+ $attr_type->password_allowed($password_allowed);
+ $attr_type->staff_searchable($staff_searchable);
+ $attr_type->authorised_value_category($authorised_value_category);
+ $attr_type->store();
+ $attr_type->delete();
+
+ my $attr_type = C4::Members::AttributeTypes->fetch($code);
+ $attr_type = C4::Members::AttributeTypes->delete($code);
=head1 FUNCTIONS
=head2 GetAttributeTypes
-=over 4
-
-my @attribute_types = C4::Members::AttributeTypes::GetAttributeTypes($all_fields);
-
-=back
+ my @attribute_types = C4::Members::AttributeTypes::GetAttributeTypes($all_fields);
Returns an array of hashrefs of each attribute type defined
in the database. The array is sorted by code. Each hashref contains
at least the following fields:
-code
-description
+ - code
+ - description
If $all_fields is true, then each hashref also contains the other fields from borrower_attribute_types.
@@ -93,11 +85,7 @@ sub GetAttributeTypes_hashref {
=head1 METHODS
-=over 4
-
-my $attr_type = C4::Members::AttributeTypes->new($code, $description);
-
-=back
+ my $attr_type = C4::Members::AttributeTypes->new($code, $description);
Create a new attribute type.
@@ -122,11 +110,7 @@ sub new {
=head2 fetch
-=over 4
-
-my $attr_type = C4::Members::AttributeTypes->fetch($code);
-
-=back
+ my $attr_type = C4::Members::AttributeTypes->fetch($code);
Fetches an attribute type from the database. If no
type with the given C<$code> exists, returns undef.
@@ -160,11 +144,7 @@ sub fetch {
=head2 store
-=over 4
-
-$attr_type->store();
-
-=back
+ $attr_type->store();
Stores attribute type in the database. If the type
previously retrieved from the database via the fetch()
@@ -209,12 +189,8 @@ sub store {
=head2 code
-=over 4
-
-my $code = $attr_type->code();
-$attr_type->code($code);
-
-=back
+ my $code = $attr_type->code();
+ $attr_type->code($code);
Accessor. Note that the code is immutable once
a type is created or fetched from the database.
@@ -228,12 +204,8 @@ sub code {
=head2 description
-=over 4
-
-my $description = $attr_type->description();
-$attr_type->description($description);
-
-=back
+ my $description = $attr_type->description();
+ $attr_type->description($description);
Accessor.
@@ -246,12 +218,8 @@ sub description {
=head2 repeatable
-=over 4
-
-my $repeatable = $attr_type->repeatable();
-$attr_type->repeatable($repeatable);
-
-=back
+ my $repeatable = $attr_type->repeatable();
+ $attr_type->repeatable($repeatable);
Accessor. The C<$repeatable> argument
is interpreted as a Perl boolean.
@@ -265,12 +233,8 @@ sub repeatable {
=head2 unique_id
-=over 4
-
-my $unique_id = $attr_type->unique_id();
-$attr_type->unique_id($unique_id);
-
-=back
+ my $unique_id = $attr_type->unique_id();
+ $attr_type->unique_id($unique_id);
Accessor. The C<$unique_id> argument
is interpreted as a Perl boolean.
@@ -283,12 +247,8 @@ sub unique_id {
}
=head2 opac_display
-=over 4
-
-my $opac_display = $attr_type->opac_display();
-$attr_type->opac_display($opac_display);
-
-=back
+ my $opac_display = $attr_type->opac_display();
+ $attr_type->opac_display($opac_display);
Accessor. The C<$opac_display> argument
is interpreted as a Perl boolean.
@@ -301,12 +261,8 @@ sub opac_display {
}
=head2 password_allowed
-=over 4
-
-my $password_allowed = $attr_type->password_allowed();
-$attr_type->password_allowed($password_allowed);
-
-=back
+ my $password_allowed = $attr_type->password_allowed();
+ $attr_type->password_allowed($password_allowed);
Accessor. The C<$password_allowed> argument
is interpreted as a Perl boolean.
@@ -319,12 +275,8 @@ sub password_allowed {
}
=head2 staff_searchable
-=over 4
-
-my $staff_searchable = $attr_type->staff_searchable();
-$attr_type->staff_searchable($staff_searchable);
-
-=back
+ my $staff_searchable = $attr_type->staff_searchable();
+ $attr_type->staff_searchable($staff_searchable);
Accessor. The C<$staff_searchable> argument
is interpreted as a Perl boolean.
@@ -338,12 +290,8 @@ sub staff_searchable {
=head2 authorised_value_category
-=over 4
-
-my $authorised_value_category = $attr_type->authorised_value_category();
-$attr_type->authorised_value_category($authorised_value_category);
-
-=back
+ my $authorised_value_category = $attr_type->authorised_value_category();
+ $attr_type->authorised_value_category($authorised_value_category);
Accessor.
@@ -356,12 +304,8 @@ sub authorised_value_category {
=head2 delete
-=over 4
-
-$attr_type->delete();
-C4::Members::AttributeTypes->delete($code);
-
-=back
+ $attr_type->delete();
+ C4::Members::AttributeTypes->delete($code);
Delete an attribute type from the database. The attribute
type may be specified either by an object or by a code.
@@ -384,11 +328,7 @@ sub delete {
=head2 num_patrons
-=over 4
-
-my $count = $attr_type->num_patrons();
-
-=back
+ my $count = $attr_type->num_patrons();
Returns the number of patron records that use
this attribute type.
@@ -410,11 +350,7 @@ sub num_patrons {
=head2 get_patrons
-=over 4
-
-my @borrowernumbers = $attr_type->get_patrons($attribute);
-
-=back
+ my @borrowernumbers = $attr_type->get_patrons($attribute);
Returns the borrowernumber of the patron records that
have an attribute with the specifie value.
diff --git a/C4/Members/Attributes.pm b/C4/Members/Attributes.pm
index 72af3c8..70c34b4 100644
--- a/C4/Members/Attributes.pm
+++ b/C4/Members/Attributes.pm
@@ -43,22 +43,14 @@ C4::Members::Attributes - manage extend patron attributes
=head1 SYNOPSIS
-=over 4
-
- use C4::Members::Attributes;
- my $attributes = C4::Members::Attributes::GetBorrowerAttributes($borrowernumber);
-
-=back
+ use C4::Members::Attributes;
+ my $attributes = C4::Members::Attributes::GetBorrowerAttributes($borrowernumber);
=head1 FUNCTIONS
=head2 GetBorrowerAttributes
-=over 4
-
-my $attributes = C4::Members::Attributes::GetBorrowerAttributes($borrowernumber[, $opac_only]);
-
-=back
+ my $attributes = C4::Members::Attributes::GetBorrowerAttributes($borrowernumber[, $opac_only]);
Retrieve an arrayref of extended attributes associated with the
patron specified by C<$borrowernumber>. Each entry in the arrayref
@@ -104,12 +96,7 @@ sub GetBorrowerAttributes {
=head2 SearchIdMatchingAttribute
-=over 4
-
-my $matching_records = C4::Members::Attributes::SearchIdMatchingAttribute($filter);
-
-=back
-
+ my $matching_records = C4::Members::Attributes::SearchIdMatchingAttribute($filter);
=cut
@@ -130,11 +117,7 @@ AND attribute like ?};
=head2 CheckUniqueness
-=over 4
-
- my $ok = CheckUniqueness($code, $value[, $borrowernumber]);
-
-=back
+ my $ok = CheckUniqueness($code, $value[, $borrowernumber]);
Given an attribute type and value, verify if would violate
a unique_id restriction if added to the patron. The
@@ -178,11 +161,7 @@ sub CheckUniqueness {
=head2 SetBorrowerAttributes
-=over 4
-
- SetBorrowerAttributes($borrowernumber, [ { code => 'CODE', value => 'value', password => 'password' }, ... ] );
-
-=back
+ SetBorrowerAttributes($borrowernumber, [ { code => 'CODE', value => 'value', password => 'password' }, ... ] );
Set patron attributes for the patron identified by C<$borrowernumber>,
replacing any that existed previously.
@@ -207,12 +186,8 @@ sub SetBorrowerAttributes {
=head2 extended_attributes_code_value_arrayref
-=over 4
-
- my $patron_attributes = "homeroom:1150605,grade:01,extradata:foobar";
- my $aref = extended_attributes_code_value_arrayref($patron_attributes);
-
-=back
+ my $patron_attributes = "homeroom:1150605,grade:01,extradata:foobar";
+ my $aref = extended_attributes_code_value_arrayref($patron_attributes);
Takes a comma-delimited CSV-style string argument and returns the kind of data structure that SetBorrowerAttributes wants,
namely a reference to array of hashrefs like:
@@ -238,16 +213,12 @@ sub extended_attributes_code_value_arrayref {
=head2 extended_attributes_merge
-=over 4
-
- my $old_attributes = extended_attributes_code_value_arrayref("homeroom:224,grade:04,deanslist:2007,deanslist:2008,somedata:xxx");
- my $new_attributes = extended_attributes_code_value_arrayref("homeroom:115,grade:05,deanslist:2009,extradata:foobar");
- my $merged = extended_attributes_merge($patron_attributes, $new_attributes, 1);
-
- # assuming deanslist is a repeatable code, value same as:
- # $merged = extended_attributes_code_value_arrayref("homeroom:115,grade:05,deanslist:2007,deanslist:2008,deanslist:2009,extradata:foobar,somedata:xxx");
+ my $old_attributes = extended_attributes_code_value_arrayref("homeroom:224,grade:04,deanslist:2007,deanslist:2008,somedata:xxx");
+ my $new_attributes = extended_attributes_code_value_arrayref("homeroom:115,grade:05,deanslist:2009,extradata:foobar");
+ my $merged = extended_attributes_merge($patron_attributes, $new_attributes, 1);
-=back
+ # assuming deanslist is a repeatable code, value same as:
+ # $merged = extended_attributes_code_value_arrayref("homeroom:115,grade:05,deanslist:2007,deanslist:2008,deanslist:2009,extradata:foobar,somedata:xxx");
Takes three arguments. The first two are references to array of hashrefs, each like:
[ { code => 'CODE', value => 'value' }, { code => 'CODE2', value => 'othervalue' } ... ]
diff --git a/C4/Reports/Guided.pm b/C4/Reports/Guided.pm
index 5fb1aae..22ee977 100644
--- a/C4/Reports/Guided.pm
+++ b/C4/Reports/Guided.pm
@@ -106,7 +106,7 @@ if (C4::Context->preference('item-level_itypes')) {
}
=head1 NAME
-
+
C4::Reports::Guided - Module for generating guided reports
=head1 SYNOPSIS
@@ -115,6 +115,7 @@ C4::Reports::Guided - Module for generating guided reports
=head1 DESCRIPTION
+=cut
=head1 METHODS
@@ -374,25 +375,22 @@ sub get_criteria {
=item execute_query
-=over
+ ($results, $total, $error) = execute_query($sql, $offset, $limit)
-($results, $total, $error) = execute_query($sql, $offset, $limit)
-=back
+When passed C<$sql>, this function returns an array ref containing a result set
+suitably formatted for display in html or for output as a flat file when passed in
+C<$format> and C<$id>. It also returns the C<$total> records available for the
+supplied query. If passed any query other than a SELECT, or if there is a db error,
+C<$errors> an array ref is returned containing the error after this manner:
- When passed C<$sql>, this function returns an array ref containing a result set
- suitably formatted for display in html or for output as a flat file when passed in
- C<$format> and C<$id>. It also returns the C<$total> records available for the
- supplied query. If passed any query other than a SELECT, or if there is a db error,
- C<$errors> an array ref is returned containing the error after this manner:
+C<$error->{'sqlerr'}> contains the offending SQL keyword.
+C<$error->{'queryerr'}> contains the native db engine error returned for the query.
- C<$error->{'sqlerr'}> contains the offending SQL keyword.
- C<$error->{'queryerr'}> contains the native db engine error returned for the query.
-
- Valid values for C<$format> are 'text,' 'tab,' 'csv,' or 'url. C<$sql>, C<$type>,
- C<$offset>, and C<$limit> are required parameters. If a valid C<$format> is passed
- in, C<$offset> and C<$limit> are ignored for obvious reasons. A LIMIT specified by
- the user in a user-supplied SQL query WILL apply in any case.
+Valid values for C<$format> are 'text,' 'tab,' 'csv,' or 'url. C<$sql>, C<$type>,
+C<$offset>, and C<$limit> are required parameters. If a valid C<$format> is passed
+in, C<$offset> and C<$limit> are ignored for obvious reasons. A LIMIT specified by
+the user in a user-supplied SQL query WILL apply in any case.
=cut
diff --git a/C4/SIP/ILS/Item.pm b/C4/SIP/ILS/Item.pm
index b0c385c..3ff7f10 100644
--- a/C4/SIP/ILS/Item.pm
+++ b/C4/SIP/ILS/Item.pm
@@ -32,9 +32,9 @@ BEGIN {
@EXPORT_OK = qw();
}
-=head2 EXAMPLE
+=head1 EXAMPLE
-our %item_db = (
+ our %item_db = (
'1565921879' => {
title => "Perl 5 desktop reference",
id => '1565921879',
@@ -234,7 +234,7 @@ sub status_update { # FIXME: this looks unimplemented
$status->{ok} = 1;
return $status;
}
-
+
sub title_id {
my $self = shift;
return $self->{title};
diff --git a/C4/SIP/ILS/Patron.pm b/C4/SIP/ILS/Patron.pm
index e6b53b1..3f4e136 100644
--- a/C4/SIP/ILS/Patron.pm
+++ b/C4/SIP/ILS/Patron.pm
@@ -354,9 +354,9 @@ sub charge_denied {
1;
__END__
-=head2 EXAMPLES
+=head1 EXAMPLES
-our %patron_example = (
+ our %patron_example = (
djfiander => {
name => "David J. Fiander",
id => 'djfiander',
@@ -388,96 +388,96 @@ our %patron_example = (
},
);
-From borrowers table:
-+---------------------+--------------+------+-----+
-| Field | Type | Null | Key |
-+---------------------+--------------+------+-----+
-| borrowernumber | int(11) | NO | PRI |
-| cardnumber | varchar(16) | YES | UNI |
-| surname | mediumtext | NO | |
-| firstname | text | YES | |
-| title | mediumtext | YES | |
-| othernames | mediumtext | YES | |
-| initials | text | YES | |
-| streetnumber | varchar(10) | YES | |
-| streettype | varchar(50) | YES | |
-| address | mediumtext | NO | |
-| address2 | text | YES | |
-| city | mediumtext | NO | |
-| zipcode | varchar(25) | YES | |
-| country | text | YES | |
-| email | mediumtext | YES | |
-| phone | text | YES | |
-| mobile | varchar(50) | YES | |
-| fax | mediumtext | YES | |
-| emailpro | text | YES | |
-| phonepro | text | YES | |
-| B_streetnumber | varchar(10) | YES | |
-| B_streettype | varchar(50) | YES | |
-| B_address | varchar(100) | YES | |
-| B_address2 | text | YES | |
-| B_city | mediumtext | YES | |
-| B_zipcode | varchar(25) | YES | |
-| B_country | text | YES | |
-| B_email | text | YES | |
-| B_phone | mediumtext | YES | |
-| dateofbirth | date | YES | |
-| branchcode | varchar(10) | NO | MUL |
-| categorycode | varchar(10) | NO | MUL |
-| dateenrolled | date | YES | |
-| dateexpiry | date | YES | |
-| gonenoaddress | tinyint(1) | YES | |
-| lost | tinyint(1) | YES | |
-| debarred | tinyint(1) | YES | |
-| contactname | mediumtext | YES | |
-| contactfirstname | text | YES | |
-| contacttitle | text | YES | |
-| guarantorid | int(11) | YES | |
-| borrowernotes | mediumtext | YES | |
-| relationship | varchar(100) | YES | |
-| ethnicity | varchar(50) | YES | |
-| ethnotes | varchar(255) | YES | |
-| sex | varchar(1) | YES | |
-| password | varchar(30) | YES | |
-| flags | int(11) | YES | |
-| userid | varchar(30) | YES | MUL |
-| opacnote | mediumtext | YES | |
-| contactnote | varchar(255) | YES | |
-| sort1 | varchar(80) | YES | |
-| sort2 | varchar(80) | YES | |
-| altcontactfirstname | varchar(255) | YES | |
-| altcontactsurname | varchar(255) | YES | |
-| altcontactaddress1 | varchar(255) | YES | |
-| altcontactaddress2 | varchar(255) | YES | |
-| altcontactaddress3 | varchar(255) | YES | |
-| altcontactzipcode | varchar(50) | YES | |
-| altcontactcountry | text | YES | |
-| altcontactphone | varchar(50) | YES | |
-| smsalertnumber | varchar(50) | YES | |
-+---------------------+--------------+------+-----+
-
-From C4::Members
-
-$flags->{KEY}
-{CHARGES}
+ From borrowers table:
+ +---------------------+--------------+------+-----+
+ | Field | Type | Null | Key |
+ +---------------------+--------------+------+-----+
+ | borrowernumber | int(11) | NO | PRI |
+ | cardnumber | varchar(16) | YES | UNI |
+ | surname | mediumtext | NO | |
+ | firstname | text | YES | |
+ | title | mediumtext | YES | |
+ | othernames | mediumtext | YES | |
+ | initials | text | YES | |
+ | streetnumber | varchar(10) | YES | |
+ | streettype | varchar(50) | YES | |
+ | address | mediumtext | NO | |
+ | address2 | text | YES | |
+ | city | mediumtext | NO | |
+ | zipcode | varchar(25) | YES | |
+ | country | text | YES | |
+ | email | mediumtext | YES | |
+ | phone | text | YES | |
+ | mobile | varchar(50) | YES | |
+ | fax | mediumtext | YES | |
+ | emailpro | text | YES | |
+ | phonepro | text | YES | |
+ | B_streetnumber | varchar(10) | YES | |
+ | B_streettype | varchar(50) | YES | |
+ | B_address | varchar(100) | YES | |
+ | B_address2 | text | YES | |
+ | B_city | mediumtext | YES | |
+ | B_zipcode | varchar(25) | YES | |
+ | B_country | text | YES | |
+ | B_email | text | YES | |
+ | B_phone | mediumtext | YES | |
+ | dateofbirth | date | YES | |
+ | branchcode | varchar(10) | NO | MUL |
+ | categorycode | varchar(10) | NO | MUL |
+ | dateenrolled | date | YES | |
+ | dateexpiry | date | YES | |
+ | gonenoaddress | tinyint(1) | YES | |
+ | lost | tinyint(1) | YES | |
+ | debarred | tinyint(1) | YES | |
+ | contactname | mediumtext | YES | |
+ | contactfirstname | text | YES | |
+ | contacttitle | text | YES | |
+ | guarantorid | int(11) | YES | |
+ | borrowernotes | mediumtext | YES | |
+ | relationship | varchar(100) | YES | |
+ | ethnicity | varchar(50) | YES | |
+ | ethnotes | varchar(255) | YES | |
+ | sex | varchar(1) | YES | |
+ | password | varchar(30) | YES | |
+ | flags | int(11) | YES | |
+ | userid | varchar(30) | YES | MUL |
+ | opacnote | mediumtext | YES | |
+ | contactnote | varchar(255) | YES | |
+ | sort1 | varchar(80) | YES | |
+ | sort2 | varchar(80) | YES | |
+ | altcontactfirstname | varchar(255) | YES | |
+ | altcontactsurname | varchar(255) | YES | |
+ | altcontactaddress1 | varchar(255) | YES | |
+ | altcontactaddress2 | varchar(255) | YES | |
+ | altcontactaddress3 | varchar(255) | YES | |
+ | altcontactzipcode | varchar(50) | YES | |
+ | altcontactcountry | text | YES | |
+ | altcontactphone | varchar(50) | YES | |
+ | smsalertnumber | varchar(50) | YES | |
+ +---------------------+--------------+------+-----+
+
+ From C4::Members
+
+ $flags->{KEY}
+ {CHARGES}
{message} Message showing patron's credit or debt
{noissues} Set if patron owes >$5.00
-{GNA} Set if patron gone w/o address
+ {GNA} Set if patron gone w/o address
{message} "Borrower has no valid address"
{noissues} Set.
-{LOST} Set if patron's card reported lost
+ {LOST} Set if patron's card reported lost
{message} Message to this effect
{noissues} Set.
-{DBARRED} Set if patron is debarred
+ {DBARRED} Set if patron is debarred
{message} Message to this effect
{noissues} Set.
-{NOTES} Set if patron has notes
+ {NOTES} Set if patron has notes
{message} Notes about patron
-{ODUES} Set if patron has overdue books
+ {ODUES} Set if patron has overdue books
{message} "Yes"
{itemlist} ref-to-array: list of overdue books
{itemlisttext} Text list of overdue items
-{WAITING} Set if there are items available that the patron reserved
+ {WAITING} Set if there are items available that the patron reserved
{message} Message to this effect
{itemlist} ref-to-array: list of available items
diff --git a/C4/Search/PazPar2.pm b/C4/Search/PazPar2.pm
index 59f4103..3aceb95 100644
--- a/C4/Search/PazPar2.pm
+++ b/C4/Search/PazPar2.pm
@@ -34,6 +34,8 @@ C4::Search::PazPar2 - implement client for PazPar2
=head1 SYNOPSIS
+=cut
+
=head1 DESCRIPTION
=cut
diff --git a/C4/VirtualShelves/Page.pm b/C4/VirtualShelves/Page.pm
index 9d15847..e772db8 100644
--- a/C4/VirtualShelves/Page.pm
+++ b/C4/VirtualShelves/Page.pm
@@ -387,11 +387,11 @@ __END__
=head1 NAME
- VirtualShelves/Page.pm
+VirtualShelves/Page.pm
=head1 DESCRIPTION
- Module used for both OPAC and intranet pages.
+Module used for both OPAC and intranet pages.
=head1 CGI PARAMETERS
@@ -399,32 +399,32 @@ __END__
=item C<modifyshelfcontents>
- If this script has to modify the shelf content.
+If this script has to modify the shelf content.
=item C<shelfnumber>
- To know on which shelf to work.
+To know on which shelf to work.
=item C<addbarcode>
=item C<op>
- Op can be:
- * modif: show the template allowing modification of the shelves;
- * modifsave: save changes from modif mode.
+ Op can be:
+ * modif: show the template allowing modification of the shelves;
+ * modifsave: save changes from modif mode.
=item C<viewshelf>
- Load template with 'viewshelves param' displaying the shelf's information.
+Load template with 'viewshelves param' displaying the shelf's information.
=item C<shelves>
- If the param shelves == 1, then add or delete a shelf.
+If the param shelves == 1, then add or delete a shelf.
=item C<addshelf>
- If the param shelves == 1, then addshelf is the name of the shelf to add.
+If the param shelves == 1, then addshelf is the name of the shelf to add.
=back
-=cut
\ No newline at end of file
+=cut
diff --git a/Makefile.PL b/Makefile.PL
index 5021f6c..0f75325 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -1578,4 +1578,5 @@ MJ Ray mjr at phonecoop.coop
Galen Charlton galen.charlton at liblime.com
=cut
+
FIXME: deal with .htaccess
diff --git a/acqui/addorder.pl b/acqui/addorder.pl
index 94560c4..35d3507 100755
--- a/acqui/addorder.pl
+++ b/acqui/addorder.pl
@@ -30,17 +30,21 @@ addorder.pl
this script allows to add an order.
It is called by :
+=over
+
=item neworderbiblio.pl to add an order from nothing.
=item neworderempty.pl to add an order from an existing biblio.
=item newordersuggestion.pl to add an order from an existing suggestion.
+=back
+
=head1 CGI PARAMETERS
All of the cgi parameters below are related to the new order.
-=over 4
+=over
=item C<ordernumber>
the number of this new order.
diff --git a/acqui/check_budget_total.pl b/acqui/check_budget_total.pl
index 62e5453..6ee346c 100755
--- a/acqui/check_budget_total.pl
+++ b/acqui/check_budget_total.pl
@@ -25,7 +25,7 @@ use C4::Output;
use C4::Auth;
use C4::Budgets;
-=head1
+=head1 DESCRIPTION
fetches the budget amount fron the DB
diff --git a/acqui/fetch_sort_dropbox.pl b/acqui/fetch_sort_dropbox.pl
index 1bc9332..21d3c61 100755
--- a/acqui/fetch_sort_dropbox.pl
+++ b/acqui/fetch_sort_dropbox.pl
@@ -25,9 +25,9 @@ use C4::Output;
use C4::Auth;
use C4::Budgets;
-=head1
+=head1 NAME
-fetch_sort_dropbox :
+fetch_sort_dropbox
=cut
diff --git a/acqui/neworderempty.pl b/acqui/neworderempty.pl
index 6c10459..61f0962 100755
--- a/acqui/neworderempty.pl
+++ b/acqui/neworderempty.pl
@@ -26,6 +26,7 @@
neworderempty.pl
=head1 DESCRIPTION
+
this script allows to create a new record to order it. This record shouldn't exist
on database.
@@ -363,9 +364,9 @@ $template->param(
output_html_with_http_headers $input, $cookie, $template->output;
-=item MARCfindbreeding
+=head2 MARCfindbreeding
- $record = MARCfindbreeding($breedingid);
+ $record = MARCfindbreeding($breedingid);
Look up the import record repository for the record with
record with id $breedingid. If found, returns the decoded
diff --git a/acqui/orderreceive.pl b/acqui/orderreceive.pl
index a1e6fce..f084f8f 100755
--- a/acqui/orderreceive.pl
+++ b/acqui/orderreceive.pl
@@ -26,6 +26,7 @@
orderreceive.pl
=head1 DESCRIPTION
+
This script shows all order already receive and all pendings orders.
It permit to write a new order as 'received'.
@@ -34,16 +35,19 @@ It permit to write a new order as 'received'.
=over 4
=item supplierid
+
to know on what supplier this script has to display receive order.
=item receive
=item invoice
+
the number of this invoice.
=item freight
=item biblio
+
The biblionumber of this order.
=item datereceived
diff --git a/acqui/parcel.pl b/acqui/parcel.pl
index 675b07d..b1e11e7 100755
--- a/acqui/parcel.pl
+++ b/acqui/parcel.pl
@@ -26,6 +26,7 @@
parcel.pl
=head1 DESCRIPTION
+
This script shows all orders receipt or pending for a given supplier.
It allows to write an order as 'received' when he arrives.
@@ -34,9 +35,11 @@ It allows to write an order as 'received' when he arrives.
=over 4
=item supplierid
+
To know the supplier this script has to show orders.
=item code
+
is the bookseller invoice number.
=item freight
@@ -46,6 +49,7 @@ is the bookseller invoice number.
=item datereceived
+
To filter the results list on this given date.
=back
diff --git a/acqui/supplier.pl b/acqui/supplier.pl
index 6c49a90..a939ce1 100755
--- a/acqui/supplier.pl
+++ b/acqui/supplier.pl
@@ -24,6 +24,7 @@
supplier.pl
=head1 DESCRIPTION
+
this script shows the details for a bookseller given on input arg.
It allows to edit & save information about this bookseller.
@@ -32,6 +33,7 @@ It allows to edit & save information about this bookseller.
=over 4
=item supplierid
+
To know the bookseller this script has to display details.
=back
diff --git a/acqui/updatesupplier.pl b/acqui/updatesupplier.pl
index e324a29..05e8db2 100755
--- a/acqui/updatesupplier.pl
+++ b/acqui/updatesupplier.pl
@@ -23,27 +23,27 @@
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
=head1 NAME
+
updatesupplier.pl
=head1 DESCRIPTION
+
this script allow to update or create (if id == 0)
a supplier. This script is called from acqui/supplier.pl.
=head1 CGI PARAMETERS
-=over 4
-
All informations regarding this supplier are listed on input parameter.
Here is the list :
+
supplier, id, company, company_postal, physical, company_phone,
physical, company_phone, company_fax, website, company_contact_name,
company_contact_position, contact_phone, contact_phone_2, contact_fax,
company_email, contact_notes, notes, status, publishers_imprints,
list_currency, gst, list_gst, invoice_gst, discount, gstrate.
-=back
-
=cut
+
use strict;
#use warnings; FIXME - Bug 2505
use C4::Context;
diff --git a/admin/branches.pl b/admin/branches.pl
index 27d374e..758fa32 100755
--- a/admin/branches.pl
+++ b/admin/branches.pl
@@ -21,7 +21,7 @@
FIXME: individual fields in branch address need to be exported to templates,
in order to fix bug 180; need to notify translators
-FIXME: looped html (e.g., list of checkboxes) need to be properly
+ FIXME: looped html (e.g., list of checkboxes) need to be properly
TMPL_LOOP'ized; doing this properly will fix bug 130; need to
notify translators
FIXME: need to implement the branch categories stuff
@@ -34,7 +34,7 @@ FIXME: looped html (e.g., list of checkboxes) need to be properly
Finlay working on this file from 26-03-2002
Reorganising this branches admin page.....
-
+
=cut
use strict;
diff --git a/admin/check_budget_parent.pl b/admin/check_budget_parent.pl
index 810e117..8f56e2c 100755
--- a/admin/check_budget_parent.pl
+++ b/admin/check_budget_parent.pl
@@ -25,7 +25,7 @@ use C4::Output;
use C4::Auth;
use C4::Budgets;
-=head1
+=head1 DESCRIPTION
fetches the budget amount fron the DB,
called by aqbudgets.pl and neworderempty.pl
diff --git a/admin/check_parent_total.pl b/admin/check_parent_total.pl
index 76b3e9a..f5d5000 100755
--- a/admin/check_parent_total.pl
+++ b/admin/check_parent_total.pl
@@ -25,7 +25,7 @@ use C4::Output;
use C4::Auth;
use C4::Budgets;
-=head1
+=head1 DESCRIPTION
This script checks the amount unallocated from the new parent budget , or the period - if no parent_id is given
diff --git a/authorities/authorities.pl b/authorities/authorities.pl
index 468021c..491aed6 100755
--- a/authorities/authorities.pl
+++ b/authorities/authorities.pl
@@ -37,8 +37,14 @@ use vars qw( $is_a_modif );
my $itemtype; # created here because it can be used in build_authorized_values_list sub
our($authorised_values_sth,$is_a_modif,$usedTagsLib,$mandatory_z3950);
+=head1 FUNCTIONS
+
+=over
+
=item build_authorized_values_list
+builds list, depending on authorised value...
+
=cut
sub build_authorized_values_list ($$$$$$$) {
@@ -47,7 +53,6 @@ sub build_authorized_values_list ($$$$$$$) {
my @authorised_values;
my %authorised_lib;
- # builds list, depending on authorised value...
#---- branch
if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
@@ -111,7 +116,9 @@ sub build_authorized_values_list ($$$$$$$) {
=item create_input
+
builds the <input ...> entry for a subfield.
+
=cut
sub create_input {
@@ -310,7 +317,7 @@ sub format_indicator {
=item CreateKey
- Create a random value to set it into the input name
+Create a random value to set it into the input name
=cut
@@ -519,6 +526,11 @@ sub build_hidden_data () {
}
}
+=back
+
+=cut
+
+
# ========================
# MAIN
#=========================
diff --git a/cataloguing/value_builder/barcode.pl b/cataloguing/value_builder/barcode.pl
index e21105b..3c6ef74 100755
--- a/cataloguing/value_builder/barcode.pl
+++ b/cataloguing/value_builder/barcode.pl
@@ -30,6 +30,7 @@ my $DEBUG = 0;
plugin_parameters : other parameters added when the plugin is called by the dopop function
=cut
+
sub plugin_parameters {
# my ($dbh,$record,$tagslib,$i,$tabloop) = @_;
return "";
@@ -49,6 +50,7 @@ returns :
the 3 scripts are inserted after the <input> in the html code
=cut
+
sub plugin_javascript {
my ($dbh,$record,$tagslib,$field_number,$tabloop) = @_;
my $function_name= "barcode".(int(rand(100000))+1);
diff --git a/cataloguing/value_builder/dateaccessioned.pl b/cataloguing/value_builder/dateaccessioned.pl
index 3b8e8c0..3a9a3da 100755
--- a/cataloguing/value_builder/dateaccessioned.pl
+++ b/cataloguing/value_builder/dateaccessioned.pl
@@ -27,6 +27,7 @@
plugin_parameters : useless here
=cut
+
sub plugin_parameters {
# my ($dbh,$record,$tagslib,$i,$tabloop) = @_;
return "";
@@ -46,6 +47,7 @@ returns :
the 3 scripts are inserted after the <input> in the html code
=cut
+
sub plugin_javascript {
# my ($dbh,$record,$tagslib,$field_number,$tabloop) = @_;
my $function_name = "dateaccessioned".(int(rand(100000))+1);
diff --git a/cataloguing/value_builder/macles.pl b/cataloguing/value_builder/macles.pl
index 4b2a202..2d535c1 100755
--- a/cataloguing/value_builder/macles.pl
+++ b/cataloguing/value_builder/macles.pl
@@ -36,6 +36,7 @@ use utf8;
plugin_parameters : other parameters added when the plugin is called by the dopop function
=cut
+
sub plugin_parameters {
my ($dbh,$record,$tagslib,$i,$tabloop) = @_;
return "";
diff --git a/cataloguing/value_builder/marc21_field_003.pl b/cataloguing/value_builder/marc21_field_003.pl
index 531f586..e08ee6c 100755
--- a/cataloguing/value_builder/marc21_field_003.pl
+++ b/cataloguing/value_builder/marc21_field_003.pl
@@ -27,6 +27,7 @@ use C4::Context;
plugin_parameters : other parameters added when the plugin is called by the dopop function
=cut
+
sub plugin_parameters {
# my ($dbh,$record,$tagslib,$i,$tabloop) = @_;
return "";
@@ -46,6 +47,7 @@ returns :
the 3 scripts are inserted after the <input> in the html code
=cut
+
sub plugin_javascript {
my ($dbh,$record,$tagslib,$field_number,$tabloop) = @_;
my $function_name= $field_number;
diff --git a/cataloguing/value_builder/marc21_field_005.pl b/cataloguing/value_builder/marc21_field_005.pl
index 3c33145..7db29b7 100755
--- a/cataloguing/value_builder/marc21_field_005.pl
+++ b/cataloguing/value_builder/marc21_field_005.pl
@@ -46,6 +46,7 @@ returns :
the 3 scripts are inserted after the <input> in the html code
=cut
+
sub plugin_javascript {
my ($dbh,$record,$tagslib,$field_number,$tabloop) = @_;
my $function_name= $field_number;
diff --git a/cataloguing/value_builder/marc21_leader.pl b/cataloguing/value_builder/marc21_leader.pl
index b244f0b..69b79d0 100755
--- a/cataloguing/value_builder/marc21_leader.pl
+++ b/cataloguing/value_builder/marc21_leader.pl
@@ -32,6 +32,7 @@ use C4::Output;
plugin_parameters : other parameters added when the plugin is called by the dopop function
=cut
+
sub plugin_parameters {
my ($dbh,$record,$tagslib,$i,$tabloop) = @_;
return "";
diff --git a/cataloguing/value_builder/marc21_leader_authorities.pl b/cataloguing/value_builder/marc21_leader_authorities.pl
index bbbc85e..b9cbe8b 100755
--- a/cataloguing/value_builder/marc21_leader_authorities.pl
+++ b/cataloguing/value_builder/marc21_leader_authorities.pl
@@ -32,6 +32,7 @@ use C4::Output;
plugin_parameters : other parameters added when the plugin is called by the dopop function
=cut
+
sub plugin_parameters {
my ($dbh,$record,$tagslib,$i,$tabloop) = @_;
return "";
diff --git a/cataloguing/value_builder/marc21_leader_book.pl b/cataloguing/value_builder/marc21_leader_book.pl
index 6eb0f61..005ea97 100755
--- a/cataloguing/value_builder/marc21_leader_book.pl
+++ b/cataloguing/value_builder/marc21_leader_book.pl
@@ -32,6 +32,7 @@ use C4::Output;
plugin_parameters : other parameters added when the plugin is called by the dopop function
=cut
+
sub plugin_parameters {
my ($dbh,$record,$tagslib,$i,$tabloop) = @_;
return "";
diff --git a/cataloguing/value_builder/marc21_leader_computerfile.pl b/cataloguing/value_builder/marc21_leader_computerfile.pl
index 9ce7f91..800b445 100755
--- a/cataloguing/value_builder/marc21_leader_computerfile.pl
+++ b/cataloguing/value_builder/marc21_leader_computerfile.pl
@@ -32,6 +32,7 @@ use C4::Output;
plugin_parameters : other parameters added when the plugin is called by the dopop function
=cut
+
sub plugin_parameters {
my ($dbh,$record,$tagslib,$i,$tabloop) = @_;
return "";
diff --git a/cataloguing/value_builder/marc21_leader_video.pl b/cataloguing/value_builder/marc21_leader_video.pl
index 62e98da..3e72ad9 100755
--- a/cataloguing/value_builder/marc21_leader_video.pl
+++ b/cataloguing/value_builder/marc21_leader_video.pl
@@ -32,6 +32,7 @@ use C4::Output;
plugin_parameters : other parameters added when the plugin is called by the dopop function
=cut
+
sub plugin_parameters {
my ($dbh,$record,$tagslib,$i,$tabloop) = @_;
return "";
diff --git a/cataloguing/value_builder/stocknumber.pl b/cataloguing/value_builder/stocknumber.pl
index 88e726a..005f011 100755
--- a/cataloguing/value_builder/stocknumber.pl
+++ b/cataloguing/value_builder/stocknumber.pl
@@ -21,19 +21,20 @@
#use warnings; FIXME - Bug 2505
use C4::Context;
-=head1
+=head1 plugin_parameters
-plugin_parameters : other parameters added when the plugin is called by the dopop function
+other parameters added when the plugin is called by the dopop function
=cut
+
sub plugin_parameters {
# my ($dbh,$record,$tagslib,$i,$tabloop) = @_;
return "";
}
-=head1
+=head1 plugin_javascript
-plugin_javascript : the javascript function called when the user enters the subfield.
+The javascript function called when the user enters the subfield.
contain 3 javascript functions :
* one called when the field is entered (OnFocus). Named FocusXXX
* one called when the field is leaved (onBlur). Named BlurXXX
@@ -45,6 +46,7 @@ returns :
the 3 scripts are inserted after the <input> in the html code
=cut
+
sub plugin_javascript {
my ($dbh,$record,$tagslib,$field_number,$tabloop) = @_;
my $function_name= "inventory".(int(rand(100000))+1);
diff --git a/installer/data/mysql/update22to30.pl b/installer/data/mysql/update22to30.pl
index 6d5b1cc..76bb3c2 100755
--- a/installer/data/mysql/update22to30.pl
+++ b/installer/data/mysql/update22to30.pl
@@ -3538,12 +3538,12 @@ my $DBversion = "3.00.00.000";
print "upgrade to Koha 3.0 done\n";
SetVersion ($DBversion);
-
-=item GetDefaultClause
+=head1 GetDefaultClause
Generate a default clause (for an ALTER TABLE command)
=cut
+
sub GetDefaultClause {
my $default = shift;
@@ -3554,11 +3554,11 @@ sub GetDefaultClause {
return "default " . $dbh->quote($default);
}
-=item TransformToNum
+=head1 TransformToNum
+
+Transform the Koha version from a 4 parts string
+to a number, with just 1.
- Transform the Koha version from a 4 parts string
- to a number, with just 1 .
-
=cut
sub TransformToNum {
@@ -3568,8 +3568,10 @@ sub TransformToNum {
return $version;
}
-=item SetVersion
- set the DBversion in the systempreferences
+=head1 SetVersion
+
+set the DBversion in the systempreferences
+
=cut
sub SetVersion {
diff --git a/kohaversion.pl b/kohaversion.pl
index 0ddf98e..1c409f3 100644
--- a/kohaversion.pl
+++ b/kohaversion.pl
@@ -1,11 +1,17 @@
# the next koha public release version number;
-# the kohaversion is divided in 4 parts :
-# - #1 : the major number. 3 atm
-# - #2 : the functionnal release. 00 atm
-# - #3 : the subnumber, moves only on a public release
-# - #4 : the developer version. The 4th number is the database subversion.
-# used by developers when the database changes. updatedatabase take care of the changes itself
-# and is automatically called by Auth.pm when needed.
+
+=head1 FUNCTIONS
+
+=head2 kohaversion
+
+the kohaversion is divided in 4 parts :
+ - #1 : the major number. 3 atm
+ - #2 : the functionnal release. 00 atm
+ - #3 : the subnumber, moves only on a public release
+ - #4 : the developer version. The 4th number is the database subversion.
+ used by developers when the database changes. updatedatabase take care of the changes itself
+ and is automatically called by Auth.pm when needed.
+=cut
use strict;
diff --git a/labels/label-create-csv.pl b/labels/label-create-csv.pl
index c053842..50262df 100755
--- a/labels/label-create-csv.pl
+++ b/labels/label-create-csv.pl
@@ -11,10 +11,6 @@ use C4::Debug;
use C4::Creators 1.000000;
use C4::Labels 1.000000;
-=head
-
-=cut
-
my $cgi = new CGI;
my $batch_id = $cgi->param('batch_id') if $cgi->param('batch_id');
diff --git a/labels/label-create-xml.pl b/labels/label-create-xml.pl
index 85e4136..a6c5808 100755
--- a/labels/label-create-xml.pl
+++ b/labels/label-create-xml.pl
@@ -11,10 +11,6 @@ use C4::Debug;
use C4::Creators 1.000000;
use C4::Labels 1.000000;
-=head
-
-=cut
-
my $cgi = new CGI;
my $batch_id = $cgi->param('batch_id') if $cgi->param('batch_id');
diff --git a/members/patronimage.pl b/members/patronimage.pl
index c5e061a..e76d117 100755
--- a/members/patronimage.pl
+++ b/members/patronimage.pl
@@ -76,8 +76,6 @@ if ($imagedata) {
exit;
-=back
-
=head1 AUTHOR
Chris Nighswonger cnighswonger <at> foundations <dot> edu
diff --git a/misc/cronjobs/check-url.pl b/misc/cronjobs/check-url.pl
index 063eb7e..3936b49 100755
--- a/misc/cronjobs/check-url.pl
+++ b/misc/cronjobs/check-url.pl
@@ -38,7 +38,7 @@ C4::URL::Checker - base object for checking URL stored in Koha DB
"is_success: ", $url->{ is_success }, "\n",
"status: ", $url->{ status }, "\n";
}
-
+
=head1 FUNCTIONS
=head2 new
diff --git a/tools/letter.pl b/tools/letter.pl
index 0f5113d..4416c3f 100755
--- a/tools/letter.pl
+++ b/tools/letter.pl
@@ -36,6 +36,7 @@
- we delete the designated record
=cut
+
# TODO This script drives the CRUD operations on the letter table
# The DB interaction should be handled by calls to C4/Letters.pm
--
1.7.0
More information about the Koha-patches
mailing list