Bug 16791 - [DOCS] Explanation of callnumber.pl plugin
Summary: [DOCS] Explanation of callnumber.pl plugin
Status: Needs documenting
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement (vote)
Assignee: David Nind
QA Contact: Testopia
URL:
Keywords: Manual
Depends on:
Blocks:
 
Reported: 2016-06-21 16:59 UTC by Elaine Bradtke
Modified: 2023-07-19 15:51 UTC (History)
4 users (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact: David Nind
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Elaine Bradtke 2016-06-21 16:59:53 UTC
Perhaps a brief explanation of what callnumber.pl is meant to do would be a useful addition to the manual.  I am not certain what its function is, though I discovered that it doesn’t do what I was hoping it would.  See bug 13615 for a long winded query.
Comment 1 Katrin Fischer 2017-09-12 13:20:52 UTC
Still valid. I could also not find references to value builders or plugins in the context of catalouging - there might be a whole lot to document there!
Comment 2 David Nind 2023-02-07 18:56:07 UTC
There is now a cataloguing (value builder) section in the manual (https://koha-community.org/manual/23.05/en/html/valuebuilder.html).

My plan is to add a table/list of the plugins with a short description, then to add the details for each one.

I'll start with this one, and go from there.

Some already have a good description in the actual script, and many of the UNIMARC ones are helpers used to populate the fields with the required values.
Comment 3 Anke Bruns 2023-07-19 15:50:46 UTC
Explanation could be added to https://koha-community.org/manual//latest/de/html/valuebuilder.html

In the script callnumber.pl there is a fairly good explanation that might be used as a template for the manual text:

=head1 DESCRIPTION

Is used for callnumber computation.

If the user send an empty string, we return a simple incremented callnumber.
If a prefix is submited, we look for the highest callnumber with this prefix, and return it incremented.
In this case, a callnumber has this form : "PREFIX 0009678570".
 - PREFIX is an upercase word
 - a space separator
 - 10 digits, with leading 0s if needed

=cut
Comment 4 Anke Bruns 2023-07-19 15:51:53 UTC
(In reply to Anke Bruns from comment #3)
> Explanation could be added to
> https://koha-community.org/manual//latest/de/html/valuebuilder.html
> 
> In the script callnumber.pl there is a fairly good explanation that might be
> used as a template for the manual text:
> 
> =head1 DESCRIPTION
> 
> Is used for callnumber computation.
> 
> If the user send an empty string, we return a simple incremented callnumber.
> If a prefix is submited, we look for the highest callnumber with this
> prefix, and return it incremented.
> In this case, a callnumber has this form : "PREFIX 0009678570".
>  - PREFIX is an upercase word
>  - a space separator
>  - 10 digits, with leading 0s if needed
> 
> =cut

(and I overlooked that David already pointed out the manual page, sorry!)