Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/TODO, Revision 1.26

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