DOCBOOK: DocBook 4.0: ClassSynopsis

[Norman Walsh <ndw@nwalsh.com>]

Hello World,

At the face-to-face meetings in conjunction with XML'99, the
DocBook Technical Committee decided to add the ClassSynopsis
element to DocBook V4.0, with a few small modifications:

- The "verbish" names have been made "nounish". Exception has
  been renamed ExceptionName, etc. Several of the elements will
  also be made available inline.

- The content models have been adjusted a little to better
  reflect the new names and in response to some feedback.

- A ClassSynopsisInfo element was added

If you have any comments, please send them to the list as soon
as possible.  I expect to package up DocBook V4.0beta1 sometime
next week.

Attached is the new DTD fragment, you will find complete examples
at http://nwalsh.com/docbook/edbsyn/, including some sample
instances and stylesheets which format them.

In real life, the attlists will also include local extension
parameter entities and role attributes.

<!ELEMENT ClassSynopsis - - (Modifier*,
                             (ClassName|InterfaceName|ExceptionName)+,
                             (ClassSynopsisInfo
                              |FieldSynopsis|%method.synop.class;)*)>

<!ATTLIST ClassSynopsis
	%common.attrib;
	Language	CDATA	#IMPLIED
	Class	(Class|Interface)	"Class"
>

<!ELEMENT ClassSynopsisInfo - O (LineAnnotation | %cptr.char.mix;)*>

<!ATTLIST ClassSynopsisInfo
		%linespecific.attrib;
		%common.attrib;
>

<!ELEMENT Modifier - - (%smallcptr.char.mix;)*>

<!ATTLIST Modifier
	%common.attrib;
>

<!ELEMENT InterfaceName - - (%smallcptr.char.mix;)*>

<!ATTLIST InterfaceName
	%common.attrib;
>

<!ELEMENT ExceptionName - - (%smallcptr.char.mix;)*>

<!ATTLIST ExceptionName
	%common.attrib;
>

<!ELEMENT FieldSynopsis - - (Modifier*, Type?, VarName, Initializer?)>

<!ATTLIST FieldSynopsis
	%common.attrib;
>

<!ELEMENT Initializer - - (%smallcptr.char.mix;)*>

<!ATTLIST Initializer
	%common.attrib;
>

<!ELEMENT ConstructorSynopsis - - (Modifier*,
                              MethodName?,
                              (MethodParam+|Void),
                              ExceptionName*)>

<!ATTLIST ConstructorSynopsis
	%common.attrib;
>

<!ELEMENT DestructorSynopsis - - (Modifier*,
                              MethodName?,
                              (MethodParam+|Void),
                              ExceptionName*)>

<!ATTLIST DestructorSynopsis
	%common.attrib;
>

<!ELEMENT MethodSynopsis - - (Modifier*,
                              (Type|Void)?, MethodName,
                              (MethodParam+|Void),
                              ExceptionName*)>

<!ATTLIST MethodSynopsis
	%common.attrib;
>

<!ELEMENT MethodName - - (%smallcptr.char.mix;)*>

<!ATTLIST MethodName
	%common.attrib;
>

<!ELEMENT MethodParam - - (Modifier*,
                           Type?, ((Parameter,Initializer?)|FuncParams))>

<!ATTLIST MethodParam
	%common.attrib;
	Choice		(Opt
			|Req
			|Plain)		"Req"
	Rep		(Norepeat
			|Repeat)	"Norepeat"
>