Merge remote branch 'kc/master' into new/enh/bug_5917
[koha.git] / koha-tt / intranet-tmpl / prog / en / modules / help / admin / authorised_values.tt
1 [% INCLUDE 'help-top.inc' %]
2
3 <h1>Authorized values management</h1>
4
5 <p>Koha allows you to restrict the values that catalogers can place in some MARC subfields to certain pre-defined &quot;authorized&quot; values. These authorized values are defined here.</p>
6         <ul>
7                 <li>HINT : if a subfield is non mandatory, Koha automatically adds an empty value to the authorized value list, that is selected by default. If the subfield is mandatory, no empty value is added (and you should NOT add it in the list, as it's an illegal value !)</li>
8                 <li>HINT2 : in the MARC editor, the list is ordered by Text, NOT by value. So you can define a default value by putting a space before the value you want to see first. For example, if your list is related to language, you can set &quot;ENG&quot; as authorized value and &quot; English&quot; as text. The space will order &quot;ENG&quot; as first default value, and the space won't be shown (because html automatically discard useless spaces). Super hint : you can put a value 1st with N spaces, then another one 2nd with N-1 space,..., a value in Nth position with 1 space. Don't abuse of this feature, it's easier to find a value in an alphabetical order. It should be used only to have a default value</li>
9         </ul>
10 <p>Koha automatically sets up authorized value categories for your item types and branch codes, and you can link these authorized values to MARC subfields when you set up your MARC tag structure.</p>
11 <p> </p>
12 <h3>Why would I want to define authorized values for MARC tags?</h3>
13 <p>Authorized Values create a 'controlled vocabulary' for your staff. As an example, let us assume that your Koha installation is used by several libraries, and you use MARC 21. You might want to restrict the 850a MARC subfield to the institution codes for just those libraries. In that case, you could define an authorized values category (perhaps called &quot;INST&quot;) and enter the institution codes as the authorized values for that category.</p>
14     <span style="background-color: #ffe599">
15 TIP: Koha automatically sets up authorized value categories for your item types and branch codes, and you can link these authorized values to MARC subfields when you set up your MARC tag structure</span>.
16    
17    <strong>Existing Authorized Values</strong>
18 Koha comes with several other categories and pre-defined values your library is likely to use, for instance 'Lost'.
19
20         <ul>
21                 <li>Asort1
22                 <ul>
23                         <li>attached to acquisitions, that can be used for stats purposes</li>
24                 </ul></li>
25                 <li>Asort2
26                 <ul>
27                         <li>attached to acquisitions, that can be used for stats purposes</li>
28                 </ul></li>
29                 <li>Bsort1
30                 <ul>
31                         <li>attached to patrons, that can be used for stats purposes</li>
32                 </ul></li>
33                 <li>Bsort2
34                 <ul>
35                         <li>attached to patrons, that can be used for stats purposes</li>
36                 </ul></li>
37                 <li>CCODE
38                 <ul>
39                         <li>collection code (appears when editing at item)</li>
40                 </ul></li>
41                 <li>DAMAGED
42                 <ul>
43                         <li>descriptions for items marked as damaged (appears when editing an item)</li>
44                 </ul></li>
45                 <li>HINGS_AS
46                 <ul>
47                         <li>
48                     
49 holdings coded value<strong style="color: #0000ff">??</strong></li>
50                 </ul></li>
51                 <li>HINGS_C
52                 <ul>
53                         <li>
54                     
55 holdings coded value<strong style="color: #0000ff">??</strong></li>
56                 </ul></li>
57                 <li>HINGS_PF
58                 <ul>
59                         <li>
60                     
61 holdings coded value<strong style="color: #0000ff">??</strong></li>
62                 </ul></li>
63                 <li>HINGS_RD
64                 <ul>
65                         <li>
66                     
67 holdings coded value<strong style="color: #0000ff">??</strong></li>
68                 </ul></li>
69                 <li>HINGS_UT
70                 <ul>
71                         <li>
72                     
73 holdings coded value<strong style="color: #0000ff">??</strong></li>
74                 </ul></li>
75                 <li>LOC
76                 <ul>
77                         <li>                
78 shelving location (usually appears when editing an item)</li>
79                 </ul></li>
80                 <li>LOST
81                 <ul>
82                         <li>descriptions for the items marked as lost (appears when editing an item)</li>
83                 </ul></li>
84                 <li>NOT_LOAN
85                 <ul>
86                         <li>reasons why a title is not for loan</li>
87                 </ul></li>
88                 <li>RESTRICTED
89                 <ul>
90                         <li><strong style="color: #0000ff">??</strong></li>
91                 </ul></li>
92                 <li>STACK
93                 <ul>
94                         <li><strong style="color: #0000ff">??</strong></li>
95                 </ul></li>
96                 <li>SUGGEST
97                 <ul>
98                         <li>list of patron suggestion reject or accept reasons (appears when managing suggestions)</li>
99                 </ul></li>
100                 <li>WITHDRAWN
101                 <ul>
102                         <li>description of a withdrawn item (appears when editing an item)</li>
103                 </ul></li>
104         </ul>   
105    <strong>View Authorized Values</strong>
106
107         <ul>
108                 <li>To view the authorized values defined for a category that already exists like 'Lost', choose 'Lost' from the category dropdown menu</li>
109                 <li>Then, you can see the values defined for the category &quot;Lost&quot; and edit them if you like.</li>
110         </ul><strong>   
111    Add Authorized Value</strong>
112
113         <ul>
114                 <li>To add a new value under an existing category, click &quot;New authorized value for&quot;</li>
115                 <li>Enter the value and description and choose an icon if you'd like</li>
116                 <li>When finished, click 'Save'</li>
117         </ul><h1>   
118    Edit authorized values<br/></h1>
119         <ul>
120                 <li>Choose a category from the 'Show Category' dropdown menu</li>
121                 <li>Click 'Edit' beside the authorized value you wish to edit</li>
122                 <li>Make the changes you'd like and click 'Save'</li>
123                 <li>
124             <span style="background-color: #ffe599">
125 TIP: Be careful about changing the 'Authorized value' as it may be associated with existing records</span>.</li>
126         </ul><h2></h2> <h1><strong>   
127    Add a new Authorized Value Category<br/></strong></h1>
128
129 <h2></h2> <strong><br/></strong>
130         <ul>
131                 <li>To add a new category, click 'New Category'</li>
132                 <li>Fill in the 'Category', 'Authorized value' and 'Description' fields<br/>
133                 <ul>
134                         <li>
135                     <span style="color: #ff0000">
136 IMPORTANT: The category name must be 8 characters or less. Also, just input one authorized value for the category. You can edit and add more after you save the category.</span></li>
137                 </ul></li>
138                 <li>Click 'Save'</li>
139                 <li>You've added a new category and can immediately start adding more authorized values to that category by clicking &quot;New authorized value for...&quot;</li>
140         </ul>
141 [% INCLUDE 'help-bottom.inc' %]