=================================================================== RCS file: /cvs/mandoc/TODO,v retrieving revision 1.20 retrieving revision 1.37 diff -u -p -r1.20 -r1.37 --- mandoc/TODO 2010/07/02 10:43:21 1.20 +++ mandoc/TODO 2010/08/14 09:48:56 1.37 @@ -1,4 +1,9 @@ ************************************************************************ +* Official mandoc TODO. +* $Id: TODO,v 1.37 2010/08/14 09:48:56 kristaps Exp $ +************************************************************************ + +************************************************************************ * missing features ************************************************************************ @@ -9,16 +14,6 @@ - fix bad block nesting involving multiple identical explicit blocks see the OpenBSD mdoc_macro.c 1.47 commit message -- we need real .ds; for example, terminfo.3 has - .ds n 5 - and then later - \fBterminfo\fR(\*n) - reported orally by halex@ during c2k10 - -- \*(Pu is not implemented, but used in mdoc.samples - implementing .ds would solve this as well - reminded by jmc@, last on Sun, 27 Jun 2010 15:29:18 +0100 - - .Bl -column .Xo support is missing ultimate goal: restore .Xr and .Dv to @@ -26,6 +21,14 @@ lib/libc/gen/signal.3 lib/libc/sys/sigaction.2 +- edge case: decide how to deal with blk_full bad nesting, e.g. + .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1) + from jmc@ Wed, 14 Jul 2010 18:10:32 +0100 + +- auto-Bk in the SYNOPSIS + patch from kristaps@ Fri, 16 Jul 2010 14:51:24 +0200 + to be revisited after OpenBSD 4.8 tree unlock + - implement \\ in plain text, identical to \e as a macro argument, identical to \ i.e. escaping the next character @@ -37,6 +40,7 @@ from kristaps@ Fri, 11 Sep 2009 17:10:53 +0200 also look at the mail from Thomas Klausner wiz at NetBSD on Wed, 2 Jun 2010 11:01:29 +0200 + joerg@ has patches for this somewhere... - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1) These are a weird mixture of man(7) and custom autogenerated low-level @@ -56,39 +60,26 @@ - have a blank `It' head for `Bl -tag' not puke -- ignore horrendous m[] font colouring - reported by J.C. Roberts - - prohibit `Nm' from having non-text HEAD children (e.g., NetBSD mDNSShared/dns-sd.1) (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified) + +- allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments + noted by Alex Kozlov 08/06/10 23:05 ************************************************************************ * formatting issues: ugly output ************************************************************************ -- outside list context, text following .Sm off - seems to follow without a blank (TERM_NOBLANK reset late?) e.g. - .Sm off - .Xo - .Op Ar bind_address No / - .Ar port - .Xc - .Sm on - or by enclosing - reported by jmc Tue, 13 Apr 2010 08:48:14 +0100 +- perl(1) SYNOPSIS looks bad; reported by deraadt@ + 1) man(7) seems to need SYNOPSIS .Nm blocks, too -- indentation got lost in SYNOPSIS, e.g. - SYNOPSIS - date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format] - - [[[[[[cc]yy]mm]dd]HH]MM[.SS]] - + [[[[[[cc]yy]mm]dd]HH]MM[.SS]] - reminded by Ludo Smissaert Mon, 10 May 2010 12:15:11 +0200 - - empty phrases in .Bl column produce too few blanks 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. + ************************************************************************ * formatting issues: gratuitious differences ************************************************************************ @@ -101,12 +92,17 @@ Several areas can be cleaned up to make mandoc even faster. These are -- improve caching mechanism to handle other per-element arguments so - that they need not be recalculated between front- and back-ends (also - reduces code size and complexity): - `Bl -column' pointer - `Bf' font type - - improve hashing mechanism for macros (quite important: performance) - improve hashing mechanism for characters (not as important) + +- the PDF file is HUGE: this can be reduced by using relative offsets + +************************************************************************ +* 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