Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/TODO, Revision 1.27

1.1       kristaps    1: ************************************************************************
1.27    ! kristaps    2: * Official mandoc TODO.  May not be quite up to date.
        !             3: * $Id$
        !             4: ************************************************************************
        !             5:
        !             6: ************************************************************************
1.1       kristaps    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:
1.18      schwarze   14: - fix bad block nesting involving multiple identical explicit blocks
                     15:   see the OpenBSD mdoc_macro.c 1.47 commit message
                     16:
1.1       kristaps   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: - implement \\
                     25:   in plain text, identical to \e
                     26:   as a macro argument, identical to \ i.e. escaping the next character
                     27:   We do not have macro definitions yet; if we implement them,
                     28:   \\ must behave in a macro def like in a macro argument,
                     29:   and when using the macro, it must expand yet again.
                     30:
1.22      schwarze   31: - implement \s (physical font size)
                     32:   \sN - set to N
                     33:   \s+N - increment by N, 1 <= N <= 8
                     34:   \s-N - decrement by N, 1 <= N <= 8
                     35:   \s0 - restore previous size
                     36:   \s(nn \s+-(nn \s'+-nn' \s+-'nn' \s[+-nn] \s+-[nn] - disambiguate
                     37:   registers: .s .ps .sr .psr
                     38:   used by e.g. cu(1), tip(1)
                     39:
1.1       kristaps   40: - look at bsd.lv tbl(1)
                     41:   from kristaps@  Fri, 11 Sep 2009 17:10:53 +0200
1.17      schwarze   42:   also look at the mail from Thomas Klausner wiz at NetBSD
                     43:     on Wed, 2 Jun 2010 11:01:29 +0200
1.1       kristaps   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:
1.10      kristaps   51: - implement blank `Bl -column', such as
                     52:   .Bl -column
                     53:   .It foo Ta bar
                     54:   .El
1.11      kristaps   55:
                     56: - explicitly disallow nested `Bl -column', which would clobber internal
                     57:   flags defined for struct mdoc_macro
1.12      kristaps   58:
                     59: - set a meaningful default if no `Bl' list type is assigned
1.13      kristaps   60:
                     61: - have a blank `It' head for `Bl -tag' not puke
1.15      kristaps   62:
                     63: - ignore horrendous m[] font colouring
                     64:   reported by J.C. Roberts
1.20      kristaps   65:
                     66: - prohibit `Nm' from having non-text HEAD children
                     67:   (e.g., NetBSD mDNSShared/dns-sd.1)
                     68:   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.10      kristaps   69:
1.1       kristaps   70: ************************************************************************
                     71: * formatting issues: ugly output
                     72: ************************************************************************
                     73:
                     74: - outside list context, text following .Sm off
                     75:   seems to follow without a blank (TERM_NOBLANK reset late?) e.g.
                     76:         .Sm off
                     77:         .Xo
                     78:         .Op Ar bind_address No /
                     79:         .Ar port
                     80:         .Xc
                     81:         .Sm on
                     82:         or by enclosing
                     83:   reported by jmc Tue, 13 Apr 2010 08:48:14 +0100
                     84:
                     85: - empty phrases in .Bl column produce too few blanks
                     86:   try e.g. .Bl -column It Ta Ta
                     87:   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
                     88:
                     89: ************************************************************************
                     90: * formatting issues: gratuitious differences
                     91: ************************************************************************
                     92:
1.19      schwarze   93: - none reported right now (yet schwarze@ knows of some)
1.1       kristaps   94:
1.9       kristaps   95: ************************************************************************
                     96: * performance issues
                     97: ************************************************************************
                     98:
                     99: Several areas can be cleaned up to make mandoc even faster.  These are
                    100:
                    101: - improve hashing mechanism for macros (quite important: performance)
                    102:
                    103: - improve hashing mechanism for characters (not as important)
1.23      kristaps  104:
                    105: ************************************************************************
                    106: * structural issues
                    107: ************************************************************************