Home | Resources | Services | Hosting | Publications | Collaboration | Joining CERL | About CERL |

You are here:: Home » CERL Resources » CERL Thesaurus » Editing the CERL Thesaurus » Guide to Editing the CERL Thesaurus 

Editing the CT Format Description Printers' Records Indexing Principles CERL Thesaurus

News|Contact|Index|

 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
resources:cerl_thesaurus:editing:newinterface [2018/03/20 19:20] – [2.3 Using search keys] jahnkeresources:cerl_thesaurus:editing:newinterface [2018/03/27 14:28] – [4.3 Using the CT Internal Format Editor] jahnke
Line 120: Line 120:
 |placeName|search only within the names (headings and variants) of places \\ ''placeName:hamburg''| |placeName|search only within the names (headings and variants) of places \\ ''placeName:hamburg''|
 |personalName|search only within the names (headings and variants) of persons \\ personalName:aristoteles| |personalName|search only within the names (headings and variants) of persons \\ personalName:aristoteles|
-|record_flag|search for records bearing a specific marker|+|record_flag|search for records bearing a specific marker \\ ''record_flag:ba18''| 
 +|related_to|search for records that link to the given record id. There is a number of search keys that allow for more detailled searches for certain relationship types, which are not listed here. \\ ''related_to:cnl00032270''|
 |sign|search within the sign/marks/devices fields \\ ''sign:tortuga''| |sign|search within the sign/marks/devices fields \\ ''sign:tortuga''|
 |type|search for a certain record type \\ type:cnp| |type|search for a certain record type \\ type:cnp|
 |year_end|search for entities whose activity or existence ended before, in or after a certain year \\ ''year_end:>1800'' \\ year_end:<1500| |year_end|search for entities whose activity or existence ended before, in or after a certain year \\ ''year_end:>1800'' \\ year_end:<1500|
 |year_start|search for entities whose activity or existence started before, in or after a certain year \\ ''year_start:[1530 TO 1560]''| |year_start|search for entities whose activity or existence started before, in or after a certain year \\ ''year_start:[1530 TO 1560]''|
 +
 +a complete list of available search keys can be found here: [[indexing]]
  
 ==== 2.4 Working with the Search History ==== ==== 2.4 Working with the Search History ====
Line 176: Line 179:
 3.10 Other Formats 3.10 Other Formats
  
-4 Editing the CERL Thesaurus+===== 4 Editing the CERL Thesaurus ===== 
 + 
 +{{ :resources:cerl_thesaurus:editing:editing1.png?300|editing}} 
 + 
 +At the bottom of every record you will find the buttons that allow you to edit the data in the CERL Thesaurus (if you have the necessary access rights, that is). This follows the principle that things that are important to every user are placed on the top of the screen and items that are of importance only to the CERL appointed editors are a bit more hidden away at the bottom. 
 + 
 +Depending on your editing rights, there can be up to three icons: 
 + 
 +The rightmost, that shows a small rubbish bin, will **delete** the record. Please be careful with this one, you will be asked for confirmation (twice, acutally) before the record is deleted, but once you have confirmed that, it is gone for good. 
 + 
 +The middle one, showing two sheets of paper, will make a **copy** of the record and open it in the form based editor. This might be useful if you are creating a number of very similar records and want to save some time typing the same things in over and over. Although, this is probably more of use in the other databases living in this hosting environment than to the CERL Thesaurus. 
 + 
 +The leftmost button, showing a notepad and a pencil, will open the current record for **editing**. There are currently four different editors available, according to your editing rights you will presented a list where you can pick the one that is best for what you want to do with the record. 
 + 
 + 
 +==== 4.1 Selecting an Editor ==== 
 +{{ :resources:cerl_thesaurus:editing:editing2.png?300|Choose and editing client}} 
 + 
 +If your account has complete editing rights on the CERL Thesaurus, you will be shown the following selection of editing clients. Each of it has its strengths and weaknesses and you may want to choose the client you want to use according to the things you want to edit in the record and according to how close you feel to the Thesaurus's internal format. 
 + 
 + 
 +==== 4.2 Using the Form Based Editor ==== 
 +{{  :resources:cerl_thesaurus:editing:editing3.png?300|Form Based Editor}} 
 + 
 +The form based editor presents the record in a web form where each data element is in a separate field and where each field has a plain text label. If you are not (yet) very familiar with the CERL Thesaurus format or want to enter a new record from scratch, this editor might be a good choice. On the other hand, the record structure of the Thesaurus is quite complex and records can get rather lengthy, which can lead to enormously long forms that can be difficult to navigate. 
 + 
 +The form consists of two main parts: data about the entity that the record describes (the actual "content" of the record) and data about the record itself. Both are folded by default, click on a part to open it. 
 + 
 +{{ :resources:cerl_thesaurus:editing:editing4.png?300|Form based editor}} 
 + 
 +The part //Desription of the Record// holds the record status, the internal (cataloguer's) note field, any internal record flags, information about definite, possible and definitely not duplicates and the editing history. 
 + 
 +Fields you cannot edit, like the editing history, have a pale grey background. 
 + 
 +Fields may contain subfields. In these cases subfields are contained in a separate sub-form, which by default is also folded, so you can only see the fields title. You will recognise these folded subforms by a little black downward pointing error on the left side. Click on the field's title to open the subform. A subform has an elegant grey background to make what belongs together more visible. 
 + 
 +A big blue plus-sign on the right of a field means that this field is repeatable and that you can add another field of this kind by clicking on it. Please note that in order to add an additional complex sub-form, you have to open the last sub-form to find the blue plus-button. When adding additonal fields, the order of fields is kept as it is in the form. So, if you want to add a new "possible duplicate" field at the end of the list, click the plus-botton next to the last "possible duplicate" field - if you want to add one, say, after the first field, click the plus-button next to the first "possible duplicate" field. 
 + 
 +When done editing, click the green //Save// button at the bottom of the form, or //Cancel// if you want to discard your changes. 
 + 
 +==== 4.3 Using the CT Internal Format Editor ==== 
 + 
 +{{ :resources:cerl_thesaurus:editing:editing6.png?300|FLC Editor}} 
 + 
 +The "Internal Format" editor allows to edit the CERL Thesaurus data in the same Unimarc based field format as it has been the case in the old Avanti environment. It's called "Internal Format" since this has been the internal format in the old system and is still used for a ingesting and update, although the actual internal format is quite different now (JSON).  
 + 
 +The format description and input conventions can be found [[format|here]]. Different from the old WinADH client, the Internal Format editor is used for editing records only - for merging duplicate records there is now a different editor available (see below). 
 + 
 +There is also no input validation implemented yet, any invalid fields, indicator positions or subfields will be silently ignored when the data is converted to JSON, so make sure to check from the record's full display if all information has been entered correctly. 
 + 
 + 
 +==== 4.4 Using the YAML Editor ====
  
-4.1 Selecting an Editor+{{ :resources:cerl_thesaurus:editing:editing5.png?300|yaml editor}}
  
-4.2 Using the Form Based Editor+The YAML editor is the most powerfull of the available editing clients. It allows you to directly manipulate the internal data structure and you should use it only if you know exactly what you are doing. 
  
-4.3 Using the CT Internal Format Editor+Internally records are stored in [[https://en.wikipedia.org/wiki/JSON|JSON]] - YAML is a way to represent JSON data structures in a conveniently readable form((actually, YAML can do more than that, but since we have to transform our record back to JSON to store and process them, we will limit ourselves to this aspect of it)), replacing all the curly brackets with indentations (use blanks, not tab stops!) and the square ones with hyphens. Before you are using this editing client, get familiar with the basic [[https://en.wikipedia.org/wiki/YAML#Syntax|YAML Syntax]].
  
-4.4 Using the YAML Editor+For longer records, you can switch the editor to full screen mode by pressing [F11] or clicking the yellow button labeled "Fullscreen". To return to normal mode press [F11] again or [ESC].
  
-4.5 Deduplicating Records+If you are trying to save your record, but nothing happens, you have most likely made an error with the YAML-Syntax. Since the editor does not yet return a validation report, you may try copying the record into an external validator (e.g. [[http://www.yamllint.com/]]) to see what went wrong. 
 +==== 4.5 Deduplicating Records ====
 resources/cerl_thesaurus/editing/newinterface.txt · Last modified: 2023/12/11 15:13 by jahnke

 

 

Recent changes RSS feed Valid XHTML 1.0 Driven by DokuWiki