Re: Representing variables

[Joe Malin <jmalin -at- jmalin -dot- com>]

Dear Janice,

I had never thought of using regular-font italic. I will have to try
this. I see no harm in it, since it reinforces the idea that the reader
needs to replace the string with an appropriate value.

Can you give me an example of an underscore meaning something in a
command? I never thought of this, either. I do note, though, that
hyphens are not used in either Windows or UN*X commands.

Joe

Janice Gelb wrote:
> Odile Sullivan-Tarazi wrote:
>>
>> A style question . . .
>>
>> When you are documenting variables in code, do you apply italics in
>> addition to the code font, do you instead enclose the word or phrase
>> in angle brackets, or do you do both?
>>
>
> We use regular-font italic (as opposed to monospace
> font italic, which we think is more difficult to read).
> No angle brackets. We also encourage the use of hyphens
> rather than underscores to separate a long variable name
> because underscores often mean something in commands.
>
> -- Janice
>
> ***********************************************************
> Janice Gelb          | The only connection Sun has with
> janice -dot- gelb -at- sun -dot- com  | this message is the return address.
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> WebWorks ePublisher Pro for Word features support for every major Help
> format plus PDF, HTML and more. Flexible, precise, and efficient
> content delivery. Try it today! http://www.webworks.com/techwr-l
>
> Easily create HTML or Microsoft Word content and convert to any
> popular Help file format or printed documentation. Learn more at
> http://www.DocToHelp.com/TechwrlList
>
> ---
> You are currently subscribed to TECHWR-L as jmalin -at- jmalin -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/jmalin%40jmalin.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/techwhirl/ for more resources and info.
>
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help 
format plus PDF, HTML and more. Flexible, precise, and efficient content 
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.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/techwhirl/ for more resources and info.