Differences

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

--- resources:cerl_thesaurus:editing:newinterface [2018/03/20 18:15] – [2.1 Full text search] jahnke
+++ resources:cerl_thesaurus:editing:newinterface [2018/03/27 14:32] – [4.3 Using the CT Internal Format Editor] jahnke
@@ Line 7: / Line 7: @@
 With its migration into the hosting environment, the current editing infrastructure consisting mainly of the WinADH editing client becomes obsolete and can no longer be used. All editing can now done via your web browser. This allows also users of non-Windows operating systems to edit the CT from their computers.
-==== 1.1 Logging in ====
+==== 1.1 Logging in ====
+{{ :resources:cerl_thesaurus:editing:login.png?300|Login}}
 To use the editing facilities in the new web interface you will need a user account for the new hosting environment. The login details for WinADH or the CERL Website will not be recognised by the new system. There is, however, only one account for all databases hosted on http://data.cerl.org ; if you already have an account for the ISTC or MEI, let the database administrator know and they will assign the necessary editing rights to it.
@@ Line 19: / Line 20: @@
 Please note that an account is only necessary for editing; searching and downloading records does not require a login.
-{{ :resources:cerl_thesaurus:editing:login.png?600 |Login}}
-==== 1.2 Forgot your password ====
+==== 1.2 Forgot your password ====
+{{ :resources:cerl_thesaurus:editing:forgotpassword.png?300|Resend password}}
 If you ever forget your password, you can request a temporary login that will allow you to set a new password (see below how). Hit the "Forgot your password?" button which you can find at the bottom of the login form and in the form popping up next, fill in either your username or, if you have forgotten that, too, your email address. You will then receive an email with further instructions.
-{{ :resources:cerl_thesaurus:editing:forgotpassword.png?600 |}}
-==== 1.3 Maintaining your user data ====
+==== 1.3 Maintaining your user data ====
+{{ :resources:cerl_thesaurus:editing:account.png?300|Account}}
 Once you have sucessfully logged in, your name will be displayed in the bottom navigation bar, in the place where the login button was before. Clicking on your name will take you to the page where you can manage your account.
@@ Line 50: / Line 57: @@
 ==== 1.6 Changing the interface language ====
+{{ :resources:cerl_thesaurus:editing:language.jpg?300|Language}}
 Changing your preferred interface language on your account page, takes effect only after you log out and log in again. To change the interface language for the immedeately, click the link labelled "Language" in the navigation bar at the bottom of the page. A menu will pop up, which will let you choose a different language.
@@ Line 56: / Line 63: @@
 Please note that not all databases within the hosting environment are available in all languages. If you select a language which is available for the CERL Thesaurus and then switch to a different database that does not support that language, the system will try the language you've set as "preferred language" in your account settings, if you are logged in, or if that is not available either, the language set as default by your browser (check browser's help pages how to change this) or if that doesn't work either, it defaults to English.
-{{ :resources:cerl_thesaurus:editing:language.jpg?600 |Language}}
 ==== 1.7 Navigation ====
@@ Line 69: / Line 76: @@
 ===== 2 Searching the CERL Thesaurus =====
-{{:resources:cerl_thesaurus:editing:search1.png?400 |Search}}
 ==== 2.1 Full text search ====
+{{ :resources:cerl_thesaurus:editing:search1.png?300|Search}}
 Probably the easiest approach to searching the CT is to use one or more terms in the full text search field. A full text search in the new environment will typically yield more hits than in the previous system, due to different indexing principles applied to the data. (To let your search mimic the behaviour of the old system, see below.)
@@ Line 89: / Line 94: @@
 The option "Search for names only" will limit your search to the headings and variant names fields of a record, thus emulating the search behaviour of the old CERL Thesaurus web interface.
+{{ :resources:cerl_thesaurus:editing:search2.png?300|Search}}
 The limit "by feature" option allows you to select those records from the current sets that contain either provenance information, Links to the printers' devices or images (portraits). The number in parentheses indicates the size of the resultset after applying the limitation. You may also limit your result by the gender of the described person (persons and imprint names).
@@ Line 96: / Line 103: @@
 ==== 2.3 Using search keys ====
+You may formulate more complex queries using the following search keys in the search box. A search key must always be followed by a colon and the value you are searching for without any blanks. You may also use parentheses and the Boolean operators AND, OR and NOT (note that the Boolean operators must be written in capital letters).
+Truncation is possible by adding an asterisk (*) to the search term. To search for phrases, put those in quotation marks (").
+|address|search within the address of an entity \\ ''address:"Kerk-straat"''|
+|corporateName|search only within the names (headings and variants) of corporate entities \\ ''corporateName:university''|
+|dedup|search for records marked for deduplication (see below) \\ ''dedup:cnl''|
+|external_id|search for IDs from external files \\ ''external_id:gnd'' or ''external_id:(gnd 1029934118)''|
+|feature|search for records with certain features \\ ''prdv'' Printers' Devices \\ ''prov'' Provnance Information \\ feature:prdv |
+|gender|search for persons or printers by their gender \\ ''a'' female \\ ''b'' male \\ ''u'' unknown \\ ''gender:a''|
+|id|search for a CERL Thesaurus ID \\ ''id:cnc00006222''|
+|imprintName|search only within the names (headings and variants) of printers etc. \\ ''imprintName:sermartelli''|
+|last_changed|search for records last changed at a certain date or within a certain time period \\ ''last_changed:[2017-12-01 TO * ]'' all records changed at or after Dec, 1st 2017|
+|name|search only within name fields \\ ''name:hamburg''|
+|note|search only within note fields \\ ''note:printer''|
+|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|
+|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''|
+|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_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 ====
@@ Line 106: / Line 138: @@
 ==== 2.5 Browsing alphabetical indexes ====
+{{ :resources:cerl_thesaurus:editing:browse.png?300|Browse}}
 You may search for names of places, corporate bodies, printers, persons and entities for which provenance information is available by using alphabetical browse lists. They are available from the item "Browse" in the top navigation bar.
@@ Line 147: / Line 179: @@
 .10 Other Formats
-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).
+In comparison to the form based editor, the display of the information stored in a record is much more compact and easiert to grasp at first glance. For experienced editors typing field numbers and subfields is probably faster than handling a complex form.
+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 ====
-.1 Selecting an Editor
+{{ :resources:cerl_thesaurus:editing:editing5.png?300|yaml editor}}
-.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.
-.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 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].
-.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