headers
Ingo Schwarze | 24 Feb 2010 11:05
Picon
Favicon

patch: improve mdoc(7) syntax in arlad.8

Dear colleagues,

the SYNOPSIS of the arlad(8) manual page uses overlapping blocks,
i.e. the sequence .Oo Xo Oc Xc.  This is a conceptual problem because
the blocks do not nest, it is not clear which block is the inner and
which is the outer one.  For example, such constructs cannot be rendered
into languages like SGML or XML, and some formatters error out, e.g.
mandoc(1), see http://mdocml.bsd.lv/.

The arlad(8) manual can be fixed nicely with the patch included below.
This is based on a patch by Jason McIntyre committed to the OpenBSD
tree, and i have tweaked it such that it applies to your current
rev. 1.22 of the file.

Note that, while here, we propose to use the \*(Ba escape sequence
to represent the vertical bar at all places for consistency -
it is already used at some places.

I checked that the patch
 - does not change rendering with groff-1.15
 - does not change rendering with groff-1.20.1
 - allows proper rendering with mandoc-1.9.15

Yours,
  Ingo

--- arlad.8.orig	Wed Feb 24 10:32:59 2010
+++ arlad.8	Wed Feb 24 10:38:49 2010
 <at>  <at>  -41,31 +41,31  <at>  <at> 
 .Sh SYNOPSIS
(Continue reading)

Permalink | Reply | 1 comment |
headers
Tomas Olsson | 27 Feb 2010 07:42
Picon
Picon
Favicon

RE: patch: improve mdoc(7) syntax in arlad.8

Ingo Schwarze wrote:
> The arlad(8) manual can be fixed nicely with the patch included below.
>
Thanks, I'll apply it.

/t
Permalink | Reply | 0 comments |

Gmane