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]

Re: 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
overkill.

                                        Be seeing you,
                                          norm

-- 
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 |

------------------------------------------------------------------
To unsubscribe from this elist send a message with the single word
"unsubscribe" in the body to: docbook-request@lists.oasis-open.org


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