Changes between Version 10 and Version 11 of Standards


Ignore:
Timestamp:
Apr 13, 2025, 3:51:58 PM (8 days ago)
Author:
jac
Comment:

Update wording and formatting for clarity

Legend:

Unmodified
Added
Removed
Modified

  • Standards

    v10 v11  
    1 == Title standards ==
     1== Format Standards ==
    22
    3 1. These words:
    4  
    5      '''A, An, And, As, By, From, For, In, Of, On, Or, The, To'''
     3See the SAP format specification https://asap.sourceforge.net/sap-format.html for the available tags and their technical specification.
    64
    7      in filenames and NAME tags '''should be lowercase'''.
    8  
    9      '''Exception:''' filename beginning with such a word.
     5== Title and Filename Standards (NAME Tag) ==
    106
    11 2. "Don't Worry Be Happy" -> filename: Dont_Worry_Be_Happy.sap
     71. The words "A, An, And, As, By, From, For, In, Of, On, Or, The, To" shall be lowercase in filenames and NAME tags.\\
     8   Exception: The filename begins with such a word.
    129
    13     "I'm" => "Im" in filename.
     102. The apostrophe should be omitted in filenames.\\
     11   Example: "Don't Worry Be Happy" -> filename "Dont_Worry_Be_Happy.sap"\\
     12   Example: "I'm in Love" -> filename "Im_in_Love.sap"
    1413
    15 3. '''pg:''' Omit articles where they are the first word of the title. This is practiced, but not very consistently.[[BR]]
    16    Example: The_Nutty_Professor.sap > Nutty_Professor.sap
     143. Omit articles where they are the first word of the title. ('''pg''')\\
     15   Example: "The_Nutty_Professor.sap" -> "Nutty_Professor.sap"\\
     16   Note:  This is practiced, but not very consistently.[[BR]]\\
    1717
    18 == Author standards ==
     18== Author Standards (AUTHOR Tag) ==
    1919
    20 1. '''pfusik''': "Jan & David Spilka" -> "Jan Spilka & David Spilka" ?
     201. Use full names, separated by "&" ('''pfusik''')\\
     21   Example: "Jan & David Spilka" -> "Jan Spilka & David Spilka" ?\\
     22   Reason: Normally, the value of the "AUTHOR" tag is shown to the user without further processing. Exceptions are the ASMA web player and the Windows Explorer plugins, which split authors on " & ", so it will show two authors: "Jan" and "David Spilka".
    2123
    22     Normally AUTHOR is shown to the user without further processing. Exceptions are the ASMA web player and the Windows Explorer plugins, which splits authors on " & ", so it will show two authors: "Jan" and "David Spilka".
     242. Avoid diminutives ('''pfusik''')\\
     25   Examples: "Johnny" -> "John", "Maciek Szczesniak" -> "Maciej Szcześniak", "Slawek Sledz" -> "Sławomir Śledź"
    2326
    24 2. '''pfusik''': avoid diminutives? Johnny -> John, Maciek Szczesniak -> Maciej Szcześniak, Slawek Sledz -> Sławomir Śledź ?
     273. Use "<?> (nickname)" if the real name is unknown ('''pfusik''')\\
     28   Example: AUTHOR "null1024" -> AUTHOR "<?> (null1024)"
    2529
    26 3. '''pfusik''': if real name is unknown, write "<?> (nickname)", e.g. AUTHOR "null1024" -> AUTHOR "<?> (null1024)"
     30== Date Standards (DATE Tag) ==
    2731
    28 == Date standards ==
    29 
    30 1. '''pfusik''': DD/MM/YYYY (preferred), DD-DD/MM/YYYY, MM/YYYY, MM-MM/YYYY, YYYY, YYYY-YYYY, it is possible to replace the last digits with question marks
     321. Use DD/MM/YYYY (preferred), DD-DD/MM/YYYY, MM/YYYY, MM-MM/YYYY, YYYY, YYYY-YYYY ) ('''pfusik''')\\
     33   It is possible to replace the last digits with question marks when they are unknown.