W3C home > Mailing lists > Public > public-dxwg-wg@w3.org > July 2018

Re: [dxwg] profileDesc and the Guidance document

From: kcoyle via GitHub <sysbot+gh@w3.org>
Date: Mon, 30 Jul 2018 16:01:27 +0000
To: public-dxwg-wg@w3.org
Message-ID: <issue_comment.created-408916364-1532966486-sysbot+gh@w3.org>
I've thought more about this, and here is an outline that is based on some metadata profiles that I am familiar with. Although none of our use cases specifies the need for administrative data, we can probably assume that it is, if not required, at least a good idea.

This outline separates into two separate sections the expression of the profile itself, and information about the profile (meta information). What goes where is up for discussion, but this seems to me to break the profile description into sections that would make sense to the reader: what is a profile? how do I make it available? (publishing), how is it administered?, what needs to be said about its context? All of this could be managed in a single profile document, or there could be separate documents that are linked.


Introduction (non-normative)
What is a profile? (normative)
* A profile SHOULD have a textual description intended for humans
* A profile SHOULD describe metadata elements/properties
* A profile SHOULD describe valid value types for elements
* A profile SHOULD provide relevant cardinality rules
* (etc. here until we finalize requirements - these are just examples)

Profile publication (normative)
* (here the various options for publication - PDF, XML, RDF...)

Examples (non-normative)
    * ODRL is a good example since their profiles are explicitly media-type independent
    * DCAT APs
    * BIBFRA.ME (one namespace)

Definitions (normative)
* Profile
* Schema (?)
* Formalism (?)
* ...

Administrative and descriptive metadata (normative)
* Administrative
  * A profile MUST have URI (or an IRI?) identifying it. The URI SHOULD be an http URI
  * creator/maintainer (+ contact info)
  * date/version
  * ...
* Descriptive
  * title
  * human-readable description
    * Background, motivation, use cases
    * Design rationale
    * Model and elements
  * Relationship to vocabs or other profiles
  * Link to validation schemas implementing the profile 
  * Example(s) (non-normative)

Bibliography


-- 
GitHub Notification of comment by kcoyle
Please view or discuss this issue at https://github.com/w3c/dxwg/issues/242#issuecomment-408916364 using your GitHub account
Received on Monday, 30 July 2018 16:01:30 UTC

This archive was generated by hypermail 2.3.1 : Monday, 25 March 2019 10:33:24 UTC