DataWiki

User Tools

Site Tools

Trace: • 16_march_2012_friday_quarterly_telecon • membership • syntax • igsn
igsn:syntax

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
igsn:syntax [2015/05/08 06:11]
jklump [Explanation] Reference to syntax approval added. 		igsn:syntax [2016/03/24 10:16] (current)
ulbricht
Line 1: Line 1:
-====== IGSN Syntax Guidelines ====== 
  
-The following is a summary of the syntax guidelines for the IGSN: +:!: The documentation of the IGSN has moved to [[http://igsn.github.io/]] :!:
- +
-  - **The IGSN must be unique and is case insensitive**. +
-  - In consideration of human readability the **IGSN should be as concise as possible**. IGSNs will be displayed online and in print and will be re-typed by end users. The recommended format is therefore a string of nine characters. +
-  - **In general, an IGSN should not be considered "derivable"**. Although some IGSNs may be generated according to an algorithm, it is preferable to look them up in IGSN, as there is no guarantee that a generated IGSN has been registered with IGSN or that it will resolve. +
-  - Organisations assigning IGSNs may choose to adopt a consistent, logical system that can be easily documented and readily understood by employees of your organization. This helps to ensure the uniqueness of assigned IGSNs and makes it easier for the task of assigning IGSNs to be passed from one employee to the next. You might therefore **consider to include existing internal identifiers** already in use within your organization. +
-  - Suffix nodes may be used to reflect hierarchical information or levels of granularity. For instance, the first node might be a multiple-letter code for a drill core, while successive nodes encode sub-samples taken from the drill core. IGSN suffixes may be extensible, and the suffix nodes may be used for this purpose. For instance, in the future, further sub-samples taken from already subsampled materials might be assigned IGSNs. **In trying to keep IGSNs as short as possible, careful consideration should be taken before adopting a naming scheme that makes use of extending already existing IGSN names**. +
-===== Recommended Practice ===== +
- +
-Unlike many other persistent identifiers, an IGSN is used not only used by machines but also needs to be handled by humans. The labeling of sample containers prescribes a limit to the number of characters that fit on a label. Also, IGSNs in lists and tables will often need editing by humans. Long character strings increase the risk of mistypings. To reduce the risk of mistypings, the IGSN is case insensitive and we recommend to limit the length on an IGSN to nine characters((Deviations from the nine character format need to be approved by the IGSN technical committee. See also [[igsn:29_august_2014_friday_namespace_allocation_call|minutes of IGSN assembly on namespace allocation]].)) and to avoid characters that can easily be confused, such as ‘1’ and ‘I’, or  ‘0’ and ‘O’. +
- +
-Using [[http://tools.ietf.org/html/rfc5234|ABNF notation]] the syntax proposed syntax for an IGSN is: +
- +
-   <IGSN> = <Namespace><Code> +
-   <Namespace> = mUPPER (an m character code denoting the namespace) +
-   <Code> = nCHAR (a n character code)  +
-   UPPER                        = %x41-5A                       (A-Z) +
-   DIGIT                        = %x30-39                       (0-9) +
-   CHAR                         = UPPER / DIGIT / "-" / "."  +
-   reserved                     = ":" / "/" / "?" / "#" / "[" / "]" / "@" / "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" / "_" / "~" +
- +
-The [[igsn:glossary#allocating_agent|Allocating Agent]] ensures that the n-character code is unique within their [[igsn:glossary#namespace|namespaces]]. (see also IGSN [[igsn:namespaces|namespace governance]]) +
- +
-Characters a-z and A-Z in the IGSN string are case insensitive (e.g. ABC is identical to AbC). It is recommended to use upper case characters in all cases. +
- +
-Characters that may be confused with digits should be avoided (I = %x49, O = %x4F, i = %x69, o = %x6F) +
- +
-The resolvable handle URI of an IGSN is made up of three components: a resolving service (http://dx.doi.org or http://hdl.handle.net), the IGSN Handle prefix 10273, and the IGSN, separated by a forward slash. +
- +
-===== Using IGSNs in Manuscripts ===== +
- +
-IGSN e.V., Allocating Agents and academic publishers ask authors to tag IGSNs in their manuscripts. This will enable publishers to link the IGSN number to the respective samples sample when the paper is published online. To tag an IGSN, please use the syntax +
- +
-    IGSN: <IGSN>  +
- +
-In a journal article or manuscript a sample identified by IGSN SSH000SUA may look like this (tagged IGSN): +
- +
-    IGSN: SSH000SUA +
- +
-Tagging IGSNs in manuscripts in this way allows publishers to automatically link samples identified by IGSN to their respective descriptive pages on the web. See also [[http://www.geosamples.org/news/tag]] for more information about journals using IGSN. +
- +
-An example of a publication using live IGSNs can be found here: +
- +
-  * Dere, A. L., T. S. White, R. H. April, B. Reynolds, T. E. Miller, E. P. Knapp, L. D. McKay, and S. L. Brantley (2013), Climate dependence of feldspar weathering in shale soils along a latitudinal gradient, //Geochimica et Cosmochimica Acta//, **122**, 101–126, [[http://dx.doi.org/10.1016/j.gca.2013.08.001|doi:10.1016/j.gca.2013.08.001]]. +
- +
-===== IGSN Syntax Example ===== +
- +
-An International GeoSample Number (IGSN), is a unique string created to identify a sample object in an online environment. The IGSN is organised by [[igsn:glossary#namespace|namespaces]] to ensure globally unique allocation of IGSNs to samples. The [[igsn:syntax|recommended format]] of the IGSN is a nine character string consisting of a [[igsn:glossary#namespace|namespace]] identifier and a sample number. +
- +
-    Example (IGSN):      SSH000SUA (a sample at the Department of Geosciences, Pennsylvania State University, from the Susquehanna Shale Hills Critical Zone Observatory) +
- +
-The resolvable Handle URI is concatenated by the following rule: +
- +
-    <resolver>/<prefix>/<igsn> +
- +
-resulting in +
- +
-    Example (Handle):    http://hdl.handle.net/10273/SSH000SUA or http://dx.doi.org/10273/SSH000SUA +
- +
-where <resolver>/<prefix> is http://hdl.handle.net/10273 and  <igsn> is the value (IGSN) assigned by an [[igsn:glossary#allocating_agent|Allocating Agent]]. +
- +
-The example given above follows the [[igsn:syntax#recommended_practice|recommended practice]] for IGSN names. IGSN user [[igsn:glossary#community|communities]] may adopt their own IGSN formats, if necessary. These deviations from the recommended format need to be approved by the IGSN technical committee. +
- +
-    Example (IGSN):        GeoB3375-1 (a gravity core from the core repository of MARUM, Univ. Bremen, Germany) +
-    Example (Handle URI):  http://hdl.handle.net/10273/GeoB3375-1 +
- +
- +
-===== Explanation ===== +
- +
-Using [[http://tools.ietf.org/html/rfc5234|ABNF notation]] the recommended syntax for an IGSN is +
- +
-   <IGSN>               = <Namespace><Code> +
-   <Namespace>          = UPPER                        ; namespace adminstrated by the allocating agent +
-   <Code>               = CHAR                         ;  +
-   UPPER                = %x41-5A                       (A-Z) +
-   DIGIT                = %x30-39                       (0-9) +
-   CHAR = UPPER and DIGIT                               (A-Z and 0-9) +
- +
-Since IGSNs are intended to be combined into a URI, in order to retain maximum compatibility with [[http://tools.ietf.org/html/rfc3986|URI production rules]] it is suggested to limit the characters that can be used in the code to the so-called 'unreserved' + 'reserved' set, but not allow any other or percent-encoded characters which may exist on the keyboard or other character sets (e.g. no accented characters or non-latin alphabets, no space, CR, LF characters) leading to:  +
- +
-   <IGSN>               = <Namespace><Code> +
-   <Namespace>          = UPPER                        ; namespace adminstrated by the allocating agent +
-   <Code>               = CHAR                         ;  +
-   UPPER                = %x41-5A                       (A-Z) +
-   DIGIT                = %x30-39                       (0-9) +
-   CHAR = UPPER and DIGIT +
-   unreserved           = UPPER / DIGIT / "-" / "."  +
-   reserved             = ":" / "/" / "?" / "#" / "[" / "]" / "@" / "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "=" / "_" / "~" +
- +
- +
-The Allocating Agent ensures that element <Code> is unique within their namespace. +
- +
-Please note: +
-  * Characters 'a' - 'z' and 'A' - 'Z' in the IGSN string are case insensitive (e.g. ABC is identical to AbC). These characters in the IGSN string are converted to upper case upon registration and resolution. If an IGSN were registered as ABC, then abc would resolve it and a later attempt to register AbC would be rejected with an error message stating that the IGSN was already in existence. Comparison of two IGSNs (to decide if they match or not) should be done by first converting all characters 'a' - 'z' in IGSN strings to upper case, followed by octet-by-octet comparison of the entire IGSN string. +
-  * Consider URI Syntax (http://www.ietf.org/rfc/rfc2396.txt). UTF-8, which preserves ASCII characters, is the required coding.  +
- +
- +
-IGSN members have requested to allow deviations from this recommended practice to fit the requirements of existing large core repositories. Any deviations from the recommended nine character format for IGSN have to be approved by the IGSN technical committee. +
- +
- +
- +
-======  ====== +
- +
-[[igsn:start|Back]] to IGSN overview+
igsn/syntax.1431065471.txt.gz · Last modified: 2015/05/08 06:11 by jklump

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki