Encoded URL on generation of AEM site output in Adobe Experience Manager Guides

Disclaimer:

Adobe Experience Manager Guides was formerly branded as XML Documentation for Adobe Experience Manager. Please note certain references within the documentation may still refer to prior branding but are still applicable to the current offering.

 Troubleshoot the issue of encoded URLs while generating AEM Site output.

Issue

While generating AEM site output, URL gets encoded leading to unexpected results.  

Cause

Earlier, while creating DITA topics in XML documentation solution, users were allowed to use descriptive file names containing special characters such as @, $, >, and so on. This led to URLs getting encoded while generating to AEM site output. 

Solution

How is this issue now handled? 

To avoid this conversion in URL, the 3.8 release of  XML documentation solution allows you to define a list of special characters other than the default valid filename configurations (a-z  A-Z  0-9 - _). 

This implies that, although you can configure a list of special characters in a file name including a space, it will get replaced with a hyphen (-). 

For example, files named Introduction 1 and  Introduction@1 will generate the corresponding file as Introduction-1 in both the cases.  

Resolution

Upgrade your build to the 3.8 release of  XML documentation solution.

It is strongly recommended to configure valid special characters immediately after the upgrade.

How to configure valid special characters in file names?