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: Tags/concept mappings


Along this topic, does anyone have any policy papers or other 
guides mapping specific C constructs to DocBook tags.  I've been 
inventing my own as I go, but it strikes me as something where
there may already be common conventions.

For some examples: Is a #define macro a <function>?  Is a #define'd
value a <constant>? (seems it should be, but it might be a literal)
What is a pre-processor directive?  Is a number or a quoted string a
literal or a contant?  What are asm and volatile?  What is a software
package name? (option, filename or productname?)

I realize for most (if not all) of these the answer may be "Whatever
you think is best", but I am just curious if there is any cultural
convention which has been summarized somewhere. I guess what I want is
the reverse of Appendix G of TDG ;)

-- 
Gary Lawrence Murphy <garym@teledyn.com> TeleDynamics Communications Inc
Business Innovations Through Open Source Systems: http://www.teledyn.com
"Computers are useless.  They can only give you answers."(Pablo Picasso)

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