Difference between revisions of "Add/edit terms"

From ICA-AtoM
Jump to navigation Jump to search
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<span class="pageTitle">Edit taxonomies (terms)</span>
+
{{DISPLAYTITLE:Terms}}
  
[[Main Page]] > [[User manual|(UM) User manual]] > [[UM-3|UM-3 Add / edit content]] > UM-3.5 Edit taxonomies (terms)
 
  
== Overview ==
+
[[Main Page]] > [[User manual]] > [[Add/edit content]] > Add/edit terms
  
[[Image:um3-5Taxonomy.png|500px|right|thumb|Drop-down value lists draw terms from taxonomies]]
 
  
Throughout ICA-AtoM, [[Glossary#Controlled vocabulary|controlled vocabularies]] are used to generate drop-down [[Glossary#Value list|value lists]] to restrict data entry in certain fields to certain values. ICA-AtoM stores these values as [[Glossary#Term|term]] records in the database, and assigns them to [[Glossary#Taxonomy|taxonomies]].
+
[[Image:valueList.png|500px|right|thumb|Value lists in drop-down menus draw terms from taxonomies]]
  
*E.g. the "Type of entity" field of an [[Glossary#Authority record|authority record]] can take only one of ''Corporate body, Person, Family''. Each of these values is a [[Glossary#Term|term]] assigned to the "Actor entity types" [[Glossary#Taxonomy|taxonomy]].
+
As defined in our documentation glossary, a [[Glossary#Taxonomy|taxonomy in AtoM is “a grouping of controlled-vocabulary terms used to generate value lists and access points.” Throughout ICA-AtoM, [[Glossary#Controlled vocabulary|controlled vocabularies]] are used to generate [[Glossary#Drop-down menu|drop-down menus]]. These provide [[Glossary#Value list|value lists]] that restrict data entry in certain [[Glossary#Field|fields]] to certain values. A value list is defined in our glossary as restricting “data entry in certain fields to controlled vocabulary terms or terms derived from authority records. They appear as drop-down menus in edit pages.”  ICA-AtoM typically stores these values as [[Glossary#Term|term]] records in the database, and assigns them to [[Glossary#Taxonomy|taxonomies]], e.g. the type of entity [[Glossary#Field|field]] of an [[Glossary#Authority record|authority record]] can take only one of "corporate body, person, family." Each of these values is a [[Glossary#Term|term]] assigned to the actor entity types [[Glossary#Taxonomy|taxonomy]]. All controlled vocabularies are managed via taxonomies in AtoM, accessible to authorized users via the Manage > Taxonomies menu
  
 +
ICA-AtoM ships with a fixed number of [[Glossary#Taxonomy|taxonomies]] containing default values ([[Glossary#Term|terms]]). Some [[Glossary#Term|terms]] are locked, i.e. cannot be edited or deleted, because they are used by the application's underlying code. Most [[Glossary#Term|terms]], however, can be edited or deleted, and all [[Glossary#Taxonomy|taxonomies]] can be assigned new [[Glossary#Term|terms]] in addition to any locked values.
  
ICA-AtoM ships with a fixed number of [[Glossary#Taxonomy|taxonomies]] containing default values ([[Glossary#Term|terms]]). Some [[Glossary#Term|terms]] are '''locked''', i.e. cannot be deleted or edited, because they are accessed by the application's underlying code. Most [[Glossary#Term|terms]], however, can be edited or deleted, and all [[Glossary#Taxonomy|taxonomies]] can be assigned new [[Glossary#Term|terms]] in addition to any locked values.
+
<div class="text-alert">
 +
<h3>An Example of a locked  taxonomy: Material Type</h3>
 +
Material type is a controlled vocabulary that supports our Canadian Rules for Archival Description (RAD) template. A complete version of RAD is available from the Canadian Council on Archives here: http://www.cdncouncilarchives.ca/archdesrules.html
  
*Note that users (even [[Glossary#Administrator|administrators]]) '''cannot''' add new [[Glossary#Taxonomy|taxonomies]]; the number and names of [[Glossary#Taxonomy|taxonomies]] are fixed and can only be altered by [[Glossary#Developer|developers]] working directly with the code.
+
Section 1.1C of RAD defines an optional additional to an archival description, the General Material Designation (GMD). The list of approved terms for a GMD description is provided in 1.1C1 of RAD, and conforms to the terms available in the AtoM Material Type taxonomy. As such, when a user sets the Default template in AtoM to RAD instead of ISAD(G), the template provides different fields (including different controlled drop down lists) to support the differences between the two descriptive standards. In the RAD description template, the General Material designation is a repeatable field with a controlled list of drop-down terms – the list of these terms is maintained and managed in the Material Type taxonomy.  
  
 +
These terms, or this descriptive practice, are not formally recommended within ISAD(G), and consequently, are not provided anywhere in the descriptive template. In ISAD(G), this information is captured via free-text in sections such as 3.1.5 Extent and Medium, and possibly other related fields (such as 3.4.4 Physical characteristics and technical requirements)
 +
</div>
  
This page describes how to edit [[Glossary#Taxonomy|taxonomies]] by adding, editing or deleting their [[Glossary#Term|terms]]. Note that you must have at least [[Glossary#Editor|editor access privileges]] to edit [[Glossary#Taxonomy|taxonomies]]. For detailed notes on individual fields, see the following pages:
+
By allowing authorized administrators access to all taxonomies, users have the ability to customize descriptive templates to meet local or regional descriptive practices, or to remove controlled field terms that are not in use within the institution. This ability to customize is one of the strengths of AtoM as a freely available open-source software application.
*[[UM-3.5.1|Data entry: terms]].
 
  
For exiting [[Glossary#Edit mode|edit mode]] (return to the [[Glossary#View mode|view mode]]), see the following page:
 
*[[UM-3.6|Exit edit mode (same for all record types)]].
 
  
 +
<div class="note">
  
== Add a term to a taxonomy ==
+
Users (even [[Glossary#Administrator|administrators]]) cannot add new [[Glossary#Taxonomy|taxonomies]]; the number and names of [[Glossary#Taxonomy|taxonomies]] are fixed and can only be altered by [[Glossary#Developer|developers]] working directly with the code.
  
[[Image:um3-1Create1.png|500px|right|thumb|Create a new description]]
+
</div>
  
[[Image:um3-1Create2.png|500px|right|thumb|Create a new description]]
 
  
1. Click the [[Glossary#Add / edit tab|Add / edit tab]] on the [[Glossary#Main menu bar|Main menu bar]].
+
== Actions ==
  
 +
* [[Add a new term]]
 +
* [[Edit a term]]
 +
* [[Delete a term]]
  
2. Click the "Term" sub-tab on the [[Glossary#Main menu bar|Main menu bar]]; ICA-AtoM takes you to the [[Glossary#List screen|List taxonomy terms screen]] showing all existing [[Glossary#Taxonomy|taxonomies]].
 
  
 +
== Data entry ==
  
3. Click a [[Glossary#Taxonomy|taxonomy]] to expand it and view the [[Glossary#Term|terms]] associated with it.
+
[[Term data entry]]
  
  
4. Click the [[Glossary#Add new button|Add new button]] to add a new term to the [[Glossary#Taxonomy|taxonomy]]. ICA-AtoM routes you to the [[Glossary#Edit screen|Edit screen]] for data entry.
+
== [[Hierarchical taxonomies]] ==
  
  
5. Enter data (see [[UM-3.5.1|Data entry: terms]] for detailed explanations and notes on fields).
+
== See also ==
  
 +
[[Exit edit mode]] (same for all record types)
  
6. Click the [[Glossary#Save button|Create button]] to commit the new record.
 
  
 +
[[Category:User manual]]
  
7. ICA-AtoM returns you to the [[Glossary#List screen|List taxonomy terms screen]].
+
__NOTOC__
 
 
<br clear=right>
 
== Edit an existing taxonomy ==
 
 
 
[[Image:um3-5Edit1.png|500px|right|thumb|Edit an existing taxonomy]]
 
 
 
[[Image:um3-5Edit2.png|500px|right|thumb|Edit an existing taxonomy]]
 
 
 
 
 
1. Click the [[Glossary#Add / edit tab|Add / edit tab]] on the [[Glossary#Main menu bar|Main menu bar]].
 
 
 
 
 
2. Click the "Term" sub-tab on the [[Glossary#Main menu bar|Main menu bar]]; ICA-AtoM takes you to the [[Glossary#List screen|List taxonomy terms screen]] showing all existing [[Glossary#Taxonomy|taxonomies]].
 
 
 
 
 
3. Click the [[Glossary#Taxonomy|taxonomy]] you want to edit to expand it and view the [[Glossary#Term|terms]] associated with it.
 
 
 
 
 
4. [[Glossary#Term|Terms]] that appear in black with a lock icon are '''locked''' and cannot be edited.
 
 
 
 
 
5. [[Glossary#Term|Terms]] that appear in blue can edited; click an editable [[Glossary#Term|term]].
 
 
 
 
 
6. Add / revise data as required (see [[UM-3.5.1|Data entry: terms]] for detailed explanations and notes on fields).
 
 
 
 
 
7. To discard all changes, click the [[Glossary#Cancel button|Cancel button]]; ICA-AtoM returns you to a [[Glossary#List screen|List screen]] showing only terms associated with the current [[Glossary#Taxonomy|taxonomy]], no changes saved.
 
 
 
 
 
8. To save changes, click the [[Glossary#Save button|Save button]]; ICA-AtoM commits the changes and routes you to a [[Glossary#List screen|List screen]] showing only terms associated with the current [[Glossary#Taxonomy|taxonomy]], any changes saved.
 
 
 
 
 
9. Repeat with other [[Glossary#Term|terms]] to continue editing the [[Glossary#Taxonomy|taxonomy]].
 
 
 
 
 
10. Click the [[Glossary#List all|List all button]] to return to the [[Glossary#List screen|List taxonomy terms screen]].
 
 
 
<br clear=right>
 
== Delete an existing description ==
 
 
 
[[Image:um3-1Delete.png|500px|right|thumb|Delete an existing description]]
 
 
 
To delete an archival description:
 
 
 
 
 
1. Click the [[Glossary#Add / edit tab|Add / edit tab]] on the [[Glossary#Main menu bar|Main menu bar]].
 
 
 
 
 
2. Click the "Term" sub-tab on the [[Glossary#Main menu bar|Main menu bar]]; ICA-AtoM takes you to the [[Glossary#List screen|List taxonomy terms screen]] showing all existing [[Glossary#Taxonomy|taxonomies]].
 
 
 
 
 
3. Click the [[Glossary#Taxonomy|taxonomy]] you want to edit to expand it and view the [[Glossary#Term|terms]] associated with it.
 
 
 
 
 
4. Click the [[Glossary#Term|term]] you want to delete from the taxonomy (locked terms cannot be deleted). ICA-AtoM displays the [[Glossary#Term|term]] in [[Glossary#Edit mode|edit mode]] ([[Glossary#Edit screen|Edit screen]]).
 
 
 
 
 
5. Click the [[Glossary#Delete button|Delete button]].
 
 
 
 
 
6. ICA-AtoM prompts you to confirm the delete request; click "OK".
 
 
 
 
 
7. ICA-AtoM deletes the record and returns you to the [[Glossary#List screen|List taxonomy terms screen]].
 
 
 
 
 
8. Note that you '''cannot delete a term that has been used as a value in another record'''. Attempting to do so will generate an [[Glossary#Error message|error message]].
 
 
 
*E.g. you try to delete ''Sub-fonds'' from the "Levels of description" [[Glossary#Taxonomy|taxonomy]], but you get an if an [[Glossary#Error message|error message]]; this means one or more [[Glossary#Archival description|archival descriptions]] has ''Sub-fonds'' as the value of the "Level of description" field.
 
 
 
*As of the current version of ICA-AtoM (v0.6), the delete error message is not very information and only tells that an error has occurred but not which error or why; this will be addressed in a future release (post-1.0).
 
 
 
<br clear="right">
 
<span class="revised">Last revised: 2 June 2008 (ICA-AtoM v0.6)</span>
 

Latest revision as of 14:09, 23 January 2013

Please note that ICA-AtoM is no longer actively supported by Artefactual Systems.
Visit https://www.accesstomemory.org for information about AtoM, the currently supported version.


Main Page > User manual > Add/edit content > Add/edit terms


Value lists in drop-down menus draw terms from taxonomies

As defined in our documentation glossary, a [[Glossary#Taxonomy|taxonomy in AtoM is “a grouping of controlled-vocabulary terms used to generate value lists and access points.” Throughout ICA-AtoM, controlled vocabularies are used to generate drop-down menus. These provide value lists that restrict data entry in certain fields to certain values. A value list is defined in our glossary as restricting “data entry in certain fields to controlled vocabulary terms or terms derived from authority records. They appear as drop-down menus in edit pages.” ICA-AtoM typically stores these values as term records in the database, and assigns them to taxonomies, e.g. the type of entity field of an authority record can take only one of "corporate body, person, family." Each of these values is a term assigned to the actor entity types taxonomy. All controlled vocabularies are managed via taxonomies in AtoM, accessible to authorized users via the Manage > Taxonomies menu

ICA-AtoM ships with a fixed number of taxonomies containing default values (terms). Some terms are locked, i.e. cannot be edited or deleted, because they are used by the application's underlying code. Most terms, however, can be edited or deleted, and all taxonomies can be assigned new terms in addition to any locked values.

An Example of a locked taxonomy: Material Type

Material type is a controlled vocabulary that supports our Canadian Rules for Archival Description (RAD) template. A complete version of RAD is available from the Canadian Council on Archives here: http://www.cdncouncilarchives.ca/archdesrules.html

Section 1.1C of RAD defines an optional additional to an archival description, the General Material Designation (GMD). The list of approved terms for a GMD description is provided in 1.1C1 of RAD, and conforms to the terms available in the AtoM Material Type taxonomy. As such, when a user sets the Default template in AtoM to RAD instead of ISAD(G), the template provides different fields (including different controlled drop down lists) to support the differences between the two descriptive standards. In the RAD description template, the General Material designation is a repeatable field with a controlled list of drop-down terms – the list of these terms is maintained and managed in the Material Type taxonomy.

These terms, or this descriptive practice, are not formally recommended within ISAD(G), and consequently, are not provided anywhere in the descriptive template. In ISAD(G), this information is captured via free-text in sections such as 3.1.5 Extent and Medium, and possibly other related fields (such as 3.4.4 Physical characteristics and technical requirements)

By allowing authorized administrators access to all taxonomies, users have the ability to customize descriptive templates to meet local or regional descriptive practices, or to remove controlled field terms that are not in use within the institution. This ability to customize is one of the strengths of AtoM as a freely available open-source software application.


Users (even administrators) cannot add new taxonomies; the number and names of taxonomies are fixed and can only be altered by developers working directly with the code.


Actions


Data entry

Term data entry


Hierarchical taxonomies

See also

Exit edit mode (same for all record types)