Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/guidance-doc' into guidance-doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicholas Car committed Oct 16, 2018
2 parents 84ffb9f + 2e81631 commit eafd488
Show file tree
Hide file tree
Showing 14 changed files with 701 additions and 388 deletions.
2 changes: 1 addition & 1 deletion conneg-by-ap/config.js
@@ -1,5 +1,5 @@
var respecConfig = {
specStatus: "ED",
specStatus: "FPWD",
shortName: "conneg-by-ap",
edDraftURI: "https://w3c.github.io/dxwg/conneg-by-ap/",
previousURI: "https://w3c.github.io/dxwg/conneg-by-ap/",
Expand Down
2 changes: 0 additions & 2 deletions conneg-by-ap/index.html
Expand Up @@ -3,9 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" >
<meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name="viewport">
<meta content="ED" name="w3c-status">
<title>Content Negotiation by Profile</title>
<link rel="stylesheet" type="text/css" href="https://www.w3.org/StyleSheets/TR/2016/W3C-WD"/>
</head>
<body class="h-entry" id="respecDocument">
<section id="abstract">
Expand Down
2 changes: 1 addition & 1 deletion dcat/config.js
Expand Up @@ -11,7 +11,7 @@ var respecConfig = {
issueBase: "https://github.com/w3c/dxwg/issues/",
editors: [{
name: "Alejandra Gonzalez Beltran",
company: "University of Oxford eResearch Centre",
company: "Oxford eResearch Centre, Engineering Science, University of Oxford",
url: "https://www.oerc.ox.ac.uk/people/alejandra",
companyURL: "http://www.oerc.ox.ac.uk/"
},{
Expand Down
48 changes: 48 additions & 0 deletions dcat/examples/dataset-004.ttl
@@ -0,0 +1,48 @@
# baseURI: http://example.org/dataset-004
# imports: http://www.w3.org/ns/dcat

@prefix : <http://example.org/dataset-004#> .
@prefix dcat: <http://www.w3.org/ns/dcat#> .
@prefix dct: <http://purl.org/dc/terms/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

<http://example.org/dataset-004>
rdf:type owl:Ontology ;
owl:imports <http://www.w3.org/ns/dcat> ;
.
:dataset-004
rdf:type dcat:Dataset ;
dcat:distribution :dataset-004-csv ;
dcat:distribution :dataset-004-png ;
.
:dataset-004-csv
rdf:type dcat:Distribution ;
dcat:accessService :table-service-005 ;
dcat:accessURL <http://example.org/api/table-005> ;
dcat:mediaType <https://www.iana.org/assignments/media-types/text/csv> ;
.
:dataset-004-png
rdf:type dcat:Distribution ;
dcat:accessService :figure-service-006 ;
dcat:accessURL <http://example.org/api/figure-006> ;
dcat:mediaType <https://www.iana.org/assignments/media-types/image/png> ;
.
:figure-service-006
rdf:type dcat:DataDistributionService ;
dct:conformsTo <http://example.org/apidef/figure/v1.0> ;
dct:type <https://inspire.ec.europa.eu/metadata-codelist/SpatialDataServiceType/view> ;
dcat:endpointDescription <http://example.org/api/figure-006/params> ;
dcat:endpointURL <http://example.org/api/figure-006> ;
dcat:servesDataset :dataset-004 ;
.
:table-service-005
rdf:type dcat:DataDistributionService ;
dct:conformsTo <http://example.org/apidef/table/v2.2> ;
dct:type <https://inspire.ec.europa.eu/metadata-codelist/SpatialDataServiceType/download> ;
dcat:endpointDescription <http://example.org/api/table-005/capability> ;
dcat:endpointURL <http://example.org/api/table-005> ;
dcat:servesDataset :dataset-004 ;
.
588 changes: 346 additions & 242 deletions dcat/index.html

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions profiles/config.js
Expand Up @@ -87,6 +87,16 @@ var respecConfig = {
"date": " 2017-10-24",
"status": "IETF Internet Draft"
},
"PROF-ONT": {
editors: [
"Rob Atkinson",
"Nicholas J. Car"
],
href: "https://www.w3.org/TR/vocab-prof/",
title: "Profile Descriptions ontology",
date: "2018-09-15",
status: "W3C Working Group Note"
},
"vocab-dcat-2": {
editors: [
"Alejandra Gonzalez Beltran",
Expand Down
80 changes: 41 additions & 39 deletions profiles/index.html
Expand Up @@ -15,13 +15,20 @@
<ul>
<li><a href="https://www.w3.org/2017/dxwg/wiki/ProfileRoundup">Profile Roundup</a></li>
</ul>
<div class="issue" data-number="196"></div>
<div class="issue" data-number="242"></div>
<div class="issue" data-number="323"></div>
</div>

<section id="abstract">
<h2>Abstract</h2>
<div class="issue" data-number="476"></div>
<p>
A <em>profile</em> is a named set of constraints on one or more identified <em>base specifications</em>, necessary
to accomplish a particular function.
</p>
<p>
This document aims to provide guidance on how to create, describe and publish profiles.
</p>
</section>

<section id="sotd">
Expand Down Expand Up @@ -106,12 +113,12 @@ <h1>Introduction</h1>
<div class="issue" data-number="417"></div>
<div class="issue" data-number="450"></div>
<div class="note">(Antoine:) Nick suggested to reuse some elements of the F2F3 outline as a 'motivation' section. I believe the following ones could be mentioned in intro:
<ul>
<li>Communities, national identity on data standards, domains of activity</li>
<li>Functions: consensus; sharing; search; etc.</li>
<ul>
<li>Communities, national identity on data standards, domains of activity</li>
<li>Functions: consensus; sharing; search; etc.</li>
</ul>
</div>
</div>
<h4>Related work and examples of existing profiles</h4>
<p>
<em>profiling</em> is an activity that has been undertaken by many communities with a range of formalisms.
Expand Down Expand Up @@ -144,12 +151,12 @@ <h4>BIBFRA.ME</h4>
<div class="issue" data-number="435"></div>
<h2>What is a profile?</h2>
<div class="note">(Antoine:) From https://github.com/w3c/dxwg/issues/242#issuecomment-408916364:
<ul>
<li>A profile SHOULD have a textual description intended for humans</li>
<li>A profile SHOULD describe metadata elements/properties</li>
<li>A profile SHOULD describe valid value types for elements</li>
<li>A profile SHOULD provide relevant cardinality rules</li>
<li>(etc. here until we finalize requirements - these are just examples)</li>
<ul>
<li>A profile SHOULD have a textual description intended for humans</li>
<li>A profile SHOULD describe metadata elements/properties</li>
<li>A profile SHOULD describe valid value types for elements</li>
<li>A profile SHOULD provide relevant cardinality rules</li>
<li>(etc. here until we finalize requirements - these are just examples)</li>
</ul>
</div>

Expand All @@ -162,9 +169,9 @@ <h2>What is a profile?</h2>
<section id="publication">
<h2>Profile publication</h2>
<div class="note">(Antoine:) From https://github.com/w3c/dxwg/issues/242#issuecomment-408916364:
<ul>
<li>(here the various options for publication - PDF, XML, RDF...)</li>
<li>URL requirement fits here?</li>
<ul>
<li>(here the various options for publication - PDF, XML, RDF...)</li>
<li>URL requirement fits here?</li>
</ul>
</div>
<div class="issue" data-number="365"></div>
Expand All @@ -176,26 +183,28 @@ <h2>Profile publication</h2>
<section id="metadata">
<h2>Administrative and descriptive metadata</h2>
<div class="note">(Antoine:) From https://github.com/w3c/dxwg/issues/242#issuecomment-408916364, Administrative metadata:
<ul>
<li>A profile MUST have URI (or an IRI?) identifying it. The URI SHOULD be an http URI</li>
<li>creator/maintainer (+ contact info)</li>
<li>date/version</li>
<li>etc</li>
<li></li>
<ul>
<li>A profile MUST have URI (or an IRI?) identifying it. The URI SHOULD be an http URI</li>
<li>creator/maintainer (+ contact info)</li>
<li>date/version</li>
<li>etc</li>
<li></li>
</ul>
</div>
<div class="note">(Antoine:) I've kept it here, but I do agree with the comment at https://github.com/w3c/dxwg/issues/242#issuecomment-408916364 (and above) that URI should be in a specific section on publication of profiles.</div>
<div class="note">(Antoine:) From https://github.com/w3c/dxwg/issues/242#issuecomment-408916364, Descriptive metadata:
<ul>
<li>title</li>
<li>human-readable description </li>
<li><ul>
<li>title</li>
<li>Design rationale</li>
<li>Model and elements</li>
</ul></li>
<li>Relationship to vocabs or other profilesn</li>
<li>Link to validation schemas implementing the profile</li>
<ul>
<li>title</li>
<li>human-readable description </li>
<li>
<ul>
<li>title</li>
<li>Design rationale</li>
<li>Model and elements</li>
</ul>
</li>
<li>Relationship to vocabs or other profilesn</li>
<li>Link to validation schemas implementing the profile</li>
</ul>
</div>
<div class="issue" data-number="369"></div>
Expand All @@ -215,7 +224,7 @@ <h2>Examples of applying these recommendations</h2>
<p><em>This section is non-normative.</em></p>
<div class="note">(Antoine:) The idea here would be to point to examples that follow our recommendations, made up to illustrate specific features, or complete 'real' implementations. Ideally these would be using prof-o, on the condition that we still refer to prof-o as a suggestion not a formal recommendation (see the way it's been mentioned above). I reckon that some may find it more natural to have fully fledged</div>
<div class="issue" data-number="370"></div>
<section id="relatedworkexamples">
<h3>Examples on existing profiles</h3>
<section id="dcat-ap">
Expand Down Expand Up @@ -369,12 +378,5 @@ <h3>Additional Issues</h3>

<script class="remove" src="config.js"></script>
<script class="remove" src="https://www.w3.org/Tools/respec/respec-w3c-common"></script>
<script>
var allIssues = document.getElementsByClassName('custid');
for (var i = 0; i < allIssues.length; ++i) {
var item = allIssues[i];
item.innerHTML = '';
}
</script>
</body>
</html>
22 changes: 21 additions & 1 deletion profilesont/config.js
@@ -1,7 +1,9 @@
var respecConfig = {
specStatus: "ED",
specStatus: "FPWD-NOTE",
shortName: "vocab-prof",
edDraftURI: "https://w3c.github.io/dxwg/profilesont/",
canonicalURI: "TR",
implementationReportURI: "https://github.com/CSIRO-enviro-informatics/prof-ont-implementation-results",
editors: [
{
name: "Rob Atkinson",
Expand All @@ -15,6 +17,15 @@ var respecConfig = {
companyURL: "https://www.csiro.au/",
w3cid: 70131
}],
otherLinks: [{
key: "Contributors",
data: [
{
value: "Simon Cox",
href: "http://people.csiro.au/Simon-Cox"
}
]
}],
wg: "Dataset Exchange Working Group",
wgURI: "https://www.w3.org/2017/dxwg/",
wgPublicList: "public-dxwg-comments",
Expand Down Expand Up @@ -130,3 +141,12 @@ var respecConfig = {
}
}
};

/*
,
extras: [{
name: "<img src='orcid_logo.png' alt='orcid logo' />",
href: "https://orcid.org/0000-0002-8742-7730",
class: "orcid"
}]
*/
Binary file modified profilesont/diagrams.pptx
Binary file not shown.

0 comments on commit eafd488

Please sign in to comment.