Task #3687 (closed)
Opened 13 years ago
Closed 7 years ago
Element and Attribute English Definitions
Reported by: | caitlin | Owned by: | hflynn |
---|---|---|---|
Priority: | minor | Milestone: | Unscheduled |
Component: | Documentation | Version: | OMERO-5.2.0 |
Keywords: | schema | Cc: | |
Resources: | n.a. | Referenced By: | n.a. |
References: | n.a. | Remaining Time: | n.a. |
Sprint: | n.a. |
Description
Moved from http://www.ome-xml.org/ticket/101
- The schema documentation would be much better and more user friendly if all of the entities were defined in plain language in the documentation.
- Elements and attributes need to be defined individually, and not just included in the documentation of the top-level elements, because otherwise they do not show up in any auto-generated documentation, like that on the website.
- I would like to encourage you to use an Aristotelian structure for these definitions, or at least to begin them if they include other comments. These take the structure:
- A is a B that Cs, where A, B, and C are all independently defined entities.
- Ex: ExcitationWavelength? is the wavelength of the laser light that excites the specimen. Units: nanometers (nm).
- I encourage this not just for the sake of consistency in a document created by many hands, but because this is the type of definition required of ontological terms in the OBO Foundry. Prepping these types of definitions will give you a leg up on being ontologically compatible down the line; especially since it is feasible your consortium will contribute imaging terms to the Foundry ontologies.
Change History (3)
comment:1 Changed 13 years ago by ajpatterson
- Keywords schema added
comment:2 Changed 11 years ago by ajpatterson
- Component changed from General to Documentation
- Owner set to hflynn
comment:3 Changed 7 years ago by hflynn
- Resolution set to wontfix
- Status changed from new to closed
- Version set to OMERO-5.2.0
Note: See
TracTickets for help on using
tickets.
You may also have a look at Agilo extensions to the ticket.