<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>
-<p>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>
+<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>
<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>
-<h2>Add New Framework</h2>
+<h3>Add New Framework</h3>
<p>To add a new framework</p>
<ul>
<li>Click 'New Framework'
<ul>
- <li>Enter a code of 4 or fewer characters</li>
- <li>Use the Description field to enter a more detailed definition of your framework</li>
+ <li>Enter a code of 4 or fewer characters</li>
+ <li>Use the Description field to enter a more detailed definition of your framework</li>
</ul>
</li>
- <li>Click 'Submit'</li>
- <li>Once your Framework is added click 'MARC structure' to the right of it on the list of Frameworks
+ <li>Click 'Submit'</li>
+ <li>Once your Framework is added click 'MARC structure' to the right of it on the list of Frameworks
<ul>
- <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>
+ <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>
</ul>
</li>
- <li>Once your Framework appears on the screen you can edit or delete each field by following the instructions for editing subfields</li>
+ <li>Once your Framework appears on the screen you can edit or delete each field by following the instructions for editing subfields</li>
</ul>
-<h2>Edit Existing Frameworks</h2>
+<h4>Edit Existing Frameworks</h4>
<p>Clicking 'Edit' to the right of a Framework will only allow you to edit the Description for the Framework</p>
<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>
+<h4>Add subfields to Frameworks</h4>
+
+<p>To add a field to a Framework click the 'New Tag' button at the top of the Framework definition</p>
+
+<p>This will open up a blank form for entering MARC field data</p>
+
+<p>Enter the information about your new tag:</p>
+<ul>
+ <li>The 'Tag' is the MARC field number</li>
+ <li>The 'Label for lib' is the text that will appear in the staff client when in the cataloging module</li>
+ <li>The 'Label for OPAC' is the text that will appear in the OPAC when viewing the MARC version of the record</li>
+ <li>If this field can be repeated, check the 'Repeatable' box</li>
+ <li>If this field is mandatory, check the 'Mandatory' box</li>
+ <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>
+</ul>
+
+<p>When you're finished, click 'Save Changes' and you will be presented with your new field</p>
+
+<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>
+
+<h4>Edit Framework Subfields</h4>
+
+<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>
+
+<ul>
+ <li>Each field has a tag (which is the MARC tag) that is uneditable
+<ul>
+ <li>The 'Label for lib' is what will show in the staff client if you have advancedMARCeditor set to display labels</li>
+ <li>The 'Label for OPAC' is what will show on the MARC view in the OPAC</li>
+ <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>
+ <li>If you check 'Mandatory' the record will not be allowed to save unless you have a value assigned to this tag</li>
+ <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>
+</ul>
+</li>
+</ul>
+
+<p>To edit the subfields associated with the tag, click 'Subfields' to the right of the tag on the 'MARC Structure' listing</p>
+
+<ul>
+ <li>From the list of subfields you can click 'Delete' to the right of each to delete the subfields</li>
+ <li>To edit the subfields click 'Edit Subfields'</li>
+ <li>For each subfield you can set the following Basic constraint values
+<ul>
+ <li>Text for librarian
+<ul>
+ <li>what appears before the subfield in the librarian interface</li>
+</ul>
+</li>
+ <li>Text for OPAC
+<ul>
+ <li>what appears before the field in the OPAC.
+<ul>
+ <li>If left empty, the text for librarian is used instead</li>
+</ul>
+</li>
+</ul>
+</li>
+ <li>Repeatable
+<ul>
+ <li>the field will have a plus sign next to it allowing you to add multiples of that tag</li>
+</ul>
+</li>
+ <li>Mandatory
+<ul>
+ <li>the record will not be allowed to save unless you have a value assigned to this tag</li>
+</ul>
+</li>
+ <li>Managed in tab
+<ul>
+ <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>
+</ul>
+</li>
+</ul>
+</li>
+ <li>For each subfield you can set the following Advanced constraint values
+<ul>
+ <li>Default value
+<ul>
+ <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>
+</ul>
+</li>
+ <li>Visibility
+<ul>
+ <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>
+</ul>
+</li>
+ <li>Is a URL
+<ul>
+ <li>if checked, it means that the subfield is a URL and can be clicked</li>
+</ul>
+</li>
+ <li>Link
+<ul>
+ <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 :
+<ul>
+ <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>
+ <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>
+</ul>
+</li>
+ <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>
+</ul>
+</li>
+ <li>Koha link
+<ul>
+ <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>
+</ul>
+</li>
+</ul>
+</li>
+ <li>For each subfield you can set the following Other option values
+<ul>
+ <li>Authorized value
+<ul>
+ <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>
+</ul>
+</li>
+ <li>Thesaurus
+<ul>
+ <li>means that the value is not free text, but must be searched in the authority/thesaurus of the selected category</li>
+</ul>
+</li>
+ <li>Plugin
+<ul>
+ <li>means the value is calculated or managed by a plugin. Plugins can do almost anything.</li>
+ <li>Examples:
+<ul>
+ <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>
+ <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>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+ <li>To save your changes simply click the 'Save Changes' button at the top of the screen</li>
+</ul>
+
+<h4>Import/Export Frameworks</h4>
+
+<p>Next to each framework is a link to either import or export the framework.</p>
+
+<h5>Export Framework</h5>
+
+<p>To export a framework simply click the 'Export' link to the right of framework title.</p>
+
+<p>When you click 'Export' you will be prompted to choose what format to export the file in.</p>
+
+<p>A framework exported this way can be imported into any other Koha installation using the import framework option.</p>
+
+<h5>Import Framework</h5>
+
+<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>
+
+<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>
+
+<p>You will be prompted to find a file on your computer to import into the framework.</p>
+
+<p>You will be asked to confirm your actions before the file is imported.<p>
+
+<p>As your file is uploaded you will see an image that will confirm that the system is working.<p>
+
+<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>
+
<p><strong>See the full documentation for Frameworks in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/catadmin.html#marcbibframeworks">manual</a> (online).</strong></p>
[% INCLUDE 'help-bottom.inc' %]
\ No newline at end of file
<h2>Columns settings</h2>
-<p>This administration area will help you hide or display columns on fixed tables throughout the staff client. Right now there is only one table, the currencies table, you can control with this, but more will come.</p>
+<p>This administration area will help you hide or display columns on fixed tables throughout the staff client.</p>
-<p>Clicking on the module you'd like to edit tables for will show you the options available to you. Right now only 'Administration' has any options.</p>
+<p>Clicking on the module you'd like to edit tables for will show you the options available to you.</p>
-<p>This area lets you control the columns that show in the Currency admin area. If nothing is hidden you will see no check marks and will see all of the columns when viewing the table.</p>
+<p>This area lets you control the columns that show several of the modules in Koha. If nothing is hidden you will see no check marks and will see all of the columns when viewing the table.</p>
<p>If columns are hidden they will be checked off and hidden when you view the table.</p>
-<p>You can also toggle columns using the 'Show/Hide Columns button in the top right of the page.</p>
+<p>You can also toggle columns using the 'Show/Hide Columns' button in the top right of the page you altered the columns for.</p>
<p><strong>See the full documentation for Columns settings in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/additionaladmin.html#admincolumns">manual</a> (online).</strong></p>
<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>
<ul>
- <li>Each field has a tag (which is the MARC tag)
+ <li>Each field has a tag (which is the MARC tag) that is uneditable
<ul>
- <li>The 'Label for lib' is what will show in the staff client if you have advancedMARCeditor set to display labels</li>
- <li>The 'Label for OPAC' is what will show on the MARC view in the OPAC</li>
- <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>
- <li>If you check 'Mandatory' the record will not be allowed to save unless you have a value assigned to this tag</li>
- <li>'Authorized value' is where you define an authorized value that your catalogers can choose from a pull down to fill this field in
-To edit the subfields associated with the tag, click 'Subfields' to the right of the tag on the 'MARC Structure' listing</li>
+ <li>The 'Label for lib' is what will show in the staff client if you have advancedMARCeditor set to display labels</li>
+ <li>The 'Label for OPAC' is what will show on the MARC view in the OPAC</li>
+ <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>
+ <li>If you check 'Mandatory' the record will not be allowed to save unless you have a value assigned to this tag</li>
+ <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>
</ul>
</li>
- <li>From the list of subfields you can click 'Delete' to the right of each to delete the subfields</li>
- <li>To edit the subfields click 'Edit Subfields'</li>
- <li>For each subfield you can set the following values
+</ul>
+
+<p>To edit the subfields associated with the tag, click 'Subfields' to the right of the tag on the 'MARC Structure' listing</p>
+
<ul>
- <li>Text for librarian
+ <li>From the list of subfields you can click 'Delete' to the right of each to delete the subfields</li>
+ <li>To edit the subfields click 'Edit Subfields'</li>
+ <li>For each subfield you can set the following Basic constraint values
<ul>
- <li>what appears before the subfield in the librarian interface</li>
+ <li>Text for librarian
+<ul>
+ <li>what appears before the subfield in the librarian interface</li>
</ul>
</li>
- <li>Text for OPAC
+ <li>Text for OPAC
+<ul>
+ <li>what appears before the field in the OPAC.
<ul>
- <li>what appears before the field in the OPAC.</li>
- <li>If left empty, the text for librarian is used instead</li>
+ <li>If left empty, the text for librarian is used instead</li>
</ul>
</li>
- <li>Repeatable
-<ul>
- <li>the field will have a plus sign next to it allowing you to add multiples of that tag</li>
</ul>
</li>
- <li>Mandatory
+ <li>Repeatable
<ul>
- <li>the record will not be allowed to save unless you have a value assigned to this tag</li>
+ <li>the field will have a plus sign next to it allowing you to add multiples of that tag</li>
</ul>
</li>
- <li>Managed in tab
+ <li>Mandatory
<ul>
- <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>
+ <li>the record will not be allowed to save unless you have a value assigned to this tag</li>
</ul>
</li>
-</ul>
-<ul>
- <li>Default value
+ <li>Managed in tab
<ul>
- <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>
+ <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>
</ul>
</li>
</ul>
+</li>
+ <li>For each subfield you can set the following Advanced constraint values
<ul>
- <li>Visibility
+ <li>Default value
<ul>
- <li>Allows you to set the visibility options for a MARC field.</li>
- <ul>
- <li><strong>OPAC</strong> - Checking this box determines whether the subfield is visible in the public interface. Unchecking it hides the field in the public interface.</li>
- <li><strong>Intranet</strong> - Checking this box determines whether the subfield is visible in the staff interface. Unchecking it hides the field in the staff interface.</li>
- <li><strong>Editor</strong> - Checking this box makes the subfield available to the MARC editor. Unchecking it indicates the field should not be shown in the editor.</li>
- <li><strong>Collapsed</strong> - Checking this box determines whether the subfield is expanded or collapsed in the MARC editor; the subfield will appear as a clickable link to expand and edit the subfield. Unchecking it indicates that the field will be expanded by default.</li>
- <li><strong>Flagged</strong> - This setting is exclusive of all other visibility options, and flags the field.</li>
+ <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>
</ul>
</li>
-</ul>
-<ul>
- <li>Max length
+ <li>Visibility
<ul>
- <li>Set the max characters allowed for the subfield. If empty or 0, it defaults to 9999.</li>
+ <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>
</ul>
</li>
-</ul>
+ <li>Is a URL
<ul>
- <li>Is a url
-<ul>
- <li>if checked, it means that the subfield is a url and can be clicked</li>
+ <li>if checked, it means that the subfield is a URL and can be clicked</li>
</ul>
</li>
-</ul>
-<ul>
- <li>Link
+ <li>Link
<ul>
- <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 :
+ <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 :
<ul>
- <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>
- <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>
+ <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>
+ <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>
</ul>
</li>
- <li style="color: #990000;">NOTE: If you change this value you must ask your administrator to run misc/batchRebuildBiblioTables.pl.</li>
+ <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>
</ul>
</li>
-</ul>
-<ul>
- <li>Koha link
+ <li>Koha link
<ul>
- <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>
+ <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>
</ul>
</li>
</ul>
+</li>
+ <li>For each subfield you can set the following Other option values
<ul>
- <li>Authorized value
+ <li>Authorized value
<ul>
- <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>
- <li>In the example above, the 504a field will show the MARC504 Authorized Values when cataloging</li>
+ <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>
</ul>
</li>
-</ul>
-<ul>
- <li>Thesaurus
+ <li>Thesaurus
<ul>
- <li>means that the value is not free text, but must be searched in the authority/thesaurus of the selected category</li>
+ <li>means that the value is not free text, but must be searched in the authority/thesaurus of the selected category</li>
</ul>
</li>
-</ul>
+ <li>Plugin
<ul>
- <li>Plugin
+ <li>means the value is calculated or managed by a plugin. Plugins can do almost anything.</li>
+ <li>Examples:
<ul>
- <li>means the value is calculated or managed by a plugin. Plugins can do almost anything.</li>
- <li>For example, 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>
+ <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>
+ <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>
+</ul>
+</li>
</ul>
</li>
</ul>
</li>
- <li>To save your changes simply click the 'Save Changes' button at the top of the screen</li>
+ <li>To save your changes simply click the 'Save Changes' button at the top of the screen</li>
</ul>
<p><strong>See the full documentation for MARC Frameworks in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/catadmin.html#marcbibframeworks">manual</a> (online).</strong></p>
<p>This will open up a blank form for entering MARC field data</p>
<p>Enter the information about your new tag:</p>
-
<ul>
- <li>The 'Tag' is the MARC field number</li>
- <li>The 'Label for lib' is the text that will appear in the staff client when in the cataloging module</li>
- <li>The 'Label for OPAC' is the text that will appear in the OPAC when viewing the MARC version of the record</li>
- <li>If this field can be repeated, check the 'Repeatable' box</li>
- <li>If this field is mandatory, check the 'Mandatory' box</li>
- <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>
+ <li>The 'Tag' is the MARC field number</li>
+ <li>The 'Label for lib' is the text that will appear in the staff client when in the cataloging module</li>
+ <li>The 'Label for OPAC' is the text that will appear in the OPAC when viewing the MARC version of the record</li>
+ <li>If this field can be repeated, check the 'Repeatable' box</li>
+ <li>If this field is mandatory, check the 'Mandatory' box</li>
+ <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>
</ul>
<p>When you're finished, click 'Save Changes' and you will be presented with your new field</p>
-<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.</p>
+<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>
<p><strong>See the full documentation for MARC Frameworks in the <a href="http://manual.koha-community.org/[% helpVersion %]/en/catadmin.html#marcbibframeworks">manual</a> (online).</strong></p>
</ul>
</li>
<li>If 'Unique identifier' is checked, the attribute will be a unique identifier which means, if a value is given to a patron record, the same value cannot be given to a different record.
+ <li>Unique attributes can be used as match points on the patron import tool</li>
<ul>
<li style="color: #990000;">Important: This setting cannot be changed after an attribute is defined</li>
</ul>
<li>If you're allowing renewals you can control how soon before the due date patrons can renew their materials with the 'No renewals before' box.
<ul><li>Items can be renewed at any time if this value is left blank. Otherwise items can only be renewed if the item is before the number in units (days/hours) entered in this box.</li></ul></li>
<li>You can enable automatic renewals for certain items/patrons if you'd like. This will renew automatically following your circulation rules unless there is a hold on the item
- <ul><li style="color: #990000;">Important: You will need to enable the automatic renewal cron job for this to work.</li></ul>
+ <ul>
+ <li style="color: #990000;">Important: You will need to enable the automatic renewal cron job for this to work.</li>
+ <li style="color: #990000;">Important: This feature needs to have the "no renewal before" column filled in or it will auto renew everyday after the due date.</li>
+ </ul>
</li>
<li>If the patron can place holds on this item type, enter the total numbers of items (of this type) that can be put on hold in the 'Holds Allowed' field</li>
+ <li>Next you can decide if this patron/item combo are allowed to place holds on items that are on the shelf (or available in the library) or not. If you choose 'no' then items can only be placed on hold if checked out</li>
+ <li>You can also decide if patrons are allowed to place item specific holds on the item type in question. The options are:
+ <ul>
+ <li>Allow: Will allow patrons the option to choose next available or item specific</li>
+ <li>Don't allow: Will only allow patrons to choose next available</li>
+ <li>Force: Will only allow patrons to choose an specific item</li>
+ </ul></li>
<li>Finally, if you charge a rental fee for the item type and want to give a specific patron type a discount on that fee, enter the percentage discount (without the % symbol) in the 'Rental Discount' field</li>
</ul>
projects / koha-equinox.git / commitdiff