Skip to content

Latest commit

 

History

History
80 lines (75 loc) · 2.44 KB

readme-spec.md

File metadata and controls

80 lines (75 loc) · 2.44 KB
Raw

READMEdc File Specification

Version 2019-12-17

  1. File Name Convention

    • Scope
      • Public: READMEdc.txt
      • Private: READMEdc.private.txt
    • Sorting __ prefixing can be used to bring README files to a front file list position

  2. Content
    2.1 Comments

    • Lines starting with a hash sign (#) are identified as a comment. All the text from the hash sign to the end of the line is ignored. 
      # This is a comment

    2.2 Keys

    • The content is represented as key:value pairs on one line: 
      key:value
    • A key starts at the beginning of a line
    • A key is composed of any character: 
      key1:value
    • The usage of spaces in key terms is not recommended.
    • Any leading and trailing whitespace is removed in keys
    • All keys are optional
    • Duplicate keys are allowed and do not overwrite previous values 
      key:value1
key:value2
    • Keys with empty values are ignored
    • All key names with a preceding _ are reserved for system use

    2.3 Separator

    • A colon separates key and value

    2.4 Values

    • A value is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.
    • Multiline values can be indented with spaces: 
      key:Line1
 Line2
 Line3
    • Text and Numeric value types are detected automatically
    • Date value format: yyyy/MM/dd in UTC
    • Time value format: yyyy/MM/dd HH:mm:ss in UTC
    • Multiple values for one key can be separated with a semicolon: 
      key: value1; value2

  3. Example READMEdc.txt
    The following file content is based on the Dublin Core metadata schema:

    title:Getting started on BayCEER CLOUD
creator:Oliver Archner; Stefan Holzheu
subject:ownCloud
subject:BayCEER
description:A small guide to work with BayCEER CLOUD
  Installation 
  Getting started
  Demo 
publisher:University of Bayreuth
contributor:BayCEER IT Group
date:2019/01/10
type:Text
format:Markdown
identifier:
source:
language:en
relation:
coverage:
rights:Creative commons share alike