Dxwg: Determine which examples of use are to be published in the Profiles Ont doc

Created on 25 Oct 2018  路  12Comments  路  Source: w3c/dxwg

We have a series of existing profiles modelled using PROF already and we have to decide which of these, and any other examples, get included in the Profiles Ontology Doc (https://w3c.github.io/dxwg/profilesont/). Other examples might be listed elsewhere.

due for closing profiles-vocabulary

All 12 comments

For the FPWD you might just point to the github folder with examples, or point to the individual examples. For the final document you could have an examples section, or you may decide to create a primer that has the examples if you have many of them. Having a primer would allow you to add any explanation that will help readers understand decisions, options, etc.

+1 for pointing for the folder for the moment.

A Primer sounds a good idea but it adds another document that has "explanation that will help readers understand decisions, options, etc." - both Ontology and Guidance documents may have this...
Actually I'd make a bold suggestion: if the Prof model is not much different from the Guidance model (which we all hope will be the case) and if the number of examples is no bigger than what is envisioned at https://w3c.github.io/dxwg/profiles/#examples, then we could try to have the Prof examples in the Guidance document.

This creates more dependencies in case the Prof ontology is updated in the future. But:

  • it may save us a lot of editorial work overal, now and in the future, because of avoiding redundancies on motivations/principles/etc
  • I believe that every time the Prof document(s) would have to be updated in the future, anyway there will probably be the need to update some part of the Guidance doc too.

I guess we don't need to agree on this yet, but I want to use this as an extra argument for saving time on editorial work to fit the examples in the Profile Ontology document now, and merely pointing to the folder.

Very happy to work Prof Ont examples into the Guidance doc. We have many of the Guidance examples listed just with headings already modelled so I will tidy those up and PR them into Guidance. Perhaps then there will still be a need for snippets and one full example in the Ont doc (I鈥檓 just uncomfortable about having none!) but the majority of examples that keep the Guidance and Ont in sync will be in the Guidance doc.

Two examples now in ProfOnt doc: a basic profile described and a small hierarchy. Likely there will be one or two more examples to demo all parts of the ontology. When complete there, we will be more easily able to decide what examples the Guidance doc might benefit from.

E.g. in the Prof Ont doc all in words, diagrams & RDF.

Examples to be delt with case-by-case

General examples now in doc:

Specific profile examples:

The two titling errors noted above, and some example ID tidying, are addressed in PR #1047.

Closing after listing in plenary 2019-09-03 + 3-day wait period.

Check with @aisaac if his comment has been satisfied.

@kcoyle it's fine. Ideally these examples should be in the Profile Guidance (or they should at least be mirrored in it, somehow) but as the work on it has been delayed, I believe that the coming version of PROF must have them in.

Note that this is not a formal agreement about the content of these examples (which I've not checked), and I may still argue later for moving the examples. But that can be done in another issue. Anyway the goal of this issue here was rather editorial: determine what examples should go in the document. And I think @nicholascar 's comment is good enough.

I can live with keeping these examples in the document now, but I think that some of them are examples of properties and features that are not fully decided. That makes this a bit of a "chicken and egg" situation, and I will also say (as @aisaac does) that this is not agreement on the content of the examples.

@kcoyle agreed: not agreement of content, just agreement to, as per title, "Determine which examples are to be published...".

So... still like to close!

Examples as listed in comment are now in Section 10 of the editor's draft.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

dr-shorthair picture dr-shorthair  路  4Comments

jpullmann picture jpullmann  路  7Comments

davebrowning picture davebrowning  路  7Comments

andrea-perego picture andrea-perego  路  6Comments

dret picture dret  路  4Comments