AEM Sites presets in the Web Editor
You can create AEM Sites presets from the Web Editor and configure them to generate the AEM Sites output. AEM Sites output is based on the composite components mapping along with the guides-components, facilitating efficient content creation and management.
Experience Manager Guides provides predefined templates for creating AEM Sites. These presets help you ensure consistency in content layout and structure.
- Create home pages based on these predefined templates.
- You can edit topic templates and apply styles according to your requirements.
- You can also customize existing AEM Sites templates.
Create AEM Sites Presets
Perform the following steps to create the AEM Sites presets from the Web Editor:
- In the Repository panel, open the DITA map file in Map View.
- In the Output tab, select the + icon to create an output preset.
- Select AEM Sites from the Type drop-down in the New output preset dialog box.
- Deselect the Use legacy component mapping option from the New output preset dialog box.
Add presets to the current folder profile
As an administrator, Experience Manager Guides allows you to create and manage output presets for the Global and Folder Profiles. Select the Add to current folder profile option from the New output preset dialog box to create an output preset for the current folder profile.
AEM Sites presets based on legacy component mapping
You can also create the AEM Sites presets using the legacy component mapping. To create the AEM Sites presets based on legacy component mapping, select Use legacy component mapping option from the New output preset dialog box.
Some options may differ for the presets that use legacy component mapping.
Configure the AEM Sites presets
The configurations are organized under the General, Content, Topic list, and Cross map references tabs.
General
The General tab contains the following configurations related to generating outputs:
-
Use site path
-
Site path
-
Site
-
Publish path
-
Topic page template
-
Generate page names based on
- Topic file name
- Topic title
-
Cleanup previously generated pages
- Delete previously generated pages for topics removed from the map
- Delete all pages created by other sources at this path:
-
Post generation workflow
Content
The Content tab contains the following configurations:
-
Use Baseline
-
Condition filtering
-
Additional DITA-OT command line arguments
-
Metadata
- File (Assets) properties
- Use map properties as fallback
For details, refer to AEM Sites configuration.
Topic List
The Topic List displays the list of topics present in the current working copy of the DITA map. By default, all topics are included. You can select specific topics and generate the AEM Sites output only for them. For example, you have updated some topics so you can publish only those topics instead of publish the entire DITA map.
Topic List tab is present in the AEM presets that are not created based on legacy mapping.
Cross-map references
This list contains topics containing cross-map references with scope =”peer”. You can specify the publishing context for a list of cross map references with scope=”peer” to topics available in other DITA maps. This tab appears if you use the Experience Manager Guides (UUID) version.
Learn more about how to publish linked topics.
AEM Sites configuration aem_sites_config
The following options are available for the AEM Sites output:
Select Refresh
AEMG-Docs and the Publish Path as aemg-docs-en/docs/product-abc., then the AEM Sites output is generated under the aemg-docs-en/docs/product-abc/ node in crx/de.Topic title: Uses the DITA topic’s title to create the Experience Manager Site names.
Let’s say you have published a DITA map, which contains topics a.dita, b.dita, and c.dita. Before publishing the map again, you removed b.dita topic from the map. Now, if you have selected this option, then all content related to b.dita is removed from the AEM Sites output and only a.dita and c.dita are published.
Note: Information about deleted pages is also captured in the output generation logs. For more information about accessing the log files, View and check the log file.
Caution: On deleting the topics, the pages become unavailable from the published site. So, before the topics are deleted, a warning appears. You must confirm to delete them.
- Delete all pages created by other sources at this path: If you select this option, all pages published on this path from other maps, individual topics, or any other source are deleted. The pages also become unavailable from the published site. So, before the topics are deleted, a warning appears. You must confirm to delete them.
Important: When you are generating incremental output for the AEM Site, then the output is created using the current version of the files and not the attached Baseline.
View Work with Baseline for more details.
None: Select this option if you do not want to apply any condition on the published output.
Using DITAVAL: Select DITAVal file(s) to generate conditionalized content. You can select multiple DITAVal files using the browse dialog or by typing file path. Use the cross icon near the file name to remove it. DITAVal files are evaluated in the order specified, so the conditions specified in the first file take precedence over the matching conditions specified in later files. You can maintain the file order by adding or deleting files. If the DITAVal file is moved to some other location or is deleted, it is not automatically deleted from the map dashboard. You need to update the location in case files are moved or deleted. You can hover over the file name to view the path in the AEM repository where the file is stored. You can only select DITAVal files and an error is displayed if you select any other file type.
Condition preset: Select a condition preset from the drop-down to apply a condition while publishing the output. This option is visible if you have added a condition for the DITA map file. The conditional settings are available in the Condition Presets tab of the DITA map console. To know more about condition preset, view Use condition presets.
File (Assets) Properties
Note: The metadata properties are case-sensitive.
If you have selected a Baseline, then the values for the properties are based on the version of the selected Baseline. If you have not selected a Baseline, then the values for the properties are based on the latest version.
You can also pass on the metadata to the output using DITA-OT publishing. For more details view, Pass on the metadata to the output using DITA-OT.
Note: If you have not defined the
cq:tags in the Properties option, then the values for cq:tags are picked from the current working copy even if you have selected a Baseline for publishing.Use map properties as fallback
Only String, Date, or Long (singe and multi-valued) properties can be passed on to the AEM Site pages. The metadata values for a String type property does not support any special characters (such as
@, #, " ").* This option should be used along with the
Properties option.After generating the output, select the Download temporary files
Note: If file properties are added during generation, the output temporary files also include a metadata.xml file containing those properties.
Generate the AEM Sites output using the templates
Experience Manager Guides allows you to use the out of the box templates or add your own AEM Sites templates.
Before configuring the AEM Sites presets, ensure to create an AEM Sites structure using the templates.
For more details, view Download and install AEM Sites templates.
Perform the following steps to create and configure an AEM Sites preset:
-
Open the Output Presets tab of the DITA map you want to publish.
-
Select the AEM Sites output preset.
-
(Optional) Uncheck Use legacy component mapping option to create a non-legacy AEM Sites preset .
-
Click Add. The preset for AEM Sites is created.
-
You can configure the Out-of-the-box Sites template in two ways:
-
Select Site and then choose the publish path and the topic page templates from the populated options:
- Select the Site.
- Select Site. For example,
AEMG Docs. - The Publish path and the Topic page template options are automatically set in the dropdown. You can also choose the options. For example,
AEMG-Docs-Site/en/docs/product1andTopic pageare set respectively.
-
Select the complete Site path:
- Select Use Site path option.
- Select the complete Site path. For example,
/content/AEMG-Docs-Site/en/docs/product1. - The ‘Topic page template’ is automatically set as
Topic Page.
-
-
Save the changes done to the preset.
-
Select the Generate option.
-
Generate AEM Sites for the corresponding map. For example,
/content/AEMG-Docs-Site/en/docs/product.note note NOTE If you are publishing content to an AEM site for the first time, it is recommended to publish the pages at the site level. This ensures the output is displayed correctly on the Publish instance without any CSS disruption.
Publish linked topics
Experience Manager Guides simplifies the publishing of complex documents by allowing you to create topic references using the peer @scope. You can then define the publishing context of these references from the AEM Sites presets and finally generate the output of the linked topics.
For more details, view Generate output of linking topics from other maps.
Perform the following steps to specify the publishing context for cross-linked files:
-
Open the Output Presets tab of the DITA map you want to publish.
-
Select the AEM Sites output preset.
You can view the General, Content, Topic list, and Cross map references tabs. Cross map references tab appears if you use the Experience Manager Guides (UUID) version.
You’ll not be able to view the cross-map linking in the following cases:
- For the presets created before the 4.6 release. The Cross references tab is disabled and a tool tip, Refer to Map dashboard appears.
- For presets created from the map dashboard. Refer to Map dashboard tooltip appears.
- For OOTB presets, Refer to Map dashboard tooltip appears.
- For global presets, Create a local copy of this global preset to set cross map references.
If you want to use AEM Sites presets from the Web Editor, either create a new preset or duplicate the existing one.
-
Open the Cross map references tab.
You are shown a list of topics and their references. You can specify the publishing context for a list of cross map references to topics available in other DITA maps with
scope=”peer”.To use the cross-map reference panel from Web Editor,
<xrefs>must have unique IDs. Unique IDs for<xrefs>will be automatically generated on editing/saving the older content if the ID isn’t there.note note NOTE The Cross map references tab shows topics that are linked using the scope=”peer”only. For links withscope=”local”, you don’t need to specify the publishing context.All linked topics have their latest output preset and map selected by default. The publishing context for all the linked topics is set to
<Most recently generated>map by default.
-
If you want to use the most recently published output of each dependent file in the map, select Use most recently generated publish context for all dependent topics.
You should publish the map selected as the parent map before publishing the map containing linked topics. If the map with linked topics isn’t published, the links appear as normal text instead of hyperlinks in the AEM Sites output.
You should select the same type of AEM Sites preset for the linked topic. For example, if the current AEM Sites preset uses legacy component mapping, then select a similar AEM Sites preset of the linked topic. -
In the Parent Map drop-down list, select the map file with whose output you want to link the current map’s output.
Selecting a map file shows the map’s UUID in the Parent Map UUID column. The Output Presets associated with the chosen map are listed in the Parent Map’s Preset list. For example, Topic 1 in Map A contains a reference to Topic 2. Topic 2 can be present in single or multiple maps. You can select the parent map and a specific preset or the most recently published output for each link. -
If the same topic is referred to more than once in a file, then you can add a different publishing context for each instance. This provides greater flexibility and control over their content. For example, Topic 3 is present in both Map B and Map C. Topic 1 contains two references to Topic 3. You can choose Map B as a parent map for the first link and Map C as the parent for the second link.
-
In the Parent Map’s Preset drop-down list, select the output preset with which you want to link the current map’s output.
note note NOTE The different AEM Sites presets of the current map appear in the dropdown list. If you don’t select a preset, a warning icon appears, and the output generation, fails. 1. Select the required map and its output preset for all source topics and select **Generate**.
Parent topic: Understanding the output presets