Red Gate forums :: View topic - Markup in descriptions
Return to www.red-gate.com RSS Feed Available

Search  | Usergroups |  Profile |  Messages |  Log in  Register 
Go to product documentation
SQL Doc 2
SQL Doc 2 forum

Markup in descriptions

Search in SQL Doc 2 forum
This forum is locked: you cannot post, reply to, or edit topics.   This topic is locked: you cannot edit posts or make replies.
Jump to:  
Author Message
alex.weatherall



Joined: 29 Nov 2005
Posts: 42

PostPosted: Thu Jan 08, 2009 3:42 pm    Post subject: Markup in descriptions Reply with quote

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
Back to top
View user's profile Send private message
David Lovemore



Joined: 18 Dec 2007
Posts: 31

PostPosted: Fri Jan 09, 2009 11:33 am    Post subject: Reply with quote

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
Back to top
View user's profile Send private message
alex.weatherall



Joined: 29 Nov 2005
Posts: 42

PostPosted: Fri Jan 09, 2009 1:06 pm    Post subject: Reply with quote

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
Back to top
View user's profile Send private message
Display posts from previous:   
This topic is locked: you cannot edit posts or make replies. All times are GMT + 1 Hour
Page 1 of 1

 
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum


Powered by phpBB © 2001, 2005 phpBB Group