[Koha-patches] [PATCH] updated Tools help files
Nicole Engard
nengard at gmail.com
Tue Jan 5 15:41:15 CET 2010
---
.../prog/en/modules/help/tags/review.tmpl | 45 ++-------
.../prog/en/modules/help/tools/export.tmpl | 37 ++++----
.../prog/en/modules/help/tools/koha-news.tmpl | 27 +++---
.../en/modules/help/tools/manage-marc-import.tmpl | 35 ++++---
.../prog/en/modules/help/tools/overduerules.tmpl | 97 ++++++++------------
.../en/modules/help/tools/stage-marc-import.tmpl | 33 +++----
.../intranet-tmpl/prog/en/modules/tags/review.tmpl | 4 +-
7 files changed, 115 insertions(+), 163 deletions(-)
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tags/review.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tags/review.tmpl
index cf52a96..ce63f2c 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tags/review.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tags/review.tmpl
@@ -2,41 +2,18 @@
<h1>Tags</h1>
-<p>This tool gives librarians the option to moderate patron added tags. This moderation page will show up regardless of the system preference settings related to tagging.</p>
+<p>Depending on your tagging system preferences, librarians may need to approve tags before they are published on the OPAC. This is done via the Tag Moderation Tool.</p>
-<p style="background-color: #ffe599">IMPORTANT: This feature is still experimental</p>
+<p>When first visiting the tool, you will be presented with a list of tags that are pending approval or rejection by a librarian</p>
-<p style="background-color: #ffe599">IMPORTANT: Tagging will make use of AJAX capability in JavaScript-enabled browsers</p>
- <ul>
- <li>Go to the 'Tools' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Tags'</li>
- <li>From this menu you can approve or reject tags
- <ul>
- <li>
- <span style="background-color: #ffe599">
-TIP: Note that you are approving the terms used, but not the title the terms are applied to, moderation is for checking that terms are approriate for your library</span></li>
- </ul></li>
- <li>The 'Weight' refers to the number of times the tag has been used within the system</li>
- <li>To approve a tag, click 'approve' in that line or check the box and click 'approve' at the top
- <ul>
- <li>Approving a tag adds it to your whitelist</li>
- </ul></li>
- <li>To reject a tag, click 'reject' in that line or check the box and click 'reject' at the top
- <ul>
- <li>Rejecting a tag adds it to your blacklist</li>
- </ul></li>
- <li>The terms summary in the top left will allow you to filter your results by tag status</li>
- <li>The status of tags can always be edited by clicking on one of these filters and changing the status</li>
- <li>You can test terms against you whitelist or blacklist by using the test tool</li>
- <li>If a term has been rejected the test will tell you that that term is prohibited. If it has been approved it will show that that word is allowed.
- <ul>
- <li>
- <span style="background-color: #ffe599">
-TIP: The blacklist is already populated with some key terms depending on the dictionary you're using</span></li>
- </ul></li>
- <li>When a patron adds a tag to an item that a librarian has already rejected, it will automatically be rejected.</li>
- </ul>
- <h3>Will I be notified when new tags are added?</h3>
- <p>This feature is yet to be developed, but is in the works.</p>
+<ul><li>To approve a tag, you can either click the 'Approve' button inline with the term, or check all terms you want to approve and click 'Approve' below the table.</li>
+<li>To reject a tag, you can either click the 'Reject' button inline with the term, or check all terms you want to approve and click 'Reject' below the table.</li>
+</ul>
+
+<p>Once a tag has been approved or rejected it will be moved to the appropriate list of tags. A summary of all tags will appear on the right of the screen.</p>
+
+<p>Even though a tag is approved or rejected, it can still be moved to another list. When viewing approved tags each tag has the option to reject.</p>
+
+<p>To check terms against the approved and rejected lists (and possibly against the dictionary you have assigned for tag moderation) simply enter the term into the search box on the bottom right of the screen to see the status of the term</p>
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/export.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/export.tmpl
index bfa7b6a..cf64bfa 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/export.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/export.tmpl
@@ -1,22 +1,23 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
- <h1>MARC Export</h1>
- <p>This tool allows librarians to export both bibliographic records and holdings in either MARC format or MARCXML.</p>
-
- <p>
- <span style="background-color: #ffe599">
-TIP: The only fields above that are required are the two under 'Output format'.</span></p>
- <ul>
- <li>If you'd like a limited number of records, enter in a filter for biblio numbers or item call numbers.</li>
- <li>If you'd like to only import items of one type or from one library, you can choose those from the pull downs</li>
- <li>By default all items are exported unless the 'Don't export items' box is checked.</li>
- <li>You can also choose to not export specific MARC fields
- <ul>
- <li>
- <span style="background-color: #ffe599">
-TIP: Separate these fields by a space.</span></li>
- </ul></li>
- <li>Click 'Export' and follow your browser's instructions for saving the file</li>
- </ul>
+<h1>MARC Export</h1>
+
+<p>Koha comes with a tool that will allow you to export your bibliographic and/or holdings data in bulk. This can be used to send your records to fellow libraries, organizations or services; or simply for backup purposes.</p>
+
+<ul><li>Fill in the form in order to limit your export to a specific range (all fields are optional)</li>
+<ul><li>Choose to limit your export by any one or more of the following options</li>
+<ul><li>Limit to a bib number range</li>
+<li>Limit to a specific item type</li>
+<li>Limit to a specific library</li>
+<li>Limit to a call number range</li>
+<li>Limit to an acquisition date range</li></ul>
+<li>Next choose what to skip when exporting</li>
+<ul><li>By default items will be exported, if you would like to only export bibliographic data, check the 'Don't export items' box</li>
+<li>To limit your export only to items from the library you're logged in as (if you leave the 'Library' field set to 'All') or to the library you selected above check the 'Remove non-local items' box</li>
+<li>You can also choose what fields you don't want to export. This can be handy if you're sharing your data, you can remove all local fields before sending your data to another library</li></ul>
+<li>Finally choose the file type and file name</li>
+<ul><li>Choose to export your data in marc or marcxml format</li>
+<li>Choose the name you want your file to save as</li></ul>
+<li>Click 'Export'</li></ul></ul>
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/koha-news.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/koha-news.tmpl
index 30f50a7..cd1ddb3 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/koha-news.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/koha-news.tmpl
@@ -1,19 +1,16 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<h1>News Help</h1>
+<h1>News</h1>
-<h2>What is News?</h2>
+<p>Koha's news module allows librarians to post news to the OPAC and the staff interface.
-<p>News items are short, blog or news item type posts that can be displayed on both the OPAC and Staff Client main pages. News posts can be formatted using simple HTML code.</p>
-
-<h2>How to post a News Item?</h2>
-<p>To add a new news item the following fields need to be completed:</p>
-
-<h3>Display Location</h3>
-<p>For single language setups, there will be 2 options here. One for the 'opac (language code)' and the 'Librarian interface'. For multilingual setups, multiple languages for the OPAC will show.</p>
-<p>News Items must be entered in all languages to show up for each language in multi lingual setups.</p><h3>Title </h3>
-<p>The title of the news post. Try to keep this short and pithy. Avoid long sentances.</p><h3>Expiration Date</h3>
-<p>This is the date the item should be removed from the news item listings. Note that the posting or publishing date of an item will default to today's date (where today is the date of entry). </p>
-<p>To have a news item remain on the page, do not enter an expiration date.</p><h3>Appear in Position</h3>
-<p>An integer value (e.g 1,2,3). Items at position 1 appear at the top of the listings. If two items have the same position value then the order defaults to publication date, where the oldest item displays at the top posistion, and newer items are displayed under this.</p><h3>News</h3>
-<p>This is the content of the news item. Note that all news appears in line in the same page. Try to keep news items to no more than a couple of short paragraphs. If you wish to add images and embed them into your posts, then these will need to be uploaded to a web server somewhere and linked to using standard HTML image tags.</p><!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+<p>To add news to either the OPAC or the Staff Client:</li>
+<ul><li>Click 'New Entry'</li>
+<ul><li>Under 'Display Location' choose whether to put the news on the OPAC or the Librarian (Staff) Interface.</li>
+<li>Choose a title for your entry</li>
+<li>Using the publication and expiration date fields you can control how long your item appears</li>
+<li>'Appear in position' lets you decide what order your news items appear in</li>
+<li>The 'News' box allows for the use of HTML for formatting of your news item</li></ul>
+<i>After filling in all of the fields, click 'Submit'</li>
+<li>News in the OPAC will appear above the OpacMainUserBlock</li>
+<li>News in the Staff Client will appear on the far left of the screen</li></ul>
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/manage-marc-import.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/manage-marc-import.tmpl
index 36965ca..e7d4c46 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/manage-marc-import.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/manage-marc-import.tmpl
@@ -2,22 +2,25 @@
<h1>Manage Staged MARC Records</h1>
-<p>After records have been imported, you can review the records before finalizing the import.</p>
- <ul>
- <li>By default the records are matched using the field you specified when importing the data
- <ul>
- <li>You can change this before completing the import by choosing a new option from the pull down.</li>
- </ul></li>
- <li>After reviewing the records, click 'Complete import'</li>
- <li>After your import is complete, you will be given a summary of the import and the ability to undo your actions</li>
- </ul>
-
- <h2>Cleaning Staged Records</h2>
-<ul>
- <li>Next to each entry on the list of imported files to import is a clean button. </li>
- <li>Clicking 'clean' will clear those records from the database</li>
- <li style="color: #ff0000">IMPORTANT: This cannot be undone.</li>
-</ul>
+<p>Once you have staged your records for import you can complete the import using this tool.</p>
+
+<ul><li>From the list of staged records, click on the file name that you want to finish importing</li>
+<ul><li>You will note that records that have already been imported will say so under 'Status'</li></ul>
+<li>A summary of your import will appear along with the option to change your matching rules</li>
+<li>Below the summary there will be a list of the records that will be imported</li>
+<ul><li>Review your summary before completing your import to make sure that your matching rule worked and that the records appear as you expect them to</li></ul>
+<li>Click 'Import into catalog' to complete the import</li>
+<li>Once your import is complete a link to the new bib records will appear to the right of each title that was imported</li>
+<li>You can also undo your import by clicking the 'Undo import into catalog' button</li>
+<li>Records imported using this tool remain in the 'reservior' until they are cleaned. These items will appear when searching the catalog from the Cataloging tool.</li></ul>
+
+<p>To clean items out of the 'reservoir':</p>
+
+<ul><li>Visit the main screen of the Manage Staged MARC Records tool</li>
+<li>To clean a batch, click the 'Clean' button to the right</li>
+<li>You will be presented with a confirmation message</li>
+<ul><li>Accept the deletion and the records will be removed from the reservoir and the status will be changed to 'cleaned'</li></ul>
+<li>This action cannot be undone, so make sure you confirm that you are cleaning the correct import</li></ul>
<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tmpl
index be874be..d115968 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/overduerules.tmpl
@@ -2,62 +2,41 @@
<h1>Overdue 'Notice/Status Triggers'</h1>
-<p>This tool lets you define triggers for overdue notices. You can send a borrower up to three notices and also tell Koha how many days should pass between the day a book was due and the sending of each of these notices. Koha lets you define a different notice schedule for each branch, and different schedules for each patron type you've defined within those branches. Finally you can set a notice to trigger a 'debar' on the borrower's account during any of the three triggers.</p>
-
- <ul>
- <li>Go to the 'Tools' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Overdue notice/status triggers'</li>
- <li>'Select a library' to define an overdue schedule for</li>
- <li>
- <span style="background-color: #ffe599">
-TIP: If you would like to define one overdue schedule for ALL libraries at once, select 'Default'. This will apply the schedule you define to all the libraries in your system</span></li>
- </ul>
- <ul>
- <li>For each patron type (left most column), enter a number under the columns labeled 'Delay'. The number you enter represents DAYS.<br/>
- <ul>
- <li>Each number you enter indicates the days after an issue is due before an action is triggered.</li>
- </ul></li>
- <li>For each 'Delay' you choose a notice type (or 'letter') that will go to the borrower.<br/>
- <ul>
- <li>
- <span style="background-color: #ffe599">
-TIP: You will need to set up your library's notices to populate this pull down</span><br/>
- <ul>
- <li><em>Get there:</em> More > Tools > Notices</li>
- </ul></li>
- </ul></li>
- </ul>
- <ul>
- <li>When you are finished, click 'Save changes'</li>
- </ul>
- <h3>Help! I've gotten an error message!</h3>
-
- <p>If the numbers you've entered in a give row beneath the 'delay' columns are logically inconsistent, Koha will give you an alert, and explain the inconsistency.</p>
-<h3>What happens if I leave the row for an patron type blank? (ie, no 'delays' have been defined)</h3>
-
-<p>If you want Koha to trigger an action (send a letter or debar member), a delay value is required. No delays means no actions will be performed.</p>
-<h3>Where do I define overdue schedules? (ie, how many days pass before an item becomes 'overdue')</h3>
-
-<p>When an item becomes overdue (ie, duration of checkout) is defined in Koha's 'Administration' module:</p>
- <ul>
- <li><em>Get there:</em> More > Administration > Circulation Rules (under 'Patrons and Circulation')</li>
- </ul>
-<h3>Where do I define fines?</h3>
- <ul>
- <li><em>Get there:</em> More > Administration > Fines Rules (under 'Patrons and Circulation')</li>
- </ul>
-<h3>What type of notice gets sent when a 'trigger' occurs in the 'Notice/Status Triggers' module? Email? Printed Notice?</h3>
-<p>Koha handles overdue notices in one of two automated ways: by email or by printed labels.
-If a borrower has an email defined in their patron account, overdue notices automatically get sent to the patron's email account according to the schedule defined in the 'Notice/Status Triggers' Tool.</p>
-
- <p style="background-color: #ffe599">
-TIP: Patrons can alter their notification setting using the Messaging tool on their account.</p>
-<p>Borrowers that have no email defined will have their notices sent via email to the library for printing. The email is sent to the branch admin email, or failing that to the address set in the system preference as the 'KohaAdminEmailAddress'. This email is generated by the misc/cronjobs/overdue_notices.pl cron job. Contact your system administrator for help with this setting.</p>
-
- <p><strong>IMPORTANT:</strong> The email notice report that is compiled and sent to the admin (for borrowers with no email in Koha) rely on the 'delays' to determine when/how often that email gets sent as well.</p>
-
-<h3>Where are notices defined? (ie, what information will appear in the notice)</h3>
- <ul>
- <li><em>Get there: </em>More > Tools > Notices</li>
- </ul>
- </div> <!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
+<p>This tool lets you define triggers for overdue notices. You can send a borrower up to three reminder emails (depending on your library workflow)</p>
+
+<p>In order to send the overdue notices that you defined using the Notices tool, you need to first set the triggers to have these messages.</p>
+
+<p>In order to have overdue notices sent to your patrons, you need to set that patron category to require overdue notices.</p>
+
+<p>The Overdue Notice/Status Triggers tool gives the librarian the power to send up to three notices to each patron type notifiying them of overdue items</p>
+
+<ul><li>Delay is the number of days after an issue is due before an action is triggered.</li>
+<ul><li style="color:#990000;"><strong>Important: If you want Koha to trigger an action (send a letter or debar member), a delay value is required.</strong></li></ul>
+<li>To send additional notices, click on the tabs for 'Second' and 'Third' notice</li>
+<li>If you would like to prevent a patron from checking items out because of their overdue items, check the 'Debar' box, this will put a notice on the patron's record at checkout informing the librarian that the patron cannot check out due to overdue items.</li></ul>
+
+<p>If the numbers you've entered in a give row beneath the 'delay' columns are logically inconsistent, Koha will give you an alert, and explain the inconsistency.</p>
+
+<h3>Sample Overdue Notice</h3>
+
+<p>Nicole Engard
+<br>410 Library Rd.
+<br>Philadelphia, PA 19107</p>
+
+<p>Dear Nicole Engard (23529000035726),</p>
+
+<p>According to our records, at the time of this notice, you have items that are overdue. Please return or renew them as soon as possible to avoid increasing late fines.</p>
+
+<p>If you have registered a password with the library, you may use it with your library card number to renew online.</p>
+
+<p>If you believe you have returned the items below please call at and library staff will be happy to help resolve the issue.</p>
+
+<p>The following item(s) are currently overdue:</p>
+
+<p>07/08/2008 Creating drug-free schools and communities : 502326000054 Fox, C. Lynn.</p>
+
+<p>06/27/2008 Eating fractions / 502326000022 McMillan, Bruce.</p>
+
+<p>Sincerely, Library Staff</p>
+
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/stage-marc-import.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/stage-marc-import.tmpl
index 7860f17..80778f3 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/stage-marc-import.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/stage-marc-import.tmpl
@@ -2,24 +2,19 @@
<h1>MARC Import</h1>
-<p>This is one of the screens you will see frequently if you are starting from scratch.</p>
-
-<p>It is useful to import a bunch of ISO 2709 biblios that can be used later for a quick cataloguing</p>
-
-<p>First, you need to browse your computer to find the MARC record that you grabbed for your item. Click on</p>
-
-<p>Choose File to browse.</p>
-
-<p>If you aren't sure if you've already imported a record, keep the radio button set to</p>
-
-<p>Ignore this one, keep the existing one.</p>
-
-<p>You can "name" the import to help you when you need to choose between more than 1 imported biblio (or just want to keep trace on where the biblios comes from)</p>
-
-<p>You can also change char encoding between MARC21 and UNIMARC</p>
-
-<p>You don't need to actually name every import, so you don't need to fill in this box if you don't want to. It is useful for telling imports apart if you've more than one of the same record.</p>
-
-<p><b>IMPORTANT : This tool is NOT intended to import ISO 2709 in your ACTIVE database. If you need to migrate data from another ILS, then you must consider $kohaInstall/scripts/misc/bulkmarcimport.pl</b></p>
+<p>Importing records into Koha includes two steps. The first is to stage records for import.</p>
+
+<ul><li>First find the MARC file on your computer</li>
+<li>Next you will be presented with options for record matching and item imports</li>
+<ul><li>Enter 'Comments about this file' to identify your upload when going to the 'Manage Staged MARC Records' tool</li>
+<li>Choose the character encoding</li>
+<li>Choose whether or not you want to look for matching records</li>
+<ul><li>You can set up record matching rules through the administration area</li></ul>
+<li>Next choose what to do with matching records if they are found</li>
+<li>Finally choose what to do with records that are unique</li>
+<li>Next you can choose whether or not to import the item data found in the MARC records</li></ul>
+<li>Click 'Stage for import'</li>
+<li>You will be presented with a confirmation of your MARC import</li>
+<li>To complete the process continue to the Managed Staged MARC Records Tool</li></ul>
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
\ No newline at end of file
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/tags/review.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/tags/review.tmpl
index 55adfc1..a42a71a 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/tags/review.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/tags/review.tmpl
@@ -202,7 +202,7 @@ td input,td input[type="submit"] { font-size: 85%; padding: 1px; }
<th>Term</th>
<th>Weight</th>
<th>Actions</th>
- <th>Reviewer</th>
+ <!-- TMPL_UNLESS NAME="filter_approved_pending" --><th>Reviewer</th><!-- /TMPL_UNLESS -->
<th>Date</th>
</tr>
<!-- TMPL_LOOP NAME="tagloop" -->
@@ -239,7 +239,7 @@ td input,td input[type="submit"] { font-size: 85%; padding: 1px; }
<input class="rej" type="submit" title="<!-- TMPL_VAR NAME="term"-->" value="Reject" name="reject" />
</span>
</td>
- <td> </td>
+ <!-- TMPL_UNLESS NAME="filter_approved_pending" --><td> </td><!-- /TMPL_UNLESS -->
<!-- /TMPL_IF -->
<td><!-- TMPL_VAR NAME="date_approved"-->
</td>
--
1.5.6.5
More information about the Koha-patches
mailing list