Table of Contents
Generating Short Alias File Names
When generating documentation for some reference documentation items it is possible to exceed the path and filename length limitation imposed by Windows (260 characters). This is most common for XSD Schemas with very complex hierarchies, or for .NET methods with very large parameter lists. In that situation you can enable the Generate shortened alias filenames setting in the Build Profile Editor. that will automatically generate shorter filenames instead of the default filenames during the build process.
Short alias filename fundamentals
To enable automatic generation of shortened alias filenames for a particular Build Profile
- Open the Build Profile Editor.
- Select the Settings page.
- Select the Generate shortened alias filenames option.
Additional options for how shortened alias filenames are generated can be found on the Shortened Alias Filenames page in the Build Profile Editor.
To change settings for how shortened alias filenames are generated
- Open the Project Settings Editor by clicking the Project Settings button on the Project Ribbon Tab.
- Select the Shortened Alias Filenames page.
- Choose from the available entries on the Shortened Filename Generator list according to how you would like shortened filenames to be generated.
- Enable the Only shorten filenames where the total path and filename exceeds a certain length option if you only want to shorten very long filenames (i.e. to avoid exceeding the Windows path and filename length of 260 characters). If you enable this option and the path and filename for a given item doesn't exceed the limit you specify, it will not be shortened.
- Enable the Save shortened filename mappings option if you want to ensure that the shortened filename is always the same for a given item whenever you build. This option can be useful when publishing public content, so that links to a given page remain valid when you update the content.
If you have previously enabled the Save shortened filename mappings option and wish to discard any previously generated shortened filenames (i.e. after changing one of the settings affecting how the filenames are generated), click the Clear Saved Mappings button.