TODO

   1 ************************************************************************
   2 * Official mandoc TODO.  May not be quite up to date.
   3 * $Id: TODO,v 1.36 2010/08/07 17:52:36 kristaps Exp $
   4 ************************************************************************
   5
   6 ************************************************************************
   7 * missing features
   8 ************************************************************************
   9
  10 - explicit blocks with missing end macro should be implicitely closed
  11   at the end of the enclosing block, e.g. .Bl It (El) Sh
  12   reminded by stsp@  in net/pptp pptp.8  Fri, 23 Apr 2010 20:32:39 +0200
  13
  14 - fix bad block nesting involving multiple identical explicit blocks
  15   see the OpenBSD mdoc_macro.c 1.47 commit message
  16
  17 - .Bl -column .Xo support is missing
  18   ultimate goal:
  19   restore .Xr and .Dv to
  20   lib/libc/compat-43/sigvec.3
  21   lib/libc/gen/signal.3
  22   lib/libc/sys/sigaction.2
  23
  24 - edge case: decide how to deal with blk_full bad nesting, e.g.
  25   .Sh .Nm .Bk .Nm .Ek .Sh found by jmc@ in ssh-keygen(1)
  26   from jmc@  Wed, 14 Jul 2010 18:10:32 +0100
  27
  28 - auto-Bk in the SYNOPSIS
  29   patch from kristaps@  Fri, 16 Jul 2010 14:51:24 +0200
  30   to be revisited after OpenBSD 4.8 tree unlock
  31
  32 - implement \\
  33   in plain text, identical to \e
  34   as a macro argument, identical to \ i.e. escaping the next character
  35   We do not have macro definitions yet; if we implement them,
  36   \\ must behave in a macro def like in a macro argument,
  37   and when using the macro, it must expand yet again.
  38
  39 - look at bsd.lv tbl(1)
  40   from kristaps@  Fri, 11 Sep 2009 17:10:53 +0200
  41   also look at the mail from Thomas Klausner wiz at NetBSD
  42     on Wed, 2 Jun 2010 11:01:29 +0200
  43   joerg@ has patches for this somewhere...
  44
  45 - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
  46   These are a weird mixture of man(7) and custom autogenerated low-level
  47   roff stuff.  Figure out to what extent we can cope.
  48   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
  49   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
  50
  51 - implement blank `Bl -column', such as
  52   .Bl -column
  53   .It foo Ta bar
  54   .El
  55
  56 - explicitly disallow nested `Bl -column', which would clobber internal
  57   flags defined for struct mdoc_macro
  58
  59 - set a meaningful default if no `Bl' list type is assigned
  60
  61 - have a blank `It' head for `Bl -tag' not puke
  62
  63 - prohibit `Nm' from having non-text HEAD children
  64   (e.g., NetBSD mDNSShared/dns-sd.1)
  65   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
  66
  67 - allow `Qq', `Dq', `Sq', `Aq', `Bq' to have 0 arguments
  68   noted by Alex Kozlov 08/06/10 23:05
  69
  70 ************************************************************************
  71 * formatting issues: ugly output
  72 ************************************************************************
  73
  74 - perl(1) SYNOPSIS looks bad; reported by deraadt@
  75   1) man(7) seems to need SYNOPSIS .Nm blocks, too
  76
  77 - empty phrases in .Bl column produce too few blanks
  78   try e.g. .Bl -column It Ta Ta
  79   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
  80
  81 - %A doesn't put an "and" before the final author name.
  82
  83 ************************************************************************
  84 * formatting issues: gratuitious differences
  85 ************************************************************************
  86
  87 - none reported right now (yet schwarze@ knows of some)
  88
  89 ************************************************************************
  90 * performance issues
  91 ************************************************************************
  92
  93 Several areas can be cleaned up to make mandoc even faster.  These are
  94
  95 - improve hashing mechanism for macros (quite important: performance)
  96
  97 - improve hashing mechanism for characters (not as important)
  98
  99 ************************************************************************
 100 * structural issues
 101 ************************************************************************
 102
 103 - rendering frontend code can calculate widths only for plain strings,
 104   not for strings containing escape sequences.  For example, this
 105   hinders calculation of the indent required for .Nm \&[ in text(1).
 106   comments from kristaps@  Wed, 21 Jul 2010 23:26:08 +0200
 107