Library talk:Circle/File Naming Conventions

From UBC Wiki


Thread titleRepliesLast modified
Examples519:05, 18 January 2023
Non/unique Title319:05, 18 January 2023
Guiding principles718:14, 9 January 2023
File Naming Significance - Draft Section318:13, 9 January 2023

I believe these may be all real examples. Consider including links to actual items in OC. Sometimes folks like a visual

Tkstephe (talk)20:39, 7 November 2022

Yes that would be good! I can look up each example in OC. Regarding where/how to link - would it just be best/least messy to hyperlink the example file names?

I think the Lorenz Yeung example is currently linked to the pdf file itself - should I replace that with the OC link for consistency or leave as is?

ClaireSwanson (talk)21:58, 7 November 2022

Can we just add "See example" underneath each example?

Tkstephe (talk)00:07, 11 November 2022

I attempted to add a couple but I'm actually not sure now that it adds much. Feel free to remove if you don't lik eit.

Tkstephe (talk)23:43, 8 December 2022

I removed the external links to OC records - the links are not very helpful because most of our wiki examples for file names do not match the actual file names in cIRcle.

ClaireSwanson (talk)18:26, 9 January 2023

thread done

ClaireSwanson (talk)19:05, 18 January 2023

Non/unique Title

I'm not sure I understand the non/unique title. Is this new? It uses the same example twice. My preference would be to remove the distinction between non/unique and just have one example for this section.

Tkstephe (talk)23:36, 8 December 2022

No this section has always been here, though I might have reformatted as I did some reformatting across the whole page for consistency in headings.

Since non-unique titles is only under "Agency and Organizations as Authors" my assumption was that it serves a purpose - maybe agencies submit a lot of generically named reports to cIRcle?

But I agree that at the very least, the use of the same example is confusing.

I'll see if I can find any use cases for this. But if not, then this section could be removed.

ClaireSwanson (talk)18:06, 9 January 2023

So, I re-read the examples a couple of times and then I finally understood what it was getting at. In some cases, they may be giving us chapters or newsletters or something with the exact same title (ie. non-unique) so I think the person who wrote this was trying to explain what to do to differentiate. To simplify, I merged these two which I'm hoping brings more clarity. I'm happy to take direction from you if you disagree or have other suggestions.

Tkstephe (talk)00:02, 13 January 2023

thread done

ClaireSwanson (talk)19:05, 18 January 2023

Guiding principles

Do we want to link to a good reference for these principles here? Also, would we consider using this image at the top of the page for visual interest I use it in my presentations and feel it resonates:)

Tkstephe (talk)20:32, 7 November 2022

I will play around with the layout of the image to add it.

I can also look up a reference for the guiding principles. The only potential hesitation with this is that all the references I've come across so far have stated that special characters should never be used - while the principles on this wiki are cIRcle-specific, would it cause confusion if our linked reference is in conflict with our guide?

ClaireSwanson (talk)22:02, 7 November 2022

I feel like I might be misunderstanding our meeting about this. If all the guidelines are saying do not use special characters, why are we saying you can?

Tkstephe (talk)00:05, 11 November 2022

Ok, I was getting confused by what we are trying to say so I looked it up and I think we could adapt this example from

Avoid special characters Just because you can use something doesn't mean you should. There are two reasons to avoid special characters, punctuation marks, and symbols in filenames:

Special characters and punctuation marks are often reserved characters for computer operating systems. This means that the character is used in a very specififc way by the operating system and using it in a file name will cause errors. Not all operating systems and programs support the same characters. A common example is how the modern Mac OS (9 and after) support a number of special characters (/ \ : * ? < > |) that are not supported by Windows. Also: Never Use Emojis in file names! It's a very bad idea at this time.

Tkstephe (talk)00:15, 11 November 2022
Tkstephe (talk)00:18, 11 November 2022

I added text to support my recommendation. Please edit as needed/preferred.

Tkstephe (talk)23:24, 8 December 2022

No additional edits - considering this thread done

ClaireSwanson (talk)18:14, 9 January 2023

File Naming Significance - Draft Section

Edited by author.
Last edit: 17:19, 28 October 2022

Significance (draft)[wikitext]

Consistently using a file naming convention is an essential component of the long term preservation of digital records. File names should be both human-readable and machine-readable, meaning that the people and computer software interacting with cIRcle files are able to recognize and understand these files' names. If a file name is not human-readable (e.g., lacks a descriptive name), content may be lost or accidentally overwritten. If a file name is not machine-readable (e.g., contains spaces or unsupported special characters), computer software may fail to open the file rendering it unusable.

The naming guidelines that follow are designed to provide files with concise yet descriptive names that help ensure content can be found, opened, and maintained for as long as possible.

ClaireSwanson (talk)16:31, 15 September 2022

I like this significance section, too!

KellyGauvin (talk)23:15, 20 October 2022

I like how the OER Accessibility Toolkit uses the header "Key Concepts". Consider renaming "Significance" heading to "Key Concepts: File Names Should Be Readable" or something to that effect. Consider doing the same for the File Format Guidelines "Significance" heading.

Tkstephe (talk)20:22, 7 November 2022

headings changed - considering this thread done

ClaireSwanson (talk)18:13, 9 January 2023