RE: [docbook] Marking up optional parameters?

[Jeff Beal <jeff dot beal at ansys dot com>]

I would use the <optional/> element in a <parameter/>:
 
<paramdef><parameter><optional>argument_name</optional></parameter></paramde
f>

You may also want to consider <cmdsynopsis/> to see if it will be better
able to document Perl methods.  <cmdsynopsis/> is typically used for UNIX
shell commands, but I don't see anything in TDG that in any way forbids its
use for other "software commands".  The above would just be

 <arg choice="opt">argument_name</arg> 

if you were in a <cmdsynopsis/>

> -----Original Message-----
> From: pvh@wfeet.za.net [mailto:pvh@wfeet.za.net]
> Sent: Friday, June 27, 2003 4:03 AM
> To: docbook@lists.oasis-open.org
> Subject: [docbook] Marking up optional parameters?
> 
> 
> Hi DocBook users
> 
> I'm marking up some reference pages for perl modules. I'm 
> describing each 
> method of the module using <funcsynopsis>, and then each parameter of 
> each method using <paramdef>. Is there a recognised way of 
> noting that 
> some parameters are optional (in perl, you don't have 
> function prototypes as 
> such, so the typical get/set method is a get method when you 
> don't give it 
> an argument, and a set method when you do)?
> 
> Peter
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: docbook-unsubscribe@lists.oasis-open.org
> For additional commands, e-mail: docbook-help@lists.oasis-open.org
> 
> 
> 

---------------------------------------------------------------------
To unsubscribe, e-mail: docbook-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: docbook-help@lists.oasis-open.org