Skip to content

Commit

Permalink
Shuffle related work examples
Browse files Browse the repository at this point in the history 
Moved examples from their own section to a bit in the intro and a bit in the section on examples of applying best practices. This is to address #366 and #419
  • Loading branch information
@aisaac
aisaac committed Oct 3, 2018
1 parent b3fb7de commit abdf46c
Showing 1 changed file with 91 additions and 54 deletions.
145 changes: 91 additions & 54 deletions profiles/index.html
View file
Expand Up @@ -13,8 +13,9 @@
(Antoine:) This document seeks to reflect the structure suggested by Karen at https://github.com/w3c/dxwg/issues/242#issuecomment-408916364. It also tries to re-use as much as possible the material edited by Nick at https://w3c.github.io/dxwg/profiles/ (on Sept 15 2018).
</p>
<p>
I should still also try to go through and incorporate material that the group agrees to in the <a href="https://www.w3.org/2017/dxwg/wiki/ProfileRoundup">Profile Roundup</a>, <a href="https://github
.com/w3c/dxwg/issues/196">Issue 196</a> and <a href="https://github.com/w3c/dxwg/issues/323">Issue 323</a> (for better articulation with the documentation for the ProfileDesc vocabulary).
I should still also try to go through and incorporate material that the group agrees to in the
<a href="https://www.w3.org/2017/dxwg/wiki/ProfileRoundup">Profile Roundup</a>,
<a href="https://github.com/w3c/dxwg/issues/196">Issue 196</a> and <a href="https://github.com/w3c/dxwg/issues/323">Issue 323</a> (for better articulation with the documentation for the ProfileDesc vocabulary).
</p>
</div>

Expand Down Expand Up @@ -110,6 +111,42 @@ <h1>Introduction (non-normative)</h1>
<li>Functions: consensus; sharing; search; etc.</li>
</ul>
</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.
</p>
<div class="issue" data-number="366" title="Location of related work">
(Antoine:) These examples were recommended in another part in https://github.com/w3c/dxwg/issues/242#issuecomment-408916364.
We now try to have them mentioned in the intro and in the section to present examples of applying best practices.
Karen's note below could provide the rationale for mentioning examples here.
</div>
<div class="note">
(Karen:) I had thought of this as showing examples of TYPES of profiles. There are profiles like DCAT that take place within a community, make primary use of a base metadata schema, but add or remove based on local need. There are profiles like ODRL that have a very formal meaning (legal license) and are in essence cumulative, with the base standard elements assumed and specific rules for over-riding. There are profiles that use only the namespace of the base profile, but are defined subsets (BIBFRA.ME, but any other example of this would be fine - that's the one I know). And then we could perhaps find a profile that has no strong base profile (ADMS perhaps?) but combines elements as needed from a variety of sources and is independent of any existing vocabulary. The idea would be to show a range of profile motivations, designs, and community involvement.
</div>
<h4>DCAT Application Profiles</h4>
<p></p>
<h4>Asset Description Metadata Schema</h4>
<p>From the Asset Description Metadata Schema (ADMS) specification [[vocab-adms]]: "ADMS is a profile of DCAT [[vocab-dcat]], used to describe semantic assets".</p>
<h4>Dublin Core Application Profile &amp; The Singapore Framework</h4>
<p>The Singapore Framework for Dublin Core Application Profiles [[DCSF]]</p>
<p>The Guidelines for Dublin Core Application Profiles [[DCAP]] </p>
<p>Description Set Profiles: A constraint language for Dublin Core Application Profiles [[DCDSP]]</p>
<h4>Open Geospatial Consortium Profiling</h4>
<p></p>
<h4>Profiling of ISO standards</h4>
<p></p>
<div class="issue" data-number="367" title="Complete ISO profiles">
(Antoine:) I've kept this from Nick's doc but I'm not so sure what it's about.
</div>
<h4>ODRL profiles</h4>
<p></p>
<div class="issue" data-number="368" title="Mention and align with ODRL profiles">
(Antoine) I've added this as we should really have something on this. The W3C ODRL community group is going to work on profiles of ODRL (including guidelines) quite extensively in the coming months and I think we should make sure our respective recommendations are aligned!
</div>
<h4>BIBFRA.ME</h4>
<p></p>
<div class="note">(Antoine) This comes from https://github.com/w3c/dxwg/issues/242#issuecomment-408916364, I'm ok having it but if we don't have time to write it up I can live with it...</div>
</section>

<section id="whatisaprofile">
Expand Down Expand Up @@ -146,56 +183,7 @@ <h2>Profile publication (normative)</h2>
</div>
</section>

<section id="relatedwork">
<h2>Related work and examples of existing profiles (non-normative)</h2>
<p>
<em>profiling</em> is an activity that has been undertaken by many communities with a range of formalisms.
</p>
<div class="issue" data-number="366" title="Location of related work">
(Antoine:) This section was recommended here in https://github.com/w3c/dxwg/issues/242#issuecomment-408916364. I now have doubts about the it, as it breaks the flow between two crucial (normative) sections on DXWG recommendations. As an alternative, I suggest to try to fit this in (a subsection of) the introduction if it can be short enough. Otherwise we could put it as appendix and refer to it from the introduction.
</div>
<div class="note">
(Karen:) I had thought of this as showing examples of TYPES of profiles. There are profiles like DCAT that take place within a community, make primary use of a base metadata schema, but add or remove based on local need. There are profiles like ODRL that have a very formal meaning (legal license) and are in essence cumulative, with the base standard elements assumed and specific rules for over-riding. There are profiles that use only the namespace of the base profile, but are defined subsets (BIBFRA.ME, but any other example of this would be fine - that's the one I know). And then we could perhaps find a profile that has no strong base profile (ADMS perhaps?) but combines elements as needed from a variety of sources and is independent of any existing vocabulary. The idea would be to show a range of profile motivations, designs, and community involvement.
</div>
<section id="dcat-ap">
<h3>DCAT Application Profiles</h3>
<p></p>
</section>
<section id="adms">
<h3>Asset Description Metadata Schema</h3>
<p>From the Asset Description Metadata Schema (ADMS) specification [[vocab-adms]]: "ADMS is a profile of DCAT [[vocab-dcat]], used to describe semantic assets".</p>
</section>
<section id="dcap">
<h3>Dublin Core Application Profile &amp; The Singapore Framework</h3>
<p>The Singapore Framework for Dublin Core Application Profiles [[DCSF]]</p>
<p>The Guidelines for Dublin Core Application Profiles [[DCAP]] </p>
<p>Description Set Profiles: A constraint language for Dublin Core Application Profiles [[DCDSP]]</p>
</section>
<section id="ogcp">
<h3>Open Geospatial Consortium Profiling</h3>
<p></p>
</section>
<section id="isop">
<h3>Profiling of ISO standards</h3>
<p></p>
<div class="issue" data-number="367" title="Complete ISO profiles">
(Antoine:) I've kept this from Nick's doc but I'm not so sure what it's about.
</div>
</section>
<section id="odrl">
<h3>ODRL profiles</h3>
<p></p>
<div class="issue" data-number="368" title="Mention and align with ODRL profiles">
(Antoine) I've added this as we should really have something on this. The W3C ODRL community group is going to work on profiles of ODRL (including guidelines) quite extensively in the coming months and I think we should make sure our respective recommendations are aligned!
</div>
<div class="note">(Antoine) If we really have a productive exchange with the ODRL community and they implement our recommendations, then we could have this example listed instead in the section on 'Examples of applying these recommendations'.</div>
</section>
<section id="bibframe">
<h3>BIBFRA.ME (one namespace)</h3>
<p></p>
<div class="note">(Antoine) This comes from https://github.com/w3c/dxwg/issues/242#issuecomment-408916364, I'm ok having it but if we don't have time to write it up I can live with it...</div>
</section>
</section>


<section id="metadata">
<h2>Administrative and descriptive metadata (normative)</h2>
Expand All @@ -213,11 +201,11 @@ <h2>Administrative and descriptive metadata (normative)</h2>
<ul>
<li>title</li>
<li>human-readable description </li>
<ul>
<li><ul>
<li>title</li>
<li>Design rationale</li>
<li>Model and elements</li>
</ul>
</ul></li>
<li>Relationship to vocabs or other profilesn</li>
<li>Link to validation schemas implementing the profile</li>
</ul>
Expand All @@ -241,6 +229,55 @@ <h2>Examples of applying these recommendations (non-normative)</h2>
<div class="issue" data-number="370" title="ProfileDesc example">
(Antoine:) Some may prefer to have fully fledged examples in ProfileDesc in ProfileDesc's own documentation. I do think there is value in having at least some examples here, even if as a result we decide that the ProfileDesc documentation would be a 'pure' namespace doc like this one for SKOS: https://www.w3.org/2009/08/skos-reference/skos.html
</div>

<section id="relatedworkexamples">
<h3>Examples on existing profiles</h3>
<div class="issue" data-number="366" title="Location of related work">
(Antoine:) These examples were recommended in another part in https://github.com/w3c/dxwg/issues/242#issuecomment-408916364.
We now try to have them mentioned in the intro and in this section to present examples of applying best practices.
</div>
<section id="dcat-ap">
<h4>DCAT Application Profiles</h4>
<p></p>
</section>
<section id="adms">
<h4>Asset Description Metadata Schema</h4>
<p>From the Asset Description Metadata Schema (ADMS) specification [[vocab-adms]]: "ADMS is a profile of DCAT [[vocab-dcat]], used to describe semantic assets".</p>
</section>
<section id="dcap">
<h4>Dublin Core Application Profile &amp; The Singapore Framework</h4>
<p>The Singapore Framework for Dublin Core Application Profiles [[DCSF]]</p>
<p>The Guidelines for Dublin Core Application Profiles [[DCAP]] </p>
<p>Description Set Profiles: A constraint language for Dublin Core Application Profiles [[DCDSP]]</p>
</section>
<section id="ogcp">
<h4>Open Geospatial Consortium Profiling</h4>
<p></p>
</section>
<section id="isop">
<h4>Profiling of ISO standards</h4>
<p></p>
<div class="issue" data-number="367" title="Complete ISO profiles">
(Antoine:) I've kept this from Nick's doc but I'm not so sure what it's about.
</div>
</section>
<section id="odrl">
<h4>ODRL profiles</h4>
<p></p>
<div class="issue" data-number="368" title="Mention and align with ODRL profiles">
(Antoine) I've added this as we should really have something on this. The W3C ODRL community group is going to work on
profiles of ODRL (including guidelines) quite extensively in the coming months and I think we should make sure our
respective recommendations are aligned!
If we really have a productive exchange with the ODRL community and they implement our recommendations, then
we could have this example listed instead in this section on 'Examples of applying these recommendations'.
</div>
</section>
<section id="bibframe">
<h4>BIBFRA.ME (one namespace)</h4>
<p></p>
<div class="note">(Antoine) This comes from https://github.com/w3c/dxwg/issues/242#issuecomment-408916364, I'm ok having it but if we don't have time to write it up I can live with it...</div>
</section>
</section>

</section>

Expand Down

0 comments on commit abdf46c

Please sign in to comment.