Difference between revisions of "Template:Metadata"

From OpenMedia
Jump to: navigation, search
m (output separator from • to ;)
m ({{Metadata/List to property}} + |sep=; )
Line 98: Line 98:
 
   -->|Collection={{#if: {{{Creators|}}}<!--
 
   -->|Collection={{#if: {{{Creators|}}}<!--
 
   -->|<tr class="note"><td><b>Creators:</b> <!--
 
   -->|<tr class="note"><td><b>Creators:</b> <!--
   -->{{Metadata/List to property|list={{{Creators|}}}|property=Creator}}<!-- --></td></tr>
+
   -->{{Metadata/List to property|list={{{Creators|}}}|property=Creator|sep=;&#32;}}<!-- --></td></tr>
 
}}<!-- Collection:Creator::true end --><!--
 
}}<!-- Collection:Creator::true end --><!--
  
 
   all other types: Creators should be given
 
   all other types: Creators should be given
 
-->| #default =<tr class="note"><td><b>Creators:</b> {{#if: {{{Creators|}}}<!--
 
-->| #default =<tr class="note"><td><b>Creators:</b> {{#if: {{{Creators|}}}<!--
   then-->|<!-- -->{{Metadata/List to property|list={{{Creators|}}}|property=Creator}}<!--
+
   then-->|<!-- -->{{Metadata/List to property|list={{{Creators|}}}|property=Creator|sep=;&#32;}}<!--
 
   else-->|<!-- --><span style="color:#646D7E">(Please consider adding this information)<!--
 
   else-->|<!-- --><span style="color:#646D7E">(Please consider adding this information)<!--
 
     + Category
 
     + Category
Line 113: Line 113:
 
-->{{
 
-->{{
 
#if: {{{Contributors<includeonly>|</includeonly>}}}
 
#if: {{{Contributors<includeonly>|</includeonly>}}}
|<tr class="note"><td><b>Contributors:</b> {{Metadata/List to property|list={{{Contributors|}}}|property=Contributor}}</td></tr>
+
|<tr class="note"><td><b>Contributors:</b> {{Metadata/List to property|list={{{Contributors|}}}|property=Contributor|sep=;&#32;}}</td></tr>
 
}}{{
 
}}{{
 
#if: {{{Attribution Statement<includeonly>|</includeonly>}}}
 
#if: {{{Attribution Statement<includeonly>|</includeonly>}}}
Line 125: Line 125:
 
}}{{
 
}}{{
 
#if: {{{Copyright Owner<includeonly>|</includeonly>}}}
 
#if: {{{Copyright Owner<includeonly>|</includeonly>}}}
|<tr class="note"><td><b>Copyright Owner:</b> {{Metadata/List to property|list={{{Copyright Owner|}}}|property=Copyright Owner}}</td></tr>
+
|<tr class="note"><td><b>Copyright Owner:</b> {{Metadata/List to property|list={{{Copyright Owner|}}}|property=Copyright Owner|sep=;&#32;}}</td></tr>
 
}}{{#switch: {{{Type}}}<!-- Copyright, License, Country Code, World Region required, except for Type=Collection:-->
 
}}{{#switch: {{{Type}}}<!-- Copyright, License, Country Code, World Region required, except for Type=Collection:-->
 
| Collection=<!-- Display only if present: -->{{
 
| Collection=<!-- Display only if present: -->{{
Line 226: Line 226:
 
{{#if: {{{General Keywords<includeonly>|</includeonly>}}}
 
{{#if: {{{General Keywords<includeonly>|</includeonly>}}}
 
|<tr class="note"><td><b>General Keywords:</b> <nowiki> </nowiki><includeonly><!--  
 
|<tr class="note"><td><b>General Keywords:</b> <nowiki> </nowiki><includeonly><!--  
       -->{{Metadata/List to property|list={{#replace: {{{General Keywords|}}}|,|;}}|property=General Keywords|add category=yes}}</includeonly></td></tr>
+
       -->{{Metadata/List to property|list={{#replace: {{{General Keywords|}}}|,|;}}|property=General Keywords|add category=yes|sep=;&#32;}}</includeonly></td></tr>
 
}}{{
 
}}{{
 
#if: {{{Setting<includeonly>|</includeonly>}}}
 
#if: {{{Setting<includeonly>|</includeonly>}}}
Line 238: Line 238:
 
}}{{
 
}}{{
 
#if: {{{Scientific Names<includeonly>|</includeonly>}}}
 
#if: {{{Scientific Names<includeonly>|</includeonly>}}}
|<tr class="note"><td><b>Scientific Names:</b> {{Metadata/List to property|list={{{Scientific Names|}}}|property=Scientific Name|add category=yes|strip formatting=yes}}</td></tr>
+
|<tr class="note"><td><b>Scientific Names:</b> {{Metadata/List to property|list={{{Scientific Names|}}}|property=Scientific Name|add category=yes|strip formatting=yes|sep=;&#32;}}</td></tr>
 
}}{{
 
}}{{
 
#if: {{{Scientific Names with Author<includeonly>|</includeonly>}}}
 
#if: {{{Scientific Names with Author<includeonly>|</includeonly>}}}
|<tr class="note"><td><b>{{#switch: {{NAMESPACE}}|Template=Scientific Names with Author|#default=Scientific Names (w. Auth.)}}:</b> {{Metadata/List to property|list={{{Scientific Names with Author|}}}|property=Scientific Name with Author|strip formatting=yes}}</td></tr>
+
|<tr class="note"><td><b>{{#switch: {{NAMESPACE}}|Template=Scientific Names with Author|#default=Scientific Names (w. Auth.)}}:</b> {{Metadata/List to property|list={{{Scientific Names with Author|}}}|property=Scientific Name with Author|strip formatting=yes|sep=;&#32;}}</td></tr>
 
}}{{
 
}}{{
 
#if: {{{Scientific Name Synonyms<includeonly>|</includeonly>}}}
 
#if: {{{Scientific Name Synonyms<includeonly>|</includeonly>}}}
|<tr class="note"><td><b>Scientific Name Synonyms:</b> {{Metadata/List to property|list={{{Scientific Name Synonyms|}}}|property=Scientific Name Synonym|strip formatting=yes}}</td></tr>
+
|<tr class="note"><td><b>Scientific Name Synonyms:</b> {{Metadata/List to property|list={{{Scientific Name Synonyms|}}}|property=Scientific Name Synonym|strip formatting=yes|sep=;&#32;}}</td></tr>
 
}}{{
 
}}{{
 
#if: {{{Identified By<includeonly>|</includeonly>}}}
 
#if: {{{Identified By<includeonly>|</includeonly>}}}
Line 250: Line 250:
 
}}{{
 
}}{{
 
#if: {{{Common Names<includeonly>|</includeonly>}}}
 
#if: {{{Common Names<includeonly>|</includeonly>}}}
|<tr class="note"><td><b>Common Names:</b> {{Metadata/List to property|list={{{Common Names|}}}|property=Common Name}}</td></tr>
+
|<tr class="note"><td><b>Common Names:</b> {{Metadata/List to property|list={{{Common Names|}}}|property=Common Name|sep=;&#32;}}</td></tr>
 
}}{{
 
}}{{
 
#if: {{{Associated Specimen ID<includeonly>|</includeonly>}}}
 
#if: {{{Associated Specimen ID<includeonly>|</includeonly>}}}

Revision as of 21:34, 28 June 2017

Documentation of this template
Search media by metadata
{{{Title}}}
Description:
Caption:
Content Modification:
Creation Technique:

Creators: (Please consider adding this information)
Contributors:
Attribution: {{{Attribution Statement}}}
Attribution Logo URL:
Attribution Link URL:
Copyright Owner:
Copyright Statement: Copyrighted Material; the copyright remains with the author (not this web publication)
License Statement: Creative Commons: Author Attribution Required, Share-Alike (cc-by-sa 3.0)
License URL:
World Region: (Desirable information missing!)
Country Names:
Country Codes: (Desirable information missing!)
State or Province:
County or Subprovince:
City or Place Name:
Locality:
Subject Category:
General Keywords:
Setting:
Taxonomic Coverage:
Taxonomic Coverage: {{{Lowest Common Taxon}}}
(Use “Taxonomic Coverage=…” instead of deprecated parameter Lowest Common Taxon.)
Scientific Names:
Scientific Names with Author:
Scientific Name Synonyms:
Identified By:
Common Names:
Associated Specimen ID:
Associated Observation ID:
Association Info:
Published Source:
Peer Reviewer Name:
Peer Reviewer Comments:
TypeType=‹empty›” is no recognized value. Valid values are for instance: “StillImage”, “Movie” or “IdentificationTool”. Details see documentation.
Subtype
Rating
Languageundetermined (und)
Original Creation Date
Accession Date
Digitization Date
Modified
Resource ID
Metadata Creator
Metadata Manager
Metadata Copyright Owner
Metadata Modified
Geocoordinates
Elevation
Depth
Compass Heading
Taxon Count
Subject Part
Subject Sex
Subject Life Stage
Subject Orientation
Derived From
Other Versions
Format
Offline Use
Interactivity
Host App.
Target System
ID Tool Structure
Exchange Formats
— Collection: [[{{{Collection Page}}}]] — Provided by: [[{{{Provider Page}}}]]


[edit]

Documentation

The metadata template[1] allows you to store metadata on external resources, especially identification tools or media resources, directly in a Wiki page. The template supports a number of metadata fields, some of which will only rarely be used. The set of metadata fields was decided upon in collaboration between Key to Nature, NBII, GBIF-MRTG, and Morphbank (see Resource Metadata Exchange Agreement on Key to Nature).

Resource collections are considered just another type of resources and can be described using the same template (using Type=Collection instead of Type=StillImage, IdentificationTool, etc.).

The importance of the metadata template is that it contains structured information that can be read by software agents. While it is possible to do some searches directly in the Wiki, software agents reading the information into a database can do more complex external queries. It is possible to design the system such that metadata editing is done directly in external databases, but we believe that the current solution has some advantages. For high value resources such as collections or identification tools, contributors are free to structure a special wiki page describing their resource in text and images, the structured metadata record being just a small part of that information. In other cases, where metadata are typically batch converted and submitted from another database, the Wiki-submission offers a simple low-tech and accessible method for batch submission, including some support for syntax checking on behalf of the submitter.

You can use this form to edit metadata:

 


See How to add resource metadata on the Wiki for further information.

  1. A template is a Wiki page that, using a syntax of "{{pagename | parameter1=value1 | parameter2=value2 }}", can be called with parameters and thus reused many times.



Test records

Documentation of this template
Search media by metadata
English

Ascochyta allii-cepae

Description:
English: This can be long text, describing the item in free-form text. This can be long text, describing the item in free-form text. This can be long text, describing the item in free-form text. This can be long text, describing the item in free-form text.

Creators: Mr. Smith
Copyright Statement: (c) xyz xxx
License Statement: Creative commons cc-by-sa 3.0
World Region: (Desirable information missing!)
Country Codes: (Desirable information missing!)
Subject Category: Fungi
Scientific Names: Ascochyta allii-cepae
Scientific Names with Author: Ascochyta allii-cepae Punith., Gladders & McKeown.
Type:StillImage
Language:no linguistic content (zxx)
Resource ID:768479362
Taxon Count:1
Interactivity:hyperlinked
ID Tool Structure:Dichotomous

This record was specified as below (raw edit view):

{{Metadata
| Type=StillImage
| Title=Ascochyta allii-cepae 
| Creators = Mr. Smith
| Description = {{Metadata/Description|language code=en|content=This can be long text, describing the item in free-form text. This can be long text, describing the item in free-form text. This can be long text, describing the item in free-form text. This can be long text, describing the item in free-form text.}}
| Metadata Language=en 
| Language=zxx
| Resource ID=768479362 
| Copyright Statement= (c) xyz xxx 
| License Statement=Creative commons cc-by-sa 3.0
| Scientific Names=Ascochyta allii-cepae;
| Scientific Names with Author=Ascochyta allii-cepae Punith., Gladders & McKeown.;
| Taxon Count= 20 
| Taxon Count= 1
| Interactivity = hyperlinked | ID Tool Structure = Dichotomous 
| Best Quality URI=http://160.45.63.11/Storage/Fungi/Coelos/AscochytaPunith/edt/AscP88-006.png
| Best Quality Availability=online (login)
| Medium Quality URI=http://160.45.63.11/Storage/Fungi/Coelos/AscochytaPunith/low/AscP88-006.png
| Medium Quality Availability=online (free)
}}

Note that blanks before or after the "=", and new lines between metadata fields do not matter. Also, the sequence of parameters does not matter. If parameters are repeated, only the last occurrence of the parameter will define the value (compare Taxon Count in the example above).

As shown below this template tries to give apropriate information if something is missing:

Documentation of this template
Search media by metadata
Example for erroneous resource type and missing URI
Creators: (Please consider adding this information)
Copyright Statement: Copyrighted Material; the copyright remains with the author (not this web publication)
License Statement: Creative Commons: Author Attribution Required, Share-Alike (cc-by-sa 3.0)
World Region: (Desirable information missing!)
Country Codes: (Desirable information missing!)
Subject Category: (Desirable information missing!)
Type:Type=Image” is no recognized value. Did you mean “StillImage”?
Language:undetermined (und)
Interactivity:'interactive' is no recognized value for interactivity; please use ‘n/a’, ‘static’, ‘hyperlinked’ or ‘dynamic’.
ID Tool Structure:'dichtomous' is no recognized value for the structure of identification tools. Please specify something like ‘n/a’, ‘dichotomous’ or ‘multi-access’. For more values see documentation.

A minimum example can look like:

{{Metadata
| Type  = StillImage
| Title = Bombus barbutellus color pattern (female)
| Scientific Names    = Bombus barbutellus;
| Metadata Language   = en 
| Language = zxx
| Copyright Statement = © Paul Williams, NHM
| Creators  = Paul Williams - NHM
| Subject Category    = Insecta
| General Keywords    = Schematic drawings; Bumblebees;
}}


Additional temporary or technical documentation

This metadata infobox is full width, non-floating. It has two columns of fields (i.e. 3-4 table column) in the middle, plus some fields column spanning as a Header (Title, Logo, Descriptions) and Footer (URIs). Not all fields are labeled; those that are not are labeled with a tooltip (pop-up if mouse hovers).

Used semantic properties

Additional properties are:

Further semantic properties are named after the template parameters, but note that most of them are mapped in the property name space to well defined ontology vocabulary concepts using the import mechanism by Semantic Media Wiki.

Dependencies

Template:WikiSyntaxToHTMLEntities 
replace simple Wiki syntax to HTML
Template:Metadata/Description 
for template parameter “description” a language specific description
Template:Metadata/Caption 
for template parameter “caption” a language specific caption
Template:Metadata/List to property 
for “Creators”, “Contributors” or “Copyright Owner” (remove Wiki syntax like [[User:…]])
Form:Metadata 
form for metadata
Template:Edit or create metadata 
form for creating metadata
Form:Search media by metadata 
form for searching metadata
Template:Search media by metadata 
template for searching metadata