Field display format guidelines

This section describes coding guidelines for field display formats (FDFs) when using the Field Display Format Editor.

Naming

  • Reusable FDFs follow a different naming convention than non-reusable FDFs.
  • FDFs that are candidates for reuse are named using this format:
    • Type
    • Source
    • Format Details
    • Click (optional)
    • Justification (optional)
      Note: Having justification as the last part of the format is technically correct, but it should be very rare that a different FDF be created just for the purposes of justification. FDFs should be created only for different formatter properties. Styles, which typically handle justification, should be added at the layout cell level. Only in the case of an extensively re-used FDF, with minimal usage exceptions, should the initial style be placed on the FDF. For example, ButtonClick contains initial styling for the button, because the button style is expected to be consistent across the entire website, with very few exceptions. The reason it is done this way is because any exception would require that a style be placed on the cell, and that overwrites the initial style on the FDF.
    • Ends with "Exp" when the FDF is an image or video FDF and has the Expanding option set to true.
  • FDFs that are not candidates for reuse start with the page name, using this format: [PageName][FormatDetails][Type]
  • In the name, only the first letter of each identifier should be capitalized, for example, SLCosConum instead of SLCosCoNum.
  • Similar FDFs should be named so that, when sorted by name, they are grouped together with other FDFs of the same type.
  • Some flexibility in naming is allowed for special cases. Standards should be followed whenever possible.