Working with Content Fragments working-with-content-fragments

They are based on a Content Fragment Model, which predefines a structure for the resulting fragment.

The structure can range between:

• Basic

  • For example, a single, multi-line text field.
  • Used for preparing straightforward content for use in page authoring.

• Complex

  • A combination of many fields of varying data types, including text, number, boolean, data, and time, among others.
  • Used either for preparing more structured content for page authoring, or for delivery to your application.

• Nested

  • The reference data types available let you nest your content.
  • Tends to be used for delivery to your application.

Stored as Assets:

• Content fragments (and their variations) can be created and maintained from the Assets console.
• Authored and edited in the Content Fragment Editor.

Used in the page editor with the Content Fragment component (referencing component):

• The Content Fragment component is available to page authors. It allows them to reference, and deliver, the required content fragment in either HTML or JSON format.

Accessible using the AEM GraphQL API.

Insert Asset into a fragment (mixed-media fragments)

• Are a part of the fragment (see Constituent Parts of a Content Fragment).
• Define the position of the asset.
• See Inserting Assets into your Fragment in the Fragment Editor for more information.

Associated Content

• Are connected to a fragment; but not a fixed part of the fragment (see Constituent Parts of a Content Fragment).
• Allows some flexibility for positioning.
• Are easily available for use (as in-between content) when using the fragment on a page.
• See Associated Content for more information.

Assets available from the Assets browser of the page editor

• Allow full flexibility for selection of an asset.
• Allows some flexibility for positioning.
• Does not provide the concept of being approved for a specific fragment.

Fragment Elements

• Elements correlate to the data fields holding content.
• You use a content model to create the content fragment. The elements (fields) specified in the model define the structure of the fragment. These elements (fields) can be of various data-types.

Fragment Paragraphs

• Blocks of text–often multi-line–that are delimited as individual entities.

• In the Rich Text and Markdown modes, a paragraph can be formatted as a header, in which case it and the following paragraph belong together as one unit.

• Enable content control during page authoring.

Assets Inserted into a Fragment (Mixed-Media Fragments)

• Assets (images) inserted into the actual fragment and used as the internal content of a fragment.

• Are embedded in the paragraph system of the fragment.

• Can be formatted when the fragment is used/referenced on a page.

• Can only be added to, deleted from, or moved within, a fragment using the fragment editor. These actions cannot be made in the page editor.

• Can only be added to, deleted from, or moved within, a fragment using the Rich Text format in the fragment editor.

• Can only be added to multi-line text elements (any fragment type).

• Are attached to the preceding text (paragraph).

  note caution
  CAUTION
  Assets can be (inadvertently) removed from a fragment by switching to Plain Text format.

  note note
  NOTE
  Assets can also be added as additional (in-between) content when using a fragment on a page; using either Associated Content or assets from the Assets browser.

Associated Content

• This is content external to, but with editorial relevance for, a fragment. Typically images, videos, or other fragments.

• The individual assets within the collection are available to be used with the fragment in the page editor, when it is added to a page. This means that they are optional, depending on the requirements of the specific channel.

• The assets are associated to fragments via collections; associated collections allow the author to decide which assets to use when they are authoring the page.

  • Collections can be associated to fragments as default content, or by authors during fragment authoring.
  • Assets (DAM) Collections are the basis for the associated content of fragments.

• Optionally you can also add the fragment itself to a collection to aid tracking.

Fragment Metadata

• Use the Assets metadata schemas.

• Tags can be created when you:

  • Create and author the fragment

  • Or later:

    • By viewing/editing the fragment Properties from the console
    • By editing the Metadata when in the fragment editor

Master

• A part of the fragment

  • Every content fragment has one instance of Master.
  • Master cannot be deleted.

• Master is accessible in the fragment editor under Variations.

• Master is not a variation as such, but is the basis of all variations.

Variations

• Renditions of fragment text that are specific to an editorial purpose; can be related to channel but is not compulsory, can also be for ad-hoc local modifications.
• Are created as copies of Master, but can then be edited as required; there is content overlap between the variations themselves.
• Can be defined during fragment authoring.
• Stored in the fragment, to help avoid scattering of content copies.
• Variations can be synchronized with Master if the Master content has been updated.
• Can be Summarized to quickly truncate the text to a predefined length.
• Available under the Variations tab of the fragment editor.

Content Model

• Are enabled using the Configuration Browser.
• Are created using Tools.
• Required to create a fragment.
• Defines the structure of a fragment (title, content elements, tag definitions).
• Content model definitions require a title and one data element; everything else is optional.
• The model can define default content - if applicable.
• Authors cannot change the defined structure when authoring fragment content.
• Changes made to a model after dependent content fragments have been created, can impact those content fragments.

Content Fragment Component

• Instrumental in delivering the fragment in HTML and/or JSON format.
• Required to reference the fragment on a page.
• Responsible for layout and delivery of a fragment; that is, channels.
• Fragments need one or more dedicated components to define the layout and deliver some or all elements/variations and associated content.
• Dragging a fragment onto a page in authoring automatically associates the required component.