Clarino-logo
COMEDI :: Getting started: Create metadata with COMEDI



Getting started: Create metadata with COMEDI

Note

This page is a low-threshold supplement to the general Documentation page of COMEDI. The present page is intended to give a stepwise introduction to how to get started using COMEDI. For more details, please consult COMEDI's general Documentation page. If you have problems, try the Frequently asked questions (FAQ) page.

Step 1: Login

  • Go to the COMEDI main page: http://clarino.uib.no/comedi/.
  • Click on one of the options on the Sign in menu on the top right of the webpage.
    • If you are connected to a Norwegian institution of higher education, or if you have an identity provider (IdP) that is a member of eduGAIN, use the eduGAIN link.
    • You may also use a Clarin IdP account.
    • Otherwise, you can register an OpenIdP account or you may use a Clarin IdP account (but the latter solution may be temporary).

Fig1: Login.
Fig1: Login.

Step 2: Define an editor group (optional)

Normally, only you (based on your login user ID) are able to edit or delete your metadata, but everybody can see your metadata. Users can share access to metadata files via editor groups.

  • To create a new group, or to request for membership in an existing group, click on Groups in the left hand menu. This should take you to the Groups page.

Fig2: Editor group: see your current group memberships, create new group, request membership in group or delete group.
Fig2: Editor group: see your current group memberships, create new group, request membership in group or delete group.

  • Under Your groups: the groups you are a member of are listed.
  • To create a new group, type a string in the field after Create new group:, then click "apply". You cannot give membership to predefined persons, each logged in user must request membership in groups (se next item).
  • To request membership in an existing group, select from the drop-down menu after Request membership in group:. When you have requested a membership, the creator of the group will receive an email notification, and can approve or deny your request.
Tip: When you create a group, keep in mind that COMEDI is an open tool; everybody can see all identifiers and groups. Therefore, try to find names that are not too generic (e.g., “corpus1”, “mygroup”, “test”, “University of Oslo” etc.), but rather make their association to your specific institute or project conspicuous (e.g., “TextLab”, “INESS”, etc.).

Step 3: Create a metadata record to edit

To create metadata, click on the Metadata Records page in the left hand menu. From this page you can choose one of the following four options:

  • Create a new, empty metadata record;
  • Upload a metadata file;
  • Clone an existing metadata record; or
  • Open an existing metadata record
Tip: If you are not sure which profile to use, contact your local repository, or COMEDI helpdesk.

Create a new, empty metadata record:
1. Choose a profile from the drop-down menu, or type a valid CMDI profile ID.
2. Provide an identifier.
3. Click "Go".

Fig 3: Create a new metadata record.
Fig 3: Create a new metadata record.

Upload a metadata file:
1. Choose an existing CMDI file.
2. Click "Upload".

Fig 4: Upload a metadata file.
Fig 4: Upload a metadata file.

Clone an existing metadata record:
1. Choose an existing metadata file in COMEDI from the drop-down menu.
2. Provide an identifier.
3. Click "Go".

Fig 5: Clone an existing metadata file.
Fig 5: Clone an existing metadata file.

Tip: If you know you will create a set of metadata files with repetitive information (e.g. the same IPR holder, similar description, the same language(s), metadata provider, you might want to first create a dummy file with the repetitive information and then clone this file repetitively. When you are done, the dummy file can be deleted.
  • Open an existing metadata record: see step 10 below.

Step 4: A quick look at the metadata editor interface

In the previous step, you will have created a metadata file and COMEDI should now have sent you to the metadata editor page, where your metadata file is now open. In the next few steps you will provide the details about your resource.

The example below uses the the CLARINO Corpus profile, clarin.eu:cr1:p_1407745711925.

Tip: In COMEDI's Documentation page, you will find a short list of very useful keyboard shortcuts to navigate efficiently in the COMEDI editor.

As shown in fig. 6, the metadata editor interface has three main elements: the header information at the top (profile ID, creator of the metadata, etc.); a menu of the top-level components in the middle, and the component section at the bottom, displaying all components/elements within the selected top level component.
The header section and the top level component menu are there all the time. To work with metadata, use the top-level component menu to go from one top-level component to another one (click on the component name in the horizonal menu bar, or use the “next'/'previous” buttons).

In COMEDI, the components and their elements are shown hierarchically as boxes inside boxes (cf. the component section at the bottom of fig. 6).

Fig 6: The metadata editor interface.
Fig 6: The metadata editor interface.

Step 5: Switch from view mode to edit mode (with Ctrl-A)

Editing metadata happens in the component section (the lower third in fig. 6).

Initially, the metadata are displayed in view mode. The view mode displays: (i) everything you have typed in thus far and (ii) marks in red any errors and all obligatory, remaining information. Switch to view mode whenever you need an overview of what you have filled in and what remains in order to obtain a valid metadata file.

In order to edit/add information, you must switch to edit mode with the keyboard shortcut Ctrl-A. (cf. Documentation).
If you really have to, click the radio button instead (cf. the middle of fig. 6). The important advantage of using Ctrl-A, though, is that you can then switch directly between edit and view mode (both directions) while focussing on the selected component (or part of a component) you are working in. With the radio buttons, you have to scroll down to the relevant component.

Step 6: “Walk” through a top-level component

The easiest way to work with a top-level component is to “walk through it with the keyboard shortcuts Ctrl-Arrow down/up. This way, the editor moves each element/component into focus for you. Alternatively, use mouse-clicks.

Step 7: Instantiate elements/components

Walking through a top-level component, some items (elements/components) are optional and others are obligatory, here is how to see the difference.

To the right of an element/component name, in square brackets, you can see its number of actual instantiations followed by its minimal and maximal cardinality. For example, in fig. 7, the element Email has 1 instantiation, and the element is obligatory (minimal cardinality is 1) and it may occur infinitely many times.

Fig 7: Illustration of instantiation and cardinalities
Fig 7: Illustration of instantiation and cardinalities

  • Obligatory elements/components have minimal cardinality=1, and are by default always instantiated for you in COMEDI, even if it has no content. Instantiated items have a blue title font. If an obligatory element has no content, you will see an alert with a red font in View mode.
  • Optional elements/components have minimal cardinality=0, and are by default not instantiated in COMEDI. Uninstantiated items are greyed out.
  • To instantiate it (in order to edit it), click the “+” button adjacent to its name (cf. fig. 7 and 8). Once you have instantiated an optional component, its font colour will change from grey to blue (compare the element URL in fig. 8 vs. 9).
  • To delete a component/element, click the “-” button, which will appear after instantiation (cf. Fig 9).

Fig8: Uninstantiated element (edit mode), click on the “+”  button to make a typing field appear
Fig8: Uninstantiated element (edit mode), click on the “+” button to make a typing field appear

Fig9: Instantiated element, start typing in the open field. To delete it, click the “-”  button
Fig9: Instantiated element, start typing in the open field. To delete it, click the “-” button

Step 8: Edit elements

The elements are the `leaf nodes” where you actually provide values, e.g. the elements Email and URL in fig. 7 and 9, respectively. For some elements there will be a string field for you to type in; for other elements you can select a predefined value from a drop-down menu.

To edit/add info to an element, it must first be instantiated; it will then have a blue font (fig. 7 and 9).
If its title has a grey font, instantiate it by pressing Ctrl - +, or click the “+” button to the right of the title (fig. 8). Its font colour should then turn blue, and the leftmost number in the square brackets behind the title should be 1 (or more).
If the element in question may occur more than once, (if its max. cardinality is more than 1), there will be a “+” button to add even more instances.

When you are done with an element, click Ctrl - A to inspect the result in view mode, (switching to view mode will also automatically save your work thus far; alternatively you may click the “save” button at the bottom of the header section (fig. 6).

Step 9: Edit components (cloning or adding new)

A component is a cluster of information that naturally belongs together, e.g a “person info” component (with elements such as surname and given name) or a “license” component (with informaton about license name, license URL, licensor).

A component can be filled with the contents of a component of the same type from an already existing metadata file. You can clone and then edit the copy; this will not affect the contents of the original component.

1. Click on select existing (...) next to the component name; a list of existing components of the same type appears (top left of fig. 10).
2. A yellow pop-up window then appears (middle of fig. 10). You can browse through the list of existing components using Ctrl-Arrow left and Ctrl-Arrow right; narrow the number of components by typing a search word in the "filter by" field.
3. Click 'select' when you have found a component; its content is then copied into the component in focus (right-hand side of fig 10).
4. Useful components can be marked as favourites in the component selection box; they will appear first next time you open the list of existing components for this component type.
5. The copied information may be edited freely, it will not affect the original that you cloned from.

Note: a component can only be filled with new content if it is empty. If a component already has content, you must first clear it by clicking Remove content.

Fig10: Clone components
Fig10: Clone components

Step 10: Retrieve and select an existing metadata record for viewing and editing

Any user can search in the existing metadata files that have been saved to the COMEDI database (within the local installation that you are using), and anyone may open any metadata file to view it. To edit it, you must require editing rights.

To do a freetext search in existing metadata records: (for example to find all metadata files mentioning the license "CC-BY")
1. Click on the Metadata Records page in the left hand menu.
2. Find the box entitled Search in metadata records.
3. Type a search string, which will return all files and all components within that file mathching your search.
Note: the freetext search does not search among the identifiers, unless an identifier is explicitly mentioned somewhere in the metadata.

Find a file:
All metadata files are listed by resource name (if such a name is filled in in the metadata file) and identifier in the yellow box below the white boxes on the Metadata Records page. The display of metadata files depend on the selected filtering option.
1. Select a relevant owner name from the drop-down menus for filtering on the line:
Show records owned by: and in group: (see the middle of fig. 11). To display all files, select records owned by='anybody' in group 'any'.
2. If you are looking for a metadata file with a specific resource name or identifier, do a simple webpage search (usually using Ctrl-F) on the Metadata Records page.

To open a metadata file in the list of metadata records:
1. Click on its identifier (e.g. the encircled identifier “Menotec” at the bottom of fig. 11). This will open the metadata file in a new webpage. From there, you can at least read the file and (depending on your editing rights for this file) start editing it.

Fig. 11: Search for, filter and select an existing metadata record for viewing and editing
Fig. 11: Search for, filter and select an existing metadata record for viewing and editing


Design & implementation: Paul Meurer, Uni Computing, 2017