| 06.DANNOTATION.R1 | RS3.3 | Each object record, uploaded into ResearchSpace could be annotated |
| 06.DANNOTATION.R2 | RS3.3 | Object records that are uploaded to ResearchSpace may be annotated the following ways: |
| 06.DANNOTATION.R2-1 | RS3.3 | - Add data currently missing from a record. The missing data may be uncovered as a result of the research collaboration. |
| 06.DANNOTATION.R2-2 | RS3.3 | - Propose a replacement/edit of existing data. For example, the project may conclude that existing data is inaccurate or there is some doubt and wish to propose an alternative |
| 06.DANNOTATION.R2-3 | RS3.3 | - Add new fields with an appropriate data type. These new fields may be part of the ResearchSpace data templates and have CRM mappings but may also be outside this structure.
- Fields outside the ResearchSpace structure should be recorded using a standard mechanism but be alerted to the Project Administrator and ResearchSpace administrator for incorporation into the ResearchSpace CRM data structure.
- By default, no new data fields should be allowed without this being configured by the Project Administrator whose dashboard will control this setting |
| 06.DANNOTATION.R2-4 | RS3.3 | - Annotate data with other data which is not part of the object data structure but has some relevance to the research being conducted and would provide information that would increase understanding or help with the research. This could be some contextual information or document a relationship to other data in the repository. For example, there may be an interesting connection with another object or some qualification may be required to make better sense of the data that cannot be entered into a data field itself. |
| 06.DANNOTATION.R5 | RS3.3 | To annotate data on a single record the researcher would first find the record. |
| 06.DANNOTATION.R6 | RS3.3 | Once the record has been found a form would provide the data already available. |
| 06.DANNOTATION.R7 | RS3.3 | The form should have configuration settings so that a researcher can see various views of the record with different versions of annotation. For example, the researcher may wish to see the original uploaded data only, or the latest version of the data or all the versions of the data |
| 06.DANNOTATION.R8 | RS3.3 | Clicking on a particular field will open up a new edit box. |
| 06.DANNOTATION.R8-1 | RS3.3 | - The researcher will indicate whether s/he is adding new structured data (in which case the edit box will validate the entry) or an additional annotation. It is possible that these additional annotations could be qualified by a given set of predicates |
| 06.DANNOTATION.R9 | RS3.3 | Data entry against the object data will create a new version of the data for the object record. |
| 06.DANNOTATION.R9-1 | RS3.3 | - This information will be attributed to the researcher and the project. The date of the version should also be recorded. The new version itself could be also predicated, e.g. “proposed”, “proven” etc. It should also be possible to predicate additional non-object record annotations. |
| 06.DANNOTATION.R9-2 | RS3.3 | - The researcher should also be given the opportunity to annotate the entry -- perhaps to document the rational for the data entry. |
| 06.DANNOTATION.R9-3 | RS3.3 | - For example, a researcher disagrees with a place of production for a particular object. A new version of the place of production is entered and a reason for this is added as an annotation. |
| 06.DANNOTATION.R10 | RS3.3 | Annotations which seek to establish a relationship between data in two different object records will also require the ability for two records to be selected and arranged on the screen so that a researcher can establish a link -- perhaps by dragging the mouse from one data element in one record to another data element within another record and allowing the researcher to enter the reason for the relationship. |
| 06.DANNOTATION.R11 | RS3.3 | The annotation should also collect the following information taken from W3C [http://www.w3.org/2000/10/annotation-ns#]
* *annotates* - Relates an Annotation to the resource to which the Annotation applies. The inverse relation is 'has Annotation'.
* *author* - The name of the person/s or organization most responsible for creating the Annotation. Sub property of dc:creator
* *body* - Relates the resource representing the 'content' of an Annotation to the Annotation resource. Sub property of dc:related
* *context* - The context within the resource named in 'annotates' to which the Annotation most directly applies.
* *created* - The date and time on which the Annotation was created. yyyy-mm-ddThh:mm:ssZ format recommended. Sub property of dc:date
* *modified* - The date and time on which the Annotation was modified. yyyy-mm-ddThh:mm:ssZ format recommended. Sub property of dc:date
* *related* - A relationship between an annotation and additional resources that is less specific than 'body'. The 'related' property is expected to be subclassed by more specific relationships. |
| 06.DANNOTATION.R12 | RS3.3 | Annotation Filtering |
| 06.DANNOTATION.R12-1 | RS3.3 | - Filter the abbreviated annotations in area 2 by group (of fields), field and author. |
| 06.DANNOTATION.R12-2 | RS3.3 | - It should be possible to show only project annotations. |
| 06.DANNOTATION.R13 | RS3.3 | Abbreviated Annotations |
| 06.DANNOTATION.R13-1 | RS3.3 | - Shows previous annotations created and referenced against the data fields. |
| 06.DANNOTATION.R14 | RS3.3 | Annotation Sort |
| 06.DANNOTATION.R14-1 | RS3.3 | - Sorts the abbreviated annotations by date and author |
| 06.DANNOTATION.R15 | RS3.3 | Field View and Edit |
| 06.DANNOTATION.R15-1 | RS3.3 | - The field view is by group (groups to be determined for each record type). By default the fields should the original uploaded data (first version). Other versions can be display by expanding the combo box which are sorted by date and also provide the author identifier. |
| 06.DANNOTATION.R15-2 | RS3.3 | - Each field also has an icon for creating another data version of the data entry. This should open another window which provides access to controlled terms (separate design). |
| 06.DANNOTATION.R15-3 | RS3.3 | - The view of fields can be altered to show the preferred project fields, the user’s fields and the original source fields. |
| 06.DANNOTATION.R15-4 | RS3.3 | - The user's view of the fields can be saved for the next session. |
| 06.DANNOTATION.R15-5 | RS3.3 | - The groups will depend upon the type of record selected from the search. These will be different depending upon whether the user is looking at objects, sites or buildings. |
| 06.DANNOTATION.R15-6 | RS3.3 | - Button allows deletion of a selected data entry (with authorisation). |
| 06.DANNOTATION.R15-7 | RS3.3 | - Can add a new field (Leads to a field definition control for determining the type, size and authority for the field). |
| 06.DANNOTATION.R16 | RS3.3 | Annotation Detail |
| 06.DANNOTATION.R16-1 | RS3.3 | - The text box shows the complete annotation. |
| 06.DANNOTATION.R16-2 | RS3.3 | - This can be edited by the original author (and others authorised) and re-saved. |
| 06.DANNOTATION.R16-3 | RS3.3 | - Other users can create a new annotation against the selected data field and save that annotation to join the others. |
| 06.DANNOTATION.R16-3 | RS3.3 | - It should be possible to enforce ontology terms (qualifiers) for the type of annotation. (Open Annotation Project). |
| 06.DANNOTATION.R16-4 | RS3.3 | - Editing should be supported by a full html editing control which includes the ability to insert hypertext links. |
| 06.DANNOTATION.R17 | RS3.3 | Thumbnails |
| 06.DANNOTATION.R17-1 | RS3.3 | - Show the thumbnails associated with records |
| 06.DANNOTATION.R17-2 | RS3.3 | - Thumbnails can be used to link to the Image Annotation tool. |
| 06.DANNOTATION.R17-2 | RS3.3 | - Thumbnails should provide basic information about the image (file size, type, filename, ID). |
!DataAnnotationScreen.png|border=1!
| 06.DANNOTATION.R2 | RS3.3 | Object records that are uploaded to ResearchSpace may be annotated the following ways: |
| 06.DANNOTATION.R2-1 | RS3.3 | - Add data currently missing from a record. The missing data may be uncovered as a result of the research collaboration. |
| 06.DANNOTATION.R2-2 | RS3.3 | - Propose a replacement/edit of existing data. For example, the project may conclude that existing data is inaccurate or there is some doubt and wish to propose an alternative |
| 06.DANNOTATION.R2-3 | RS3.3 | - Add new fields with an appropriate data type. These new fields may be part of the ResearchSpace data templates and have CRM mappings but may also be outside this structure.
- Fields outside the ResearchSpace structure should be recorded using a standard mechanism but be alerted to the Project Administrator and ResearchSpace administrator for incorporation into the ResearchSpace CRM data structure.
- By default, no new data fields should be allowed without this being configured by the Project Administrator whose dashboard will control this setting |
| 06.DANNOTATION.R2-4 | RS3.3 | - Annotate data with other data which is not part of the object data structure but has some relevance to the research being conducted and would provide information that would increase understanding or help with the research. This could be some contextual information or document a relationship to other data in the repository. For example, there may be an interesting connection with another object or some qualification may be required to make better sense of the data that cannot be entered into a data field itself. |
| 06.DANNOTATION.R5 | RS3.3 | To annotate data on a single record the researcher would first find the record. |
| 06.DANNOTATION.R6 | RS3.3 | Once the record has been found a form would provide the data already available. |
| 06.DANNOTATION.R7 | RS3.3 | The form should have configuration settings so that a researcher can see various views of the record with different versions of annotation. For example, the researcher may wish to see the original uploaded data only, or the latest version of the data or all the versions of the data |
| 06.DANNOTATION.R8 | RS3.3 | Clicking on a particular field will open up a new edit box. |
| 06.DANNOTATION.R8-1 | RS3.3 | - The researcher will indicate whether s/he is adding new structured data (in which case the edit box will validate the entry) or an additional annotation. It is possible that these additional annotations could be qualified by a given set of predicates |
| 06.DANNOTATION.R9 | RS3.3 | Data entry against the object data will create a new version of the data for the object record. |
| 06.DANNOTATION.R9-1 | RS3.3 | - This information will be attributed to the researcher and the project. The date of the version should also be recorded. The new version itself could be also predicated, e.g. “proposed”, “proven” etc. It should also be possible to predicate additional non-object record annotations. |
| 06.DANNOTATION.R9-2 | RS3.3 | - The researcher should also be given the opportunity to annotate the entry -- perhaps to document the rational for the data entry. |
| 06.DANNOTATION.R9-3 | RS3.3 | - For example, a researcher disagrees with a place of production for a particular object. A new version of the place of production is entered and a reason for this is added as an annotation. |
| 06.DANNOTATION.R10 | RS3.3 | Annotations which seek to establish a relationship between data in two different object records will also require the ability for two records to be selected and arranged on the screen so that a researcher can establish a link -- perhaps by dragging the mouse from one data element in one record to another data element within another record and allowing the researcher to enter the reason for the relationship. |
| 06.DANNOTATION.R11 | RS3.3 | The annotation should also collect the following information taken from W3C [http://www.w3.org/2000/10/annotation-ns#]
* *annotates* - Relates an Annotation to the resource to which the Annotation applies. The inverse relation is 'has Annotation'.
* *author* - The name of the person/s or organization most responsible for creating the Annotation. Sub property of dc:creator
* *body* - Relates the resource representing the 'content' of an Annotation to the Annotation resource. Sub property of dc:related
* *context* - The context within the resource named in 'annotates' to which the Annotation most directly applies.
* *created* - The date and time on which the Annotation was created. yyyy-mm-ddThh:mm:ssZ format recommended. Sub property of dc:date
* *modified* - The date and time on which the Annotation was modified. yyyy-mm-ddThh:mm:ssZ format recommended. Sub property of dc:date
* *related* - A relationship between an annotation and additional resources that is less specific than 'body'. The 'related' property is expected to be subclassed by more specific relationships. |
| 06.DANNOTATION.R12 | RS3.3 | Annotation Filtering |
| 06.DANNOTATION.R12-1 | RS3.3 | - Filter the abbreviated annotations in area 2 by group (of fields), field and author. |
| 06.DANNOTATION.R12-2 | RS3.3 | - It should be possible to show only project annotations. |
| 06.DANNOTATION.R13 | RS3.3 | Abbreviated Annotations |
| 06.DANNOTATION.R13-1 | RS3.3 | - Shows previous annotations created and referenced against the data fields. |
| 06.DANNOTATION.R14 | RS3.3 | Annotation Sort |
| 06.DANNOTATION.R14-1 | RS3.3 | - Sorts the abbreviated annotations by date and author |
| 06.DANNOTATION.R15 | RS3.3 | Field View and Edit |
| 06.DANNOTATION.R15-1 | RS3.3 | - The field view is by group (groups to be determined for each record type). By default the fields should the original uploaded data (first version). Other versions can be display by expanding the combo box which are sorted by date and also provide the author identifier. |
| 06.DANNOTATION.R15-2 | RS3.3 | - Each field also has an icon for creating another data version of the data entry. This should open another window which provides access to controlled terms (separate design). |
| 06.DANNOTATION.R15-3 | RS3.3 | - The view of fields can be altered to show the preferred project fields, the user’s fields and the original source fields. |
| 06.DANNOTATION.R15-4 | RS3.3 | - The user's view of the fields can be saved for the next session. |
| 06.DANNOTATION.R15-5 | RS3.3 | - The groups will depend upon the type of record selected from the search. These will be different depending upon whether the user is looking at objects, sites or buildings. |
| 06.DANNOTATION.R15-6 | RS3.3 | - Button allows deletion of a selected data entry (with authorisation). |
| 06.DANNOTATION.R15-7 | RS3.3 | - Can add a new field (Leads to a field definition control for determining the type, size and authority for the field). |
| 06.DANNOTATION.R16 | RS3.3 | Annotation Detail |
| 06.DANNOTATION.R16-1 | RS3.3 | - The text box shows the complete annotation. |
| 06.DANNOTATION.R16-2 | RS3.3 | - This can be edited by the original author (and others authorised) and re-saved. |
| 06.DANNOTATION.R16-3 | RS3.3 | - Other users can create a new annotation against the selected data field and save that annotation to join the others. |
| 06.DANNOTATION.R16-3 | RS3.3 | - It should be possible to enforce ontology terms (qualifiers) for the type of annotation. (Open Annotation Project). |
| 06.DANNOTATION.R16-4 | RS3.3 | - Editing should be supported by a full html editing control which includes the ability to insert hypertext links. |
| 06.DANNOTATION.R17 | RS3.3 | Thumbnails |
| 06.DANNOTATION.R17-1 | RS3.3 | - Show the thumbnails associated with records |
| 06.DANNOTATION.R17-2 | RS3.3 | - Thumbnails can be used to link to the Image Annotation tool. |
| 06.DANNOTATION.R17-2 | RS3.3 | - Thumbnails should provide basic information about the image (file size, type, filename, ID). |
!DataAnnotationScreen.png|border=1!