RE: Font choices

Subject: RE: Font choices
From: "Liz Tam" <ltam -at- ariba -dot- com>
To: "Dana Worley" <dana -at- campbellsci -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 1 Dec 2010 21:19:12 -0800

Sorry, I guess I'm letting my Un*x bias show. It drives me nuts when people use angle backets to indicate replaceable parameters in Un*x commands.

However, there is a still a key difference between BNF and the Microsoft conventions: BNF includes double quotes to indicate terminal (literal) characters, which the Microsoft convention does not use.

-----Original Message-----
From: techwr-l-bounces+ltam=ariba -dot- com -at- lists -dot- techwr-l -dot- com on behalf of Dana Worley
Sent: Wed 12/1/2010 2:41 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: RE: Font choices

The Microsoft guidelines are very similar to EBNF syntax, which is supposedly language
agnostic. I was looking for EBNF when I typed my original post, but I was getting the letters
backwards in my search and not finding what I needed so I resorted to the MS guidelines :)

It's my understanding this is commonly known among programmers, and about as close to
an "industry standard" as there is. If you are looking for a font-free convention for presenting
syntax to programmers, it's a valid option.

http://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_Form

On the other than, you can make up your own convention of bold, italic, and font changes,
and as long as you're consistent, they'll probably get it :)

Dana W.

> IMO, the Microsoft style conventions might not be suitable for APIs or other environments where
> the symbols Microsoft uses as delimiters (angle brackets, square brackets, etc.) have literal
> meanings. For example, most programming languages use square brackets to indicate arrays. In
> Un*x shells, angle brackets and pipes (|)direct input and output.

***************************
Dana Worley
Software Product Manager/Manager, Software Support Group
Campbell Scientific, Inc.
Microsoft MVP, Windows Help
www.jestersbaubles.blogspot.com
www.jestersbaubles.com

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

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as ltam -at- ariba -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/ltam%40ariba.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


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

Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days.
http://www.doctohelp.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
RE: Font choices: From: Liz Tam
RE: Font choices: From: Dana Worley

Previous by Author: RE: Font choices
Next by Author: Re: MadCap Flare - footnotes with hyperlinks
Previous by Thread: RE: Font choices
Next by Thread: [techwr-l-daily-announce] TECHWR-L Daily Announcements


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads