Managing Content Fragments managing-content-fragments
Learn how to use the Assets console to manage your AEM Content Fragments, as either the basis of your headless content or for page authoring.
After defining your Content Fragment Models you can use these to create your Content Fragments.
The Content Fragment Editor provides various modes to enable you to:
- when authoring pages; see Page Authoring with Content Fragments.
- for Headless Content Delivery using Content Fragments with GraphQL.
Creating Content Fragments creating-content-fragments
Creating a Content Model creating-a-content-model
Content fragment models can be enabled and created, prior to creating content fragments with structured content.
Creating a Content Fragment creating-a-content-fragment
The method of creating a content fragment is:
-
Navigate to the Assets folder where you want to create the fragment.
-
Select Create, then Content Fragment to open the wizard.
-
The first step of the wizard requires you to specify the basis of the new fragment.
-
Model - used to create a fragment that requires structured content; for example, the Adventure model
- All available models are displayed.
After selection, use Next to proceed.
-
-
In the Properties step specify:
-
Basic
-
Title
The fragment title.
Mandatory.
-
Description
-
Tags
-
-
Advanced
-
Name
The name; is used to form the URL.
Mandatory; is automatically derived from the title, but can be updated.
-
-
-
Select Create to complete the action, then either Open the fragment for editing or return to the console with Done.
note note NOTE In List mode of the console you can update the View Settings to enable the Content Fragment Model column.
Actions for a Content Fragment in the Assets Console actions-for-a-content-fragment-assets-console
In the Assets console a range of actions are available for your content fragments, either:
- From the toolbar; after selection of your fragment all appropriate actions are available.
- As quick actions; a subset of actions available for the individual fragment cards.
Select the fragment to reveal the toolbar with applicable actions:
-
Reprocess Assets
-
Create
-
Download
- Save the fragment as a ZIP file; you can define whether to include Elements, Variations, Metadata.
-
Checkout
-
Properties
- Lets you view, or edit, or both, the fragment’s metadata.
-
Edit
- Lets you open the fragment for editing content together with its elements, variations, associated content and metadata.
-
Quick Publish
-
Manage Publication
-
Manage Tags
-
To Collection
-
Copy (and Paste)
-
Move
-
Delete
Opening the Fragment Editor opening-the-fragment-editor
To open your fragment for editing:
-
Use the Assets console to navigate to the location of your content fragment.
-
Open the fragment for editing, by either:
- Clicking/tapping on the fragment or fragment link (this is dependent on the console view).
- Selecting the fragment, then Edit from the toolbar.
-
The fragment editor opens. Make your changes as required:
-
After making changes, use Save, Save & close or Close as required.
note note NOTE Save & close is available by way of the Save drop-down list. note note NOTE Both Save & Close and Close will exit the editor - see Save, Close and Versions for full information on how the various options operate for content fragments.
Modes and Actions in the Content Fragment Editor modes-actions-content-fragment-editor
There are various modes and actions available from the Content Fragment Editor.
Modes in the Content Fragment Editor modes-in-the-content-fragment-editor
Navigate through the various modes using the icons in the side panel:
Toolbar Actions in the Content Fragment Editor toolbar-actions-in-the-content-fragment-editor
Some features in the top toolbar are available from multiple modes:
-
A message is shown when the fragment is already referenced on a content page. You can Close the message.
-
The side panel can be hidden/shown using the Toggle Side Panel icon.
-
Underneath the fragment name you can see the name of the Content Fragment Model used for creating the current fragment:
- The name is also a link that opens the model editor.
-
See the status of the fragment; for example, information about when it was created, modified or published. The status is also color-coded:
- New: grey
- Draft: blue
- Published: green
- Modified: orange
- Deactivated: red
-
A button enables you to Try New Editor, by directly opening the new Content Fragment Editor that is accessible via the Content Fragments console.
note warning WARNING The new editor opens in the same tab. It is not recommended to have both editors open at the same time. -
Save provides access to the Save & close option.
-
The three dots (…) drop-down provides access to additional actions:
- Update page references
- This updates any page references.
- Quick publish
- Manage Publication
- Update page references
Save, Close and Versions save-close-and-versions
The editor has various options:
-
Save and Save & close
- Save will save the latest changes and remain in the editor.
- Save & close will save the latest changes and exit the editor.
note caution CAUTION To edit a content fragment you need the appropriate permissions. Contact your system administrator if you are experiencing issues. note note NOTE It is possible to remain in the editor, making a series of changes, before saving. note caution CAUTION In addition to simply saving your changes, the actions also update any references and ensures that the Dispatcher is flushed as required. These changes can take time to process. Due to this time, there can be a performance impact on a large/complex/heavily-loaded system. Keep this process in mind when using Save & close and then quickly reentering the fragment editor to make and save more changes. -
Close
Will exit the editor without saving the latest changes (that is, made since the last Save).
While editing your content fragment AEM automatically creates versions to ensure that prior content can be restored if you cancel your changes (using Close without saving):
-
When a content fragment is opened for editing AEM checks for the existence of the cookie-based token that indicates whether an editing session exists:
- If the token is found, the fragment is considered to be part of the existing editing session.
- If the token is not available and the user starts editing content, a version is created and a token for this new editing session is sent to the client, where it is saved in a cookie.
-
While there is an active editing session, the content being edited is automatically saved every 600 seconds (default).
note note NOTE The auto save interval is configurable using the /confmechanism.Default value, see:
/libs/settings/dam/cfm/jcr:content/autoSaveInterval -
If the user cancels the edit, the version created at the start of the editing session is restored and the token is removed to end the editing session.
-
If the user selects to Save the edits, the updated elements/variations are persisted and the token is removed to end the editing session.
Editing the Content of your Fragment editing-the-content-of-your-fragment
Once you have opened your fragment, you can use the Variations tab to author your content.
Creating and Managing Variations within your Fragment creating-and-managing-variations-within-your-fragment
Once you have created the Master content, you can create, and manage, Variations of that content.
Associating Content with your Fragment associating-content-with-your-fragment
You can also associate content with a fragment. This provides a connection so that assets (that is, images) can be (optionally) used with the fragment when it is added to a content page.
Viewing and Editing the Metadata (Properties) of your Fragment viewing-and-editing-the-metadata-properties-of-your-fragment
You can view, and edit, the properties of a fragment using the Metadata tab.
Timeline for Content Fragments timeline-for-content-fragments
In addition to the standard options, Timeline provides both information and actions specific to content fragments:
-
View information about versions, comments, and annotations
-
Actions for Versions
-
Revert to this Version (select an existing fragment, then a specific version)
-
Compare to Current (select an existing fragment, then a specific version)
-
Add a Label and/or Comment (select an existing fragment, then a specific version)
-
Save as Version (select an existing fragment, then the up arrow at the bottom of Timeline)
-
-
Actions for Annotations
- Delete
- Standard functionality for all assets
- Made in Timeline
- Related to the fragment asset
- Entered in the fragment editor
- Specific to a selected segment of text within the fragment
For example:
Comparing Fragment Versions comparing-fragment-versions
The Compare to Current action is available from the Timeline after you have selected a specific version.
This opens:
-
the Current (latest) version (left)
-
the selected version v<x.y> (right)
They is shown side by side, where:
-
Any differences are highlighted
- Deleted text - red
- Inserted text - green
- Replaced text - blue
-
The full-screen icon lets you open either version on its own; then toggle back to the parallel view
-
You can Revert to the specific version
-
Done will return you to the console
Reverting to a Version reverting-to-a-version
You can revert to a specific version of your fragment:
-
Directly from the Timeline.
Select the required version, then the Revert to this Version action.
-
While comparing a version to the current version you can Revert to the selected version.
Publishing and Referencing a Fragment publishing-and-referencing-a-fragment
Content Fragments must be published for use in the publish environment. This is done using the standard Assets functionality:
This can be accessed:
- After creation; using actions available in the Assets console.
- From the Content Fragment Editor.
In addition, when you publish a page that uses the fragment; the fragment is listed in the page references.
Deleting a Fragment deleting-a-fragment
To delete a fragment:
-
In the Assets console navigate to the location of the content fragment.
-
Select the fragment.
note note NOTE The Delete action is not available as a quick action. -
Select Delete from the toolbar.
-
Confirm the Delete action.
note caution CAUTION If the fragment is already referenced in a page you will then see a warning message and be required to confirm that you want to proceed with a Force Delete. The fragment, together with its content fragment component, is deleted from any content pages.