Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Editorial style #85

Closed
vroddon opened this issue Dec 17, 2016 · 11 comments
Closed

Editorial style #85

vroddon opened this issue Dec 17, 2016 · 11 comments

Comments

@vroddon
Copy link
Contributor

vroddon commented Dec 17, 2016

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
Copy link
Contributor

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

@vroddon
Copy link
Contributor Author

vroddon commented Dec 20, 2016

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
Copy link
Contributor

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

@riannella
Copy link
Contributor

@vroddon Any more instances of this?

@vroddon
Copy link
Contributor Author

vroddon commented Apr 20, 2017

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
Copy link
Contributor

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

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

@vroddon
Copy link
Contributor Author

vroddon commented Apr 21, 2017

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
Copy link
Contributor

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 riannella added this to Under Current Discussion in ODRL Deliverables Review Apr 29, 2017
@riannella
Copy link
Contributor

Proposal:

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

@riannella riannella moved this from Under Current Discussion to Proposed Solution in ODRL Deliverables Review May 16, 2017
@vroddon
Copy link
Contributor Author

vroddon commented May 16, 2017

Agreed!

@riannella riannella moved this from Proposed Solution to Completed (Last Call) in ODRL Deliverables Review May 17, 2017
@riannella riannella removed this from Completed (Last Call) in ODRL Deliverables Review May 30, 2017
@vroddon
Copy link
Contributor Author

vroddon commented Aug 15, 2017

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants