summaryrefslogtreecommitdiffstats
path: root/mdoc.3
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2010-07-01 09:33:39 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2010-07-01 09:33:39 +0000
commitcd0478c4c1c8072f32c673df44009c70e8a2c3a3 (patch)
tree811722b257dbbe02e331ec372317e6f42324fd69 /mdoc.3
parent6570684c7ab9349aad77e1d8def55f852b4245a3 (diff)
downloadmandoc-cd0478c4c1c8072f32c673df44009c70e8a2c3a3.tar.gz
"Tweak previous": "badly nested" becomes badly-nested, some typos
corrected, and a bit of clarity for my own sake.
Diffstat (limited to 'mdoc.3')
-rw-r--r--mdoc.341
1 files changed, 24 insertions, 17 deletions
diff --git a/mdoc.3 b/mdoc.3
index 4a9b2e14..3e5cc5a8 100644
--- a/mdoc.3
+++ b/mdoc.3
@@ -257,10 +257,10 @@ an empty line will produce a zero-length string.
Multiple body parts are only found in invocations of
.Sq \&Bl \-column ,
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
+.Ss Badly-nested Blocks
+The ENDBODY node is available to end the formatting associated
+with a given block before the physical end of that block.
+It has a non-null
.Va end
field, is of the BODY
.Va type ,
@@ -297,25 +297,32 @@ BLOCK Ao
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
+Here, the formatting of the
+.Sq \&Ao
+block extends from TEXT ao to TEXT ac,
+while the formatting of the
+.Sq \&Bo
+block extends from TEXT bo to TEXT bc.
+It renders as follows in
.Fl T Ns Cm ascii
mode:
+.Pp
.Dl <ao [bo ac> bc] end
-Support for badly nested blocks is only provided for backward
+.Pp
+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.
+Using badly-nested blocks is
+.Em strongly discouraged :
+the
+.Fl T Ns Cm html
+and
+.Fl T Ns Cm xhtml
+front-ends are unable to render them in any meaningful way.
+Furthermore, behaviour when encountering badly-nested blocks is not
+consistent across troff implementations, especially when using multiple
+levels of badly-nested blocks.
.Sh EXAMPLES
The following example reads lines from stdin and parses them, operating
on the finished parse tree with