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: markup for default values


/ Joerg Wittenberger <Joerg.Wittenberger@pobox.com> was heard to say:
| I ran into the question how to mark up default values.
| Those would be required for funcparms, synopsis etc.
| There was a thread recently about markup for python synopsis etc.,
| which would require the same thing.

Can you provide some concrete examples? Often in funcsynopses, the
default is self-evident:

  function foo(arg1, arg2, arg3="bar")

| Is there already some consensus I overlooked how this should be done? 
| Otherwise I'd suggest to extend "tech.char.class" with "DefaultValue".

In my proposal for extended synopses, I do this with a wrapper around
both the value and the default value:

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

                                        Cheers,
                                          norm

-- 
Norman Walsh <ndw@nwalsh.com>      | O for a Muse of fire, that would
http://www.oasis-open.org/docbook/ | ascend / The brightest heaven of
Member, DocBook Editorial Board    | invention, / A kingdom for a
                                   | stage, princes to act / And
                                   | monarchs to behold the swelling
                                   | scene!--William Shakespeare, Henry
                                   | V


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