Best Practice: MP Display names should not contain underscores

 

What does this best practice check for?

MP elements have associated product knowledge and display strings that end-users use to decide how to address problems that occur in their environment. As a best practice, knowledge articles and display strings should not be written such that all words are separated by underscores instead of spaces.

Why is it important to follow this best practice? What is the impact of not following this best practice?

When words that separated by underscores instead of spaces, localization tools do not recognize this is two separate words. As a result, words connected by underscores will not be localized. This impacts all customers using localized MPs, as they will not be able to use knowledge or displays that show in English.

How do I fix this in my MP?

Using the Authoring Console:

1.        For any MP element, when creating the element, you will be asked to give it a display name. Ensure that in this display name, individual words are separated by spaces.

2.        For any MP element, click on Properties. Click on the Product Knowledge tab, and click Edit… to add knowledge. Ensure that words are separated by spaces if they are intended to be individual words.  

 

Using XML:

       < DisplayString ElementID = " Microsoft.Windows.Server.2008.DiskPartitionContainsLogicalDisk" >

         < Name > Disk Partition Contains Logical Disk </ Name >

         < Description > Windows 2008 Disk Partition Contains Logical Disk </ Description >

       </ DisplayString >