Skip to content

Commit

Permalink
Adding yuipath variable to help.pl, and doing some cleanup of help te…
Browse files Browse the repository at this point in the history 
…mplates (standardizing structure, mostly, and correcting some nomenclature).

Signed-off-by: Chris Cormack <crc@liblime.com>
Signed-off-by: Joshua Ferraro <jmf@liblime.com>
  • Loading branch information
@oleonard
oleonard authored and Joshua Ferraro committed Jan 9, 2008
1 parent 552fd87 commit d12cdc1
Show file tree
Hide file tree
Showing 68 changed files with 599 additions and 351 deletions.
1 change: 1 addition & 0 deletions help.pl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ sub gethelptemplate {
C4::Context->preference("intranetcolorstylesheet"),
intranetstylesheet => C4::Context->preference("intranetstylesheet"),
IntranetNav => C4::Context->preference("IntranetNav"),
yuipath => C4::Context->preference("yuipath"),
referer => $refer,
);
return $template;
Expand Down
13 changes: 10 additions & 3 deletions koha-tmpl/intranet-tmpl/prog/en/css/staff-global.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,15 +114,22 @@ ul {
padding-left : 1.1em;
}

li {

ul li {
list-style-type : disc;
}

li li {
ul li li {
list-style-type : circle;
}

ol {
padding-left : 1.5em;
}

ol li {
list-style : decimal;
}

#header {
background-color : #F3F3F3;
border-bottom : 1px solid #E8E8E8;
Expand Down
8 changes: 2 additions & 6 deletions koha-tmpl/intranet-tmpl/prog/en/includes/help-bottom.inc
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
<div class="action">
<form action="help.pl" method="get">
<input type="button" class="submit" onclick="window.close(); return false;" value="Close Help Window" />
</form>
<form action="/cgi-bin/koha/edithelp.pl" method="post">
<fieldset class="action"><input type="button" class="submit" onclick="window.close(); return false;" value="Close Help Window" />
<input type="hidden" name="type" value="modify" />
<input type="hidden" name="referer" value="<!-- TMPL_VAR NAME="referer" -->" />
<input type="submit" class="submit" value="Edit help" />
<input type="submit" class="submit" value="Edit help" /></fieldset>
</form>
</div></div>
</body>
</html>
3 changes: 3 additions & 0 deletions koha-tmpl/intranet-tmpl/prog/en/includes/help-top.inc
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!-- TMPL_INCLUDE NAME="doc-head-open.inc" -->
<title>Online Help</title>
<!-- TMPL_INCLUDE NAME="doc-head-close.inc" -->
<link rel="stylesheet" type="text/css" href="<!-- TMPL_VAR NAME="themelang" -->/css/help.css" />
</head>
<body id="help">
22 changes: 17 additions & 5 deletions koha-tmpl/intranet-tmpl/prog/en/modules/help/about.tmpl
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<!-- TMPL_INCLUDE name="help-top.inc" -->
<div class="main">
<h1>About Koha</h1><p>This section provides information about your Koha installation. It is useful for developers and if you wish to report bugs or issues to the Koha community.&nbsp;</p><h2>Server Information</h2><p>This section tells you which version of Koha and supporting software you are using. If possible, when reporting issues to the Koha community, always give details of which version of Koha you are using. Koha is under active development and it is highly likely that an upgrade to a more recent version will provide patches and bug fixes you require.&nbsp;</p><h2>Perl Modules</h2><p>This tab lists all the dependant Perl Modules for Koha and whether or not you have them installed, and the version number. If you are reporting an issue, the developer may ask what is the state of the Perl modules you have installed.&nbsp;</p><h2>Koha Team</h2><p>Koha is developed and supported by a large number of developers around the world. Thanks to all the developers and libraries who support Koha</p><p>&nbsp;</p>
</div>
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
<!-- TMPL_INCLUDE NAME="help-top.inc" -->

<h1>About Koha</h1><p>This section provides information about your Koha installation. It is useful for developers and if you wish to report bugs or issues to the Koha community.</p>

<h2>Server Information</h2>

<p>This section tells you which version of Koha and supporting software you are using. If possible, when reporting issues to the Koha community, always give details of which version of Koha you are using. Koha is under active development and it is highly likely that an upgrade to a more recent version will provide patches and bug fixes you require.</p>

<h2>Perl Modules</h2>

<p>This tab lists all the dependant Perl Modules for Koha and whether or not you have them installed, and the version number. If you are reporting an issue, the developer may ask what is the state of the Perl modules you have installed.</p>

<h2>Koha Team</h2>

<p>Koha is developed and supported by a large number of developers around the world. Thanks to all the developers and libraries who support Koha</p>

<!-- TMPL_INCLUDE name="help-bottom.inc" -->
19 changes: 16 additions & 3 deletions koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/acqui-home.tmpl
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
<!-- TMPL_INCLUDE name="help-top.inc" -->
<div class="main"> <h1>Acquisitions Help</h1><h2>What is Acquisitions? </h2><p>The Koha Acquisitions module provides a way where the library can record orders placed with vendors and manage purchase budgets.&nbsp;</p><p>You do not need to use Acquisitions to add items to your catalogue. If you do not want to track orders and budget expenditure, then use the <strong>&quot;Add MARC&quot; </strong>feature in <strong>Cataloging </strong>to add new bibliographic and item records.</p><h2>How to place an order? </h2><p>To place an order, the first step is to locate your Vendor (supplier). If no Vendor exists, you will need to create one. Once you have a Vendor you can place an order.&nbsp;</p><h2>How to recieve an order?</h2><p>There are two ways to recieve an order:</p><ol><li><strong>By Supplier (Supplier Search) - </strong>search for the vendor and view all order associated with the item. </li><li><strong>By Order (Orders Search) -&nbsp;</strong> enter the title of the ordered Item in the orders search and locate the item.</li></ol><h2>What needs to be setup to use Acquisitions?</h2><p>To make the most of acquisitions the following needs to be setup under <strong>System Administration</strong></p><ul><li><strong>Budgets and Funds</strong> - &quot;Funds&quot; are used to group &quot;Budgets&quot;. For example a Fund may be called &quot;General Stack&quot;, and will have a &quot;Budget&quot; which records the amount availalbe to spend during the period of the budget. A budget must have a start and end date. </li><li><strong>Exchange Rates (optional)- </strong>If making purchases in overseas currency, the exchange rate will need to be set realtive to your local currency. Remember that your local currency should be set to 1.00<br /><strong>NOTE: Exchanges Rates need to be updated manually. <br /></strong></li><li><strong>Vendor(s) - </strong>These are the entities where items are purchased, or donated from. Orders are placed with Vendors.&nbsp; </li></ul></div><div class="main"><h2>How do you handle donated items? </h2></div><div class="main">In Koha, doners are simply vendors who do not charge anything for items. You can either setup a catchall vendor account for all donations, or setup a new vendor account for each doner. When items are &quot;ordered&quot; from a vendor, simply enter 0 in the purchase price. If you wish to, you can record the actual value of the item in the &quot;Replacement Cost&quot; field.&nbsp;</div><div class="main">&nbsp;</div>
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
<h1>Acquisitions Help</h1><h2>What is Acquisitions? </h2>

<p>The Koha Acquisitions module provides a way where the library can record orders placed with vendors and manage purchase budgets.</p><p>You do not need to use Acquisitions to add items to your catalogue. If you do not want to track orders and budget expenditure, then use the <strong>&quot;Add MARC&quot; </strong>feature in <strong>Cataloging </strong>to add new bibliographic and item records.</p>

<h2>How to place an order? </h2>

<p>To place an order, the first step is to locate your Vendor (supplier). If no Vendor exists, you will need to create one. Once you have a Vendor you can place an order.</p>

<h2>How to recieve an order?</h2>

<p>There are two ways to recieve an order:</p><ol><li><strong>By Supplier (Supplier Search) - </strong>search for the vendor and view all order associated with the item. </li><li><strong>By Order (Orders Search) -</strong> enter the title of the ordered Item in the orders search and locate the item.</li></ol><h2>What needs to be setup to use Acquisitions?</h2>

<p>To make the most of acquisitions the following needs to be setup under <strong>System Administration</strong></p><ul><li><strong>Budgets and Funds</strong> - &quot;Funds&quot; are used to group &quot;Budgets&quot;. For example a Fund may be called &quot;General Stack&quot;, and will have a &quot;Budget&quot; which records the amount availalbe to spend during the period of the budget. A budget must have a start and end date. </li><li><strong>Exchange Rates (optional)- </strong>If making purchases in overseas currency, the exchange rate will need to be set realtive to your local currency. Remember that your local currency should be set to 1.00<br /><strong>NOTE: Exchanges Rates need to be updated manually. <br /></strong></li><li><strong>Vendor(s) - </strong>These are the entities where items are purchased, or donated from. Orders are placed with Vendors.</li></ul><h2>How do you handle donated items? </h2>In Koha, doners are simply vendors who do not charge anything for items. You can either setup a catchall vendor account for all donations, or setup a new vendor account for each doner. When items are &quot;ordered&quot; from a vendor, simply enter 0 in the purchase price. If you wish to, you can record the actual value of the item in the &quot;Replacement Cost&quot; field.&nbsp;

<!-- TMPL_INCLUDE name="help-bottom.inc" -->
19 changes: 17 additions & 2 deletions koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/basket.tmpl
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
<!-- TMPL_INCLUDE name="help-top.inc" -->
<div class="main"> <h1>Placing an Order Help</h1><h2>What is a Basket and Order?</h2><p>A Basket is used to group a set of order lines. An order is placed for an individual item. </p><p>An Order can have multiple copies/units placed against it.&nbsp; A Basket can have multiple Orders.&nbsp;</p><h2>How do I add Items to an Order?</h2><ol><li><strong>From an existing record -&nbsp;</strong> Use the search to locate the bibliographic recrod of the item that you wish to order more copies of. </li><li><strong>From A Suggestion - </strong>view suggestions placed by Patrons and add to the item to the basket. </li><li><strong>From a new (empty) record - </strong>If you know that the item is not in the library already, then create a new record from scratch. </li></ol><h3>TIP: Always check your Catalogue first </h3><p>It is highly advisable that you get in the habit of checking the catalogue first before placing an order for a new item. This saves unnecessary duplicate Bibliographic records in your database and any need to merge/deduplicate records.&nbsp; </p><h2>Do I have to &quot;Close&quot; a Basket?</h2><p>No. A basket is simply a way that a set of orders can be grouped together. You may chose to &quot;Close A Basket&quot; when the Order for all the items in the basket has been placed with the Vendor. A basket does not need to be closed to recieve the items that have been ordered within that basket.&nbsp;</p><h2>Where do I enter a purchase order number? </h2><p>Purchase order numbers are entered against orders, not baskets. See <strong>Add To Order</strong>&nbsp; </p><p>&nbsp;</p> </div>
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
<h1>Placing an Order Help</h1><h2>What is a Basket and Order?</h2>

<p>A Basket is used to group a set of order lines. An order is placed for an individual item. </p><p>An Order can have multiple copies/units placed against it.&nbsp; A Basket can have multiple Orders.</p>

<h2>How do I add Items to an Order?</h2><ol><li><strong>From an existing record -</strong> Use the search to locate the bibliographic recrod of the item that you wish to order more copies of. </li><li><strong>From A Suggestion - </strong>view suggestions placed by Patrons and add to the item to the basket. </li><li><strong>From a new (empty) record - </strong>If you know that the item is not in the library already, then create a new record from scratch. </li></ol><h3>TIP: Always check your Catalogue first </h3>

<p>It is highly advisable that you get in the habit of checking the catalogue first before placing an order for a new item. This saves unnecessary duplicate Bibliographic records in your database and any need to merge/deduplicate records.</p>

<h2>Do I have to &quot;Close&quot; a Basket?</h2>

<p>No. A basket is simply a way that a set of orders can be grouped together. You may chose to &quot;Close A Basket&quot; when the Order for all the items in the basket has been placed with the Vendor. A basket does not need to be closed to recieve the items that have been ordered within that basket.</p>

<h2>Where do I enter a purchase order number? </h2>

<p>Purchase order numbers are entered against orders, not baskets. See <strong>Add To Order</strong></p>

<!-- TMPL_INCLUDE name="help-bottom.inc" -->
8 changes: 2 additions & 6 deletions koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/newbiblio.tmpl
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
<!-- TMPL_INCLUDE NAME="doc-head-open.inc" -->
<title>Online Help &rsaquo; Add Bibliographic Record</title>
<!-- TMPL_INCLUDE NAME="doc-head-close.inc" -->
</head>
<body>
<!-- TMPL_INCLUDE NAME="help-top.inc" -->

<h1>Add Bibliographic Record</h1>

<p>Sorting Field 1 and Sorting Field 2 may now be related to a list of Authorized Values. All you have to do is define an Asort1 or Asort2 category of authorised values and enter the desired values into these categories. You will then be able to use them through Add/Modify Bibliographic Record page</p>

<!-- TMPL_INCLUDE name="intranet-bottom.inc" -->
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
21 changes: 18 additions & 3 deletions koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/neworderempty.tmpl
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
<!-- TMPL_INCLUDE name="help-top.inc" -->
<div class="main"> <h1>Order Details Help</h1><h2>What is the &quot;Vendor Price&quot;?</h2><p>The vendor price is the price given to you by the vendor, sometimes called the &quot;List Price&quot;. Depdending on how the Vendor is setup this may or maynot include any discount given to you by the vendor and/or any sales tax. See Vendors for more information.&nbsp;</p><h2>What is the &quot;Replacement Price&quot;?</h2><p>The replacement price is the total cost of what it would cost to replace the item if you had to purchase the item retail at recommended retail. This is the amount that a patron could be charged if item is lost or damaged beyond repair.&nbsp; </p><h2>What is the &quot;Budgeted Price&quot;?</h2><p>This is the price you expect to pay for the item, including any discount and any relevant sales tax (depending on the vendor setup) and is the amount that will be charged to your <strong>Commited budget</strong>.&nbsp; </p><h2>What is the &quot;Actual Price&quot;?</h2><p>This is the price that shows on the invoice or packing slip when you recieve the item. When placing an order, Koha will automatically calculate this for you. When an item is recieved, this can be over keyed with the actual value. This is to take into account any slight differences in rounding or price flutucations between ordering the item and actually recieving it.&nbsp;</p><p>The Actual price is what is committed to your <strong>Spent budget</strong>.&nbsp; </p> </div>
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
<h1>Order Details Help</h1><h2>What is the &quot;Vendor Price&quot;?</h2>

<p>The vendor price is the price given to you by the vendor, sometimes called the &quot;List Price&quot;. Depdending on how the Vendor is setup this may or maynot include any discount given to you by the vendor and/or any sales tax. See Vendors for more information.</p>

<h2>What is the &quot;Replacement Price&quot;?</h2>

<p>The replacement price is the total cost of what it would cost to replace the item if you had to purchase the item retail at recommended retail. This is the amount that a patron could be charged if item is lost or damaged beyond repair.</p>

<h2>What is the &quot;Budgeted Price&quot;?</h2>

<p>This is the price you expect to pay for the item, including any discount and any relevant sales tax (depending on the vendor setup) and is the amount that will be charged to your <strong>Commited budget</strong>.</p>

<h2>What is the &quot;Actual Price&quot;?</h2>

<p>This is the price that shows on the invoice or packing slip when you recieve the item. When placing an order, Koha will automatically calculate this for you. When an item is recieved, this can be over keyed with the actual value. This is to take into account any slight differences in rounding or price flutucations between ordering the item and actually recieving it.</p><p>The Actual price is what is committed to your <strong>Spent budget</strong>.</p>

<!-- TMPL_INCLUDE name="help-bottom.inc" -->
13 changes: 10 additions & 3 deletions koha-tmpl/intranet-tmpl/prog/en/modules/help/acqui/orderreceive.tmpl
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
<!-- TMPL_INCLUDE name="help-top.inc" -->
<div class="main"> <h1>Receiving Orders Help</h1><h2>How do I receive items that have arrived?</h2><p>Firstly, check the catalogue details that you are recieiving the right item. If these are correct, you can add the&nbsp; item details.&nbsp;</p><p>For each item you will need to check the following:</p><ul><li><strong>Volume/Copy </strong>for Serails</li><li><strong>Item Barcode</strong> scan or enter the barcode that has been assigned to the item</li><li><strong>Home Library </strong>choose the home library/branch for the item from the drop down list</li><li><strong>Item Type </strong>choose the item type from the drop down. </li></ul><br /><h2>How do I receive multiple identical items?</h2><p>If you have ordered multiple copies of the same item, then use the &quot;+&quot; to bring up another <strong>Item Details</strong> input fieldset.&nbsp;</p><p>For each copy you will need to set that Item Barce, Home Library and Item Type.&nbsp;</p><p>Each time you add a new item, the <strong>Quantity Recieved</strong> under <strong>Accounting Details</strong> should be updated.&nbsp; </p><p>If you press the &quot;+&quot; by mistake, use the &quot;-&quot; button to remove the unwanted Item Details <strong>input fieldset </strong></p> </div>
<!-- TMPL_INCLUDE name="help-bottom.inc" -->
<!-- TMPL_INCLUDE NAME="help-top.inc" -->
<h1>Receiving Orders Help</h1><h2>How do I receive items that have arrived?</h2>

<p>Firstly, check the catalogue details that you are recieiving the right item. If these are correct, you can add the&nbsp; item details.</p><p>For each item you will need to check the following:</p><ul><li><strong>Volume/Copy </strong>for Serails</li><li><strong>Item Barcode</strong> scan or enter the barcode that has been assigned to the item</li><li><strong>Home Library </strong>choose the home library/branch for the item from the drop down list</li><li><strong>Item Type </strong>choose the item type from the drop down. </li></ul>

<h2>How do I receive multiple identical items?</h2>

<p>If you have ordered multiple copies of the same item, then use the &quot;+&quot; to bring up another <strong>Item Details</strong> input fieldset.</p><p>For each copy you will need to set that Item Barce, Home Library and Item Type.</p><p>Each time you add a new item, the <strong>Quantity Recieved</strong> under <strong>Accounting Details</strong> should be updated.</p><p>If you press the &quot;+&quot; by mistake, use the &quot;-&quot; button to remove the unwanted Item Details <strong>input fieldset </strong></p>

<!-- TMPL_INCLUDE name="help-bottom.inc" -->
Loading

0 comments on commit d12cdc1

Please sign in to comment.