Bug 20706: Fixes the links to the manual to reflect chanced chapter file names
[koha.git] / koha-tmpl / intranet-tmpl / prog / en / modules / help / admin / biblio_framework.tt
1 [% INCLUDE 'help-top.inc' %]
2
3 <h1>MARC Bibliographic Frameworks</h1>
4
5 <p>Think of Frameworks as templates for creating new bibliographic records. Koha comes with some predefined frameworks that can be edited or deleted, and librarians can create their own frameworks for content specific to their libraries.</p>
6
7 <p style="color: #990000;">Important: Do not delete or edit the Default Framework since this will cause problems with your cataloging records - always create a new template based on the Default Framework, or alter the other Frameworks.</p>
8
9 <p>After clicking the 'MARC structure' link to the right of each framework you can decide how many fields you want to see on one screen by using the pagination options at the top of the table.</p>
10
11 <h3>Add New Framework</h3>
12
13 <p>To add a new framework</p>
14
15 <ul>
16    <li>Click 'New Framework'
17 <ul>
18    <li>Enter a code of 4 or fewer characters</li>
19    <li>Use the Description field to enter a more detailed definition of your framework</li>
20 </ul>
21 </li>
22    <li>Click 'Submit'</li>
23    <li>Once your Framework is added click 'MARC structure' to the right of it on the list of Frameworks
24 <ul>
25    <li>You will be asked to choose a Framework to base your new Framework off of, this will make it easier than starting from scratch</li>
26 </ul>
27 </li>
28    <li>Once your Framework appears on the screen you can edit or delete each field by following the instructions for editing subfields</li>
29 </ul>
30
31 <h4>Edit Existing Frameworks</h4>
32
33 <p>Clicking 'Edit' to the right of a Framework will only allow you to edit the Description for the Framework</p>
34
35 <p>To make edits to the fields associated with the Framework you must first click 'MARC Structure' and then follow the instructions for editing subfields</p>
36
37 <h4>Add subfields to Frameworks</h4>
38
39 <p>To add a field to a Framework click the 'New Tag' button at the top of the Framework definition</p>
40
41 <p>This will open up a blank form for entering MARC field data</p>
42
43 <p>Enter the information about your new tag:</p>
44 <ul>
45    <li>The 'Tag' is the MARC field number</li>
46    <li>The 'Label for lib' is the text that will appear in the staff client when in the cataloging module</li>
47    <li>The 'Label for OPAC' is the text that will appear in the OPAC when viewing the MARC version of the record</li>
48    <li>If this field can be repeated, check the 'Repeatable' box</li>
49    <li>If this field is mandatory, check the 'Mandatory' box</li>
50    <li>If you want this field to be a pull down with limited possible answers, choose which 'Authorized value' list you want to use</li>
51 </ul>
52
53 <p>When you're finished, click 'Save Changes' and you will be presented with your new field</p>
54
55 <p>To the right of the new field is a link to 'Subfields,' you will need to add subfields before this tag will appear in your MARC editor. The process of entering the settings for the new subfield is the same as those found in the editing subfields in frameworks section of the manual.</p>
56
57 <h4>Edit Framework Subfields</h4>
58
59 <p>Frameworks are made up of MARC fields and subfields. To make edits to most Frameworks you must edit the fields and subfields. Clicking 'Edit' to the right of each subfield will allow you to make changes to the text associated with the field</p>
60
61 <ul>
62    <li>Each field has a tag (which is the MARC tag) that is uneditable
63 <ul>
64    <li>The 'Label for lib' is what will show in the staff client if you have advancedMARCeditor set to display labels</li>
65    <li>The 'Label for OPAC' is what will show on the MARC view in the OPAC</li>
66    <li>If you check 'Repeatable' then the field will have a plus sign next to it allowing you to add multiples of that tag</li>
67    <li>If you check 'Mandatory' the record will not be allowed to save unless you have a value assigned to this tag</li>
68    <li>'Authorized value' is where you define an authorized value that your catalogers can choose from a pull down to fill this field in</li>
69 </ul>
70 </li>
71 </ul>
72
73 <p>To edit the subfields associated with the tag, click 'Subfields' to the right of the tag on the 'MARC Structure' listing</p>
74
75 <ul>
76    <li>From the list of subfields you can click 'Delete' to the right of each to delete the subfields</li>
77    <li>To edit the subfields click 'Edit Subfields'</li>
78    <li>For each subfield you can set the following Basic constraint values
79 <ul>
80    <li>Text for librarian
81 <ul>
82    <li>what appears before the subfield in the librarian interface</li>
83 </ul>
84 </li>
85    <li>Text for OPAC
86 <ul>
87    <li>what appears before the field in the OPAC.
88 <ul>
89    <li>If left empty, the text for librarian is used instead</li>
90 </ul>
91 </li>
92 </ul>
93 </li>
94    <li>Repeatable
95 <ul>
96    <li>the field will have a plus sign next to it allowing you to add multiples of that tag</li>
97 </ul>
98 </li>
99    <li>Mandatory
100 <ul>
101    <li>the record will not be allowed to save unless you have a value assigned to this tag</li>
102 </ul>
103 </li>
104    <li>Managed in tab
105 <ul>
106    <li>defines the tab where the subfield is shown. All subfields of a given field must be in the same tab or ignored. Ignore means that the subfield is not managed.</li>
107 </ul>
108 </li>
109 </ul>
110 </li>
111    <li>For each subfield you can set the following Advanced constraint values
112 <ul>
113    <li>Default value
114 <ul>
115    <li>defines what you want to appear in the field by default, this will be editable, but it saves time if you use the same note over and over or the same value in a field often.</li>
116 </ul>
117 </li>
118    <li>Visibility
119 <ul>
120    <li>allows you to select from where this subfield is visible/hidden, simply check the boxes where you would like the field to show and uncheck the boxes where you would like it hidden.</li>
121 </ul>
122 </li>
123    <li>Is a URL
124 <ul>
125    <li>if checked, it means that the subfield is a URL and can be clicked</li>
126 </ul>
127 </li>
128    <li>Link
129 <ul>
130    <li>If you enter a field/subfield here (200b), a link appears after the subfield in the MARC Detail view. This view is present only in the staff client, not the OPAC. If the librarian clicks on the link, a search is done on the database for the field/subfield with the same value. This can be used for 2 main topics :
131 <ul>
132    <li>on a field like author (200f in UNIMARC), put 200f here, you will be able to see all bib records with the same author.</li>
133    <li>on a field that is a link (4xx) to reach another bib record. For example, put 011a in 464$x, will find the serials that are with this ISSN.</li>
134 </ul>
135 </li>
136    <li style="color: #990000;">Warning: This value should not change after data has been added to your catalog. If you need to change this value you must ask your system administrator to run misc/batchRebuildBiblioTables.pl.</li>
137 </ul>
138 </li>
139    <li>Koha link
140 <ul>
141    <li>Koha is multi-MARC compliant. So, it does not know what the 245$a means, neither what 200$f (those 2 fields being both the title in MARC21 and UNIMARC). So, in this list you can "map" a MARC subfield to its meaning. Koha constantly maintains consistency between a subfield and its meaning. When the user want to search on "title", this link is used to find what is searched (245 if you're MARC21, 200 if you're UNIMARC).</li>
142 </ul>
143 </li>
144 </ul>
145 </li>
146    <li>For each subfield you can set the following Other option values
147 <ul>
148    <li>Authorized value
149 <ul>
150    <li>means the value cannot by typed by the librarian, but must be chosen from a pull down generated by the authorized value list</li>
151 </ul>
152 </li>
153    <li>Thesaurus
154 <ul>
155    <li>means that the value is not free text, but must be searched in the authority/thesaurus of the selected category</li>
156 </ul>
157 </li>
158    <li>Plugin
159 <ul>
160    <li>means the value is calculated or managed by a plugin. Plugins can do almost anything.</li>
161    <li>Examples:
162 <ul>
163    <li>For call numbers there is an option to add a call number browser next to the the call number subfield. Simply choose the cn_browser.pl plugin. Learn more in the cataloging section of the manual.</li>
164    <li>In UNIMARC there are plugins for every 1xx fields that are coded fields. The plugin is a huge help for cataloger! There are also two plugins (unimarc_plugin_210c and unimarc_plugin_225a that can "magically" find the editor from an ISBN, and the collection list for the editor)</li>
165 </ul>
166 </li>
167 </ul>
168 </li>
169 </ul>
170 </li>
171    <li>To save your changes simply click the 'Save Changes' button at the top of the screen</li>
172 </ul>
173
174 <h4>Import/Export Frameworks</h4>
175
176 <p>Next to each framework is a link to either import or export the framework.</p>
177
178 <h5>Export Framework</h5>
179
180 <p>To export a framework simply click the 'Export' link to the right of framework title.</p>
181
182 <p>When you click 'Export' you will be prompted to choose what format to export the file in.</p>
183
184 <p>A framework exported this way can be imported into any other Koha installation using the import framework option.</p>
185
186 <h5>Import Framework</h5>
187
188 <p>An easy way to create a new framework is to import one created for your or another Koha installation. This framework would need to be exported from the other system using the instructions above to be available for import here.</p>
189
190 <p>To import a framework you first need to create a new framework. Once you have that framework, click 'Import' to the right of the new framework.</p>
191
192 <p>You will be prompted to find a file on your computer to import into the framework.</p>
193
194 <p>You will be asked to confirm your actions before the file is imported.<p>
195
196 <p>As your file is uploaded you will see an image that will confirm that the system is working.<p>
197
198 <p>Once your import is complete you will be brought to the framework edit tool where you can make any changes you need to the framework you imported.<p>
199
200 <p><strong>See the full documentation for Frameworks in the <a href="http://koha-community.org/manual/[% helpVersion %]/html/administration.html#marc-bibliographic-frameworks">manual</a> (online).</strong></p>
201
202 [% INCLUDE 'help-bottom.inc' %]