************************************************************************
* Official mandoc TODO.
-* $Id: TODO,v 1.39 2010/08/15 17:38:41 schwarze Exp $
+* $Id: TODO,v 1.52 2010/09/25 16:52:15 kristaps Exp $
************************************************************************
************************************************************************
- explicitly disallow nested `Bl -column', which would clobber internal
flags defined for struct mdoc_macro
+- inside `.Bl -column' phrases, punctuation is handled like normal
+ text, e.g. `.Bl -column .It Fl x . Ta ...' should give "-x -."
+
+- inside `.Bl -column' phrases, TERMP_IGNDELIM handling by `Pf'
+ is not safe, e.g. `.Bl -column .It Pf a b .' gives "ab."
+ but should give "ab ."
+
- set a meaningful default if no `Bl' list type is assigned
- have a blank `It' head for `Bl -tag' not puke
- allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments
noted by Alex Kozlov 08/06/10 23:05
-
+
************************************************************************
* formatting issues: ugly output
************************************************************************
try e.g. .Bl -column It Ta Ta
reported by millert Fri, 02 Apr 2010 16:13:46 -0400
-- %A doesn't put an "and" before the final author name.
+- in enclosures, mandoc sometimes fancies a bogus end of sentence
+ reminded by jmc@ Thu, 23 Sep 2010 18:13:39 +0059
************************************************************************
* formatting issues: gratuitious differences
Opening punctuation should not fall out of .Ns.
see for example OpenBSD csh(1)
-- .%A should append the last author with " and " (if there are two)
- or ", and " (if there are more), not ", "
- see for example OpenBSD csh(1)
-
- In .Bl -bullet, the groff bullet is "+\b+\bo\bo", the mandoc bullet
is just "o\bo".
see for example OpenBSD ksh(1)
on the next line, it must be indented by -width, not width+1;
see "rule block|pass" in OpenBSD ifconfig(8).
-- When .%T is used outside an .Rs context and with a trailing comma,
- there is no point in rendering two commata,
- see the first paragraph of the DESCRIPTION in OpenBSD mount_nfs(8).
-
-- When .%T is used outside an .Rs context and without a trailing comma,
- no comma should be rendered at all,
- see the first paragraph of the DESCRIPTION in OpenBSD exports(5).
-
- Bogus .Pp before .Bl should not cause a double blank line,
see "The route utility provides the following simple commands:"
in OpenBSD route(8).
* structural issues
************************************************************************
-- rendering frontend code can calculate widths only for plain strings,
- not for strings containing escape sequences. For example, this
- hinders calculation of the indent required for .Nm \&[ in text(1).
- comments from kristaps@ Wed, 21 Jul 2010 23:26:08 +0200
-
-- another example of the same problem:
- .Bl -tag -width "\eD{format}XX" -compact
- in OpenBSD ksh(1) gives the wrong width
- because "\e" is one character in groff, two in mandoc
-
+- remove superfluous NOSPACE invocations (e.g., with term_word(p, "("))