From e23d103f2cf21b8e906fca5b94499422abc13ced Mon Sep 17 00:00:00 2001 From: Teresa Mayfield-Meyer Date: Thu, 10 Aug 2023 09:36:34 -0600 Subject: [PATCH] Update How-to-Create-and-Manage-Geology-Terms.markdown Updating for complete overhaul of UI, but still needs work. https://github.com/ArctosDB/documentation-wiki/issues/300 --- ...o-Create-and-Manage-Geology-Terms.markdown | 123 ++++++------------ 1 file changed, 37 insertions(+), 86 deletions(-) diff --git a/_how_to/How-to-Create-and-Manage-Geology-Terms.markdown b/_how_to/How-to-Create-and-Manage-Geology-Terms.markdown index a98045e4..ed2c4c60 100644 --- a/_how_to/How-to-Create-and-Manage-Geology-Terms.markdown +++ b/_how_to/How-to-Create-and-Manage-Geology-Terms.markdown @@ -7,136 +7,87 @@ layout: default_toc ![](https://raw.githubusercontent.com/ArctosDB/documentation-wiki/gh-pages/tutorial_images/Bear%20Work%20in%20Progress.JPG) -# How To Create and Manage Geology Terms - -This guide provides step-by-step instructions for creating and managing geology terms and relationships in the [Geology Attributes Code Table](http://arctos.database.museum/info/ctDocumentation.cfm?table=CTGEOLOGY_ATTRIBUTE). In order to access the functions described in this How To, an Arctos Operator must have [MANAGE_CODETABLES](http://arctos.database.museum/Admin/user_roles.cfm) access. If you need a new term added to the code table and you do not have appropriate access, please file a new [Authority Request](https://github.com/ArctosDB/arctos/issues/new?assignees=&labels=&template=authority-request.md&title=) in [Arctos GitHub Issues](https://github.com/ArctosDB/arctos/issues) - -## Create a New Term - -To create a new geology term, from the Arctos main menu select Manage Data > Metadata > Code Tables - - - -Scroll down the list of Code Tables to CTGEOLOGY_ATTRIBUTE and select that table by clicking the link (or go directly to [CTGEOLOGY_ATTRIBUTE](http://arctos.database.museum/Admin/CodeTableEditor.cfm?action=editGeologyTree)) - - - -You will see the data entry form for a new geology attribute - - +### [Update Request Github Issue](https://github.com/ArctosDB/documentation-wiki/issues/300) -In order to create a new term, all fields must be completed - -### Attribute - - - -The Attribute term is a category to which the term you are adding belongs. If you begin typing in this field, a list of attributes that already exist in the table and closely match what you are typing will appear. +# How To Create and Manage Geology Terms -![](https://raw.githubusercontent.com/ArctosDB/documentation-wiki/gh-pages/tutorial_images/Bear%20Caution.jpg) **CAUTION** +This guide provides step-by-step instructions for creating and managing geology terms and relationships in the Geology Attributes Code Tables. - Take care when entering an attribute that you don't misspell an attribute that already exists or create an attribute that is a synonym for existing attributes. +Purpose | Table +Locality Attribute: Eons/Eonothems | [ctchronostrat_eon_eonothem](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctchronostrat_eon_eonothem) +Locality Attribute: Eras/Erathems | [ctchronostrat_era_erathem](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctchronostrat_era_erathem) +Locality Attribute: Series/Epochs | [ctchronostrat_series_epoch](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctchronostrat_series_epoch) +Locality Attribute: Stages/Ages | [ctchronostrat_stage_age](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctchronostrat_stage_age) +Locality Attribute: Substages/Subages | [ctchronostrat_substage_subage](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctchronostrat_substage_subage) +Locality Attribute: Systems/Periods | [ctchronostrat_system_period](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctchronostrat_system_period) +Locality Attribute: Informal Chronostratigraphy | [ctchronostrat_informal](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctchronostrat_informal) +Locality Attribute: Biochronology | [ctbiochronology](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctbiochronology) +Locality Attribute: Biostratigraphic Zones | [ctbiostratigraphic_zone](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctbiostratigraphic_zone) +Locality Attribute: Lithodemic Suites | [ctlithodemic_suite](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctlithodemic_suite) +Locality Attribute: Lithostratigraphic Groups | [ctlithostratigraphic_group](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctlithostratigraphic_group) +Locality Attribute: Lithostratigraphic Formations | [ctlithostratigraphic_formation](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctlithostratigraphic_formation) +Locality Attribute: Lithostratigraphic Members | [ctlithostratigraphic_member](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctlithostratigraphic_member) +Locality Attribute: Lithostratigraphic Beds | [ctlithostratigraphic_bed](https://arctos.database.museum/info/ctDocumentation.cfm?table=ctlithostratigraphic_bed) -It may help to peruse the code table to see if the attribute you want to use already exists. Think cautiously and critically about new attributes being added to ensure they will be useful to the Arctos Community. Any attributes that will only serve a single collection may belong elsewhere. Please consult with Arctos Community by creating a new [GitHub Issue](https://github.com/ArctosDB/arctos/issues) is you are unsure about adding a new attribute. -**What do I enter in the Attribute field when creating a term for search/code table organization purposes?** +In order to access the functions described in this How To, an Arctos Operator must have [MANAGE_CODETABLES](http://arctos.database.museum/Admin/user_roles.cfm) access. If you need a new term added to the code table and you do not have appropriate access, please file a new [Authority Request](https://github.com/ArctosDB/arctos/issues/new?assignees=&labels=&template=authority-request.md&title=) in [Arctos GitHub Issues](https://github.com/ArctosDB/arctos/issues) -Attribute and Value are always required and value is used in building hierarchies for searching, so " " (a blank space) should be entered in the attribute field for values that are not valid for data entry. (See [Attribute valid for data entry?](https://handbook.arctosdb.org/how_to/How-to-Create-and-Manage-Geology-Terms.html#attribute-valid-for-data-entry)) +## Create a New Term -### Value +**Navigation [Search > Code Tables ](https://arctos.database.museum/info/ctDocumentation.cfm)** - +Scroll down the list of Code Tables to the table that is appropriate for the new term and select the edit button next to it. -The Value is the term you are adding. This is what will be visible in searches and on specimen pages. For some values, the term includes its related attribute. For example, when entering a value for attribute "formation" you would enter "Value Formation". A review of existing code table terms is a good idea to ensure that the value entered will be consistent with other code table values with the same attribute. +### Term -### Attribute valid for data entry? +The new term should be entered into the yellow box at the top of the code table edit page just under the code table name. Take care when entering the term that you don't misspell a term that already exists or create aterm that is a synonym for existing terms. - +This is what will be visible in searches and on specimen pages. For some terms, the term includes its related attribute. For example, when entering a term in the Lithostratigraphic Formation table you would enter "Term Formation". A review of existing code table terms is a good idea to ensure that the term entered will be consistent with other code table values within the same code table. -This field allows you to designate some terms in the code table that will only be used for organization of the code table hierarchy to facilitate searching. For example, "Lithostratigraphy" might be a useful term as the start of a set of hierarchies, but it's not something that can have a meaning in Geology Attributes so should not be "valid." Select "no" for "Attribute valid for Data Entry" for terms of that nature. Note that Attribute and Value are always required and value is used in building hierarchies for searching, so " " (a blank space) should be entered in the attribute field for values that are not valid for data entry. +It may help to peruse the code table to see if the term you want to use already exists. Think cautiously and critically about new terms being added to ensure they will be useful to the Arctos Community. Any terms that will only serve a single collection may belong elsewhere. Please consult with Arctos Community by creating a new [GitHub Issue](https://github.com/ArctosDB/arctos/issues) if you are unsure about adding a new term. ### Description - - The description should be a detailed definition of the term or a link to a website with the definition. It is important to properly document terms in the code table so that users can select appropriate terms. -### Insert Term +#### Github Issue Link - +Following the definition, always include the link to the Github issue that documents the community's agreement to add the term. -When you are satisfied with your entries in all fields, select "Insert Term" to create the new code table term. +### Add Term + +When you are satisfied with your entries in all fields, select "Insert" to create the new code table term. ![](https://raw.githubusercontent.com/ArctosDB/documentation-wiki/gh-pages/tutorial_images/Bear%20Caution.jpg) **CAUTION** Your new term will not be included in any of the hierarchies that exist in the code table. If you want a term to be searchable using a hierarchy, you must create the appropriate relationship. (See [Create Term Relationships](https://handbook.arctosdb.org/how_to/How-to-Create-and-Manage-Geology-Terms.html#create-term-relationships)) ## Manage Terms -Geology terms can be edited if they have not yet been attached to any locality. - -To create a new parent/child relationship, from the Arctos main menu select Manage Data > Metadata > Code Tables +Geology terms can be edited if they have not yet been attached to any locality. Descriptions can be edited at any time, but should only be changed with an approval from the community. Always include the link to the Github issue where any change was discussed. - - -Scroll down the list of Code Tables to CTGEOLOGY_ATTRIBUTE and select that table by clicking the link (or go directly to [CTGEOLOGY_ATTRIBUTE](http://arctos.database.museum/Admin/CodeTableEditor.cfm?action=editGeologyTree)) - - - -You will see the data entry form for a new geology attribute - - - -Scroll down to the code table and find the term that you wish to edit: - - - -Once your edits are complete, select "Save Edits" or "Delete" if you wish to remove the term from the code table. +Once your edits are complete, select "Save" or select "Delete" if you wish to remove the term from the code table. ## Create Term Relationships -To create hierarchies in the geology code table, use the "Create Hierarchies" section to select parent and child terms. To create a new parent/child relationship, from the Arctos main menu select Manage Data > Metadata > Code Tables - - +To create hierarchies between geology attribute code table terms, use the "Manage Metadata" link to select the type of relationship and parent and child terms. -Scroll down the list of Code Tables to CTGEOLOGY_ATTRIBUTE and select that table by clicking the link (or go directly to [CTGEOLOGY_ATTRIBUTE](http://arctos.database.museum/Admin/CodeTableEditor.cfm?action=editGeologyTree)) - - - -You will see the data entry form for a new geology attribute - - - -Scroll down to see the "Create Hierarchies" section: - - - -Both a parent and child term must be entered in the form in order to create a relationship. +Both a parent and child term must be entered in the form in order to create a relationship. Parent or child can be entered in "data_value, depending upon the relationship selected in "meta_type" ![](https://raw.githubusercontent.com/ArctosDB/documentation-wiki/gh-pages/tutorial_images/Bear%20Caution.jpg) **CAUTION** - Take care when selecting both parent and child terms and review your choices before creating the relationship. + Take care when selecting meta_type, data_value and meta_value terms and review your choices before creating the relationship. ### Parent Term - - The "higher" term in the hierarchy. This can also be a "not valid for data entry" term. ### Child Term - - The "lower" term in the hierarchy. This can also be a "not valid for data entry" term. Any terms that are currently children of the term chosen here will move along with this child term to the parent. ### Create Relationship - - -After you have made and reviewed your parent and child terms, select the "Create Relationship" button. Your child term should now appear below the parent term in the code table. +After you have made and reviewed your parent and child terms, select the "Insert" button. Your relationship should now appear in the Metadata column of the code table. ## Edit this Documentation