Annotation of mandoc/TODO, Revision 1.28
1.1 kristaps 1: ************************************************************************
1.27 kristaps 2: * Official mandoc TODO. May not be quite up to date.
1.28 ! schwarze 3: * $Id: TODO,v 1.27 2010/07/16 22:33:30 kristaps Exp $
1.27 kristaps 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:
1.28 ! schwarze 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:
1.1 kristaps 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:
1.22 schwarze 39: - implement \s (physical font size)
40: \sN - set to N
41: \s+N - increment by N, 1 <= N <= 8
42: \s-N - decrement by N, 1 <= N <= 8
43: \s0 - restore previous size
44: \s(nn \s+-(nn \s'+-nn' \s+-'nn' \s[+-nn] \s+-[nn] - disambiguate
45: registers: .s .ps .sr .psr
46: used by e.g. cu(1), tip(1)
47:
1.1 kristaps 48: - look at bsd.lv tbl(1)
49: from kristaps@ Fri, 11 Sep 2009 17:10:53 +0200
1.17 schwarze 50: also look at the mail from Thomas Klausner wiz at NetBSD
51: on Wed, 2 Jun 2010 11:01:29 +0200
1.1 kristaps 52:
53: - look at pages generated from reStructeredText, e.g. devel/mercurial hg(1)
54: These are a weird mixture of man(7) and custom autogenerated low-level
55: roff stuff. Figure out to what extent we can cope.
56: noted by stsp@ Sat, 24 Apr 2010 09:17:55 +0200
57: reminded by nicm@ Mon, 3 May 2010 09:52:41 +0100
58:
1.10 kristaps 59: - implement blank `Bl -column', such as
60: .Bl -column
61: .It foo Ta bar
62: .El
1.11 kristaps 63:
64: - explicitly disallow nested `Bl -column', which would clobber internal
65: flags defined for struct mdoc_macro
1.12 kristaps 66:
67: - set a meaningful default if no `Bl' list type is assigned
1.13 kristaps 68:
69: - have a blank `It' head for `Bl -tag' not puke
1.15 kristaps 70:
71: - ignore horrendous m[] font colouring
72: reported by J.C. Roberts
1.20 kristaps 73:
74: - prohibit `Nm' from having non-text HEAD children
75: (e.g., NetBSD mDNSShared/dns-sd.1)
76: (mdoc_html.c and mdoc_term.c `Nm' handlers can be slightly simplified)
1.10 kristaps 77:
1.1 kristaps 78: ************************************************************************
79: * formatting issues: ugly output
80: ************************************************************************
81:
1.28 ! schwarze 82: - perl(1) SYNOPSIS looks bad; reported by deraadt@
! 83: 1) "\ " is non-breaking
! 84: 2) man(7) seems to need SYNOPSIS .Nm blocks, too
1.1 kristaps 85:
86: - empty phrases in .Bl column produce too few blanks
87: try e.g. .Bl -column It Ta Ta
88: reported by millert Fri, 02 Apr 2010 16:13:46 -0400
1.28 ! schwarze 89:
! 90: - .Pp before and after .Sh (and .Ss) produces a spurious blank line;
! 91: reported by jmc@ Thu, 15 Jul 2010 23:00:28 +0100
1.1 kristaps 92:
93: ************************************************************************
94: * formatting issues: gratuitious differences
95: ************************************************************************
96:
1.19 schwarze 97: - none reported right now (yet schwarze@ knows of some)
1.1 kristaps 98:
1.9 kristaps 99: ************************************************************************
100: * performance issues
101: ************************************************************************
102:
103: Several areas can be cleaned up to make mandoc even faster. These are
104:
105: - improve hashing mechanism for macros (quite important: performance)
106:
107: - improve hashing mechanism for characters (not as important)
1.23 kristaps 108:
109: ************************************************************************
110: * structural issues
111: ************************************************************************
CVSweb