w3c / poe

Permissions & Obligations Expression WG
Other
23 stars 18 forks source link

Editorial style #85

Closed vroddon closed 7 years ago

vroddon commented 7 years ago

Should text strings be ended with a dot when they are sentences? Current practice at ODRL is totally irregular, and it should be at least uniform. I could not find a recommended practice for that.

example

riannella commented 7 years ago

If it is a sentence, them it should end with a full-stop

vroddon commented 7 years ago

I have fixed them in the issue83. But there is still another style criterium pending to review.... ...systematically checking of capitals are placed where they correspond. Please see this example:

capitals

riannella commented 7 years ago

Yes, we should try and be consistent and use capital letter for the names of Entities in the human-text.

riannella commented 7 years ago

@vroddon Any more instances of this?

vroddon commented 7 years ago

Not that I am aware of, after my push. However, there are some formating elements in the text that should not be there. For example, we find in several definitions pieces of text like...

....the [[iso3166]] Country Codes...

I believe the characters "[" or "]" should be removed from the ontology. But I am not sure about what to do, because if we do it we will lose the links in the HTML.

riannella commented 7 years ago

yes, and the references in the appendix will go too...

Is it a major issue to leave the [[...]] in the skos:note ?

vroddon commented 7 years ago

Well, I guess any other ontology visualization will also show the brackets... (ontology editor, a Pubby linked data server, an application making SPARQL queries...)

riannella commented 7 years ago

We could just leave the text in the skos:note, like "W3C vCard Ontology" then under the blue table we can added an extra (html) line like: References: W3C vCard Ontology [[vcard]] that will add the reference correctly

riannella commented 7 years ago

Proposal:

After the final REC is published, we edit the .ttl file and remove all the respec code

vroddon commented 7 years ago

Agreed!

vroddon commented 7 years ago

I just fixed a typo, changing: "inhertiance" by "inheritance" in the links. See commit 06b25259a5afd620ffd1363d0be288e31940b941