OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]


Subject: DOCBOOK: Re: methodsynopsisinfo tag?


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

/ Alex Russell <alex@netwindows.org> was heard to say:
[...]
| For those not inclined to follow the link, here's a short excerpt:
|
| <!-- assume classsynopsis tag opened above and and oclass and 
| classsynopsisinfo info tags provided... -->
|
| 	<methodsynopsis>
| 		<type>boolean</type>
| 		<methodname>addDeps</methodname>
|  		<methodparam>string <parameter>path</parameter></methodparam>
| 	</methodsynopsis>
|
| 	<!-- this is the section I'd like in a methodsynopsisinfo tag -->
| 	<para>
| 		<methodname>__scripts__.addDeps()</methodname> is identical 
| 		to <methodname>__scripts__.require()</methodname>.
| 	</para>

Have you considered simply moving the methodsynopsis out of the classsynopsis,
at least for the purposes of larger description?

<section><title>addDeps</title>

	<methodsynopsis>
		<type>boolean</type>
		<methodname>addDeps</methodname>
 		<methodparam>string <parameter>path</parameter></methodparam>
	</methodsynopsis>

	<!-- this is the section I'd like in a methodsynopsisinfo tag -->
	<para>
		<methodname>__scripts__.addDeps()</methodname> is identical 
		to <methodname>__scripts__.require()</methodname>.
	</para>
</section>

You could even make the methodsynopsis a link back to some
classsynopsis overview at the top of the document, with a little
effort.

| Thanks for any guidance you can provide.

That's my first thought, anyway :-)

                                        Be seeing you,
                                          norm

- -- 
Norman Walsh <ndw@nwalsh.com>      | The skill of writing is to create
http://www.oasis-open.org/docbook/ | a context in which other people
Chair, DocBook Technical Committee | can think.--Edwin Schlossberg
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (GNU/Linux)
Comment: Processed by Mailcrypt 3.5.7 <http://mailcrypt.sourceforge.net/>

iD8DBQE+UYEvOyltUcwYWjsRAg3lAJ9qNRWXQA5H8VUJ9s8+rINtz/bELgCfVgOt
x2Yzyrxu9O8GTgPoqRGi7BE=
=BQSm
-----END PGP SIGNATURE-----


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]


Powered by eList eXpress LLC