modelica / ModelicaStandardLibrary

Free (standard conforming) library to model mechanical (1D/3D), electrical (analog, digital, machines), magnetic, thermal, fluid, control systems and hierarchical state machines. Also numerical functions and functions for strings, files and streams are included.
https://doc.modelica.org
BSD 3-Clause "New" or "Revised" License
452 stars 165 forks source link

Fix ieee transactions style #4385

Open gwr69 opened 2 months ago

gwr69 commented 2 months ago

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:

  1. Typographic (e.g., curly) quotation marks are used to clearly distinguish opening from closing marks.
  2. IEEE Transactions Style (as many others) uses American punctuation rules, which almost always place a comma inside the quotation.
HansOlsson commented 2 months ago

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.

gwr69 commented 2 months ago

@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 Something like <q>...</q> would of course be preferable imo.

gwr69 commented 2 months ago

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

henrikt-ma commented 2 months ago

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 ,&quot; but 14 matches for &quot;,; the authors of the MSL seem to have pretty consistently preferred the logical placement of the comma, and that might also give some guidance of which style to use in the MSL.

tobolar commented 2 months ago

Similar to @HansOlsson, my personal preference about the comma is still to prioritize logical structure over typography

So is my.

gwr69 commented 2 months ago

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.