From c5ed89716f35b916baa82d8b6d920c3a782ab648 Mon Sep 17 00:00:00 2001 From: jeff-techstension <157553534+jeff-techstension@users.noreply.github.com> Date: Mon, 13 Jan 2025 08:58:54 -0600 Subject: [PATCH] Added documentation for fields with alternate display modes. (#17333) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Zoltán Lehóczky --- src/docs/reference/modules/Placement/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/docs/reference/modules/Placement/README.md b/src/docs/reference/modules/Placement/README.md index 6b730222876..624895fcc72 100644 --- a/src/docs/reference/modules/Placement/README.md +++ b/src/docs/reference/modules/Placement/README.md @@ -94,6 +94,24 @@ It is built using the `Part` it's contained in, and the name of the `Field`. For instance, if a field named `MyField` would be added to an `Article` content type, its differentiator would be `Article-MyField`. If a field named `City` was added to an `Address` part then its differentiator would be `Address-City`. +### Field Display Modes + +The placement rules are stricter for non-standard display modes. + +1. The Shape must include the display type. For example `TextField_Display`. +2. You must use the full differentiator. `[ContentPart]-[ContentField]_[DisplayType]__[DisplayMode]`. For a field named MyField on the Content Type Blog the differentiator is `Blog-MyField-TextField_Display__Header`. + +```json +{ + "TextField_Display": [ + { + "place": "Content:1", + "differentiator": "Blog-MyField-TextField_Display__Header" + } + ] +} +``` + ## Shape differentiators You can find information about shape differentiators in the [Templates documentation](../../modules/Templates/README.md#content-field-differentiator)