# Naming scheme for note styles

**URL:** <https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575>\
**Category:** Uncategorized\
**Created:** [November 8, 2019, 3:48pm UTC](https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575 "2019-11-08T15:48:04Z")\
**Posts on this page:** 9\
**Page:** 1

<div class="post-metadata">

**Author:** ![Denis\_Maier](https://avatars.discourse-cdn.com/v4/letter/d/8491ac/32.png) [@Denis\_Maier](https://discourse.citationstyles.org/u/Denis_Maier)\
**Post date:** [November 8, 2019, 3:48pm UTC](https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575/1 "2019-11-08T15:48:04Z")

</div>

Some time ago, in the [Zotero forum](https://forums.zotero.org/discussion/comment/337609#Comment_337609) someone requested a version of Chicago that always shows the short title in subsequent citations, and that doesn’t follow the new rule to show only the author’s last name for `position="ibid"`. While it wouldn’t be hard to implement such a requirement, the question remains how such a style should be named.

@bwiernik suggested “chicago-fullnote-short-title-subsequent”. While that would be absolutely reasonable I think it could be worthwhile to have a more general naming scheme for new styles. For note styles we could perhaps use a naming scheme that indicates how citations are rendered depending on their position: styleguide-note-first-subsequent-ibid

For CMoS this would mean:

- Chicago fullnote style without the new ibid rule:  
chicago-note-full-short-short

- Chicago note style that always uses short form:  
chicago-note-short-short-short

- Chicago note style with ibid:  
chicago-note-short-short-ibid

- Chicago note style with the new ibid rule  
chicago-note-short-short-authoronly(?)  
chicago-note-short-short-ibidlike(?)

Opinions?

---

<div class="post-metadata">

**Author:** ![Sebastian\_Karcher](https://yyz1.discourse-cdn.com/flex029/user_avatar/discourse.citationstyles.org/sebastian_karcher/32/176_2.png) [@Sebastian\_Karcher](https://discourse.citationstyles.org/u/Sebastian_Karcher)\
**Post date:** [November 8, 2019, 4:20pm UTC](https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575/2 "2019-11-08T16:20:24Z")

</div>

Thanks for bringing this up. I agree settling on a convention would be good.

I’m actually more concerned with the human-readable names than with the filenames, though, as that’s what 98% of users sees. Our conventions from human-readable to filename are pretty good, so once we’ve agreed on the name (i.e CSL `title`) we should be able to settle on the filename quickly.

As a note, as we currently use the filename as ID, changing a lot of high-use style filenames isn’t great. @Dan_Stillman has requested (reasonably imo) that we convert IDs to UUIDs that remain stable, but the way I’m thinking about versioning this would be 1.2 or 2.0

---

<div class="post-metadata">

**Author:** ![Denis\_Maier](https://avatars.discourse-cdn.com/v4/letter/d/8491ac/32.png) [@Denis\_Maier](https://discourse.citationstyles.org/u/Denis_Maier)\
**Post date:** [November 8, 2019, 4:53pm UTC](https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575/3 "2019-11-08T16:53:19Z")

</div>

Hmm, the human-readable names seem to be more tricky.  
What about “Chicago Manual of Style 17th edition (note, without Ibid.-like rule)”?  
Or “Chicago Manual of Style 17th edition (note, always short)”?  
Doesn’t sound quite right. Better suggestions?

---

<div class="post-metadata">

**Author:** ![bwiernik](https://yyz1.discourse-cdn.com/flex029/user_avatar/discourse.citationstyles.org/bwiernik/32/438_2.png) [@bwiernik](https://discourse.citationstyles.org/u/bwiernik)\
**Post date:** [November 8, 2019, 5:08pm UTC](https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575/4 "2019-11-08T17:08:41Z")

</div>

How about:

- Chicago fullnote, per the manual, with ibid rule:  
chicago-fullnote

- Chicago short note, per the manual, with ibid rule:  
chicago-note

- Chicago fullnote, without ibid rule:  
chicago-fullnote-title-always

- Chicago short note, without ibid rule:  
chicago-note-title-always

- Chicago fullnote, with ibid:  
chicago-fullnote-ibid

- Chicago short note, with ibid:  
chicago-note-ibid

That succinctly describes each style’s behavior.

@Sebastian_Karcher is there a need to retain both UUIDs and human-readable IDs, or is link rel=“self” and the title sufficient? It might be possible to incorporate UUIDs into 1.1 by retaining both. So `<id>` stays the same (or maybe even drops the zotero link) and a new `<uuid>` property is added. I don’t think that would impact the processors at all, and that would allow clients to continue to use existing behavior relying on the current system while also allowing transition to the stable UUIDs with time?

---

<div class="post-metadata">

**Author:** ![bwiernik](https://yyz1.discourse-cdn.com/flex029/user_avatar/discourse.citationstyles.org/bwiernik/32/438_2.png) [@bwiernik](https://discourse.citationstyles.org/u/bwiernik)\
**Post date:** [November 8, 2019, 5:09pm UTC](https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575/5 "2019-11-08T17:09:22Z")

</div>

(In case not obvious, I also think that “bibliography” should be dropped from the file names for Chicago.)

---

<div class="post-metadata">

**Author:** ![Denis\_Maier](https://avatars.discourse-cdn.com/v4/letter/d/8491ac/32.png) [@Denis\_Maier](https://discourse.citationstyles.org/u/Denis_Maier)\
**Post date:** [November 8, 2019, 9:57pm UTC](https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575/6 "2019-11-08T21:57:16Z")

</div>

Your suggestions sound good to me. And yes, bibliography should be dropped.

---

<div class="post-metadata">

**Author:** ![Sebastian\_Karcher](https://yyz1.discourse-cdn.com/flex029/user_avatar/discourse.citationstyles.org/sebastian_karcher/32/176_2.png) [@Sebastian\_Karcher](https://discourse.citationstyles.org/u/Sebastian_Karcher)\
**Post date:** [November 9, 2019, 2:59am UTC](https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575/7 "2019-11-09T02:59:51Z")

</div>

> [@bwiernik](#):
>
> @Sebastian_Karcher is there a need to retain both UUIDs and human-readable IDs, or is link rel=“self” and the title sufficient? It might be possible to incorporate UUIDs into 1.1 by retaining both. So `<id>` stays the same (or maybe even drops the zotero link) and a new `<uuid>` property is added.

That’s a question for @Dan_Stillman but as an approach I like the idea of simply adding a UUID element and keeping ID around at least for the next version and potentially adding a note for implementers recommending to switch to that as ID may change (or even be removed) in future versions

---

<div class="post-metadata">

**Author:** ![Sebastian\_Karcher](https://yyz1.discourse-cdn.com/flex029/user_avatar/discourse.citationstyles.org/sebastian_karcher/32/176_2.png) [@Sebastian\_Karcher](https://discourse.citationstyles.org/u/Sebastian_Karcher)\
**Post date:** [November 9, 2019, 3:02am UTC](https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575/8 "2019-11-09T03:02:21Z")

</div>

> [@bwiernik](#):
>
> Chicago fullnote, without ibid rule:  
> chicago-fullnote-title-always

This I like for sure. I don’t think we’ve had any requests for a note version of this, so would leave that out for the time being. I’d be inclined t just add that now and then migrate the other styles later.

---

<div class="post-metadata">

**Author:** ![Dan\_Stillman](https://avatars.discourse-cdn.com/v4/letter/d/ecb155/32.png) [@Dan\_Stillman](https://discourse.citationstyles.org/u/Dan_Stillman)\
**Post date:** [November 9, 2019, 7:39am UTC](https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575/9 "2019-11-09T07:39:34Z")

</div>

> [@Sebastian\_Karcher](#):
>
> That’s a question for @Dan_Stillman but as an approach I like the idea of simply adding a UUID element and keeping ID

Continued in my original thread on this:

> [@Proposal: Make style ids immutable](https://discourse.citationstyles.org/t/proposal-make-style-ids-immutable/1478/5):
>
> Following up on this, given [recent discussion](https://discourse.citationstyles.org/t/naming-scheme-for-note-styles/1575/4) of adding a \<uuid\> field to solve the problem of ids that get changed. Above, I proposed simply freezing existing ids and using UUIDs for new ones, and updating the spec to clarify that the id field is an opaque string rather than a URI. Adding a \<uuid\> field has some advantages: People creating new styles wouldn’t be confused by seeing two different \<id\> formats in existing styles and not know which to use. Implementations that treat the id …