************************************************************************
* Official mandoc TODO.
-* $Id: TODO,v 1.230 2017/02/03 17:59:22 schwarze Exp $
+* $Id: TODO,v 1.234 2017/02/18 11:53:33 schwarze Exp $
************************************************************************
Many issues are annotated for difficulty as follows:
- support mdoc(7) and man(7) macros inside tbl(7) code;
probably requires the parser reorg and letting tbl(7)
use roff_node such that macro sets can mix;
- informed by bapt@ that FreeBSD needs this.
+ informed by bapt@ that FreeBSD needs this: 3 Jan 2015 23:32:23 +0100
loc *** exist ** algo *** size ** imp ***
- look at the POSIX manuals in the books/man-pages-posix port,
and triggers a line break; found in audio/normalize-mp3(1)
loc ** exist * algo ** size * imp **
-- rendering of double quotes in -Tascii is ugly in both groff and mandoc
- to improve, both would have to be changed
- Carsten Kunze Fri, 12 Dec 2014 14:27:56 +0100
-
- formatting /usr/local/man/man1/latex2man.1 with groff and mandoc
reveals lots of bugs both in groff and mandoc...
reported by bentley@ Wed, 22 May 2013 23:49:30 -0600
http://undeadly.org/cgi?action=article&sid=20140925064244&pid=1
loc * exist * algo ** size * imp ***
-- consider whether <var> can be used for Ar Dv Er Ev Fa Va.
- from bentley@ Wed, 13 Aug 2014 09:17:55 -0600
-
- generate <img> tags in HTML
idea from florian@ Tue, 7 Apr 2015 00:26:28 +0000
may be possible to implement with .Lk img://something.png alt_text
The same applies to .Bl -column column widths;
reported again by Nicolas Joly Thu, 1 Mar 2012 13:41:26 +0100 via wiz@ 5 Mar
reported again by Franco Fichtner Fri, 27 Sep 2013 21:02:28 +0200
+ reported again by Bruce Evans Fri, 17 Feb 2017 21:22:44 +0100 via bapt@
loc *** exist *** algo *** size ** imp ***
An easy partial fix would be to just skip the first word if it starts
with a dot, including any following white space, when measuring.
we want three blank lines, not two as in mandoc.
loc ** exist ** algo ** size * imp **
-- Header lines of excessive length:
- Port OpenBSD man_term.c rev. 1.25 to mdoc_term.c
- and document it in mdoc(7) and man(7) COMPATIBILITY
- found while talking to Chris Bennett
- loc * exist * algo * size * imp *
-
- Sequences of multiple man(7) paragraphs (.PP, .IP) interspersed
with .ps and .nf/.fi produce execessive blank lines, see libJudy
and graphics/dcmtk. The parser reorg may help with this.
all over mdoc_macro.c and all subtly different.
loc ** exist ** algo ** size ** imp **
-- warn about "new sentence, new line"
- loc ** exist ** algo *** size * imp **
-
- mandoc_special does not really check the escape sequence,
but just the overall format
loc ** exist ** algo *** size ** imp **
* documentation issues
************************************************************************
-- mention hyphenation rules:
- breaking at letter-letter in text mode (not macro args)
- proper hyphenation is unimplemented
-
-- talk about spacing around delimiters
- to jmc@, kristaps@ Sat, 23 Apr 2011 17:41:27 +0200
-
- mark macros as: page structure domain, manual domain, general text domain
is this useful?
- improve hashing mechanism for macros (quite important: performance)
-- improve hashing mechanism for characters (not as important)
-
- the PDF file is HUGE: this can be reduced by using relative offsets
-- instead of re-initialising the roff predefined-strings set before each
- parse, create a read-only version the first time and copy it
- loc * exist ** algo ** size * imp **
-
************************************************************************
* structural issues
************************************************************************
output through libz.
- Sandbox (see OpenSSH).
- Enable caching support via HTTP 304 and If-Modified-Since.
- - Allow for cgi.h to be overridden by CGI environment variables.
- Otherwise, binary distributions will inherit the compile-time
- behaviour, which is not optimal.
- Have Mac OSX systems automatically disable -static compilation of the
CGI: -static isn't supported.