Return to TODO CVS log

Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/TODO, Revision 1.22

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.17      schwarze   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:
1.1       kristaps   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:
1.22    ! schwarze   36: - implement \s (physical font size)
        !            37:   \sN - set to N
        !            38:   \s+N - increment by N, 1 <= N <= 8
        !            39:   \s-N - decrement by N, 1 <= N <= 8
        !            40:   \s0 - restore previous size
        !            41:   \s(nn \s+-(nn \s'+-nn' \s+-'nn' \s[+-nn] \s+-[nn] - disambiguate
        !            42:   registers: .s .ps .sr .psr
        !            43:   used by e.g. cu(1), tip(1)
        !            44:
1.1       kristaps   45: - look at bsd.lv tbl(1)
                     46:   from kristaps@  Fri, 11 Sep 2009 17:10:53 +0200
1.17      schwarze   47:   also look at the mail from Thomas Klausner wiz at NetBSD
                     48:     on Wed, 2 Jun 2010 11:01:29 +0200
1.1       kristaps   49:
                     50: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
                     51:   These are a weird mixture of man(7) and custom autogenerated low-level
                     52:   roff stuff.  Figure out to what extent we can cope.
                     53:   noted by stsp@  Sat, 24 Apr 2010 09:17:55 +0200
                     54:   reminded by nicm@  Mon, 3 May 2010 09:52:41 +0100
                     55:
1.10      kristaps   56: - implement blank `Bl -column', such as
                     57:   .Bl -column
                     58:   .It foo Ta bar
                     59:   .El
1.11      kristaps   60:
                     61: - explicitly disallow nested `Bl -column', which would clobber internal
                     62:   flags defined for struct mdoc_macro
1.12      kristaps   63:
                     64: - set a meaningful default if no `Bl' list type is assigned
1.13      kristaps   65:
                     66: - have a blank `It' head for `Bl -tag' not puke
1.15      kristaps   67:
                     68: - ignore horrendous m[] font colouring
                     69:   reported by J.C. Roberts
1.20      kristaps   70:
                     71: - prohibit `Nm' from having non-text HEAD children
                     72:   (e.g., NetBSD mDNSShared/dns-sd.1)
                     73:   (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.10      kristaps   74:
1.1       kristaps   75: ************************************************************************
                     76: * formatting issues: ugly output
                     77: ************************************************************************
                     78:
                     79: - outside list context, text following .Sm off
                     80:   seems to follow without a blank (TERM_NOBLANK reset late?) e.g.
                     81:         .Sm off
                     82:         .Xo
                     83:         .Op Ar bind_address No /
                     84:         .Ar port
                     85:         .Xc
                     86:         .Sm on
                     87:         or by enclosing
                     88:   reported by jmc Tue, 13 Apr 2010 08:48:14 +0100
                     89:
                     90: - indentation got lost in SYNOPSIS, e.g.
                     91:    SYNOPSIS
                     92:         date [-ajnu] [-d dst] [-r seconds] [-t minutes_west] [+format]
                     93:   -          [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
                     94:   +     [[[[[[cc]yy]mm]dd]HH]MM[.SS]]
                     95:   reminded by Ludo Smissaert  Mon, 10 May 2010 12:15:11 +0200
                     96:
                     97: - empty phrases in .Bl column produce too few blanks
                     98:   try e.g. .Bl -column It Ta Ta
                     99:   reported by millert Fri, 02 Apr 2010 16:13:46 -0400
                    100:
                    101: ************************************************************************
                    102: * formatting issues: gratuitious differences
                    103: ************************************************************************
                    104:
1.19      schwarze  105: - none reported right now (yet schwarze@ knows of some)
1.1       kristaps  106:
1.9       kristaps  107: ************************************************************************
                    108: * performance issues
                    109: ************************************************************************
                    110:
                    111: Several areas can be cleaned up to make mandoc even faster.  These are
                    112:
                    113: - improve caching mechanism to handle other per-element arguments so
                    114:   that they need not be recalculated between front- and back-ends (also
1.16      kristaps  115:   reduces code size and complexity):
                    116:     `Bl -column' pointer
1.9       kristaps  117:
                    118: - improve hashing mechanism for macros (quite important: performance)
                    119:
                    120: - improve hashing mechanism for characters (not as important)