[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: RE: [docbook-apps] Re: Describing module interfaces
This probably will not completely meet your need, but I can tell you what we do. We publish technical manuals on industrial robots. For fancier GUI things, it is hard to beat a <graphic>. For other things, we either use <screen> or <programlisting>. We are using axDocBook from ArborText Epic, but I am pretty sure that they are in DocBook. I have also heard of something called a <screenshot>, but I don't know very much about its usage. Hope that helps. -----Original Message----- From: news [mailto:news@sea.gmane.org]On Behalf Of Steinar Bang Sent: Friday, March 10, 2006 6:42 AM To: docbook-apps@lists.oasis-open.org Subject: [docbook-apps] Re: Describing module interfaces >>>>> Steinar Bang <sb@dod.no>: > I need to describe and enumerate, and classify all interfaces of some > software modules in a big software system. Is there any good markup > for that? <interface> isn't it. Neither is <interfacename> (the > object oriented stuff could _possibly_ be used when detailing some > parts of some interfaces that are APIs in object oriented languages. > But it's no good for the high level approach). > So far I've just used <section>. That is "just used <section> and free form text. One <section> for each interface I'm describing". But I would prefer real semantic markup of these interfaces. By "interface" I mean something like eg.: - A command line interface - A GUI - An API - A protocol - A temporary file Ie. everything a particular software module use to exchange information with other modules or a user. --------------------------------------------------------------------- To unsubscribe, e-mail: docbook-apps-unsubscribe@lists.oasis-open.org For additional commands, e-mail: docbook-apps-help@lists.oasis-open.org
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]