Template for Entities - NCIOCPL/cgov-digital-platform GitHub Wiki

Overall description of the item for documentation in the content model. This documentation is for us, so background can be helpful. In some cases you may have more than 1 type defined in the file, but for the most part one type one file. An example of when a file has multiple types is the Internal/External/Media Links paragraph type.

• Display Name: The name content editors will see
• Machine-readable Name: The name drupal developers will see, either cgov_XXX, pdq_XXX, or ncids_XXX

This is the description content editors will see.

Create a list of links to the specific anchor for the field in the Common Field files e.g,

• Syndicate
• ...

_ This is a set of headings for each of the local fields _

NOTE: This list of items is for all field types. Each specific type will have additional parameters and they should be supplied as well. Take a look at live examples for now until we create documentation for each field.

• Field Name: The name the developer sees e.g., field_some_field
• Label: The name the content editor sees
• Type: The Drupal field type e.g., Plain text
• Required: Yes or No
• Tooltip Text: Additional descriptive text the content editors see
• Cardinality: The number of items the user can create for this field. Usually 1 unless it is some sort of list.
• Translatable: Should this field be marked as something that would show on a Spanish translation? NOTE: Not all entity types are translatable, for example Paragraphs

This is the order that content editors should see the fields

• Field 1
• Field 2

---

This is a plain text field with nothing special.

• Max Length: The maximum length for the text