Labels in Koha

Labels in Koha

There are a number of options for creating labels in Koha.

Label Creator

Koha's label creator tool allows libraries to use layouts and templates in the creation of spine labels and barcodes for printing. A library can create customized label layouts, and custom label templates. A layout is paired with a template to print labels either singly or in batches. 

A step-by-step guide to both the creation of the template and layout can be found in the Koha Manual.

Templates

Templates apply the dimensions of the labels that will be printed. Most of the information used in templates comes from the label provider. ByWater Solutions' Koha partners will have a generic barcode label and one for spine labels built into their Koha system. If your library needs to add a new template to Koha, you will need to obtain the measurements for your label sheets. These are often provided in label packaging, or an internet search for the brand and associated number for your labels can usually identify the measurements. 


Label Layout

The layout determines the data printed on the label. There is no limit to the number of layouts (or templates) that a library can have in Koha.

Within the layout, a library can assign specific item fields and specific MARC fields that will be printed out on the label. Font, justification, and size will also be determined on the layout form.


Splitting Call Numbers

If you do not click the split call numbers check box in a layout, the call numbers will not split. The screenshot below compares one example where the checkbox is checked to split and the second which is not checked.


Label Maker Plugin

Kyle Hall, a Developers with ByWater Solutions, created a plugin to help solve some of the more complex label questions/situations that libraries may have such as specialized design customizations and multi-type label documents (sheets of labels that might include both a spine label and have another size for the barcode or faceplate for the book).

Since this is a plugin for Koha, libraries who need the plug must download it from the ByWater Github site and install it in Administration > Manage Plugins. If you are a ByWater partner and would like assistance downloading the plugin, please submit a ticket and we will be happy to help.

With the label plugin, libraries can: 
  1. Create multi-sized labels on an individual sheet
  2. Set flexible spacing within the label
  3. Have more flexibility in splitting call numbers
  4. Edit labels prior to printing
  5. Use additional fonts
  6. Use CSS for styling of the labels
By default, the label plugin has two types of labels that are commonly used outside of the label creator. The defaults will also allow users to easily modify specific areas given a type of template within the default.

Features of the Plugin

Once this plugin has been installed, any/all plugins installed on your Koha system will appear in the Administration module under plugins.

Click the Action button to run the plugin.

The plugin has three tabs: Templates, Layouts and Printer Profiles. In addition, libraries can create new templates, new layouts, new printer profiles, and new label batches. A Label Wizard is also available to help libraries create a new layout or template.

The template will determine what will be printed on the label, and the layout will be the size and dimensions of the sheet and specific label(s).

Both templates and layouts have two types of labels already set up with this plugin.
The layouts that are included are:
  1. Avery label sheet 5630
  2. Basix 55-459-007
The Avery label is a basic size barcode label and the Basix is the multi-size label sheet as described above.

These templates are included:
  1. Avery Standard has the title, barcode, and item number
  2. Basix has the title on one small label, and the title, and barcode on other two labels.
Below are the images of how the pre-defined labels will print. The Red, Green and Blue label picture is using the Basix template and layout. The other image is using the Avery Label and template.



Label Batches

Batches in the label maker plugin come from the batches that have been created in the built-in label creator in Tools. Any batch that has been created in Tools > Label creator can be used in the label maker plugin. Each batch is given a number by Koha. The number found in parenthesis is the number of items in the batch. To print your labels, you will use choose the "Print Batch" option.

Working with Layouts

The layout sets up the size of the label and label sheet as well as the type of font and color. The Basix layout that comes with the plugin includes background color for each set of labels to make it easier to determine which to edit. However, when you are ready to print your labels, you probably won't want them in color! To remove the background color, remove the line:

background-color: [color name here];


We always recommend making a copy of the default layout before making any changes! For convenience, there is a 'Copy' option under the Actions button. Remember to give your copy a new name to distinguish it from the original.


If there is no font listed on the layout, labels will print in Times New Roman. However, a font can be easily added or changed in the layout. This example adds the Verdana font:


Below are images of both the Avery and Basix layouts. More layouts are listed on the Basix because it has the dimensions for three labels. Here are details about the structure of the layouts:
  1. This is the size of the paper.
  2. This is the padding around the paper before the label begins (the measurements of the top and left hand side of paper).
  3. The size of the labels themselves - width, height, and margins.
  4. How to display the text - in this example, it is centered.
The line formatted /* like this */ is a comment field. The comment notes that it includes a dotted line to display the label edges when viewed prior to printing.


In the Basix layout displayed below, there is a little bit of code at the top and the bottom that this image does not display due to the size of the screenshot. Both 1 & 2 are the construction of the sheet itself. This is the page and padding of their physical sheet of labels. Number 3 is the dimensions of the left side label, including formatting of text and the color of the label (which can be removed. Number 4 is the dimensions of the center label, including the formatting of the text and the color of the label, and number 5 is the right side label.

Working with Templates

To update what information will print on a label, edit the label template. As with editing layouts, we recommend creating a copy using the 'Copy' option under Actions and then editing the copy, rather than editing the existing template directly. 

Using the Avery template as an example, we can see that the title, barcode, and itemnumber are included on labels. 

The multi-size label sheet follows the same principles as above, but with sections for each label (left-label, center-label, and right-label):


Splitting Call Numbers

Jessie asked a great question about call number splitting! Thank goodness we had an expert web designer on the video with us! Lucas does have a way to split the call number a space or a period. However, if you are a partner of Bywater Solutions and need assistance with this, please submit a ticket! Lucas is happy to help. Here is the code that he added to the template that needed the call number split:

$(document).ready(function () {
$('.label').each(function() {
let theText = $(this).text();
let theNewText = theText.trim().replace(/\s+/g, '
').replace('.' , '
.');
$(this).html(theNewText);
})
});

This code was added into the template- here is a look at the entire code of the template to get a better understanding of where it goes:

[% FOREACH item IN items %]
[% IF loop.index % 1 == 0 %]
[% SET label_index = 1 %]
[% UNLESS loop.first %]

[% END %]

[% END %]

[% item.marc.subfield('949','a') %]

[% IF loop.last %][% END %]
[% SET label_index = label_index + 1 %]
[% END %]


$(document).ready(function () {
$('.label').each(function() {
let theText = $(this).text();
let theNewText = theText.trim().replace(/\s+/g, '
').replace('.' , '
.');
$(this).html(theNewText);
})
});

Tutorial



Troubleshooting call number splitting for labels

LCC call number splitting

Libraries love to personalize their LCC call numbers. Sometimes they add "Ref" or something to the start of the number. Sometimes they don't put a space between the first block of letters and the first block of numbers. So they may have a call number like:

REF PN6728.B36 M55 1989

Which makes total sense, but confuses Koha's LCC splitting routine.

Go to Admin > Classification Sources and create a new splitting rule. Tell your new rule you want to define splitting behavior via regex. This regex will leave the legacy call numbers as-is in the database but transform it a bit when putting it on a label. For the example above, we need to do three things:

  • Put in a space in between "PN" and "6728"
  • Put a space before the . in ".B36"
  • Replace all spaces with line breaks

    • That's going to mean three bits of regex:
    1. s/([a-zA-Z]+)(\d+)/\1 \2/  -- Finds the first spot in the call number where a letter abuts a number and puts a space between them
    2. s/([a-zA-Z\d])\./\1 ./ -- Finds the first spot in the call number where a letter or number abuts a . and puts a space between them
    3. s/\s/\n/g -- Replaces all spaces with line breaks
    So the example call number becomes:

    REF
    PN
    6728
    .B36
    M55
    1989

    These will surely need some tweaking library-to-library to accommodate each partner's variations, but that's the general idea.

    Dewey call number splitting

    It is important to note that "/" will be removed from the call number if using the Dewey splitting rule. If you want to include the "/" you will need to switch to a Regex splitting rule. 
    Some examples of RegEx splitting routines:
    1. s/\s/\n/g     --- Split on spaces
    2. s/(\s?=)/\n=/g     --- Split on equal signs (=):
    3. s/(\s?\/)/\n/g     --- Split on forward slashes (/):
    4. s/^(J|K)\n/$1 /     --- Remove first split if call number starts with J or K:
    5. s/(^.{9})/$1\n/     --- Cut after 9 characters:
    It is possible to mix and match RegEx splitting routines by clicking the ‘New’ link just under the RegEx input box.

    These examples, as well as explanations of the other splitting rules, can be found in the community Koha Manual: Link to the manual 🔗

    Other Considerations

    If you are looking to have your barcodes wrap text to the next line, you will need to use the Label Maker Plugin and schedule a time to configure your labels with one of developers.

    Print a Range of Barcode Labels

    Libraries can print a range of barcodes from the Label Creator in Koha.

    Printing a Range of Barcodes

    In the label creator (under Cataloging), there is an option under the dropdown menu that will allow libraries to print a range of barcodes. Koha will then prompt for a beginning barcode number and an end barcode number to print.

    Next choose the layout and template for the barcode and the label number to start printing on the page. For example, if there were already printed labels used off of the label sheet, Koha does give you an option to start printing in another position than that of the 1st label in the sheet.



    Then the label sheet can be downloaded as a PDF and printed by the library.




      • Related Articles

      • Paypal Plugin for Koha

        PayPal Setup The steps below will walk you through setting up the PayPal business account. PayPal Business Account Set-Up: Log into your PayPal business account. Go to the Tools dropdown menu and select 'All Tools'. Choose Integrate API on the left ...

      • Batch Search Plugin for Koha

        The Batch Search plugin can perform a batch ISBN search in Koha. Batch Search Plugin The first step is to install the Batch Search plugin. Then, in Administration > Manage plugins, you will click the Actions button for this plugin and select "Run the ...

      • Scanned Barcode Prefixer Plugin for Koha

        The Scanned Barcode Prefixer plugin allows libraries to automatically create and read prefixed barcodes - both for patron and item barcodes. For patron or item creation, the plugin automatically adds digits to the beginning of the card number or ...

      • eCommerce in Koha

        Koha supports eCommerce through third-party payment integration and plugins to allow patrons to pay fines, fees, and make donations directly through the (OPAC) or Aspen Discovery. PayPal One of the most widely known online payment services, PayPal is ...

      • Patron Passport Plugin for Koha

        This plugin is available on the ByWater Solutions GitHub site, and currently needs to be configured by a ByWater team member. The plugin configuration does not live in the staff interface, but on the backend where it is not accessible to partners. ...