MySource Matrix Developer

Main Content

Site Map - Formating for Asset Types

Summary

This document proposes a new option for Site Map asset to specify display formats for different asset types.

Status: Complete
Key: draft -> approved proposal -> scheduled -> in development -> in testing -> complete -> released

Estimated Start Date: Thu, 23 Mar 2006
Estimated End Date: Thu, 23 Mar 2006

Planned Release Version: 3.10.0 RC1

Problem Definition

Currently, Site Map asset lists names of assets and there is no way to change the formating or displaying other asset information in a site map. Adding the ability to use keywords or formats in site map would make site map asset more flexible. It is also a good idea to change the format for each asset type.

Technical Specification

Site Map Details Screen Changes
At the end of the details screen there should be a new settings called "Display Formats". Display Formats will have an asset type selection box and a text box with "more" button so that multiple display formats can be added to the Site Map. When an asset type is selected user will be able to define its display format by using the provided text box. If an asset type's display format is not defined then Site Map will display the asset name. Display Formats may include html tags (i.e. strong) and asset keywords. Example display formats for asset type "file":
- <strong>%asset_attribute_short_name%</strong> (%asset_updated_readabledate%)
- ----> %asset_attribute_name% <-----
Site Map Changes
Page Site Map currently uses the getAssetTree() function to retrieve all the details about the assets under a specified root. Since the asset names are returned by this function there are no other processing required to print the asset names. However, to be able to get keyword replacements for assets, there has be a call to getAsset() function. getAsset() function should be called for those asset types that have a custom display format, other asset types will use the name attribute that was retrieved from getAssetTree(). Adding custom display formats for asset types will increase the site map load time. However, it will make the site map more customisable. This speed impact can easily be minimised by enabling cache.