Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 2.35 KB

naming-protocols.md

File metadata and controls

31 lines (24 loc) · 2.35 KB

(last updated 2022-01-23)

Introduction to File Naming Conventions

Computers don't always know how to handle certain characters. Neither Microsoft Windows or Apple OSX allow files to be named with special characters like questions marks ? or slashes \. Special characters, spaces, and other elements are frequently reserved and possess meanings beyond the language we are speaking or typing. For example, periods . are used by operating systems to separate the descriptive file name from the extension (file type).

Many standard services and servers, including those employed in creating our digital edition, function best with the guidelines outlined below and files named in a different way can create errors.

The guidelines below describe general good practice for file naming in computing, but these names are not always the easiest to read or use in everyday personal computing.

For more general information about file naming conventions in computing, please see Purdue Libraries Data Management for Undergraduate Researchers which links to this clear guide: Folder and File Naming Convention –10 Rules for Best Practice.

Computing Guidelines

  • Use only alphanumeric characters (letters in the English alphabet + numbers)
  • Use all lowercase letters
  • Do not use spaces anywhere in your file's name
  • Do not use special characters such as: ! # $ % & ' @ ^ `` ~ + , . ; = ) ( "
    • No periods, commas, question marks, etc.
  • The only characters allowable other than alphanumeric characters are: hyphen/minus sign -, underscores _, and plus signs +
  • For spaces between words
    • Use the hyphen/minus sign -
    • Example: painting-out-verdigris
  • For spaces between elements (e.g. date, description, name, etc.) - This is also known as an "element delimiter"
    • Use the underscore _
    • Do not use spaces or other characters such as: ! # $ % & ' @ ^ `` ~ + , . ; = ) ( "
    • Example: 20160906_painting-out-verdigris (date_description)
  • Order your elements from general to specific
    • This is most important for dates: Year, Month, Day
    • (YYYYMMDD), (YYMMDD), (YYMM), etc
    • Example: 20160906