When possible, please use the following guidelines when translating field names:
- Entity type names should not be included in the label, when it is redundant
- Example:
First name
instead ofUser first name
- Example:
- Field names should have only their first word capitalized, per FOLIO UI guidelines
- Example:
First name
,Effective call number
- Example:
- Identifier acronyms such as ID, HRID, etc., should always be fully capitalized
- Whenever handing UUIDs, call it a
UUID
. All other IDs should be referred to as their specific name.- Example: Instances will have an
Instance UUID
AND anInstance HRID
. Neither should be called justID
, since that is ambiguous.
- Example: Instances will have an
- Avoid using abbreviations/acronyms, unless they are used universally within their application
- Example:
HRID
in lieu ofHuman readable identifier
becauseHRID
is used universally within the inventory applications, andHuman readable identifier
is never used - Example:
ISBN
in lieu ofInternational standard book number
, for the same reason - Example:
POL
should be abbreviated instead ofPurchase order line
- Example: avoid using
Acq. unit
in lieu ofAcquisition unit
- Example:
- Do not refer to arrays as 'lists' directly; instead, use plurals
- Example:
Statistical codes
instead ofStatistical code list
,Country IDs
instead ofCountry ID list
- Example:
- For fields that build on another field's UUID, disambiguate each with 'UUID' and a unique description
- Example:
Material type name
andMaterial type UUID
- Incorrect:
Material type
andMaterial type UUID
- Example:
- The same applies for lists
- Example:
Acquisition unit UUIDs
andAcquisition unit names
- Example:
- To represent hierarchy in names (for example, a outer entity type name + an inner field name), an em-dash should be used (
—
).