Re: documenting commands

[Amy Gale <amyg -at- grammatech -dot- com>]

Kimberly McClintock wrote:

>Hey folks....
>
> 
>
>Wonder how you've seen commands so long they need to wrap to the next
>line handled and what you're favorite way to solve this is. I've got a 6
>page doc w/ dozens of commands, only one long enough to be a problem so
>I'd rather not use a pre if I can avoid it 'cause I don't want to do
>that for all the others.
>  
>
(I'm assuming by your mention of "pre" that you are talking about HTML, 
but maybe there is some other pre thing I know nothing about. If so, sorry.)

I have a class "indented":

.indented {
    padding: 0px;
    margin-left: 2em;
    text-align: left;
}

so I can mark up a command as (something) like:

    <p class="command">command arg1 arg2 arg 3<br>
    <span class="indented">arg4  [optional_arg5]</span>
    </p>

I originally experimented with having the "command" class do the 
indenting itself through a combination of margin-left and text-indent, 
but it wasn't consistently rendered by all browsers.

Amy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual: 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.