Difference between revisions of "Annotations"
(→Annotation Wizard) |
(→Overview) |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Structural Metadata]] | [[Category:Structural Metadata]] | ||
| + | [[Category:Structural Metadata V11]] | ||
== Overview == | == Overview == | ||
| − | Annotations are used to provide extra information to structures, almost every structure can be annotated, and can contain zero to many annotations. Annotations provide placeholders for Annotation Id, Annotation Title, Annotation Type, Annotation Text, Annotation URI all of which are optional fields. | + | Annotations are used to provide extra information to structures, almost every structure can be annotated, and can contain zero to many annotations. Annotations provide placeholders for Annotation Id, Annotation Title, Annotation Type, Annotation Text, Annotation URI all of which are optional fields. |
| + | |||
| + | Multi-lingual capabilities are introduced in Version 11.15.0 of the FMR. | ||
== Annotation Wizard == | == Annotation Wizard == | ||
| Line 13: | Line 16: | ||
The first step of the wizard is to add annotations to the parent structure that was selected, this is the top level parent structure, for example the Codelist. The subsequent steps relate to annotating the sub structures, such as the Codes that belong to the Codelist. | The first step of the wizard is to add annotations to the parent structure that was selected, this is the top level parent structure, for example the Codelist. The subsequent steps relate to annotating the sub structures, such as the Codes that belong to the Codelist. | ||
| + | |||
| + | [[File:Annotations - Wizard step 1.png|Step 1|1000px]] | ||
| + | |||
| + | Note, you do not have to use this step unless you wish the annotation to be attached to the parent structure. | ||
| + | |||
| + | In this example there is a single Annotation but the text field shows three different languages. The additional language are added via the "Add Language" button. To remove a language, select the record in the appropriate language and simply remove the text then click "Edit" to register the change. | ||
The second step allows Annotations to be imported against the sub structures, these are known as Identifiable structures, for example a Code in a Codelist. The step provides the means to import the annotation(s) as CSV. | The second step allows Annotations to be imported against the sub structures, these are known as Identifiable structures, for example a Code in a Codelist. The step provides the means to import the annotation(s) as CSV. | ||
| − | |||
| − | + | [[File:Annotations CSV input.png|Annotations csv input|1000px]] | |
The only required fields are Identifiable Id (which must reference an item in the Maintainable parent), and Annotation Id. | The only required fields are Identifiable Id (which must reference an item in the Maintainable parent), and Annotation Id. | ||
| − | The third step allows Annotations to be manually created, edited, and deleted against the sub structures (Identifiable), i.e,import for Codes in a Codelist. | + | The third step allows Annotations to be manually created, edited, and deleted against the sub structures (Identifiable), i.e,import for Codes in a Codelist. |
| + | |||
| + | [[File:Annotations - Wizard step 3.png|Annotations csv input|1000px]] | ||
This step provides a table view of all the current annotations against the sub-structures, with the means to edit the selected structure, or to create new or delete existing annotations. | This step provides a table view of all the current annotations against the sub-structures, with the means to edit the selected structure, or to create new or delete existing annotations. | ||
| Line 28: | Line 38: | ||
== Viewing Annotations == | == Viewing Annotations == | ||
| − | If a structure, or its Identifiable sub-structures, contains annotations, then | + | If a structure, or its Identifiable sub-structures, contains annotations, then these will be displayed in the table of details section for the selected structure (under the main table). |
| + | |||
| + | The '''View Annotations''' button will be present, and on clicking will open a pop-up modal which will show all the annotations against the structure, or any of its sub-structures. | ||
| − | + | [[File:Annotations - Viewing.png|View Button|1000px]] | |
| − | + | Click View Annotations to show the details. | |
| − | + | [[File:Annotations - View.png|View Button|1000px]] | |
Latest revision as of 07:57, 12 February 2024
Overview
Annotations are used to provide extra information to structures, almost every structure can be annotated, and can contain zero to many annotations. Annotations provide placeholders for Annotation Id, Annotation Title, Annotation Type, Annotation Text, Annotation URI all of which are optional fields.
Multi-lingual capabilities are introduced in Version 11.15.0 of the FMR.
Annotation Wizard
To create annotations, ensure you are logged into the system as an admin user or an Agency user. Navigate to the structure to be annotated (or the parent structure, for example to annotate a Code, navigate to the Codelist that owns the Codes). On structure selection, click the maintenance icon at the top left of the page, to select Manage Annotations to open an Annotation Wizard.
Figure 1 showing the Manage Annotations menu option
The first step of the wizard is to add annotations to the parent structure that was selected, this is the top level parent structure, for example the Codelist. The subsequent steps relate to annotating the sub structures, such as the Codes that belong to the Codelist.
Note, you do not have to use this step unless you wish the annotation to be attached to the parent structure.
In this example there is a single Annotation but the text field shows three different languages. The additional language are added via the "Add Language" button. To remove a language, select the record in the appropriate language and simply remove the text then click "Edit" to register the change.
The second step allows Annotations to be imported against the sub structures, these are known as Identifiable structures, for example a Code in a Codelist. The step provides the means to import the annotation(s) as CSV.
The only required fields are Identifiable Id (which must reference an item in the Maintainable parent), and Annotation Id.
The third step allows Annotations to be manually created, edited, and deleted against the sub structures (Identifiable), i.e,import for Codes in a Codelist.
This step provides a table view of all the current annotations against the sub-structures, with the means to edit the selected structure, or to create new or delete existing annotations.
Viewing Annotations
If a structure, or its Identifiable sub-structures, contains annotations, then these will be displayed in the table of details section for the selected structure (under the main table).
The View Annotations button will be present, and on clicking will open a pop-up modal which will show all the annotations against the structure, or any of its sub-structures.
Click View Annotations to show the details.
