This is the mail archive of the docbook@lists.oasis-open.org mailing list for the DocBook project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [docbook] Best of practice question


Kenneth Johansson wrote:

> When inserting tables, images do you  a) insert them inside the
> current para or b) after the current para?

If it's part of the paragraph, then I'd do a, if it's not part of it but
instead a semantically more separate entity, then I'd do b.

> I'm currently writing a guide for our writers and wish to have
> everyone inserting elements the same way.

I think they should be free to choose from a and b.

> I'm also curious about the difference of option/parameter/attribute,
>  and why isn't there any argument element. Where I work the
> developers either use option or argument when they are speaking
> about "-S", "-start" or "/s" etc.

http://www.docbook.org/tdg/en/html/option.html
"
<para>
The <option>-a</option> option on the <acronym>UNIX</acronym>
<command>ls</command> command or the <option>/r</option> option on the
<acronym>DOS</acronym> <command>attrib</command>
command, for example.
</para>
"

Tobi

--
http://www.pinkjuice.com/


--------------------------------------------------------------------- To unsubscribe, e-mail: docbook-unsubscribe@lists.oasis-open.org For additional commands, e-mail: docbook-help@lists.oasis-open.org


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]