Re: Expressing SQL in Design Doc

[bcliver -at- manu -dot- com]

>Right. Keep in mind, as my example showed, the question is not whether to
>capitalize KRWs in code but in narrative paragraphs.

>My question was, to SQL developers, how would they _expect_ to see the
>keywords & reserved words (KRWs) expressed in explanatory text? So I went
>to my main research facility for this type of question: Barnes & Noble ;) 

>Anyway, in a few third-party PL/SQL books, they cap all the KRWs...but in
>a SQL book I skimmed, they capitalized only the initial letter of the 
KRW.
>So, I've decided to cap all KRWs in my doc.

The number of reserved words for particular database vendor like Oracle is 
quite small. I think the DB2 list is somewhat longer. Are the KRWs defined 
by your company's schema? If not, I would just refer users to the vendor 
documentation.

Using a unique font/style is a good way to distinguish database objects in 
text.

Barry Cliver
Lead Technical Writer

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!
TRY IT TODAY at http://www.macromedia.com/go/techwrl

WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed! http://www.webworks.com/techwr-l 

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.