OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]

Subject: Re: DOCBOOK: How to markup a port number?

/ Mike Broschinsky <mbroschi@das.state.ut.us> was heard to say:
| 1) Is something like this appropriate for marking up a port number:
| <para> The PORT parameter in the Oracle connection information should point to port <systemitem class="resource">1521</systemitem></para>.

I think you should file an RFE at http://sourceforge.net/projects/docbook/
suggesting a new 'portnumber' class.

| 2) Is this overkill, or could there be a good reason for this, a "best practices for technical documentation" reason?

That's a much more subjective question. If port numbers are important
in your docs (e.g., if you can imagine users wanting to search for
them), then it makes sense to mark them up. Otherwise, it may be

                                        Be seeing you,

Norman Walsh <ndw@nwalsh.com>      | To create a little flower is the
http://www.oasis-open.org/docbook/ | labour of ages.--Blake
Chair, DocBook Technical Committee |

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]

Powered by eList eXpress LLC