AEM Sites preset in the Map console
You can create AEM Sites preset from the Map console and configure them to generate the AEM Sites output. There are two ways to create the AEM Sites output:
Use composite component mapping
The composite component mapping offers faster and scalable publishing to AEM Sites as compared to legacy component mapping. It comes with out-of-the-box editable templates which can be customized as per your requirements using AEM Template editor. The templates utilize a mix of WCM core components and specialized guides-components to ensure that your end users get the best experience on your AEM Sites pages. You can also customize your existing templates using the composite component mapping method.
Experience Manager Guides provides predefined templates for creating AEM Sites. These templates 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 Preset
Perform the following steps to create the AEM Sites preset using composite component mapping:
-
In the Output presets panel, 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.
-
Select the Add to current folder profile option to create an output preset within the current folder profile. The
Learn more about Manage Global and Folder profile output presets.
-
Select Add.
The preset for AEM Sites is created.
AEM Sites preset configuration for composite component mapping
- On-premise Software: Learn more about how to download and install AEM Sites templates for On-premise Software.
- Cloud Service: Learn more about how to download and install AEM Sites templates for Cloud Service.
In the Map console, the preset configuration options for composite component mapping are organized under the following tabs:
- General
- Content
- Topic list
- Cross map references
General
The General tab contains the following configuration options:
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鈥檚 title to create the Experience Manager Site names.
Let鈥檚 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.
Content
The Content tab contains the following configuration options:
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.Topic list
The Topic list tab 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 publishing the entire DITA map.
Cross map references
This list contains topics containing cross-map references with scope =鈥漰eer鈥. You can specify the publishing context for a list of cross map references with 蝉肠辞辫别=鈥漰别别谤鈥 to topics available in other DITA maps. This tab appears if you use the Experience Manager Guides (UUID) version.
For more details, refer to the Working with linked topics section below.
Once configured, save the changes done to the preset, and select Generate to generate AEM Sites for the corresponding map.
Use legacy component mapping
The steps to create the AEM Sites preset using legacy component mapping are the same as those outlined in Composite component mapping section above. However, while creating the preset, ensure that you select the Use legacy component mapping option in the New output preset dialog.
In the Map console, the preset configuration options for legacy component mapping are organized under the following tabs:
- General
- Content
- Cross map references
General
The General tab contains the following configuration options:
A node in the AEM repository is created with the name specified here. If you do not specify the Site Name, then the site node is created with the DITA map file name.
The Site Name you specify here is also used as the title in the browser tab.
You can also use variables while setting the Site Name.
user-guide and the Output Path as /content/output/aem-guides, then the final output is generated under the /content/output/aem-guides/user-guide node.You can also use variables while setting the output path.
Select the Delete and Create option to force delete any existing pages during publishing. This option deletes the page node along with its content and all child pages under it. Use this option if you have changed the design template of your output preset or if you want any extra pages already present in the destination to be removed.
Let鈥檚 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.
For details about how to use custom design templates to generate output, contact your publishing administrator.
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.
Content
The Content tab contains the following configuration options:
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.Cross map references
This list contains topics containing cross-map references with scope =鈥漰eer鈥. You can specify the publishing context for a list of cross map references with 蝉肠辞辫别=鈥漰别别谤鈥 to topics available in other DITA maps. This tab appears if you use the Experience Manager Guides (UUID) version.
For more details, refer to the Working with linked topics section below.
Working with linked topics
Experience Manager Guides allows 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 Cross map references tab. To view this tab, ensure that the
<xrefs>have unique IDs. Unique IDs for<xrefs>will be automatically generated on editing/saving the older content if the ID isn鈥檛 there.You鈥檒l 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.
-
A list of topics and their references is displayed
note note NOTE The Cross map references tab shows topics that are linked using the 蝉肠辞辫别=鈥漰别别谤鈥only. For links with蝉肠辞辫别=鈥漧辞肠补濒鈥, you don鈥檛 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鈥檛 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鈥檚 output.
Selecting a map file shows the map鈥檚 UUID in the Parent Map UUID column. The Output Presets associated with the chosen map are listed in the Parent Map鈥檚 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鈥檚 Preset drop-down list, select the output preset with which you want to link the current map鈥檚 output.
note note NOTE The different AEM Sites presets of the current map appear in the dropdown list. If you don鈥檛 select a preset, a warning icon appears, and the output generation, fails. -
Select the required map and its output preset for all source topics and select Generate.
Parent topic: Understanding the output presets