[Koha-patches] [PATCH] Bug 5940: Catalog and Cataloging Help Files for 3.4

Ian Walls ian.walls at bywatersolutions.com
Sat Mar 26 01:10:08 CET 2011


From: Nicole C. Engard <nengard at bywatersolutions.com>

Signed-off-by: Nicole C. Engard <nengard at bywatersolutions.com>
Signed-off-by: Ian Walls <ian.walls at bywatersolutions.com>
---
 .../en/modules/help/catalogue/issuehistory.tmpl    |    4 +-
 .../prog/en/modules/help/catalogue/search.tmpl     |   10 +-
 .../en/modules/help/cataloguing/addbiblio.tmpl     |  284 +++++---------------
 .../prog/en/modules/help/cataloguing/additem.tmpl  |   57 ++++-
 4 files changed, 129 insertions(+), 226 deletions(-)

diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/issuehistory.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/issuehistory.tmpl
index 8e6a013..945308c 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/issuehistory.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/issuehistory.tmpl
@@ -2,6 +2,8 @@
 
 <h1>Checkout History</h1>
 
-<p>This tab will provide you with information on the circulation history for this item.  Including the due date or return date and the patron information (if you are keeping track of this data).</p>
+<p>Each bibliographic record keeps a circulation history (with or without the patron information depending on your settings), but each item also has its own circulation history page. To see this, click on the 'Items' tab to the left of the record you are viewing.</p>
+
+<p>Below the 'History' heading is a link to 'View item's checkout history,' clicking that will open up the item's history which will look slightly different from the bibliographic record's history page.</p>
 
 <!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/search.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/search.tmpl
index 8c334fb..0bdf36e 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/search.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/catalogue/search.tmpl
@@ -2,13 +2,13 @@
 
 <h1>Searching</h1>
 
-<p>To see more search options click [More Options] at the bottom of the page.&nbsp; This will allow for more advanced boolean searching.</p>
+<p>To see more search options click [More Options] at the bottom of the page. This will allow for more advanced boolean searching.</p>
 
 <h2>Searching Subtypes on the Staff Client</h2>
 
 <p>Below is a summary of  the various pieces of the advanced search limit: </p>
 
-<h3>AUDIENCE</h3>
+<h3>Audience</h3>
 
 <p>The index name is 'aud' and it's derived from 008/22</p>
 
@@ -17,7 +17,7 @@
 <li>aud:d Young adult</li>
 <li>aud:e Adult</li></ul>
 
-<h3>CONTENT</h3>
+<h3>Content</h3>
 
 <p>There are three indexes that comprise Content: 'fic' is derived from 003/33; 'bio' is derived from the 008/34 and 'mus' is derived from LEADER/06. Common values for each of these are:</p>
 
@@ -27,7 +27,7 @@
 <li>mus:j Musical recording</li>
 <li>mus:i Non-musical recording</li></ul>
 
-<h3>FORMAT</h3>
+<h3>Format</h3>
 
 <p>The index name is 'l-format' and it's an index of positions 007/01 and 007/02. Common values are:</p>
 
@@ -41,7 +41,7 @@
 <li>l-format:co CD Software</li>
 <li>l-format:cr Website</li></ul>
 
-<h3>ADDITIONAL CONTENT TYPES</h3>
+<h3>Additional Content Types</h3>
 
 <p>The index name is 'ctype' is taken from the 008 and it's where we get the 'additional content types'. It's position 008/24-28 field. Common values are: </p>
 
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/addbiblio.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/addbiblio.tmpl
index 0ef48bc..4f4ac9e 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/addbiblio.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/addbiblio.tmpl
@@ -1,241 +1,91 @@
 <!-- TMPL_INCLUDE NAME="help-top.inc" -->
 
 <h1>Cataloging</h1>
-<p>
-Cataloging in Koha can be done one of two
-ways.&nbsp; This manual will explain how to use the labeled MARC view for
-cataloging.&nbsp; The other way to catalog is to use the &Dagger;bilbios cataloging
-plugin.&nbsp; 
-</p>
-<h2>Adding a Bib Record<br />
-</h2>
-<p>
-To
-catalog a new record, you need to be in Koha's 'Cataloguing' module.
-You can find this module in your global nav at the top of the screen,
-under the 'More' dropdown list.
-</p>
+
+<p>Before you start cataloging in Koha you're going to want to do some basic setup. Refer to the Implementation Checklist for a full list of these things. Most importantly you're going to want to make sure that your Frameworks are all defined the way you want. Once in the cataloging module you will not be able to add or remove fields and subfields so your frameworks must be ready before you start cataloging.</p>
+
+<h2>Adding Records</h2>
+
+<p>Records can be added to Koha via original or copy cataloging. If you would like to catalog a record using a blank template</p>
+
 <ul>
-	<li>
-	Start by searching the catalog to see if your item is already in the system</li>
-	<li>
-	If 'no results found', click on 'New Record' and choose a 'framework' from the dropdown box. </li>
-	<li style="background-color: #ffe599">TIP: Choose 'default' if you have not yet created a new framework
-	<ul>
-		<li>To create a framework you must go into the administration section
-		<ul>
-			<li><em>Get there: </em>More &gt; Administration &gt; MARC Bibliographic Framework
-			</li>
-		</ul>
-		</li>
-	</ul>
-	</li>
-</ul>
+	<li>Click 'New Record'
 <ul>
-	<li style="background-color: #ffe599">TIP: To quick start copy cataloging, instead of clicking the 'New Record' button, click the 'Z30.50 Search' button to search for a record from another target.</li>
-	<li>From the 'Add MARC Record' page, you have two options for cataloging new records</li>
+	<li>Choose the framework you would like to base your record off of</li>
 </ul>
-<ul>
-	<li>
-	<ul>
-		<li>Original cataloging OR
-		</li>
-	</ul>
-	<ul>
-		<li>Copy cataloging using the Koha's Z39.50 search
-		<ul>
-			<li style="color: #990000">IMPORTANT: You must first set up Z39.50 Search Targets
-			<ul>
-				<li><em>Get there: </em>More &gt; Administration &gt; Additional parameters &gt; Z39.50 Client Targets</li>
-			</ul>
-			</li>
-		</ul>
-		</li>
-	</ul>
-	</li>
+</li>
 </ul>
-<h2>
-Original Cataloging</h2>
+
+<p>If you want to catalog a record based on an existing record at another library</p>
+
+<ul>
+	<li>Click 'z39.50 Search'</li>
+	<li>Search for the item you would like to catalog
 <ul>
-	<li>
-	Use the numerical tabbed interface to go through your MARC record
-	<ul>
-		<li>TIP: 1xx fields will be found under tab 1, 2xx fields will be found under tab 2, etc</li>
-	</ul>
-	</li>
-	<li>To help with your original cataloging, Koha has some built in plugins denoted by an ellipsis (...) at the end of the field. <br />
-	<ul>
-		<li>Some of these will automatically enter the data just by clicking in the text field, others require that you click on the '...'
-		</li>
-	</ul>
-	</li>
+	<li>If no results are found, try searching for fewer fields, not all Z39.50 targets can search all of the fields above.</li>
 </ul>
-<h3>Leader Plugin</h3>
-<strong>
-</strong>
+</li>
+	<li>Search targets can be altered by using the Z39.50 Admin area.</li>
+	<li>From the results you can view the MARC or Card view for the records or choose to Import them into Koha
 <ul>
-	<li>The Leader is a fixed field at the beginning of each MARC
-	record that contains coded information for the processing of the
-	record.
-	</li>
-	<li>Koha has no need for Leader information and does not use
-	it. However, Koha can store Leader data, and can help you build your
-	own Leader data.</li>
-	<li>
-	When you create (or edit) bibliographic records, clicking on the '...'
-	to the right of the Leader field will open a pop-up window to guide you
-	through the creation of your MARC Leader.</li>
-	<li>Make the appropriate choices from the pull-down menus, and Koha will
-	create the encoded Leader data and insert it into your 000@ subfield. </li>
-	<li>You now have Leader data stored with your records, should you ever need
-	it for some other application.</li>
+	<li>In addition to the Import link to the right of each title, you can click on the title you're interested in and a menu will pop up with links to preview the record and import it</li>
 </ul>
-<h3>Adding Additional Fields</h3>
+</li>
+</ul>
+
+<p>Once you've opened a blank framework or imported a record via Z39.50 you will be presented with the form to continue cataloging</p>
+
+<ul>
+	<li>To expand a collapsed tag click on the tag number</li>
+	<li>To get help from the Library of Congress on a MARC tag click the question mark (?) to the right of each field number
 <ul>
-	<li>When editing MARC fields you can duplicate fields (that are repeatable) by clicking the plus (+) next to the field or subfield<br />
-	<ul>
-		<li>When clicking plus (+) it will automatically duplicate the data in the field into a new field</li>
-		<li>When
-		clicking minus (-) it will delete the field or subfield if there is
-		another of the same field or subfield.&nbsp; If you click minus (-) when
-		there are no other repeats of the field or subfield it will delete the
-		field contents.</li>
-	</ul>
-	</li>
-	<li>By default subfields will appear
-	in alphabetical order. You can move these fields to the right order by
-	clicking the ^ to the left of the subfield&nbsp;
-	</li>
+	<li style="background-color: #ffe599">If you think this is an unwanted feature, you could add the following JavaScript to your intranetuserjs system preference:
+$(document).ready(function(){<br>
+$(".tagnum a").hide();<br>
+});</li>
 </ul>
-<h3><strong>Authority Plugin</strong></h3>
+</li>
+	<li>Sometimes fields may not be editable due to the value in your BiblioAddsAuthorities system preference. If you have this preference set to not allow catalogers to type in fields controlled by authorities you may see a lock symbol to the left of the field.
 <ul>
-	<li>Some fields (such as the 100) offer Authority Plugins</li>
-	<li>Click the '...' to the left of the field</li>
-	<li>
-	Search for the authority
-	</li>
-	<li>
-	Click 'choose' next to the matching record and it will auto fill the fields in your MARC record<br />
-	</li>
+	<li>If this icon appears you must click the ellipse to the right of the field to search for an existing authority.</li>
+	<li>From the results list click 'Choose authority' to bring that into your catalog record</li>
 </ul>
-<h2>
-<strong> Using Z39.50 for Copy Cataloging</strong></h2>
-<p>
-To perform a Z39.50 search
-</p>
+</li>
+	<li>To duplicate a field click on the + (plus sign) to the right of the tag
 <ul>
-	<li>Enter data into at least one of the following MARC fields
-	<ul>
-		<li>Title - 245</li>
-		<li>ISBN - 020</li>
-		<li>ISSN - 022</li>
-		<li>Author - 100</li>
-	</ul>
-	</li>
-	<li>
-	Click 'Z39.50 Search'</li>
-	<li>
-	Alter your search and choose Z39.50 targets from the pop-up window
-	</li>
-	<li>
-	TIP: First make sure you have set up your Z39.50 search targets
-
-	<ul>
-		<li>
-		<em>Get there: </em>More &gt; Administration &gt; Additional Parameters &gt; Z39.50 Client Targets
-
-		</li>
-	</ul>
-	</li>
+	<li>To move subfields in to the right order, click the up arrow to the left of the field</li>
+	<li>To duplicate a subfield click on the clone icon (to remove a copied field, click the delete clone icon) to the right of the field</li>
+	<li>To remove a subfield (if there is more than one of the same type), click the - (minus sign) to the right of the field</li>
 </ul>
+</li>
+	<li>To use a plugin click on the ... (ellipse) to the right of the filed
 <ul>
-	<li>Click on 'import' to import the record of your choice.</li>
-	<li>
-	Koha
-	will auto-fill the fields in your new MARC record with the values
-	supplied by the record you've just imported from the Z39.50 search.
-	
-	</li>
-	<li>
-	You can now add/edit fields to the record.
-	
-	</li>
-	<li>
-	Click 'Save' when you are done.
-	
-	</li>
+	<li>Some fixed fields have editors that will change based on the material type you're cataloging (for example the 006 and the 008 fields)</li>
 </ul>
-<h2>Editing a record</h2>
-<p>
-Editing a record is mostly the same as adding
-a record except that you will find that your fields will only display
-the subfields that you entered data in.&nbsp; When adding a new record you
-will see this for a 650 field.
-</p>
-<p>
-When editing you will only see
-</p>
-<p>
-To show all possible subfields in the framework, click on the text of the MARC field
-</p>
-<h2>Deleting Records</h2>
+</li>
+	<li>Once you've finished, click the 'Save' button at the top and choose whether you want to save and view the bib record you have created or continue on to add/edit items attached to the record
 <ul>
-	<li style="background-color: #ffe599">TIP: To delete a BIB Record, first delete all holdings
-	(items) attached to the bib. </li>
-	<li>Select Delete from the Edit dropdown
-	menu in the normal view of the record. <br />
-	<ul>
-		<li>Note: the delete option on the
-		Edit dropdown menu will be grayed out when holdings exist. It will only
-		allow you to delete the bib record after all the holdings (items) have
-		been deleted.</li>
-	</ul>
-	</li>
+	<li>If you are about to add a duplicate record to the system you will be warned before saving</li>
 </ul>
+</li>
+</ul>


 
-<h2>Questions<br />
-</h2>
-
-<h3>&quot;I searched on the MARC record I just added, and no results were found&quot;</h3>
-<p>
-If your catalog changes aren't visible in search results, it is because
-of the indexing process. Indexing can take anywhere from 1 minute to 4
-hours, depending on the load. If you do not see the new records by the
-following day, (24hrs) contact your system administrator. <br />
-</p>
-<h3>How to reorder my subject heading subfields so they appear in the proper order?</h3>
-<p>
-By default Koha alphabetizes your 6xx subfields, but you can easily
-move them around by clicking on the arrow on the left hand side of the
-subfield. This will allow you to put the headings in the order that
-best suits your item.
-</p>
-<h3>Can I duplicate a record in my system to do some copy cataloging?<br />
-</h3>
+<h2>Editing Records</h2>
 
-<ul>
-	<li>Search for the record you'd like to copy</li>
-	<li>Choose the record by clicking on the title</li>
-	<li>Click on 'Edit'</li>
-	<li>Choose to 'Edit as New (Duplicate)'</li>
-	<li>After editing your record, click 'Save'</li>
-	<li>You will be warned that this record was a duplicate</li>
-	<li>Choose 'No' to save this as a new record</li>
-</ul>
+<p>To edit a record you can click 'Edit Biblio' from the search results on the cataloging page or by clicking the Edit button on the Bibliographic Record.</p>
+
+<p>The record will open in the MARC editor</p>
+
+<p>Once you have made your edits you can click 'Save' at the top of the editor.</p>
+
+<h2>Duplicating Records</h2>
+
+<p>Sometimes a copy of the record you need to catalog can't be found via Z39.50. In these cases you can create a duplicate of similar record and edit the necessary pieces to create a new record. To duplicate an existing record click 'Edit as New (Duplicate)' from the Edit menu on the Bibliographic Record</p>
+
+<p>This will open a new MARC record with the fields filled in with the values from the original Bibliographic Record.</p>
+
+<h2>Merging Records</h2>
+
+<p>If you would like to merge together multiple records you can do that via the Lists tool.</p>
 
-<h3>How do I overlay a full
-bib record over the brief one that was added at acquisitions?</h3>
-<p>
-The librarian added orders using the form in Koha, then
-'received' them on that brief record.&nbsp; Is there a way to download the full record right in acquisitions so
-that the item gets attached to that full record? Or if not that, a way
-to replace the brief record with a complete one?</p>
-<p>Search for the partial record in your catalog and then go to Edit &gt;
-Edit Record and from there you can do a Z39.50 search to pull in a more
-full record or you can do your full cataloging there.
-</p>
-<p>
-&nbsp;
-</p>
-
-<!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
+<!-- TMPL_INCLUDE name="help-bottom.inc" -->
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/additem.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/additem.tmpl
index ccaf1bf..c987eff 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/additem.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/cataloguing/additem.tmpl
@@ -1,9 +1,60 @@
 <!-- TMPL_INCLUDE NAME="help-top.inc" -->
 
-<h1>Adding item details</h1>
+<h2>Adding Items</h2>
 
-<p>After saving a MARC record, you are presented with a screen to add item details (or, local holdings). This is where you define the location of the item (home branch), the cost of the item, the barcode, etc. </p>
+<p>After saving a new bibliographic record, you will be redirected to a blank item record so that you can attach an item to the bibliographic record. You can also click 'Add Holdings' from the cataloging search results or you can add new item at any time by clicking 'New' on the bibliographic record and choosing 'New Item'</p>
 
-<ul><li>Click 'Add Item' after entering the data for your item</li><li>A confirmation will appear with the item information</li><li>From here you can edit the item or add another item</li></ul>
+<p>The item edit form will appear:</p>
+
+<p>At the very least, the following fields should be entered for new items:</p>
+
+<ul>
+	<li>8 - Collection code</li>
+	<li>a - Permanent location</li>
+	<li>b - Shelving location</li>
+	<li>o - Full call number</li>
+	<li>p - Barcode</li>
+	<li>v - Cost, replacement price
+<ul>
+	<li>This value will be charged to patrons when you mark and item they have checked out as 'Lost'</li>
+</ul>
+</li>
+	<li>y - Koha item type</li>
+</ul>
+
+<p>Below the add form there are 3 buttons for adding the item</p>
+
+<ul>
+	<li>Add Item will add just the one item</li>
+	<li>Add &amp; Duplicate will add the item and fill in a new form with the same values for your to alter</li>
+	<li>Add Multiple Copies will ask how many copies and will then add that number of copies adding +1 to the barcode so each barcode is unique</li>
+</ul>
+
+<p>Your added items will appear above the add form once submitted</p>
+
+<p>Your items will also appear below the bibliographic details on the bib record display.</p>
+
+<p>If you have SpineLabelShowPrintOnBibDetails set to 'Display' then there will also be a link to print a quick spine label next to each item.</p>
+
+<h2>Editing Items</h2>
+
+<p>Items can be edited in several ways.</p>
+
+<ul>
+	<li>Clicking 'Edit' and 'Edit Items' from the bibliographic record</li>
+	<li>Clicking 'Edit Items' beside the item on the 'Items' tab</li>
+</ul>
+
+<p>The edit menu is also where items can be deleted from</p>
+
+<h2>Moving Items</h2>
+
+<p>Items can be moved from one bibliographic record to another using the Attach Item option</p>
+
+<p>Visit the bibliographic record you want to attach the item to and choose 'Attach Item' from the 'Edit' menu.</p>
+
+<p>Simply enter the barcode for the item you want to move and click 'Select'</p>
+
+<p>If you want to move all items to a new record creating only one bibliographic record you can use the Merge Records tool instead.</p>
 
 <!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
-- 
1.5.6.5



More information about the Koha-patches mailing list