Difference between revisions of "Import description matrix (Artenquiz)"

From Biowikifarm Metawiki
Jump to: navigation, search
m
m (→‎Fields: Tags)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
[[Excel to SDD converter]] is the basis for this import module of the django application [[Artenquiz documentation|Artenquiz]].
 
[[Excel to SDD converter]] is the basis for this import module of the django application [[Artenquiz documentation|Artenquiz]].
 +
 +
== Taxon columns ==
 +
<dl>
 +
<dd style="margin-left: 1.95em;">The first column in the spreadsheet ''must always'' be the primary name of the organism (= taxon). If this is the only name column, it may be either the common or scientific name (but see below).
 +
<dd style="margin-left: 1.95em;"> <dl style="border-left:1px solid gray">
 +
<dd style="margin-left: 1.95em;"> If any of the 2nd to 5th column is labeled "Scientific Name", "scientific name", or "Wissenschaftlicher Name", it will be considered the scientific name of the organism. The first column will be the common name. <!-- SDD: maps to representation/label in taxon, with xml:lang="zxx-x-taxon" -->
 +
<dd style="margin-left: 1.95em;"> <dl style="border-left:1px solid gray">
 +
<dd style="margin-left: 1.95em;"> If any of the 2nd to 5th column is labeled "Images", "images", "Image", "image", "Bilder" or "Bild", it will be considered to contain a list of organism (taxon) images. Image references starting with http:// are direct web links, those starting with "File:" or "Datei:" are internal links to files. Each link must be written between double square brackets (e.g. <nowiki>[[File:...]]</nowiki>). No delimiter is needed for multiple images.
 +
<dd style="margin-left: 1.95em;"> <dl style="border-left:1px solid gray">
 +
<dd style="margin-left: 1.95em;"> If any of the 2nd to 5th column is labeled "URL" or "url", it will be considered a link to a species or taxon page. Only links to web pages are supported (e.g. <nowiki>http://...</nowiki>) and each link must be written in double square brackets (<nowiki>[[http://...]]</nowiki>).
 +
<dd style="margin-left: 1.95em;"> <dl style="border-left:1px solid gray">
 +
<dd style="margin-left: 1.95em;"> If any of the 2nd to 5th column is labeled "Scope", "scope", "Stadium", "Geltungsbereich" or "Gültigkeitsbereich" it will be considered a a scope like "female", "male", "juvenile", "adult", "larvae", "imago", "breeding plumage/Prachtkleid", "eclipse plumage/Schlichtkleid". Using this method, a single species with different appearances can be separately described in two different rows.
 +
<dd> <dl style="border-left:1px solid gray"><br/></dl>
 +
</dl>
 +
</dl>
 +
</dl>
 +
</dl>
 +
</dl>
 +
 +
{| style="margin-left:0.9em;" class="wikitable"
 +
|-
 +
| style="padding: 0px 0.4em 0px 0.4em;"| {{comment gray |‹1›}}
 +
| style="padding: 0px 0.4em 0px 0.4em;"| {{comment gray |‹2›}}
 +
| style="padding: 0px 0.4em 0px 0.4em;"| {{comment gray |‹3›}}
 +
| style="padding: 0px 0.4em 0px 0.4em;"| {{comment gray |‹4›}}
 +
| style="padding: 0px 0.4em 0px 0.4em;"| {{comment gray |‹5›}}
 +
| {{comment gray |‹character_1›}}
 +
| {{comment gray |‹character_2›}}
 +
| …
 +
|-
 +
| … || … || … || … || … || … || … || …
 +
|}
  
 
==Metadata rows==
 
==Metadata rows==
  
−
Below the main matrix table, a blank row and a second row containing the text <code>[METADATA]</code> indicates the start of key-wide metadata. The first column contains a field name, the second the value. The following fields are recommended:
+
Below the main matrix table must be a blank row followed by the word <code>[METADATA]</code> that indicates the start of key-wide metadata. Column one contains the metadata field name and the second column the corresponding value. The following fields are recommended:
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|+ <span style="font-weight:normal">Structure of Metadata below the data matrix; '''bold''' indicates mandatory fields</span>
 
|+ <span style="font-weight:normal">Structure of Metadata below the data matrix; '''bold''' indicates mandatory fields</span>
 
|-
 
|-
−
|<!--  -->{{comment gray | [DATA MATRIX] }} ||<!--  -->{{comment gray | [DATA MATRIX] }}
+
|<!--  -->{{comment gray | ‹DATA MATRIX› }} ||<!--  -->{{comment gray | ‹DATA MATRIX› }}
 
|-
 
|-
 
|<!--  -->{{comment gray | ‹blank line› }} ||<!--  -->{{comment gray | ‹blank line› }}
 
|<!--  -->{{comment gray | ‹blank line› }} ||<!--  -->{{comment gray | ‹blank line› }}
Line 18: Line 50:
 
|<!--  -->'''Creators:''' ||<!--  -->A. First; B. Second
 
|<!--  -->'''Creators:''' ||<!--  -->A. First; B. Second
 
|-
 
|-
−
|<!--  -->Emails: ||<!--  -->first@first.go; second@second.go
+
|<!--  -->Emails: ||<!--  -->first@email.me; second@email.me
 +
|-
 +
|<!--  -->Contributors: ||<!--  -->C. Name; D. Name
 +
|-
 +
|<!--  -->Emails: ||<!--  -->cname@email.me; dname@email.me
 
|-
 
|-
 
|<!--  -->Description: ||<!--  -->Free form text, including information about source of information, literature used, geographic or taxonomic scope, etc. <small>(Mapping to SDD:Dataset/Representation/Detail)</small><br/>
 
|<!--  -->Description: ||<!--  -->Free form text, including information about source of information, literature used, geographic or taxonomic scope, etc. <small>(Mapping to SDD:Dataset/Representation/Detail)</small><br/>
Line 26: Line 62:
 
|<!--  -->'''Kingdom:''' ||<!--  -->Aves
 
|<!--  -->'''Kingdom:''' ||<!--  -->Aves
 
|-
 
|-
−
|<!--  -->Tag: ||<!--  -->Identification
+
|<!--  -->Tags: ||<!--  -->Identification
 
|-
 
|-
 
|<!--  -->Copyright: ||<!--  -->(c) A. First and B. Second 2010
 
|<!--  -->Copyright: ||<!--  -->(c) A. First and B. Second 2010
Line 32: Line 68:
 
|<!--  -->License: ||<!--  -->Creative commons by-sa 3.0
 
|<!--  -->License: ||<!--  -->Creative commons by-sa 3.0
 
|}
 
|}
−
Note: The keywords are recognized error tolerant with and without the colon, i.e. both '''Title:''' and '''Title''' are accepted.
+
Note: The field names (left column) are recognized with and without the colon (both '''Title:''' and '''Title''' are accepted).
−
[[Category: Software documentation]]
+
 
  
 
=== Fields ===
 
=== Fields ===
−
; Title :
+
 
−
; Emails :  
+
; Copyright : …
−
; Tag : an internal (filter) tag
+
; License : …
 +
; Creators : (mandatory) semicolon separated list
 +
; Contributors : (optional) semicolon separated list
 +
; Emails : (optional) emails that correspond to each creator (semicolon separated list). If “Contributors:” precedes “Emails:” then it will be treated as contributor's email. If “Creators:” precedes “Emails:” then it will be treated as creator's email
 +
; Description : (optional) Free form text, including information about source of information, literature used, geographic or taxonomic scope, etc. <small>(Mapping to SDD:Dataset/Representation/Detail)</small>
 +
; Language :  (mandatory) language code ([http://en.wikipedia.org/wiki/ISO_639-1 ISO-639-1])
 +
; Tags : (optional, semicolon separated list) an internal filter tagging label, e.g. Identification. Used tags: Identification, Public, Artenquiz
 +
; Title :  (mandatory) a concise title
 +
 
 +
==== Taxonomic fields: ====
 +
 
 +
; Kingdom :  (mandatory)
 +
; Phylum, Division : …
 +
; Class : …
 +
; Subclass : …
 +
; Order : …
 +
; Suborder : …
 +
; Family : …
 +
; Subfamily : …
 +
[[Category: Import]]

Latest revision as of 12:17, 26 August 2013

Excel to SDD converter is the basis for this import module of the django application Artenquiz.

Taxon columns

The first column in the spreadsheet must always be the primary name of the organism (= taxon). If this is the only name column, it may be either the common or scientific name (but see below).
If any of the 2nd to 5th column is labeled "Scientific Name", "scientific name", or "Wissenschaftlicher Name", it will be considered the scientific name of the organism. The first column will be the common name.
If any of the 2nd to 5th column is labeled "Images", "images", "Image", "image", "Bilder" or "Bild", it will be considered to contain a list of organism (taxon) images. Image references starting with http:// are direct web links, those starting with "File:" or "Datei:" are internal links to files. Each link must be written between double square brackets (e.g. [[File:...]]). No delimiter is needed for multiple images.
If any of the 2nd to 5th column is labeled "URL" or "url", it will be considered a link to a species or taxon page. Only links to web pages are supported (e.g. http://...) and each link must be written in double square brackets ([[http://...]]).
If any of the 2nd to 5th column is labeled "Scope", "scope", "Stadium", "Geltungsbereich" or "Gültigkeitsbereich" it will be considered a a scope like "female", "male", "juvenile", "adult", "larvae", "imago", "breeding plumage/Prachtkleid", "eclipse plumage/Schlichtkleid". Using this method, a single species with different appearances can be separately described in two different rows.

‹1› ‹2› ‹3› ‹4› ‹5› ‹character_1› ‹character_2› …
… … … … … … … …

Metadata rows

Below the main matrix table must be a blank row followed by the word [METADATA] that indicates the start of key-wide metadata. Column one contains the metadata field name and the second column the corresponding value. The following fields are recommended:

Structure of Metadata below the data matrix; bold indicates mandatory fields
‹DATA MATRIX› ‹DATA MATRIX›
‹blank line› ‹blank line›
[METADATA]
Title: A key to XXX
Creators: A. First; B. Second
Emails: first@email.me; second@email.me
Contributors: C. Name; D. Name
Emails: cname@email.me; dname@email.me
Description: Free form text, including information about source of information, literature used, geographic or taxonomic scope, etc. (Mapping to SDD:Dataset/Representation/Detail)
Language: en
Kingdom: Aves
Tags: Identification
Copyright: (c) A. First and B. Second 2010
License: Creative commons by-sa 3.0

Note: The field names (left column) are recognized with and without the colon (both Title: and Title are accepted).


Fields

Copyright 
…
License 
…
Creators 
(mandatory) semicolon separated list
Contributors 
(optional) semicolon separated list
Emails 
(optional) emails that correspond to each creator (semicolon separated list). If “Contributors:” precedes “Emails:” then it will be treated as contributor's email. If “Creators:” precedes “Emails:” then it will be treated as creator's email
Description 
(optional) Free form text, including information about source of information, literature used, geographic or taxonomic scope, etc. (Mapping to SDD:Dataset/Representation/Detail)
Language 
(mandatory) language code (ISO-639-1)
Tags 
(optional, semicolon separated list) an internal filter tagging label, e.g. Identification. Used tags: Identification, Public, Artenquiz
Title 
(mandatory) a concise title

Taxonomic fields:

Kingdom 
(mandatory)
Phylum, Division 
…
Class 
…
Subclass 
…
Order 
…
Suborder 
…
Family 
…
Subfamily 
…
Retrieved from "https://biowikifarm.net/metawiki/index.php?title=Import_description_matrix_(Artenquiz)&oldid=4612"