Markup in descriptions

Documents SQL Server 2005 and 2008 databases.

Moderators: JonathanWatts, David Atkinson, Michelle Taylor

Markup in descriptions

Postby alex.weatherall » Thu Jan 08, 2009 3:42 pm

Is it (or could it be) possible to allow HTML markup in the description. I wish to add emphasis tags to important notes in my documentation.

e.g. "This is <b>important</b>" would appear as : "This is important" in the documentation.

This feature would be very useful.

Thanks,

Alex
alex.weatherall
 
Posts: 42
Joined: Tue Nov 29, 2005 1:32 pm

Postby David Lovemore » Fri Jan 09, 2009 11:33 am

Alex,

This is not the first time this has been requested.

Would you want this on the MS_Description property, though?

My inclination is to use HTML_Description, or BBCode_Description, or RTF_Description and then put a plain text description on MS_Description. So in your database you would have two properties automatically set by SQL Doc:

HTML_Description property is "This is <b>important</b>"
MS_Description property is "This is important"

This is not unlike how formatted emails work.

This would avoid breaking compatibility with other tools which read this and already existing descriptions that say e.g. "This constraint checks 0<b and 10>b".

Would that make sense for you? Or would that annoy you?
David Lovemore
Red Gate Software
David Lovemore
 
Posts: 8
Joined: Tue Dec 18, 2007 5:22 pm

Postby alex.weatherall » Fri Jan 09, 2009 1:06 pm

Hi David,

I don't mind if different extended properties are stored in the database so long as it's seamless in the GUI. i.e. I wouldn't want to manually maintain both copies - I'd expect to edit my description in HTML mode and it maintain a plain text version in MS_Description and the HTML version in HTML_Description.

This brings me to another question that may have been asked before. Are you planning on supporting editing bespoke extended properties?

Thanks,

Alex
alex.weatherall
 
Posts: 42
Joined: Tue Nov 29, 2005 1:32 pm


Return to SQL Doc 2

Who is online

Users browsing this forum: No registered users and 0 guests