TODO

   1 ************************************************************************
   2 * missing features
   3 ************************************************************************
   4
   5 - explicit blocks with missing end macro should be implicitely closed
   6   at the end of the enclosing block, e.g. .Bl It (El) Sh
   7   reminded by stsp@  in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200
   8
   9 - fix bad block nesting involving multiple identical explicit blocks
  10   see the OpenBSD mdoc_macro.c 1.47 commit message
  11
  12 - we need real .ds; for example, terminfo.3 has
  13   .ds n 5
  14   and then later
  15   \fBterminfo\fR(\*n)
  16   reported orally by halex@ during c2k10
  17
  18 - \*(Pu is not implemented, but used in mdoc.samples
  19   implementing .ds would solve this as well
  20   reminded by jmc@, last on Sun, 27 Jun 2010 15:29:18 +0100
  21
  22 - .Bl -column .Xo support is missing
  23   ultimate goal:
  24   restore .Xr and .Dv to
  25   lib/libc/compat-43/sigvec.3
  26   lib/libc/gen/signal.3
  27   lib/libc/sys/sigaction.2
  28
  29 - implement \\
  30   in plain text, identical to \e
  31   as a macro argument, identical to \ i.e. escaping the next character
  32   We do not have macro definitions yet; if we implement them,
  33   \\ must behave in a macro def like in a macro argument,
  34   and when using the macro, it must expand yet again.
  35
  36 - look at bsd.lv tbl(1)
  37   from kristaps@  Fri, 11 Sep 2009 17:10:53 +0200
  38   also look at the mail from Thomas Klausner wiz at NetBSD
  39     on Wed, 2 Jun 2010 11:01:29 +0200
  40
  41 - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
  42   These are a weird mixture of man(7) and custom autogenerated low-level
  43   roff stuff.  Figure out to what extent we can cope.
  44   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
  45   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
  46
  47 - implement blank `Bl -column', such as
  48   .Bl -column
  49   .It foo Ta bar
  50   .El
  51
  52 - explicitly disallow nested `Bl -column', which would clobber internal
  53   flags defined for struct mdoc_macro
  54
  55 - set a meaningful default if no `Bl' list type is assigned
  56
  57 - have a blank `It' head for `Bl -tag' not puke
  58
  59 - ignore horrendous m[] font colouring
  60   reported by J.C. Roberts
  61
  62 ************************************************************************
  63 * formatting issues: ugly output
  64 ************************************************************************
  65
  66 - outside list context, text following .Sm off
  67   seems to follow without a blank (TERM_NOBLANK reset late?) e.g.
  68         .Sm off
  69         .Xo
  70         .Op Ar bind_address No /
  71         .Ar port
  72         .Xc
  73         .Sm on
  74         or by enclosing
  75   reported by jmc Tue, 13 Apr 2010 08:48:14 +0100
  76
  77 - indentation got lost in SYNOPSIS, e.g.
  78    SYNOPSIS
  79         date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format]
  80   -          [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
  81   +     [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
  82   reminded by Ludo Smissaert  Mon, 10 May 2010 12:15:11 +0200
  83
  84 - empty phrases in .Bl column produce too few blanks
  85   try e.g. .Bl -column It Ta Ta
  86   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
  87
  88 ************************************************************************
  89 * formatting issues: gratuitious differences
  90 ************************************************************************
  91
  92 - none reported right now (yet schwarze@ knows of some)
  93
  94 ************************************************************************
  95 * performance issues
  96 ************************************************************************
  97
  98 Several areas can be cleaned up to make mandoc even faster.  These are
  99
 100 - improve caching mechanism to handle other per-element arguments so
 101   that they need not be recalculated between front- and back-ends (also
 102   reduces code size and complexity):
 103     `Bl -column' pointer
 104     `Bf' font type
 105
 106 - improve hashing mechanism for macros (quite important: performance)
 107
 108 - improve hashing mechanism for characters (not as important)