Skip to content

Commit

Permalink
Moved profile requirements one level up
Browse files Browse the repository at this point in the history
  • Loading branch information
@aisaac
aisaac committed Nov 18, 2018
1 parent 9b18ff4 commit abc88fc
Showing 1 changed file with 25 additions and 27 deletions.
52 changes: 25 additions & 27 deletions ucr/index.html
View file
Expand Up @@ -3316,8 +3316,6 @@ <h3>Publication control [RPC]</h3>


<section id="ProfileRequirements">
<h2>Profiles</h2>

<!--
- jpullmann, 2018/10/16, with reivew and re-structuring from Antoine Isaac 2018/11/11
- following requirements are extracted from: https://docs.google.com/document/d/13hV2tJ6Kg2Hfe7e1BowY5QfCIweH9GxSCFQV1aWtOPg/
Expand All @@ -3326,13 +3324,13 @@ <h2>Profiles</h2>
-->

<section id="ProfileAbstractRequirements">
<h3>Abstract requirements applying to the general definition of profiles</h3>
<h2>Profiles &mdash; abstract requirements applying to the general definition of profiles</h2>

Requirements covering aspects of profile definition, i.e. what profiles are in general,
how to identify and compose profiles etc.

<section class="requirement" id="RPFNCTERMS">
<h4>Named collections of terms [RPFNCTERMS]</h4>
<h3>Named collections of terms [RPFNCTERMS]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New title and abbreviation by Antoine Isaac, 2018-11-11
</p></div>
<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
Expand All @@ -3343,15 +3341,15 @@ <h4>Named collections of terms [RPFNCTERMS]</h4>
</section>

<section class="requirement" id="RPFMBSPEC">
<h4>Multiple base specifications [RPFMBSPEC]</h4>
<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>
</section>

<section class="requirement" id="RPFPP">
<h4>Profile of profiles [RPFPP]</h4>
<h3>Profile of profiles [RPFPP]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New abbreviation by Antoine Isaac, 2018-11-11
</p></div>
<p>One can create a profile of profiles, with elements potentially inherited on several levels.</p>
Expand All @@ -3360,7 +3358,7 @@ <h4>Profile of profiles [RPFPP]</h4>
</section>

<section class="requirement" id="RPFINHER">
<h4>Profile inheritance [RPFINHER]</h4>
<h3>Profile inheritance [RPFINHER]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">It was approved in https://www.w3.org/2018/07/10-dxwg-minutes#x16 but there was no github issue for it.
(This requirement is wrongly refered to as Github #238 and I've removed that) Antoine Isaac, 2018-11-11
</p></div>
Expand All @@ -3371,7 +3369,7 @@ <h4>Profile inheritance [RPFINHER]</h4>
</section>

<section class="requirement" id="RPFDAPUB">
<h4>Data publication according to different profiles [RPFDAPUB]</h4>
<h3>Data publication according to different profiles [RPFDAPUB]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New requirement. It is in the google doc but not in the previous UCR version. This said I'm not sure it's 100% relevant for profile guidance.
It could be rather categorized as a requirement for profile negotiation, or DCAT distribution, or both. Antoine Isaac, 2018-11-11
</p></div>
Expand All @@ -3383,14 +3381,14 @@ <h4>Data publication according to different profiles [RPFDAPUB]</h4>
</section>

<section id="ProfileFunctionalityRequirements"><!-- roles / functions -->
<h3>Profile functionality</h3>
<h2>Profiles &mdash; Profile functionality</h3>

Requirements covering aspects of how profiles are being used,
i.e. what functionality may they express or support,
for example validation, or documentation of data.

<section class="requirement" id="RPFHRDEF">
<h4>Human-readable definitions [RPFHRDEF]</h4>
<h3>Human-readable definitions [RPFHRDEF]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New title by Antoine Isaac, 2018-11-11
</p></div>
<p>Profiles can have human-readable definitions of terms and input instructions.</p>
Expand All @@ -3399,7 +3397,7 @@ <h4>Human-readable definitions [RPFHRDEF]</h4>
</section>

<section class="requirement" id="RPGRDC">
<h4>Global rules for descriptive content [RPGRDC]</h4>
<h3>Global rules for descriptive content [RPGRDC]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New title and abbreviation by Antoine Isaac, 2018-11-11
</p></div>
<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>
Expand All @@ -3408,7 +3406,7 @@ <h4>Global rules for descriptive content [RPGRDC]</h4>
</section>

<section class="requirement" id="RPFVALID">
<h4>Data validation [RPFVALID]</h4>
<h3>Data validation [RPFVALID]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New title and abbreviation by Antoine Isaac, 2018-11-11, and shifting this requirement (which is a bit redundant with github:issue/279) towards the function of data validation
</p></div>
<p>A profile may be (partially) "implemented" by "schemas" (in OWL, SHACL, XML Schema...) that allow different levels of data validation</p>
Expand All @@ -3417,7 +3415,7 @@ <h4>Data validation [RPFVALID]</h4>
</section>

<section class="requirement" id="RPFESIP">
<h4>External specifications for individual properties [RPFESIP]</h4>
<h3>External specifications for individual properties [RPFESIP]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New title and abbreviation by Antoine Isaac, 2018-11-11
</p></div>
<p>Profiles should be able to indicate which external specifications are expected to be applied/have been applied to values of individual properties.</p>
Expand All @@ -3426,7 +3424,7 @@ <h4>External specifications for individual properties [RPFESIP]</h4>
</section>

<section class="requirement" id="RPFVALIDR">
<h4>Validity rules [RPFVALIDR]</h4>
<h3>Validity rules [RPFVALIDR]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New title and abbreviation by Antoine Isaac, 2018-11-11
</p></div>
<p>Profiles may provide rules governing value validity.</p>
Expand All @@ -3437,7 +3435,7 @@ <h4>Validity rules [RPFVALIDR]</h4>
</section>

<section class="requirement" id="RPFVLIST">
<h4>Value lists for data elements [RPFVLIST]</h4>
<h3>Value lists for data elements [RPFVLIST]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New title and abbreviation by Antoine Isaac, 2018-11-11
</p></div>
<p>Profiles may provide lists of values to pick from in order to populate data elements.</p>
Expand All @@ -3446,7 +3444,7 @@ <h4>Value lists for data elements [RPFVLIST]</h4>
</section>

<section class="requirement" id="RPFCARDR">
<h4>Cardinality rules [RPFCARDR]</h4>
<h3>Cardinality rules [RPFCARDR]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New title and abbreviation by Antoine Isaac, 2018-11-11
</p></div>
<p>Profiles may provide rules on cardinality of terms (including "recommended").</p>
Expand All @@ -3457,7 +3455,7 @@ <h4>Cardinality rules [RPFCARDR]</h4>
</section>

<section class="requirement" id="RPFDEPR">
<h4>Dependency rules [RPFDEPR]</h4>
<h3>Dependency rules [RPFDEPR]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New title and abbreviation by Antoine Isaac, 2018-11-11
</p></div>
<p>Profiles may express dependencies between elements of the vocabulary (if A then not B, etc.).</p>
Expand All @@ -3466,7 +3464,7 @@ <h4>Dependency rules [RPFDEPR]</h4>
</section>

<section class="requirement" id="RPFUI">
<h4>User interface support [RPFUI]</h4>
<h3>User interface support [RPFUI]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New title and abbreviation by Antoine Isaac, 2018-11-11
</p></div>
<p>Profiles can have what is needed to drive forms for data input or for user display.</p>
Expand All @@ -3477,13 +3475,13 @@ <h4>User interface support [RPFUI]</h4>
</section>

<section id="ProfileDistributionRequirements">
<h3>Profile distributions</h3>
<h2>Profiles &mdash; Profile distributions</h2>

Requirements covering aspects of how (part of) profiles are concretely expressed/represented,
using the languages that allow such expression.

<section class="requirement" id="RPFDOCU">
<h4>Profile documentation [RPFDOCU]</h4>
<h3>Profile documentation [RPFDOCU]</h3>
<p>A profile should have human-readable documentation that expresses for humans the main components
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
Expand All @@ -3492,7 +3490,7 @@ <h4>Profile documentation [RPFDOCU]</h4>
</section>

<section class="requirement" id="RPFSCHEMAS">
<h4>Schema implementations [RPFSCHEMAS]</h4>
<h3>Schema implementations [RPFSCHEMAS]</h3>
<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">New title and abbreviation by Antoine Isaac, 2018-11-11, shifting this requirement (which is a bit redundant with github:issue/273) towards the notion of distribution of schemas
</p></div>
<p>Profiles may be written in or may link to a document or schema in a validation language (ShEx, SHACL, XMLschema).</p>
Expand All @@ -3504,7 +3502,7 @@ <h4>Schema implementations [RPFSCHEMAS]</h4>
</section>

<section id="ProfileMetadataRequirements">
<h3>Profile metadata</h3>
<h2>Profiles &mdash; Profile metadata</h2>

<section class="requirement" id="RPFDECOS">
<h4>Documenting ecosystems of profiles [RPFDECOS]</h4>
Expand All @@ -3520,36 +3518,36 @@ <h4>Documenting ecosystems of profiles [RPFDECOS]</h4>
</section>

<section id="ProfileParkedRequirements">
<h3>Parked requirements</h3>
<h2>Profiles &mdash; Parked requirements</h3>

<div class="note"><div role="heading" class="note-title marker" id="h-note" aria-level="3"></div><p class="">These are requirements that are in the previous version of the ucr_profile_requirements branch, and which I've removed as the Google Doc classifies them elsewhere. Antoine Isaac, 2018-11-11
</p></div>

<section class="requirement" id="RPFALIAS">
<h4>Profile alias [RPFALIAS]</h4>
<h3>Profile alias [RPFALIAS]</h3>
<p class="issue">A short token to specify a profile may be used as long as there is a discoverable mapping from it to the profile's identifying URI.</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/290">github:issue/290</a></span>
</section>

<section class="requirement" id="RPFMD">
<h4>Profile metadata [RPFMD]</h4>
<h3>Profile metadata [RPFMD]</h3>
<p class="issue">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>
</section>

<section class="requirement" id="RPFDIST">
<h4>Distribution profile [RPFDIST]</h4>
<h3>Distribution profile [RPFDIST]</h3>
<!-- unclear weather this means "profile" in CONNEG sense -->
<p class="issue">Provide a means to distinguish between distributions that package the entire dataset and those that support access to specific items, queries, and packaged downloads of data.</p>
<p class="relatedUseCases"><a href="#ID51"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/267">github:issue/267</a></span>
</section>

<section class="requirement" id="RPFID">
<h4>Profile identifier [RPFID]</h4>
<h3>Profile identifier [RPFID]</h3>
<p>A profile must have an identifier that can be served with a response to an API or HTTP request.</p>
<p class="relatedUseCases"><a href="#ID2"></a></p>
<span class="source"><a target="_blank" rel="nofollow" class="external free" href="https://github.com/w3c/dxwg/issues/284">github:issue/284</a></span>
Expand Down

0 comments on commit abc88fc

Please sign in to comment.