RE: Fine-grained markup in stylised function name

[<rob.cavicchio@emc.com>]

Stefan Seefeld [mailto:stefan@seefeld.name] wrote:

> I'm trying to transcribe an C API specification into DocBook 5. The API
> specification describes a class of functions like "create_f",
> "create_d", "create_i", using a typographical convention that uses
> specially marked-up characters within a function name that act as
> placeholders. Thus, instead of having to explicitly list all the
> variant, a single name is used representing all of them.
> 
> I would like to map this to DocBook, but have quite some difficulties.
> There doesn't appear to be any DB element that is suitable to mark up
> characters in a name, without severely restricting where such names may
> appear. (Specifically, in my case these names need to appear in
> <title>,
> <functionname>, et al.


Unless I'm misunderstanding, this is the purpose of the <replaceable> element.


*************************
Rob Cavicchio
rob.cavicchio@emc.com

Principal Technical Writer & Information Architect
Information Intelligence Group
EMC Corporation

The opinions expressed here are my personal opinions. Content published here is not read or approved in advance by EMC and does not necessarily reflect the views and opinions of EMC.