Skip to content

Commit

Permalink
Added documentation for fields with alternate display modes. (Orchard…
Browse files Browse the repository at this point in the history
…CMS#17333)

Co-authored-by: Zoltán Lehóczky <zoltan.lehoczky@lombiq.com>
  • Loading branch information
jeff-techstension and Piedone authored Jan 13, 2025
1 parent 657c0da commit c5ed897
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions src/docs/reference/modules/Placement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit c5ed897

Please sign in to comment.