Depicting Spaces

Subject: Depicting Spaces
From: "John J. Gardiner" <john -at- johngardiner -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Fri, 26 Oct 2001 11:09:14 -0700

I am developing docs that include examples of code. These code snippets include very important spaces among other characters. The number of successive spaces is important too. My client has asked that I find a means to indicate that a specific number spaces exist in the code via some sort of symbol, such as an underscore. So an example of code would look like this in the doc:

codecode_code__code___

Obviously, users would need to know that the underscore is not used in the code, but simply represents a space. Does anyone have any suggestions of how to handle this effectively in docs?

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
John J. Gardiner
Design and Documentation
www.johngardiner.com

Web Design * Documentation * Online Help
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day. For details and online registration, visit http://ieeepcs.org/2001

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.


Follow-Ups:

Previous by Author: RE: Most Impt. Skill to Learn in Tech Comm Program?
Next by Author: Answer: multiple user roles?, and Question: documenting classes
Previous by Thread: Re: Documenting Software in a SDLC
Next by Thread: Re: Depicting Spaces


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


Sponsored Ads