Formatting XML and other computer code

[Inbar, Paul]

Hi Carol,

Here is what I do, although I don't claim it is the best.

- I have defined a paragraph style that is single spaced and which uses a mono-space font. It has NO tab stops.

- When I have a code sample, I first paste it into a text editor called UltraEdit-32, change all the tabs to spaces (UltraEdit has a command for doing all at once. You can set how many spaces each tab should become). I do this because when I convert to HTML, I find that tabs are problematic, and that I don't have control over the length of the tab settings in someone's browser. As a result, if my code sample has tabs, it is possible that it will look like sh...well, hell in a browser.

- While in UltraEdit, I also search for "smart" items such as smart quotes that might have crept in. This might happen, say, when a developer copies and pastes some code into a Word document, which you then get as the source material. It is important to get the "smart" stuff out if it isn't meant to be there, because you have to allow for the possibility that a user of your document might want to cut and paste your example into a program and run it. 

- After this, I paste sample into Frame and apply the paragraph format.

Sounds a bit complicated but goes pretty fast once you get used to it.

I too am interested to hear what others do.

Paul

  

-----Original Message-----
From: framers-bounces at lists.frameusers.com [mailto:framers-bounces at lists.frameusers.com] On Behalf Of Carol Wade
Sent: Wednesday, November 14, 2007 11:24 PM
To: framers at frameusers.com
Subject: Formatting XML and other computer code


I'm wondering how other FrameMaker users handle formatting XML and other computer code samples in text. I have tried a couple of approaches and am not satisfied with either. 
 
One approach I've taken is to create a paragraph tag that contains regularly spaced tabs. This requires that I reformat the code when imported into Frame, which can be labor-intensive.
 
The other approach I've taken is to take screen shots of the code. Yuck! (for obvious reasons).
 
I hope I'm missing something here.
 
Thanks for your advice!
 
- Carol
_________________________________________________________________
Climb to the top of the charts!  Play Star Shuffle:  the word scramble challenge with star power.
http://club.live.com/star_shuffle.aspx?icid=starshuffle_wlmailtextlink_oct
_______________________________________________


You are currently subscribed to Framers as paul.inbar at intel.com.

Send list messages to framers at lists.frameusers.com.

To unsubscribe send a blank email to 
framers-unsubscribe at lists.frameusers.com
or visit http://lists.frameusers.com/mailman/options/framers/paul.inbar%40intel.com

Send administrative questions to listadmin at frameusers.com. Visit
http://www.frameusers.com/ for more resources and info.
---------------------------------------------------------------------
Intel Israel (74) Limited

This e-mail and any attachments may contain confidential material for
the sole use of the intended recipient(s). Any review or distribution
by others is strictly prohibited. If you are not the intended
recipient, please contact the sender and delete all copies.