What’s new in 4.3.0 release of ÃÛ¶¹ÊÓƵ Experience Manager Guides (July 2023)
This article covers the new and enhanced features in version 4.3.0 of ÃÛ¶¹ÊÓƵ Experience Manager Guides (later referred as AEM Guides).
For more details on the upgrade instructions, compatibility matrix, and the issues fixed in this release, see Release notes.
Connect to a data source and insert data into your topics
Now you can quickly connect to your data sources using out-of-the-box connectors from AEM Guides. Connecting to a data source enables you to keep your information in sync with the source, and any updates to the data are reflected automatically, making AEM Guides a true content hub. This feature helps you save time and effort to manually add or copy the data.
AEM Guides allows your administrator to configure the out-of-the-box connectors for JIRA and SQL (MySQL, PostgreSQL, SQL Server, SQLite) databases. They can also add other connectors by extending the default interfaces.
Once added, you can view the configured connectors listed under the Data Sources panel in the Web Editor.
{width="300"}
Create a content snippet to fetch the data from a connected data source. You can then insert the data into your topics and edit it. Once you’ve created a content snippet generator, you can reuse it to insert the data into any topic.
Now you can also create a topic from a connected data source. A topic can contain data in various formats, like tables, lists, and paragraphs. It also allows you to create a DITA map for all topics. You can associate metadata to the topic when pulling from a data source.
For more details, view Use data from your data source.
Add citations to your content
Citations are references to the source of information added to your content. Citations assist you in establishing credibility and preventing plagiarism. Citations help the readers to locate the source and verify the information presented in the text.
In AEM Guides, you can add citations or import citations and apply them to your content. You can add these citations from any source of books, websites, and journals.
After inserting your citations to your topics, you can preview them in the Web Editor. You can also publish content with citations using Native PDF.
{width="300"}
For more details, view Add and manage citations in your content.
Publish to a content fragment
Content fragments are discrete pieces of content in AEM. They are structured content based on a content model. Content fragments are pure content without design or layout information. They can be authored and managed independently of the channels that AEM supports. The modularity and reusability of the content fragments leads to greater flexibility, consistency, efficiency, and simpler management.
Now AEM Guides offers a way to publish a topic or the elements within a topic to a content fragment. You can create a JSON-based mapping between a topic and a content fragment model. Use this mapping to publish content present in some or all elements within a topic to a content fragment.
Capitalize the power of AEM Guides and content fragments and use content fragments in any AEM site. You can also extract the details via APIs supported by content fragments.
{width="550"}
Review Enhancements
AEM Guides now provides an improved review capability with the following functionalities:
Review panel to showcase review projects and the active review tasks
Now AEM Guides makes your reviews more seamless. It provides the Reviews panel within the Web Editor. The Reviews panel displays all the review projects and the active review tasks within the review projects that you’re part of.
As an author, this feature helps you easily open the review tasks, view the comments, and quickly address the comments in a centralized view.
{width="800"}
For more details, view the Review feature description within the Left Panel section.
Search review topics
Conducting reviews is a critical feature of AEM Guides. It helps the reviewers to review the documents assigned to them .
Now you can search for a topic by entering some part of the text of the title or filepath in the search bar of the topics view of the review panel. You can also choose to view all topics or view topics with comments. By default, you can view all topics present in the review task.
{width="800"}
For more details, view Review topics.
Guides Extension Framework
Create custom packages on top of AEM Guides to provide extensibility using AEM Guides Extension Framework. These packages are useful for developers and consultants and give them extensibility to the components in the Editor. They can target buttons, dialogs, and dropdowns and add custom JavaScript that can easily interoperate with AEM Guides UI.
Native PDF enhancements
The following Native PDF enhancements have been done in the 4.3.0 release to make AEM Guides a more robust product:
Support for language variables
AEM Guides provides support for language variables. You can use language variables to define a localized version of the out-of-the-box labels like Note, Caution, and Warning or static text in the PDF output.
You can add the language variables or the localized version of the labels to the appropriate sections in your PDF output and in the output templates.
Language variables in the PDF output
You can use the language variables to define localized labels for elements like Note, Caution, and Warning. You can update the value for these variables in one or more languages, and then the localized value is automatically picked in the PDF output.
For example, you can present the label Note in your PDF output in the following ways:
- English: Note
- French: Remarque
- German: Hinweis
Language variables in the output templates
If you wanted to create the PDF output in various languages, you had to create different PDF templates containing localized text for each language. Now with the language variables feature, you only need to create the template once. Then for any static text you need to localize, you can create corresponding language variables and use them in your template.
You can create language variables for longer text, such as a whole sentence or even a paragraph. You can also apply styles and use HTML markup to format these language variables.
For more details, view Support for language variables.
Add a watermark to PDF output for draft documents
Now you can add a watermark to the PDF output of the document which is yet not approved. This watermark does not appear if you generate the PDF for the document in ‘Approved’ docstate. For example, you can add a watermark Draft for your PDF output.
For more details, view Add a watermark to the PDF output for draft documents.
Ability to use AEM metadata in PDF layouts
Metadata is the description or definition of your content. This metadata is stored in your source DITA map content.
Now In AEM Guides you can also select the metadata properties of your assets and add them to the page layout. Then AEM Guides picks these metadata properties of your assets and publishes them in your PDF output.
{width="300"}
For more details, view Add fields and metadata.
Order pages in the PDF output
You can show or hide the following sections in your PDF and also arrange the order in which they should appear in your final PDF output:
- TOC
- Chapters & Topics
- List of Figures
- List of Tables
- Index
- Glossary
- Citation
- Page layouts
If you do not want to show a particular section in your PDF output, you can hide that by turning the toggle switch off.
For more details, view Page Order.
Merge pages
In a Native PDF output by default, all sections begin on a new page. Now you can merge a section to its previous page or the next page. This publishes the section in continuation with the selected page in the PDF output and there is no page break in between.
For more details, view the Merge pages feature description in Page Order section.
Static pages
You can also create custom page layouts and publish them as static pages in the PDF output. This helps you to add any static content like Notes or blank pages.
For more details, view the Static pages feature description in Page Order section.
Variables in cross references
You can use variables to define a cross-reference. When you use a variable, its value is picked from the properties.
Now you can also use {figure} and {table}.
Use {figure}to add a cross-reference to the figure number. It picks the figure number from the auto number styles that you’ve defined for figcaption.
Use {table} to add a cross-reference to the table number. It picks the table number from the auto number styles that you’ve defined for caption.
For more details, view Cross references.
Start any chapter from the current page
You can set the basic configuration settings for starting a chapter from odd or even page, the TOC structure, and define the leader line format for the TOC entries.
Now you can also start a chapter from the current page. If you choose to do so, all chapters are published in continuation without any page breaks. For example, if a chapter ends in the middle of page 15, then the next chapter also starts from the 15th page itself.
Ability to access temporary HTML files while generating the native PDF output
Now AEM Guides allows you to download the temporary HTML files created while generating the native PDF output. In the output preset settings, select the option to download the temporary files. AEM Guides then allow you to download the temporary files created while generating the output using that preset.
This feature enables better insights into the generation process with access to interim styles and layouts and helps you correct or change your CSS styles according to your requirements.
{width="800"}
For more details, view Create a PDF output preset.
Redesign of CSS editor
Now the CSS editor is redesigned for a better user experience with selectors and style properties.
Enhancement of Add Style dialog
You can now use custom selectors to add complex styles. The new Selector field helps you to add custom selectors besides the Class, Tag, and Pseudo Class combination. For example, you can create table a.link
style for all the hyperlinks inside a table.
{width="300"}
Customize properties of style
Now AEM Guides introduces you to a new properties panel under the preview section for styles. You can edit the properties of the styles more efficiently and quickly from the properties panel.
Rename and Move files within the Repository view
Now you can also rename or move a file from the repository panel. This feature is handy and helps manage your files easily from the Repository panel. You can select a file and rename or move it using the Options menu for the selected file. AEM Guides displays a success message when you move or rename a file.
{width="550"}
For more details on the Options menu of a file, view the Repository view feature description in the Left Panel section.
Broken Links report in the Web Editor
AEM Guides allows you to check the overall completeness of your technical documents and generate reports from the Web Editor. Now in June 2023 release AEM Guides provides you the feature to view and fix broken links. This is a useful report which helps you manage your broken links. You can easily view the broken links present in your DITA map and also fix them.
{width="800"}
Once you fix a link, it is not displayed under the list of broken links.
For more details, see View and fix broken links.
Schematron enhancements
Use report statements to check for rules in Schematron
AEM Guides also now supports the report statements with the Schematron. A report statement generates a message when a test statement evaluates to true. For example, if you want the short description to be less than or equal to 150 characters, you can define a report statement to check the topics where the short description is more than 150 characters.
For more details, view Use assert and report statements to check for rules.
Use Regex expressions
You can also use Regex expressions to define a rule with matches() function and then perform validation using the Schematron file.
For more details, view Use Regex expressions.
Define abstract patterns
AEM Guides also supports abstract patterns in Schematron. You can define generic abstract patterns and reuse these abstract patterns. Abstract patterns can simplify your Schematron schema and also help you manage and update your validation logic.
For more details, view Define abstract patterns.
Support for XLIFF format in translation
AEM Guides also provides the support for XML Localization Interchange File Format (XLIFF) format in translation. Now you can also choose to Create a new XLIFF translation project to convert the XML content into the XLIFF format. AEM Guides supports XLIFF version 1.2.
Using this format, you can export the content to the industry standard XLIFF format, and then provide the same to the translation vendors. For more details, view Create a translation project.
{width="350"}
Map Collection enhancements
A Map Collection helps you organize multiple maps and batch publish them. Many new enhancements have been made to the Map Collection:
-
Now, you can add Native PDF output presets to a map collection and use them to generate the PDF output.
-
You can view the global and folder profile presets created by your administrator and use them to generate the PDF output.
-
Now, you can not only select an individual preset, but you can also enable all the folder profile presets for a DITA map in one go.
{width="800"}
For more details, view Use Map Collection for output generation.
Native PDF support in Bulk Publish Dashboard
With AEM Guides’ Bulk Activation feature, you can quickly and easily activate your content from authoring to publishing instance. In the Bulk Activation map, you can include the Native PDF output preset, the AEM Site, PDF, HTML5, Custom, and JSON output.
For more details, view Bulk activation of published content.
Improved Bulk Move Tool
Now as an administrator, you can use the improved Bulk Move Tool to move folders with many files from one location to another.
You can use the browse file dialog to select the source folders you want to move. You can also browse to select the destination location to move the source folders. Select
{width="25"} near a field to view more information about it.
For more details, view Move files in bulk.
Improved Favorites panel
AEM Guides helps you create a collection or favorite list of your files and folders and use them easily. Now Options menu is also available in the Favorites panel. You can rename the selected collection or delete it from the Options menu. You can select the Refresh option to get a fresh list of files or folders from the repository. You can also view the folder contents in the Assets UI.
{width="650"}
For more details on the Options menu of a Favorites collection, view the Favorites feature description in the Left Panel section.
Switch to the system theme
You can also now use the device theme. Using the User Preferences, you can configure AEM Guides to automatically switch between light and dark themes based on the theme of your device.
{width="550"}
For more details, view the User Preferences feature description in the Main toolbar section.