Re: writing commands

[Lori Olcott <lori_olcott -at- yahoo -dot- com>]

I use brackets to show a limited choice or option for a user.  I like to
use italics for elements that are less restricted than a choice option
(like serial numbers or field values), but some style guides or venues
don't allow for that.  More brackets or a different style of bracers would
also serve well.

e.g.

>  init [basic/pro/delux] {serial_number}

     basic, pro, or delux is the unit type
     serial_number is the number found on the back of the unit

Hope that helps fuel some ideas.

Lori

--- Carrie Baker <carriebak -at- gmail -dot- com> wrote:

> The documentaion I am writing includes commands
> 
> The user has  to type commands and fill in paramters which change
> according to their local settings
> 
> e.g.
> "command x unit_type serial_numeber"
> when unit type is the type  of unit, either x, y or z and the serial
> number is the number stuck on the back of your unnit
> 
> What is the best way of writing the syntax here, where do I explain
> what should go in each of the fields in the command?
> 
> 
> -- 
> Carrie Baker
> carriebak -at- gmail -dot- com
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> 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 Lori_Olcott -at- yahoo -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/lori_olcott%40yahoo.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.
> 
> 



 
____________________________________________________________________________________
Do you Yahoo!?
Everyone is raving about the all-new Yahoo! Mail beta.
http://new.mail.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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.