[BACK]Return to mdoc.3 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/mdoc.3 between version 1.44 and 1.45

version 1.44, 2010/06/27 16:18:13 version 1.45, 2010/06/29 19:20:38
Line 217  and
Line 217  and
 fields), its position in the tree (the  fields), its position in the tree (the
 .Va parent ,  .Va parent ,
 .Va child ,  .Va child ,
   .Va nchild ,
 .Va next  .Va next
 and  and
 .Va prev  .Va prev
 fields) and some type-specific data.  fields) and some type-specific data, in particular, for nodes generated
   from macros, the generating macro in the
   .Va tok
   field.
 .Pp  .Pp
 The tree itself is arranged according to the following normal form,  The tree itself is arranged according to the following normal form,
 where capitalised non-terminals represent nodes.  where capitalised non-terminals represent nodes.
Line 235  where capitalised non-terminals represent nodes.
Line 239  where capitalised non-terminals represent nodes.
 .It ELEMENT  .It ELEMENT
 \(<- TEXT*  \(<- TEXT*
 .It HEAD  .It HEAD
 \(<- mnode+  \(<- mnode*
 .It BODY  .It BODY
 \(<- mnode+  \(<- mnode* [ENDBODY mnode*]
 .It TAIL  .It TAIL
 \(<- mnode+  \(<- mnode*
 .It TEXT  .It TEXT
 \(<- [[:printable:],0x1e]*  \(<- [[:printable:],0x1e]*
 .El  .El
Line 253  an empty line will produce a zero-length string.
Line 257  an empty line will produce a zero-length string.
 Multiple body parts are only found in invocations of  Multiple body parts are only found in invocations of
 .Sq \&Bl \-column ,  .Sq \&Bl \-column ,
 where a new body introduces a new phrase.  where a new body introduces a new phrase.
   .Ss Badly nested blocks
   A special kind of node is available to end the formatting
   associated with a given block before the physical end of that block.
   Such an ENDBODY node has a non-null
   .Va end
   field, is of the BODY
   .Va type ,
   has the same
   .Va tok
   as the BLOCK it is ending, and has a
   .Va pending
   field pointing to that BLOCK's BODY node.
   It is an indirect child of that BODY node
   and has no children of its own.
   .Pp
   An ENDBODY node is generated when a block ends while one of its child
   blocks is still open, like in the following example:
   .Bd -literal -offset indent
   \&.Ao ao
   \&.Bo bo ac
   \&.Ac bc
   \&.Bc end
   .Ed
   .Pp
   This example results in the following block structure:
   .Bd -literal -offset indent
   BLOCK Ao
           HEAD Ao
           BODY Ao
                   TEXT ao
                   BLOCK Bo, pending -> Ao
                           HEAD Bo
                           BODY Bo
                                   TEXT bo
                                   TEXT ac
                                   ENDBODY Ao, pending -> Ao
                                   TEXT bc
   TEXT end
   .Ed
   .Pp
   Here, the formatting of the Ao block extends from TEXT ao to TEXT ac,
   while the formatting of the Bo block extends from TEXT bo to TEXT bc,
   rendering like this in
   .Fl T Ns Cm ascii
   mode:
   .Dl <ao [bo ac> bc] end
   Support for badly nested blocks is only provided for backward
   compatibility with some older
   .Xr mdoc 7
   implementations.
   Using them in new code is stronly discouraged:
   Some frontends, in particular
   .Fl T Ns Cm html ,
   are unable to render them in any meaningful way,
   many other
   .Xr mdoc 7
   implementations do not support them, and even for those that do,
   the behaviour is not well-defined, in particular when using multiple
   levels of badly nested blocks.
 .Sh EXAMPLES  .Sh EXAMPLES
 The following example reads lines from stdin and parses them, operating  The following example reads lines from stdin and parses them, operating
 on the finished parse tree with  on the finished parse tree with
Legend:
Removed from v.1.44  
changed lines
  Added in v.1.45
CVSweb