[Koha-patches] [PATCH] updated more help files
Nicole Engard
nengard at gmail.com
Thu Dec 17 00:03:49 CET 2009
---
.../en/modules/help/reports/guided_reports.tmpl | 19 +++----
.../prog/en/modules/help/reports/manager.tmpl | 14 +-----
.../prog/en/modules/help/tools/batchmod.tmpl | 15 ++++++
.../prog/en/modules/help/tools/holidays.tmpl | 52 ++++++++++++++------
.../prog/en/modules/help/tools/scheduler.tmpl | 22 ++++++++
5 files changed, 84 insertions(+), 38 deletions(-)
create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchmod.tmpl
create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tmpl
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl
index 55dc498..63bf22e 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/guided_reports.tmpl
@@ -2,32 +2,31 @@
<h1>Add a Custom Report</h1>
-<p>If the report you need is not already available, the 'Guided Reports' Wizard will walk anyone through creating a custom report.</p>
+<p>If the report you need is not already available, the 'Guided Reports' Wizard will walk you through creating a custom report.</p>
-<p>There are three elements of a standard 'guided' report: columns, rows and filters. For issues and acquisitions, desired data is placed in each cell (count or amount, or loan length).</p>
<ul>
<li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
<li>Choose 'Guided Reports' under 'Guided Reports Wizard'</li>
</ul>
-<p>Now, you can build a report in 6 easy steps!</p>
+<p>Answer the 6 questions presented in order to create your report.</p>
<p><strong>Step 1: Choose a Module to Report on</strong></p>
<ul>
-<li>Choose a module to build a report on</li>
+<li>Choose a Koha module to build a report on (patrons, circ, cataloging, etc)</li>
<li>Click 'Next'</li>
</ul>
<p><strong>Step 2: Pick a Report Type</strong></p>
-<li style="color: #990000">IMPORTANT: Only Tabular should be chosen with this option</p>
+<ul><li style="color: #990000">IMPORTANT: Only Tabular should be chosen with this option</li></ul>
<p><strong>Step 3: Select Columns for Display</strong></p>
<p><strong>Step 4: Select Criteria to Limit</strong></p>
-<p>This is optional, if you don't want to limit results by any one field, just leave this section blank.</p>
-<p><strong>Step 5: Pick which columns to total</strong></p>
-<p>This is optional, if you don't want to do any math on the results, just leave this section blank.</p>
+<ul><li>This is optional, if you don't want to limit results by any one field, just leave this section blank.</li></ul>
+<p><strong>Step 5: Pick which columns to perform mathmatical functions on</strong></p>
+<ul><li>This is optional, if you don't want to do any math on the results, just leave this section blank.</li></ul>
<p><strong>Step 6: Choose how you want the report ordered</strong></p>
-<p>This is optional, if you want the results to come out as they are in the table, just leave this section blank.</p>
+<ul><li>This is optional, if you want the results to come out as they are in the table, just leave this section blank.</li></ul>
<h1>Edit Reports</h1>
@@ -35,7 +34,7 @@
<ul><li><em>Get there:</em> More > Reports > Guided Reports > Use Saved</li></ul>
-<ul.<li>To edit a report click 'Edit SQL' beside the report</li>
+<ul><li>To edit a report click 'Edit SQL' beside the report</li>
<li>A page with editable fields will open so that you can change the title, notes and SQL related to the report</li></ul>
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tmpl
index 6e44c2f..80a16cf 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/reports/manager.tmpl
@@ -1,18 +1,6 @@
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
-<h1>Checkouts by patron category</h1>
-
-<p>This report will show you how many items were checked out, by borrower (or 'patron') category</p>
-
- <ul>
- <li>Go to the 'Reports' module (usually under 'More' in your Global Nav)</li>
- <li>Choose 'Checkouts by patron category' under 'Other'</li>
- <li>'Select a borrower category' using the dropdown menu provided (or select the default 'Any Category code' at the top of the dropdown menu to choose all borrower categories)</li>
- <li>'Select a branch' to report on (or, leave at the default 'all' to perform the report on all branches)</li>
- <li>Click 'Submit'</li>
- </ul>
-
- <h1>Catalog by Item Type</h1>
+<h1>Catalog by Item Type</h1>
<p>This one-step report will show you how many items of each item type are currently in your branch library or libraries.</p>
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchmod.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchmod.tmpl
new file mode 100644
index 0000000..c714d3a
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/batchmod.tmpl
@@ -0,0 +1,15 @@
+<!-- TMPL_INCLUDE NAME="help-top.inc" -->
+<!--<h1>Batch Modify Items</h1>-->
+
+<h1>Batch Delete Items</h1>
+
+<p>Using this tool you will be able to delete a batch of items using a file of barcodes, or by scanning barcodes one by one.
+
+<ul><li>Choose your option (either upload file or enter barcodes one by one)</li>
+<li>Click 'Continue'</li>
+<li>You will be prompted to confirm deletion</li>
+<ul><li>From the confirmation screen you can uncheck the items you do not want to delete</li></ul>
+<li>Confirm Deletion<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/holidays.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tmpl
index 3f13158..fc472bf 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tmpl
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/holidays.tmpl
@@ -2,21 +2,43 @@
<h1>Holidays Calendar</h1>
-The calendar is used to define days when the library is closed for circulation rules.
-
-<ul>
-<li>From the pull down you can choose which branch to apply holidays to.</li>
- <ul><li style="background-color: #ffe599">TIP: If you're entering universal holidays (that apply to all branches) you will be presented with an option to add to all when adding a new holiday.</li></ul>
-<li>To add a new holiday, click on the date you'd like to add a holiday to</li>
- <ul><li style="background-color: #ffe599">TIP: Click the plus sign (+) to the right of the holiday options for a helpful tip.</li></ul>
-<li>Click on the date and fill in the necessary fields for your library.</li>
-<li>Chose whether this holiday is repeated every day of the week or yearly.</li>
- <ul><li style="background-color: #ffe599">TIP: An example of a repeatable holiday would be Christmas, New Year's or a staff in-service day</li></ul>
-<li>When you've entered the necessary data click 'Save'</li>
-<li>Once saved your holiday will be color-coded on the calendar and listed below the calendar</li>
-</ul>
-
-
+<p>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:</p><ul class="itemizedlist" type="disc"><li class="listitem"><p><span class="emphasis"><em>Get there: </em></span>More > Administration >
+ Global System Preferences > Circulation > useDaysMode</p><ul class="itemizedlist" type="circle"><li class="listitem"><p>Choose the method for calculating due date - either
+ include days the library is closed in the calculation or don't
+ include them.</p></li></ul></li><li class="listitem"><p><span class="emphasis"><em>Get there:</em></span> More > Administration >
+ Global System Preferences > Circulation > finescalendar</p><ul class="itemizedlist" type="circle"><li class="listitem"><p>This will check the holiday calendar before charging
+ fines</p></li></ul></li></ul>
+ <h3>Adding Events</h3>
+ <p>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</p><ul class="itemizedlist" type="disc"><li class="listitem"><p>Click on the date on the calendar that you would like to
+ apply the closing to</p></li><li class="listitem"><p>In the form that appears above the calendar, enter the
+ closing information</p><ul class="itemizedlist" type="circle"><li class="listitem"><p>Library will be filled in automatically based on the
+ library you chose from the pull down at the top of the
+ page</p></li><li class="listitem"><p>The day information will also be filled in automatically
+ based on the date you clicked on the calendar</p></li><li class="listitem"><p>In the description enter the reason the library is
+ closed</p></li><li class="listitem"><p>Next you can choose if this event is a one time event or
+ if it is repeatable.</p></li><li class="listitem"><p>Finally decide if this event should be applied to all
+ libraries or just the one you have originally selected</p></li></ul></div></li><li class="listitem"><p>After saving you will see the event listed in the summary
+ below the calendar</p></li></ul>
+ <h3>Editing Events</h3><p>To edit events</p><ul class="itemizedlist" type="disc"><li class="listitem"><p>Click on the event on the calendar that you want to change
+ (do this by clicking on the date on the calendar, not the event
+ listed in the summary)</p></li><li class="listitem"><p>From this form you can make edits to the holiday or deleete
+ the holiday completely. Both actions require that you click 'Save'
+ before the change will be made.</p></li><li class="listitem"><p>Clicking on repeatable events will offer slightly different
+ options</p>
+ <ul class="itemizedlist" type="circle"><li class="listitem"><p>In the form above you will note that there is now an
+ option to 'Generate an exception for this repeated holiday,'
+ choosing this option will allow you to make it so that this
+ date is not closed even though the library is usually closed
+ on this date.</p></li></ul></li></ul>
+ <h3 class="title">Additional Help</h3><p>When adding or editing events you can get additional help by
+ clicking on the blue plus sign next to various different options on
+ the form</p>
+
<h2>Questions</h2>
<p><strong>Why do I want to add holidays for my branch?</strong></p>
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tmpl b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tmpl
new file mode 100644
index 0000000..35cb9d1
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/help/tools/scheduler.tmpl
@@ -0,0 +1,22 @@
+<!-- TMPL_INCLUDE NAME="help-top.inc" -->
+<h1>Task Scheduler</h1>
+<p>The task scheduler is a way to schedule reports to run whenever
+ you want.</p><p>To schedule a task, visit the Task Scheduler and fill in the
+ form</p>
+ <ul class="itemizedlist" type="disc"><li class="listitem"><p>Current Server Time shows the time on your server (schedule
+ all of your reports to run based on that time - not on your local
+ time)</p></li><li class="listitem"><p>Time should be entered as hh:mm (2 digit hour, 2 digit
+ minute)</p></li><li class="listitem"><p>Date should be entered using the calendar pop up</p></li><li class="listitem"><p>From Report choose the report you want to schedule</p></li><li class="listitem"><p>Choose whether to receive the text of or a link to the
+ results</p></li><li class="listitem"><p>In the Email filed enter the email of the person you want to
+ receive your report</p></li></ul><p>Below the task scheduler form, there is a list of scheduled
+ reports</p>
+ <p>You can also schedule reports directly from the list of saved
+ reports by clicking the 'Schedule' link</p>
+ <h3>Troubleshooting</h3><p>Task scheduler will not work if the user the webserver 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.</p>
+<!-- TMPL_INCLUDE NAME="help-bottom.inc" -->
\ No newline at end of file
--
1.5.6.5
More information about the Koha-patches
mailing list