Re: writing commands
the following location:
<$PRODUCT_HOME>/tomcat/webapps/images/<USER_ID>
In the above location, <USER_ID> is a variable that represents the user ID
of the logged-in user that uploaded the file.
In my document's overview section, I've already explained that
<$PRODUCT_HOME> is the installation directory of the product. I explain it
once in detail in that location, giving examples for both Windows and Linux
users, and then I just use the <$PRODUCT_HOME> variable every time I want to
refer to the installation directory.
Hope that helps.
-Paul Pehrson
Midvale, UT
On 11/21/06, 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 paulpehrson -at- gmail -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/paulpehrson%40gmail.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.
--
Paul Pehrson
Midvale, UT
www.paulpehrson.com blog.paulpehrson.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.
References:
writing commands: From: Carrie Baker
Previous by Author:
Re: Using Acrobat 7 Processional and Acrobat Reader together
Next by Author:
Re: Quick Start Guide
Previous by Thread:
RE: paragraph numbering
Next by Thread:
RE: writing commands
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads