Skip to content

Commit

Permalink
Merge pull request #628 from w3c/kc_branch
Browse files Browse the repository at this point in the history 
cleaned up with requirements
  • Loading branch information
@aisaac
aisaac committed Dec 17, 2018
2 parents 0c93b91 + 5a514dd commit 9ecaeb5
Showing 1 changed file with 38 additions and 59 deletions.
97 changes: 38 additions & 59 deletions profiles/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -179,47 +179,46 @@ <h2>Profiles defined</h2>
These Components/Manifestations play specific Functions (roles) for the implementation of the services that motivate the creation of the Profile.
These Components are serialized and published as Distributions in various formats, which are the concrete input for performing these services.
</p>
<div class="note"><p>

<section class="requirement" id="RPFNCTERMS">
<h3>Named collections of terms [RPFNCTERMS]</h3>
<p>Profiles are "named collections of properties" or metadata terms (if not RDF).</p>
<p class="relatedUseCases"><a href="#ID41"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/275">github:issue/275</a></span>
<a href="https://github.com/w3c/dxwg/issues/275">github:issue/275</a></span>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">It could also be in roles/functions if there is nothing there about defining terms. Antoine Isaac, 2018-11-11
</p></div>
</section>


<section class="requirement" id="RPFMBSPEC">
<h3>Multiple base specifications [RPFMBSPEC]</h3>
<p>A profile can have multiple base specifications.</p>
<p class="relatedRequirements"><a href="#RPFINHER"></a></p>
<p class="relatedUseCases"><a href="#ID37"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/268">github:issue/268</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/268">github:issue/268</a></span>
</section>

<section class="requirement" id="RPFPP">
<h3>Profile of profiles [RPFPP]</h3>
<p>One can create a profile of profiles, with elements potentially inherited on several levels.</p>
<p class="relatedUseCases"><a href="#ID37"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/270">github:issue/270</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/270">github:issue/270</a></span>
</section>



<section class="requirement" id="RPFINHER">
<h3>Profile inheritance [RPFINHER]</h3>
<p>Profiles may add to or specialise clauses from one or more base specifications. Such profiles inherit all the constraints from base specifications.</p>
<p class="relatedRequirements"><a href="#RPFMBSPEC"></a></p>
<p class="relatedUseCases"><a href="#ID37"></a><a href="#ID39"></a></p>

<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">
It was approved in <a href="https://www.w3.org/2018/07/10-dxwg-minutes#x16">minutes</a> but there was no github issue for it.
(This requirement is wrongly refered to as Github #238 and I've removed that reference). Antoine Isaac, 2018-11-11
</p></div>
</section>




<section class="requirement" id="RPFDAPUB-1">
<h3>Data publication according to different profiles-1 [RPFDAPUB-1]</h3>
<p>Some data may conform to one or more profiles at once</p>
<p class="relatedUseCases"><a href="#ID3"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/608">github:issue/608</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/608">github:issue/608</a></span>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">
<!--
The <a href="https://docs.google.com/document/d/13hV2tJ6Kg2Hfe7e1BowY5QfCIweH9GxSCFQV1aWtOPg/">Google Doc</a>
Expand All @@ -234,23 +233,23 @@ <h3>Data publication according to different profiles-1 [RPFDAPUB-1]</h3>
<section class="requirement" id="RPFDAPUB-2">
<h3>Data publication according to different profiles-2 [RPFDAPUB-2]</h3>
<p>Data publishers may publish data according to different profiles, either simultaneously (e.g. in one same data "distribution") or in parallel (e.g. via content negotiation)</p>
<p class="relatedUseCases"><a href="#ID37"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/274">github:issue/274</a></span>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/274">github:issue/274</a></span>
<div class="note">

(KC:) This might be better placed in the publication section
</div>
<div class="note">
There is a lot of uncertainty on where this requirement should be categorized.
There is a big 'profile negotiation' flavour to it, but it's not only about it.
We are keeping it here for now as we are not sure where it should be.
<!--In the <a href="https://docs.google.com/document/d/13hV2tJ6Kg2Hfe7e1BowY5QfCIweH9GxSCFQV1aWtOPg/">Google Doc</a> -->
It was listed as a general requirement, but it could be categorized instead as a requirement for profile negotiation,
or DCAT distribution, or both. In addition, it is highly overlapping with the <a href="#RPFDAPUB-1">previous requirement</a>
(and we've edited the heading to reflect it).
Antoine Isaac, 2018-11-25
</p></div>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">

(KC:) This might be better placed in the publication section
</p></div>
</section>
Antoine Isaac, 2018-11-25</div>

<div class="note">

(Antoine:) Obviously at this stage some names in this model have to be finalized.
We will also provide with a diagram that shows our 'big picture' on profiles and their possible (or recommended) components.
Something at the level of the diagram at https://docs.google.com/drawings/d/1dHkpwKwUwMgS1RqSCTPO3uOoRiY_qNk0z5bhXJlYi4Y/,
Expand All @@ -261,12 +260,12 @@ <h3>Data publication according to different profiles-2 [RPFDAPUB-2]</h3>
<p>(Riccardo:) We should talk about 'distribution of a manifestation' not 'distribution' alone.</p>


<p>The W3C DXWG has identified general requirements about profiles, which we list here and are going to expand upon (in more detailed requirements and recommendations) in the following section:</p>
<p>The W3C DXWG has identified general requirements about profiles, which we list here and are going to expand upon (in more detailed requirements and recommendations) in the following section:</p></div>
<div class="note"><p>
(Antoine:) Once the structure is stabilized this section should list the other sections it 'introduces'.
Maybe these sections will be moved as sub-sections of this one.</p>
</div>

</div></div>
</section>

<section id="functions">
<h2>The Functions of a Profile</h2>
Expand All @@ -278,22 +277,19 @@ <h2>The Functions of a Profile</h2>
<section class="requirement" id="RPFHRDEF">
<h3>Human-readable definitions [RPFHRDEF]</h3>
<p>Profiles can have human-readable definitions of terms and input instructions.</p>
<p class="relatedUseCases"><a href="#ID46"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/283">github:issue/283</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/283">github:issue/283</a></span>
</section>

<section class="requirement" id="RPGRDC">
<h3>Global rules for descriptive content [RPGRDC]</h3>
<p>There needs to be a property in the profile where the rules for the descriptive content can be provided. This would apply to the entire profile.</p>
<p class="relatedUseCases"><a href="#ID42"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/255">github:issue/255</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/255">github:issue/255</a></span>
</section>

<section class="requirement" id="RPFVALID">
<h3>Data validation [RPFVALID]</h3>
<p>A profile may be (partially) "implemented" by "schemas" (in OWL, SHACL, XML Schema...) that allow different levels of data validation</p>
<p class="relatedUseCases"><a href="#ID37"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/273">github:issue/273</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/273">github:issue/273</a></span>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">This requirement, which is a bit redundant
with <a href="https://github.com/w3c/dxwg/issues/279">github:issue/279</a>, has been shifted towards the function of data validation instead of focusing on the representations that enable it.
</p></div>
Expand All @@ -302,50 +298,39 @@ <h3>Data validation [RPFVALID]</h3>
<section class="requirement" id="RPFESIP">
<h3>External specifications for individual properties [RPFESIP]</h3>
<p>Profiles should be able to indicate which external specifications are expected to be applied/have been applied to values of individual properties.</p>
<p class="relatedUseCases"><a href="#ID43"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/280">github:issue/280</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/280">github:issue/280</a></span>
</section>

<section class="requirement" id="RPFVALIDR">
<h3>Validity rules [RPFVALIDR]</h3>
<p>Profiles may provide rules governing value validity.</p>
<p class="relatedUseCases">
<a href="#ID41"></a>
</p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/277">github:issue/277</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/277">github:issue/277</a></span>
</section>

<section class="requirement" id="RPFVLIST">
<h3>Value lists for data elements [RPFVLIST]</h3>
<p>Profiles may provide lists of values to pick from in order to populate data elements.</p>
<p class="relatedUseCases"><a href="#ID46"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/282">github:issue/282</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/282">github:issue/282</a></span>
</section>

<section class="requirement" id="RPFCARDR">
<h3>Cardinality rules [RPFCARDR]</h3>
<p>Profiles may provide rules on cardinality of terms (including "recommended").</p>
<p class="relatedUseCases">
<a href="#ID41"></a>
</p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/276">github:issue/276</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/276">github:issue/276</a></span>
</section>

<section class="requirement" id="RPFDEPR">
<h3>Dependency rules [RPFDEPR]</h3>
<p>Profiles may express dependencies between elements of the vocabulary (if A then not B, etc.).</p>
<p class="relatedUseCases"><a href="#ID41"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/278">github:issue/278</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/278">github:issue/278</a></span>
</section>

<section class="requirement" id="RPFUI">
<h3>User interface support [RPFUI]</h3>
<p>Profiles can have what is needed to drive forms for data input or for user display.</p>
<p class="relatedUseCases"><a href="#ID46"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/281">github:issue/281</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/281">github:issue/281</a></span>
</section>

</section>

<div class="note">
We could reference a list of profile expression languages and the functions they are typically expected to enable,
Expand All @@ -364,15 +349,13 @@ <h3>Profile documentation [RPFDOCU]</h3>
of a profile, which can also be available as machine-readable resources (ontology or schema files,
SHACL files, etc). This includes listing of elements in the profile, instructions and recommendations
on how to use them, constraints that determine what data is valid according to the profile, etc.</p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/272">github:issue/272</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/272">github:issue/272</a></span>
</section>

<section class="requirement" id="RPFSCHEMAS">
<h3>Schema implementations [RPFSCHEMAS]</h3>
<p>Profiles may be written in or may link to a document or schema in a validation language (ShEx, SHACL, XMLschema).</p>
<p class="relatedRequirements"><a href="#RPFIMPL"></a></p>
<p class="relatedUseCases"><a href="#ID41"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/279">github:issue/279</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/279">github:issue/279</a></span>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">This requirement, which is a bit redundant
with <a href="https://github.com/w3c/dxwg/issues/273">github:issue/273</a>, has been shifted towards the notion of distributions of schemas, instead of focusing on the general validation function.
</p></div>
Expand All @@ -397,9 +380,7 @@ <h2>Profile metadata</h2>
<section class="requirement" id="RPFMD">
<h3>Profile metadata [RPFMD]</h3>
<p>Profiles must be discoverable through a machine-readable metadata that describes what is offered and how to invoke the offered profiles.</p>
<p class="relatedRequirements"><a href="#RPFMDUSE"></a></p>
<p class="relatedUseCases"><a href="#ID5"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/288">github:issue/288</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/288">github:issue/288</a></span>
</section>

<section class="requirement" id="RPFDECOS">
Expand All @@ -409,8 +390,7 @@ <h4>Documenting ecosystems of profiles [RPFDECOS]</h4>
especially documenting the relationships between profiles and what they are based on,
and between profiles that are based on other profiles.
</p>
<p class="relatedUseCases"><a href="#ID37"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/271">github:issue/271</a></span>
<a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/271">github:issue/271</a></span>
</section>
<div class="note">(Antoine:) From https://github.com/w3c/dxwg/issues/242#issuecomment-408916364, Administrative metadata:
<ul>
Expand Down Expand Up @@ -480,7 +460,6 @@ <h4>Open Geospatial Consortium Profiling</h4>
</section>
<section id="isop">
<h4>Profiling of ISO standards</h4>
<p></p>
<div class="issue" data-number="367"></div>
</section>
<section id="odrl">
Expand Down

0 comments on commit 9ecaeb5

Please sign in to comment.