MMFC:Lists/Database Design Standards

From Manual - MMFC. Medieval Manuscripts in Flemish Collections

1 Naming conventions

  • Element names
    • Use letters only
    • Start with a lowercase character and are formatted in strict camel case (e.g., msId, not msID)
    • Start with 'ms'
    • Are descriptive and use only frequently used, common, or obvious abbreviations
    • Are hierarchical (general > specific)
  • Sub-element names
    • Use the super-element as a prefix in their names
1.1 Examples

Various elements

msWatermark
msFolationType
msMusicNotation
msTextIsDefective
1.1.1 Various elements concerning a common aspect
msDecoDesc
msDecoArtist
msDecoExtent
msDecoTechnique
1.1.2 Element with sub-elements
msDecoExtentDim
- msDecoExtentDimHeight
- msDecoExtentDimWidth
1.1.3 Elements in strict camelCase
msId (msID)
msDescTeiXml (msDescTEIXML)


2 Interface

2.1 Fields

Data type Value Type Interface Field Width Data Size
List - Any - Drop-down 40 -
List Boolean Drop-down 12 -
List Language Type-ahead 20 -
Integer - Any - Input 7 -
Integer Sort order Input 4 0-999
Text - Tiny - Input 20 0-32
Text - Small - Input 40 0-64
Text - Medium - Input 100 0-256
Text - Large - Input 100 x 2 0-512
Text - Very large - Input 100 x 5 0-2048
Text - Huge 0 Input 100 x 5 0-...
Text Page reference Input 20 0-24
Length - Any - Input 10
Date Single date Input 15
Date Period Input 20