Technical Advisory Board (TAB)

 View Only

Name Construction for Files and Directories

  • 1.  Name Construction for Files and Directories

    Posted 10-08-2010 10:40
    Robin,
    
    
    
    > Name construction here refers to the lexical and syntactic structure
    > of names, given the restricted character inventory. Motivations for
    > these constraints include concerns for fidelity of interchange across
    > different file systems, minimizing the risks of common text-processing
    > errors, usability (visual clarity), and other data quality
    > considerations.
    
    Prefer:
    
    Names for files and directories should be chosen in consultation with
    the TC Admin or their designate. 
    
    Name for files and directories must adhere to the following constraints:
    
    
    > A single filename extension must be used in each filename except for a
    > recognized set of extensionless filenames in common use. Extensions
    > should conform to industry best practice — matching well-known MIME
    > Media Types.
    
    Prefer:
    
    Filenames must conform to standard industry practice with regard to file
    extensions and MIME Media types. [I forget the MIME listing URL but it
    could go here.]
    
    
    > Filenames and directory names must neither begin nor end with a
    > punctuation character (period, hyphen, underscore. Similarly, the
    > filename base preceding the .xxx filename extension must not end with
    > a punctuation character.
    
    Prefer:
    
    File and directory names must not begin or end with a punctuation
    character. 
    
    [file names are what precede filename extensions, which is why .xxx is
    called an "extension." Last sentence is unnecessary.]
    
    
    > No directory may contain two or more names (filenames or directory
    > names) that differ ONLY in case. For example, no directory may contain
    > two directories FOO and Foo, nor two files with filenames BAR.txt and
    > bar.txt.
    
    Prefer:
    
    Directories shall not contain two or more names (filenames or directory
    names) that differ ONLY in case.
    
    
    > No filenames having special meaning for the UNIX operating system or
    > for server software may be used in any Work Product. For example, the
    > following are forbidden: index.html, index.htm, and *.cgi.
    
    Prefer:
    
    Filenames that are meaningful to web servers shall not be used in any
    Work Product. Such as index.html, index.htm and *.cgi.
    
    [I left the examples (shudder) in out of respect for our audience's
    ignorance.]
    
    
    > Filenames and directory names should not contain the trademarked names
    > of products, companies, or other corporate entities where the mark is
    > not owned by OASIS.
    
    Prefer:
    
    Delete. This is not a constraint. Advice at best. Leave it to the TC
    Admin. 
    
    
    > Mixed case in names is generally allowed, including camel case. OASIS
    > web servers must respect case-sensitivity with no accommodation to
    > case-folding
    
    Prefer:
    
    Delete. First, permissions are not constraints. Second, the naming
    guidelines are a poor place to record requirements on OASIS servers. 
    
    
    > The name construction rules enumerated above must be followed for
    > files/directories associated with approved Work Products and any
    > candidate work for TC approval. They should be followed in all other
    > contexts where OASIS tools and publication venues support these
    > constraints.
    
    Prefer:
    
    Delete. These are the name construction rules for OASIS work. (full
    stop) What more need we say? Other than to create FUD? Just say these
    are the rules and be done with it. 
    
    Hope you are at the start of a great day!
    
    Patrick