RE: Needed: a convention to indicate a path for Windows, Linux, and Mac

Subject: RE: Needed: a convention to indicate a path for Windows, Linux, and Mac
From: "Lauren" <lauren -at- writeco -dot- net>
To: "'Leonard C. Porrello'" <Leonard -dot- Porrello -at- SoleraTec -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 5 Mar 2008 11:47:54 -0800

I try to use something that it is intuitive, like a common name for the
location, placed inside angle brackets or whatever convention of offset that
I can use that will not be confused with a literal string. So for "the
user's home directory," I might use:

<home directory>/Product_Name/Folder/File.cfg

In your case, that can be "<install location>."

Lauren

> -----Original Message-----
> From: techwr-l-bounces+lauren=writeco -dot- net -at- lists -dot- techwr-l -dot- com
> [mailto:techwr-l-bounces+lauren=writeco -dot- net -at- lists -dot- techwr-l -dot- com
> ] On Behalf Of Leonard C. Porrello
> Sent: Tuesday, March 04, 2008 8:10 AM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Needed: a convention to indicate a path for Windows,
> Linux, and Mac
>
> The applications I am documenting runs on Windows, Linux, and Mac. In
> several places, I need to indicate to users that the files
> they need are
> located at the application installation location on the hard drive. In
> Windows, this is "c:/Program files/Product_Name/Folder/File.cfg". In
> Linux, the path is different, starting from the fact that there is no
> "c:".
>
> I need a convention to indicate path prior to
> "/Product_Name/Folder/File.cfg". The convention needs to work for
> Windows, Linux, and Mac.
>
> I currently have ellipses (".../Product_Name/Folder"), but my
> development lead tells me that this won't do as ellipses are sometimes
> used literally. Does anyone have any other ideas?
>
> Thanks!
>
> Leonard C. Porrello
> SoleraTec LLC
> www.soleratec.com
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Create HTML or Microsoft Word content and convert to Help
> file formats or
> printed documentation. Features include support for Windows
> Vista & 2007
> Microsoft Office, team authoring, plus more.
> http://www.DocToHelp.com/TechwrlList
>
> True single source, conditional content, PDF export, modular help.
> Help & Manual is the most powerful authoring tool for technical
> documentation. Boost your productivity! http://www.helpandmanual.com
>
> ---
> You are currently subscribed to TECHWR-L as lauren -at- writeco -dot- net -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/lauren%40wr
> iteco.net
>
>
> 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.
>

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

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.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.


References:
Needed: a convention to indicate a path for Windows, Linux, and Mac: From: Leonard C. Porrello

Previous by Author: RE: Dream Tech Writing Job
Next by Author: RE: What do you do when there's nothing to do?
Previous by Thread: RE: Needed: a convention to indicate a path for Windows, Linux, and Mac
Next by Thread: RE: Needed: a convention to indicate a path for Windows, Linux, and Mac


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


Sponsored Ads