-
Notifications
You must be signed in to change notification settings - Fork 167
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
Fix ieee transactions style #4385
base: master
Are you sure you want to change the base?
Conversation
Corrected citations to match IEEE Transactions Style specification.
As indicated previously we should either:
I personally prefer the Wikipedia-style (both in terms of straight quotes and logical quoting - although the benefit of logical quoting is primarily for code fragments, not titles of scientific articles), but consistency is more important than my personal preference. |
@HansOlsson Just on a side note: The styling of the quotation mark, e.g., straight versus typographic, is not an issue with regard to any style. To my knowledge, using IEEE Transactions Style with ASCII straight quotes is perfectly ok. I would pledge for referencing something that is widely recognized and gives valid examples for all kinds of use cases with regard to citations, which is typically what academic style guide were made for. Could you point me to where Wikipedia clearly defines something that amounts to a clear guide for citations? The MSL conventions already deviate from IEEE Transactions Style in their use of author-year references, so that might be made more explicit as well. Indeed, consistency is to be aimed for but hard to get in the days of "European English." :) EDIT |
As an alternative to IEEE Transactions Style, why not consider: SIAM Style Manual, which does not use quotation marks for references or AMS Style Guide, which uses logical punctuation |
For titles, I have a clear personal preference for using italics rather than quotation marks, which avoids the problem with the placement of the comma in this case. More generally, I prefer the style of using quotation marks only when indicating that the author is quoting somebody else while indicating that it is a use of language that the author doesn't want to be too closely associated with, and similar situations. This is very rare in the kind of documents we produce, so the question of where to place the comma is not very important. This is how quotation marks are used in the Modelica specification, by the way. Similar to @HansOlsson, my personal preference about the comma is still to prioritize logical structure over typography (I won't pollute this discussion by elaborating all the reasons). Further, I assume it is not by some sort of coincidence that I just get a single MSL match for the regexp |
So is my. |
Sure, but is there a style guide for citing and referencing that matches your personal preferences? It obviously is not IEEE Transactions Style and at the least that reference needs to be dropped as neither referencing (author + year) nor punctuation follow it. |
Fixed documentation for
Modelica.UsersGuide.Conventions.UsersGuide.References
to follow the unambiguous style specification for IEEE Transactions Style as referenced by Modelica Standard Library.The change is twofold: