From 8e0fa49184eb5f1e5d1354e5b856419e90ddb91e Mon Sep 17 00:00:00 2001 From: "Nicole C. Engard" Date: Tue, 10 Apr 2012 12:00:12 -0400 Subject: [PATCH] Bug 7936: Tools Help for 3.8 This updates the tools help files and adds a new help file for the new upload cover images tool. Signed-off-by: Chris Cormack --- .../prog/en/modules/help/tools/batchMod.tt | 5 +- .../en/modules/help/tools/cleanborrowers.tt | 2 +- .../en/modules/help/tools/csv-profiles.tt | 2 +- .../prog/en/modules/help/tools/export.tt | 2 +- .../prog/en/modules/help/tools/holidays.tt | 32 +++-- .../en/modules/help/tools/import_borrowers.tt | 2 +- .../prog/en/modules/help/tools/inventory.tt | 2 +- .../prog/en/modules/help/tools/koha-news.tt | 2 +- .../prog/en/modules/help/tools/letter.tt | 110 ++++++++++++------ .../modules/help/tools/manage-marc-import.tt | 2 +- .../en/modules/help/tools/overduerules.tt | 2 +- .../en/modules/help/tools/picture-upload.tt | 2 +- .../prog/en/modules/help/tools/scheduler.tt | 2 +- .../modules/help/tools/stage-marc-import.tt | 8 +- .../prog/en/modules/help/tools/tools-home.tt | 2 +- .../modules/help/tools/upload-cover-image.tt | 45 +++++++ .../prog/en/modules/help/tools/viewlog.tt | 2 +- 17 files changed, 159 insertions(+), 65 deletions(-) create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/upload-cover-image.tt diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchMod.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchMod.tt index 09563fec80..acec1db626 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchMod.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchMod.tt @@ -1,5 +1,4 @@ [% INCLUDE 'help-top.inc' %] -

Batch Modify Items

@@ -19,10 +18,10 @@

From the tool you can choose to upload a file of barcodes or item ids, or you can scan items one by one into the box below the upload tool. Once you have your file uploaded or the barcodes listed you can click 'Continue.'

-

You will be presented with a confirmation screen. From here you can uncheck the items you don't want to delete before clicking 'Go.' If the items are checked out you will be presented with an error after clicking 'Go' and the items will not be deleted.

+

You will be presented with a confirmation screen. From here you can uncheck the items you don't want to delete and decide if Koha should delete the bib record if the last item is being deleted before clicking 'Delete selected items.' If the items are checked out you will be presented with an error after clicking 'Delete selected items' and the items will not be deleted.

If the items can be deleted they will be and you will be presented with a confirmation of your deletion.

-

See the full documentation for Batch Item Modifications and Batch Item Deletions in the manual (online).

+

See the full documentation for Batch Item Modifications and Batch Item Deletions 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/tools/cleanborrowers.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/cleanborrowers.tt index df1a6c7098..236e89efda 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/cleanborrowers.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/cleanborrowers.tt @@ -16,6 +16,6 @@
  • Clicking 'Finish' will delete or anonymize your data
    • -

    See the full documentation for Anonymizing Patrons in the manual (online).

    +

    See the full documentation for Anonymizing Patrons 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/tools/csv-profiles.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/csv-profiles.tt index 86cb3912aa..8f960eaf1f 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/csv-profiles.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/csv-profiles.tt @@ -48,6 +48,6 @@

    Your CSV Profiles will appear on the export list or cart menu under the 'Download' button

    -

    See the full documentation for CSV Profiles in the manual (online).

    +

    See the full documentation for CSV Profiles 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/tools/export.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/export.tt index df3425af24..5188b9d22b 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/export.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/export.tt @@ -30,6 +30,6 @@ -

    See the full documentation for Exporting MARC Records in the manual (online).

    +

    See the full documentation for Exporting MARC Records 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/tools/holidays.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tt index b34e684917..9d335a9832 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tt @@ -5,37 +5,49 @@

    Libraries can define library closings and holidays to be used when calculating due dates. You can make use of the Calendar by turning on the proper system preferences:

    -

    Adding Events

    +

    Adding Events

    -

    Before adding events, choose the library you would like to apply the closings to. When adding events you will be asked if you would like to apply the event to one library or all libraries. To add events, simply

    +

    Before adding events, choose the library you would like to apply the closings to. When adding events you will be asked if you would like to apply the event to one branch or all branches. To add events, simply

    -

    Editing Events

    +

    Editing Events

    To edit events

    @@ -49,11 +61,11 @@ -

    Additional Help

    +

    Additional Help

    When adding or editing events you can get additional help by clicking on the question mark next to various different options on the form

    -

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

    +

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

    [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/import_borrowers.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/import_borrowers.tt index 65cd1dbe66..f65ff9c37e 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/import_borrowers.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/import_borrowers.tt @@ -55,6 +55,6 @@ -

    See the full documentation for Patron Import in the manual (online).

    +

    See the full documentation for Patron Import in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/inventory.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/inventory.tt index 070de90f76..4eba7295f7 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/inventory.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/inventory.tt @@ -16,6 +16,6 @@

    Choose the text file and the date you want to mark all times as seen and click 'Submit.'

    -

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

    +

    See the full documentation for Inventory 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/tools/koha-news.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/koha-news.tt index 95916f3739..9eb742d4bb 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/koha-news.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/koha-news.tt @@ -22,6 +22,6 @@
  • News on the circulation receipts will appear below the items that are checked out
    • -

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

    +

    See the full documentation for News 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/tools/letter.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt index b44cdbd1fc..ae9cbaa3fb 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/letter.tt @@ -1,62 +1,68 @@ [% INCLUDE 'help-top.inc' %] -

    Notices

    +

    Notices & Slips

    -

    All notices sent by Koha can be customized using the Notices Tool. The system comes with several predefined templates that will appear when you first visit the Notices Tool

    +

    All notices and circulation receipts (or slips) generated by Koha can be customized using the Notices & Slips Tool. The system comes with several predefined templates that will appear when you first visit this tool.

    -

    Each notice can be edited, but only a few can be deleted, this is to prevent system errors should a message try to send without a template.

    +

    Each notice can be edited, but only a few can be deleted, this is to prevent system errors should a message try to send without a template. Each notice and slip can be edited on a per library basis, by default you will see the notices for all libraries.

    -

    Adding Notices

    +

    If you have a style you'd like applied to all slips you can point the SlipCSS preference to a stylesheet. The same is true for notices, using the NoticeCSS preference to define a stylesheet.

    -

    To add a new notice

    +

    Adding Notices & Slips

    + +

    To add a new notice or slip

    -

    Notice Markup

    +

    Overdue Notice Markup

    When creating your overdue notices there are two tags in addition to the various database fields that you can use in your notices.

    -

    Important: These new tags only work on the overdue notices, not other circulation related notices at this time.

    +

    Important These new tags only work on the overdue notices, not other circulation related notices at this time.

    -

    An example of using these two tags in a notice template might be like: +

    An example of using these two tags in a notice template might be like:

    -
    -
    The following item(s) is/are currently overdue:
-   <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <fine>GBP</fine></item>
    -
    +
       The following item(s) is/are currently overdue:
 
-
    Which, assuming two items were overdue, would result in a notice like:
    
+   <item>"<<biblio.title>>" by <<biblio.author>>, <<items.itemcallnumber>>, Barcode: <<items.barcode>> Fine: <fine>GBP</fine></item>
    +Which, assuming two items were overdue, would result in a notice like: +
       The following item(s) is/are currently overdue:
 
-
    
-
    The following item(s) is/are currently overdue:
-"A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50 
-"History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50
    
-
    
+   "A Short History of Western Civilization" by Harrison, John B, 909.09821 H2451, Barcode: 08030003 Fine: £3.50
+   "History of Western Civilization" by Hayes, Carlton Joseph Huntley, 909.09821 H3261 v.1, Barcode: 08030004 Fine: £3.50
    -

    Existing Notices

    +

    Existing Notices & Slips

    -

    Among the default notices are notices for several common actions within Koha, here are some of what those notices do

    +

    Among the default notices are notices for several common actions within Koha. All of these notices can be customized by altering their text via the Notices & Slips tool and their style using the NoticeCSS preference to define a stylesheet. Here are some of what those notices do

    + +

    There are also a set of predefined slips (or receipts) listed on this page. All of these slips can be customized by altering their text via the Notices & Slips tool and their style using the SlipCSS preference to define a stylesheet.

    + +

    Here is what those slips are used for:

    + + -

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

    +

    See the full documentation for Notices 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/tools/manage-marc-import.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/manage-marc-import.tt index c31d1d6f4a..a911863fb5 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/manage-marc-import.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/manage-marc-import.tt @@ -40,7 +40,7 @@ -

    See the full documentation for the Managing Staged MARC Records in the manual (online).

    +

    See the full documentation for the Managing Staged MARC Records in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt index a1cb85bcb4..06839ceaf8 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tt @@ -41,7 +41,7 @@

    Sincerely, Library Staff

    -

    See the full documentation for the Overdue Notice/Status Triggers in the manual (online).

    +

    See the full documentation for the Overdue Notice/Status Triggers in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/picture-upload.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/picture-upload.tt index e81d72d85a..1feb07f39b 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/picture-upload.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/picture-upload.tt @@ -20,6 +20,6 @@

    Important: There is a limit of 520K on the size of the picture uploaded and it is recommended that the image be 200x300 pixels, but smaller images will work as well.

    -

    See the full documentation for the Patron Image Uploader in the manual (online).

    +

    See the full documentation for the Patron Image Uploader in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tt index 4626c213bf..d864149b32 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tt @@ -23,6 +23,6 @@

    Task scheduler will not work if the user the web server runs as doesn't have the permission to use it. To find out if the right user has the permissions necessary, check /etc/at.allow to see what users are in it. If you don't have that file, check etc/at.deny. If at.deny exists but is blank, then every user can use it. Talk to your system admin about adding the user to the right place to make the task scheduler work.

    -

    See the full documentation for the Task Scheduler in the manual (online).

    +

    See the full documentation for the Task Scheduler in the manual (online).

    [% INCLUDE 'help-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/stage-marc-import.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/stage-marc-import.tt index fbee311f43..014d4cbea9 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/stage-marc-import.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/stage-marc-import.tt @@ -9,11 +9,7 @@
  • Next you will be presented with options for record matching and item imports
    • Enter 'Comments about this file' to identify your upload when going to the 'Manage Staged MARC Records' tool
      • -
    • Choose the character encoding -
        -
      • If you leave this set to Default Koha will try to guess the encoding, but it should be noted that this is almost always wrong for non-UTF8 records with non-ASCII characters. Specifying a character set is much more reliable if you're not using UTF-8.
        • -
      -
      • +
    • Choose the character encoding
    • Choose whether or not you want to look for matching records
      • You can set up record matching rules through the administration area
        • @@ -29,6 +25,6 @@
      • To complete the process continue to the Managed Staged MARC Records Tool
      -

      See the full documentation for the MARC Import in the manual (online).

      +

      See the full documentation for the MARC Import 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/tools/tools-home.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/tools-home.tt index 6823273b4f..40697de1d4 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/tools-home.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/tools-home.tt @@ -4,6 +4,6 @@

      Tools in Koha all perform some sort of action. Often many of the items listed under Tools in Koha are referred to as 'Reports' in other library management systems.

      -

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

      +

      See the full documentation for Tools 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/tools/upload-cover-image.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/upload-cover-image.tt new file mode 100644 index 0000000000..b28fa1872d --- /dev/null +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/upload-cover-image.tt @@ -0,0 +1,45 @@ +[% INCLUDE 'help-top.inc' %] + +

      Upload Cover Images

      + +

      This tool will allow you to upload cover images for the materials in your catalog. To access this tool, staff will need the upload_local_cover_images permission. In order for images to show in the staff client and/or OPAC you will need to set your LocalCoverImages and/or OPACLocalCoverImages preferences to 'Display.' Images can be uploaded in batches or one by one.

      + +

      If uploading a single image:

      + +
        +
      • Visit the tool and click the 'Browse' button to browse to the image on your local machine.
        • +
      • Click 'Upload file'
        • +
      • Choose 'Image file' under the 'File type' section
        • +
      • Enter the biblionumber for the record you're attaching this image to. This is not the same as the barcode, this is the system generated number assigned by Koha.
        • +
          +
        • Find the biblionumber by looking at the end of the URL in the address bar when on the detail page or by clicking on the MARC tab on the detail page in the staff client
          • +
        +
      • If you would like to replace any other cover images you may have uploaded in the past, check the 'Replace existing covers' box under the 'Options' section
        • +
      • Click 'Process images'
        • +
      • You will be presented with a summary of the upload and a link to the record you have just added the image to
        • +
      + +

      If uploading a batch of images at once you will need to prepare a ZIP file first.

      + +
        +
      • Enter in to the ZIP file all the images you are uploading
        • +
      • Also include a text file (*.TXT) named either datalink.txt or idlink.txt listing the biblionumber followed by the image name for each image one per line +
          +
        • ex. 4091,image4091.jpg
          • +
        +
        • +
      • Browse your local computer to the ZIP file
        • +
      • Click 'Upload file'
        • +
      • Choose 'Zip file' under the 'File type' section
        • +
      • If you would like to replace any other cover images you may have uploaded in the past, check the 'Replace existing covers' box under the 'Options' section
        • +
      • Click 'Process images'
        • +
      • You will be presented with a summary of the upload
        • +
      + +

      You will be able to see your cover images in the staff client on the detail page under the 'Image' tab in the holdings table at the bottom

      + +

      In the OPAC the cover images will also appear in the images tab, as well as next to the title and on the search results.

      + +

      See the full documentation for Uploading Cover Images 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/tools/viewlog.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/viewlog.tt index 6bf9cb1fe2..8783a90c7f 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/viewlog.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/viewlog.tt @@ -8,6 +8,6 @@

      You will note that real names do not appear on the log, only identifying numbers. You need to use the identifying numbers when searching the logs as well.

      -

      See the full documentation for the Log Viewer in the manual (online).

      +

      See the full documentation for the Log Viewer in the manual (online).

      [% INCLUDE 'help-bottom.inc' %] \ No newline at end of file -- 2.39.5