From 0294120b9daa2bc3191a1e44d01ef1e0bea8bac7 Mon Sep 17 00:00:00 2001 From: Nicole Date: Tue, 3 Mar 2015 02:01:56 -0800 Subject: [PATCH] Bug 13771: Add admin help files for 3.18 This patch adds a new help file for column settings and updates the files for budgets, funds, libraries, patron categories, and circ rules. To test: * Visit the above listed admin pages * Review help files Signed-off-by: Jesse Maseto Signed-off-by: Katrin Fischer Signed-off-by: Tomas Cohen Arazi (cherry picked from commit 15dd5e99432450597b3b29f975b1ad8c5c6ffdc1) Signed-off-by: Chris Cormack --- .../en/modules/help/admin/aqbudgetperiods.tt | 50 +++++++++++++++---- .../prog/en/modules/help/admin/aqbudgets.tt | 30 ++++++----- .../prog/en/modules/help/admin/branches.tt | 40 +++++++++++++-- .../prog/en/modules/help/admin/categorie.tt | 1 + .../en/modules/help/admin/columns_settings.tt | 17 +++++++ .../prog/en/modules/help/admin/smart-rules.tt | 15 +++++- 6 files changed, 125 insertions(+), 28 deletions(-) create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/columns_settings.tt diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgetperiods.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgetperiods.tt index d5a95291b7..2b84fbfbdc 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgetperiods.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgetperiods.tt @@ -2,21 +2,15 @@

Budgets

-

Budgets are used for tracking accounting values related to acquisitions. For example you could create a Budget for the current year (ex. 2012) and then break that into Funds for different areas of the library (ex. Books, Audio, etc).

+

Budgets are used for tracking accounting values related to acquisitions. For example you could create a Budget for the current year (ex. 2015) and then break that into Funds for different areas of the library (ex. Books, Audio, etc).

When visiting the main budget administration you will see two tabs, one for active and one for inactive budgets.

-

Add a budget

+

Adding a budget

-

Budgets can either be created from scratch or by duplicating the previous year's budget.

+

Budgets can either be created from scratch, by duplicating the previous year's budget or by closing a previous year's budget.

-

To duplicate a budget from a previous year, click on the link for the budget name from the list of budgets.

- -

On the screen listing the budget breakdown click the Edit button at the top and choose to Duplicate budget.

- -

You will be presented with a form where you simply need to enter the new start and end date and save the budget.

- -

This will not only duplicate your budget, but all of the funds associated with that budget so that you can reuse budgets and funds from year to year.

+

Adding a new budget

If you haven't used Koha before for acquisitions then you'll need to start fresh with a new budget. To add a new budget click the 'New Budget' button.

@@ -34,6 +28,42 @@

Once you have made your edits, click the 'Save Changes' button. You will be brought to a list of your existing budgets.

+

Duplicating a budget

+ +

To duplicate a budget from a previous year, click on the link for the budget name from the list of budgets

+ +

On the screen listing the budget breakdown click the Edit button at the top and choose to Duplicate budget

+ +

You can also click the 'Actions' button to the right of the budget and choose 'Duplicate'.

+ +

In both cases you will be presented with a form where you simply need to enter the new start and end date and save the budget.

+ +

Check the box for 'Mark the original budget as inactive' if the original budget should no longer be used.

+ +

Check the box for 'Set all funds to zero' if you wish the new budget to contain all the same fund structures as the previous budget but no allocations until you manually enter an amount in the fund.

+ +

This will not only duplicate your budget, but all of the funds associated with that budget so that you can reuse budgets and funds from year to year and so that you can move unreceived orders and if desired unspent funds from a previous budget to the new budget.

+ +

Close a budget

+ +

Close a budget to move or roll over unreceived orders and if desired unspent funds from a previous budget to a new budget. Before closing your budget you might want to duplicate the previous year's budget so that you have somewhere for the unreceived orders to roll to.

+ +

Find the previous budget with unreceived orders on the Active budgets or the Inactive budgets tab and select 'Close' under 'Actions'.

+ +

Tip: In order for the unreceived orders to be automatically moved to the new budget, the fund structures in the previous budget must exist in the new budget. Budgets without unreceived orders cannot be closed.

+ +

When you select 'Close' you will be presented with a form.

+ +

Use the 'Select a budget' drop down to choose the new budget for the unreceived orders.

+ +

Check the box for 'Move remaining unspent funds' to move the unspent amounts from the funds of the budget being closed to the selected budget.

+ +

Once you have made your choices, click the 'Move unreceived orders' button. You will be presented with a dialog box that says 'You have chosen to move all unreceived orders from 'Budget X' to 'Budget Y'. This action cannot be reversed. Do you wish to continue?' Budget X is the budget to be closed and Budget Y is the selected budget.

+ +

If everything seems correct click 'OK' and the unreceived orders and, if selected, unspent funds will be moved.

+ +

Wait until the 'Report after moving unreceived orders from budget X to Y' displays. This will list the order numbers which have been impacted (grouped by fund) and detail if the unreceived order was moved or if there was a problem. For example, if the new budget does not contain a fund with the same name as the previous budget, the order will not be moved.

+

See the full documentation for Budgets in the manual (online).

[% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgets.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgets.tt index d952f83827..2eed8d6d4e 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgets.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/aqbudgets.tt @@ -6,30 +6,36 @@

Add a Fund

-

Funds can be added to a budget.

+

A fund is added to a budget.

Important: A budget must be defined before a fund can be created.

-

To add a new fund, click the 'New' button and choose the budget to which you would like to add the fund.

+

To add a new fund click the New button and then choose which Budget you would like to add the fund to.

-

In the form that appears, enter the basics about your fund.

+

In the form that appears you wan to enter the basics about your fund.

-

The three first fields are required. The rest are optional.

+

The three first fields are required, the rest are optional

    -
  • 'Fund Code' is a unique identifier for your fund.
    • -
  • Use a fund name that clearly describes said fund.
    • -
  • The fund's amount should be should only include numerals and a decimal separator. No other characters should be entered.
    • -
  • You can assign a fund to a particular librarian. This option will restrict making changes to that fund to the assigned librarian.
    • -
  • Choose which library will use the fund
    • -
  • You can restrict who can order from a fund by selecting an owner or a library from the 'Restrict access to' menu.
    • -
  • The 'Notes' field is for descriptions to detail when librarians should use the fund.
    • +
  • Fund Code is a unique identifier for your fund
    • +
  • The Fund Name should be something that librarians will understand
    • +
  • Amount should be entered with only numbers and decimals, no other characters
    • +
  • Warning at (%) or Warning at (amount) can be filled in to make Koha warn you before you spend a certain percentage or amount of your budget. This will prevent you from overspending.
    • +
  • You can choose to assign this fund to a librarian. Doing so will make it so that only that librarian can make changes to the Fund
    • +
  • Choose which library will be using this fund
    • +
  • You can restrict who can order from this fund by choosing either the 'owner', 'owner and users' or 'owner, users and library' from the 'Restrict access to' menu
    • +
    • Important: Without an owner, the access restriction will be ignored, be sure to enter an owner as well as choose a restriction
    +
  • Notes are simply for any descriptive notes you might want to add so that librarians know when to use this fund
  • Planning categories are used for statistical purposes. To learn more about planning categories, check out the Planning Category FAQ.

When complete, click 'Submit' and you will be brought to a list of all of the funds for the budget.

-

To the right of each fund you will find the 'Edit,' 'Delete,' and 'Add Child Fund' options. A Child Fund a sub-fund of the parent fund. For example, one might have a parent fund for 'Fiction,' and Child Funds for 'New Releases' and 'Science Fiction.' It is an optional way to further organize your finances.

+

To the right of each fund you will find the 'Actions' button under which you will find the 'Edit,' 'Delete,' and 'Add Child Fund' options.

+ +

A child fund simply a sub-fund of the fund listed. An example would be to have a fund for 'Fiction' and under that have a fund for 'New Releases' and a fund for 'Science Fiction.' It is an optional way to further organize your finances.

+ +

Funds with children will show with a small arrow to the left. Clicking that will show you the children funds.

See the full documentation for Funds in the manual (online).

diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/branches.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/branches.tt index 97bf8d01eb..e696d79a92 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/branches.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/branches.tt @@ -11,15 +11,45 @@

To add a new library:

    -
  • Click 'New Library'
    • -
  • Fill in the data requested on the form that follows +
  • Click 'New Library'
    • +
  • The top of the form asks for some basics about the library
      -
    • Of the fields listed, only 'Library code' and 'Name' are required
      • -
    • Be sure to enter a library email address to make sure that notices are sent to and from the right address
      • -
    • An IP address is required if you have enabled AutoLocation
      • +
    • The library code should not contain any spaces and be 10 or fewer characters. This code will be used as a unique identifier in the database.
      • +
    • The name will be displayed on the OPAC wherever the library name displays to the public and should be a name that makes sense to your patrons.
      • +
    • If you have groups set up you can choose what group this library belongs to after entering in the code and name
    • +
  • Next you can enter basic contact info about the branch +
      +
    • The address and contact fields can be used to make notices custom for each library
      • +
    • The email address field is not required, but it should be filled for every library in your system +
        +
      • Important: Be sure to enter a library email address to make sure that notices are sent to and from the right address
        • +
      +
      • +
    • If you'd like you can enter a different 'Reply-To' email address. This is the email address that all replies will go to. +
        +
      • Tip: If you do not fill in this value Koha will use the address in the ReplytoDefault preference
        • +
      +
      • +
    • If you'd like you can also enter a different 'Return-Path' email address. This is the email address that all bounced messages will go to. +
        +
      • Tip: If you do not fill in this value Koha will use the address in the ReturnpathDefault preference
      +
      • +
    • If the URL field is populated then the library name will be linked in the holdings table on the OPAC
      • +
    • The OPAC Info box is for you to put information about the library that will appear in the OPAC when the branch name is moused over in the holdings table
      • +
    • IP Address does not have be filled in unless you plan on limiting access to your staff client to a specific IP Address +
        +
      • Important: An IP address is required if you have enabled AutoLocation
        • +
      +
      • +
    • Finally, if you have any notes you can put them here. These will not show in the OPAC
      • +
    +
    • +
+ +

Tip: Of the fields listed, only 'Library code' and 'Name' are required

Editing/Deleting a Library

diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/categorie.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/categorie.tt index 7516242f61..2cb29b0248 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/categorie.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/categorie.tt @@ -79,6 +79,7 @@
  • In the 'Category type' field choose one of the six main parent categories
  • The Branch Limitations let you limit this patron category to only some branches in your library system. Select 'All branches' if you would like any library to be able to use this category.
  • You can decide if this patron category is blocked from performing actions in the OPAC if their card is expired using the next option. By default it will follow the rule set in the BlockExpiredPatronOpacActions preference
    • +
  • Next you can choose the default privacy settings for this patron category. This setting can be edited by the patron via the OPAC if you allow it with the OPACPrivacy system preference.
  • Finally you can assign advanced messaging preferences by default to a patron category
    • Important: Requires that you have EnhancedMessagingPreferences enabled
      • diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/columns_settings.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/columns_settings.tt new file mode 100644 index 0000000000..8c33dca67d --- /dev/null +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/columns_settings.tt @@ -0,0 +1,17 @@ +[% INCLUDE 'help-top.inc' %] + +

      Column Settings

      + +

      This administration area will help you hide or display columns on fixed tables throughout the staff client. Right now there is only one table, the currencies table, you can control with this, but more will come.

      + +

      Clicking on the module you'd like to edit tables for will show you the options available to you. Right now only 'Administration' has any options.

      + +

      This area lets you control the columsn that show in the Currency admin area. If nothing is hidden you will see no check marks and will see all of the columns when viewing the table.

      + +

      If columns are hidden they will be checked off and hidden when you view the table.

      + +

      You can also toggle columns using the 'Show/Hide Columns button in the top right of the page.

      + +

      See the full documentation for Column Settings in the manual (online).

      + +[% INCLUDE 'help-bottom.inc' %] \ No newline at end of file diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/smart-rules.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/smart-rules.tt index 8efcdc66d0..7aa2743814 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/smart-rules.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/admin/smart-rules.tt @@ -17,7 +17,16 @@
    • all libraries, all patron types, all item types
    -

    Tip: If you are a single library system choose your library name before creating rules (sometimes having only rules for the 'all libraries' option can cause issues with holds)

    +

    The CircControl and HomeOrHoldingBranch also come in to play when figuring out which circulation rule to follow.

    + +
      +
    • If CircControl is set to "the library you are logged in at" circ rules will be selected based on the library you are logged in at
      • +
    • If CircControl is set to "the library the patron is from" circ rules will be selected based on the patron's library
      • +
    • If CircControl is set to "the library the item is from" circ rules will be selected based on the item's library where HomeOrHoldingBranch chooses if item's home library is used or holding library is used.
      • +
    • If IndependentBranches is set to 'Prevent' then the value of HomeOrHoldingBranch is used in figuring out if the item can be checked out. If the item's home library does not match the logged in library, the item cannot be checked out unless you are a superlibrarian.
      • +
    + +

    If you are a single library system choose your branch name before creating rules (sometimes having only rules for the 'all libraries' option can cause issues with holds)

    Important: At the very least you will need to set a default circulation rule. This rule should be set for all item types, all libraries and all patron categories. That will catch all instances that do not match a specific rule. When checking out if you do not have a rule for all libraries, all item types and all patron types then you may see patrons getting blocked from placing holds. You will also want a rule for your specific library set for all item types and all patron types to avoid this holds issue. Koha needs to know what rule to fall back on.

    @@ -55,10 +64,14 @@
  • Important: This can only be set for the Day unit, not in Hours
    • +
  • You can also define the maximum number of days a patron will be suspended in the 'Max suspension duration' setting
  • Next decide if the patron can renew this item type and if so, enter how many times they can renew it in the 'Renewals Allowed' box
  • If you're allowing renewals you can control how long the renewal loan period will be (in the units you have chosen) in the 'Renewal period' box
  • If you're allowing renewals you can control how soon before the due date patrons can renew their materials with the 'No renewals before' box.
    • Items can be renewed at any time if this value is left blank. Otherwise items can only be renewed if the item is before the number in units (days/hours) entered in this box.
    • +
  • You can enable automatic renewals for certain items/patrons if you'd like. This will renew automatically following your circulation rules unless there is a hold on the item +
    • Important: You will need to enable the automatic renewal cron job for this to work.
    +
  • If the patron can place holds on this item type, enter the total numbers of items (of this type) that can be put on hold in the 'Holds Allowed' field
  • Finally, if you charge a rental fee for the item type and want to give a specific patron type a discount on that fee, enter the percentage discount (without the % symbol) in the 'Rental Discount' field
    • -- 2.39.5