contrib/texinfo/TODO

   1 $Id: TODO,v 1.26 2004/11/22 23:57:32 karl Exp $
   2 This is the todo list for GNU Texinfo.
   3 If you are interested in working on any of these, email bug-texinfo@gnu.org.
   4
   5   Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2003,
   6   2001, 2002, 2003, 2004 Free Software Foundation.
   7
   8   Copying and distribution of this file, with or without modification,
   9   are permitted in any medium without royalty provided the copyright
  10   notice and this notice are preserved.
  11
  12 * General:
  13   - @euro{}.
  14   - Support installation of manuals in different languages, along these lines:
  15     . support a LINGUAS file or variable saying which subdirs LL in the
  16       source to descend into (under doc/).
  17     . within each subdir LL, install the info files into $infodir/LL,
  18       and run install-info on $infodir/LL/dir.
  19     . info (both emacs and standalone) should read $infodir/$LANG/dir
  20       as the first dir file, and likewise read info files first from
  21       $infodir/$LANG, before falling back to $infodir.
  22     . consider ways to avoid installing images in both places.
  23       In fact, images probably need to be installed in a subdir
  24       $infodir/MANUAL/ in the first place, to avoid conflicts of having
  25       the same image name in different manuals.
  26     For a test case, see texinfo cvs, with its one translated manual
  27     (info-fr.texi).
  28     From Wojciech Polak.
  29   - Monitor and improve the dir categories in existing manuals,
  30     following the Free Software Directory categories.  Much mail to
  31     developers has already been sent, what's needed now is to check new
  32     releases and make sure they are using the right categories.
  33     See the util/dir-example in the Texinfo distribution for our current
  34     recommended categories.
  35     For background, see the thread (which discusses a lot of other
  36     issues too) at
  37     http://mail.gnu.org/pipermail/emacs-devel/2002-10/msg00011.html,
  38     especially
  39       http://mail.gnu.org/archive/html/emacs-devel/2002-10/msg00090.html
  40       http://mail.gnu.org/archive/html/emacs-devel/2002-10/msg00137.html
  41   - Get Info declared as a MIME Content-Type.
  42   - Likewise the `info:' URI scheme; a library consortium has proposed a
  43     completely different purpose for the URI scheme, but I don't know
  44     how to send comments, despite it being a "request for comments".  Sigh.
  45     There is mail about this in the bug-texinfo archives:
  46       http://mail.gnu.org/archive/html/bug-texinfo/2003-09/msg00086.html
  47   - Support compressed image files.
  48   - Support reference card creation, perhaps by only paying attention to
  49     sectioning and @def... commands.
  50   - Allow @end (and other?) commands to be indented in the source.
  51   - Test for memory leaks, e.g., with valgrind:
  52     http://developer.kde.org/~sewardj/
  53   - Extend and improve the tests.
  54
  55 * Language:
  56   - @else for the @if... conditionals.
  57   - @xindexterm [def] primary [,secondary [,tertiary]]  or some such?
  58   - Allow subitems and `see' and `see also' in indices.
  59   - multicolumn * width to take up `the rest'.
  60   - another table command to take N succeeding items and split them
  61     into M columns (see eplain).
  62   - support bibliographies with BibTeX (see web2c/doc for kludge prototype).
  63   - @flushboth to combine @flushleft and @flushright, for RFC's.
  64   - @part sectioning command.
  65   - @exercise/@answer command for, e.g., gawk.
  66   - Allow @hsep/@vsep at @item, instead of just in template.
  67   - Support automatic line numbering of examples.
  68   - Better macro syntax.
  69   - Better def... command syntax.
  70   - Allow : in node names for info files, for names like
  71     `class::method'.  Likewise index entries.  A quoting mechanism such
  72     as surrounding node names with SPACE BACKSPACE is probably the best
  73     solution, although this is an incompatible change to Info format, sigh.
  74   - Glossary/general definition support (dumas msg 28 Nov 2003 17:09:57 +0100).
  75   - Add support for other Latin 9 (and Latin 2 and Latin 1) characters.
  76
  77 * Makeinfo:
  78   - Translation of "Appendix" etc. should depend on @doclang not $LANG.
  79   - Try directory of main source file.
  80   - Make makeinfo -E just do macro expansion, avoiding all error checks.
  81     That way, texi2dvi could run makeinfo --iftex -E.
  82   - A detexinfo program, like detex or delatex.  This command would
  83     strip all the texinfo commands out, and would be used as a filter on
  84     the way to a speller.  An option would be to NOT strip comments out.
  85     makeinfo --no-headers comes close.
  86   - If node name contains an @ command, complain explicitly.
  87   - Use @documentlanguage instead of LANG for many translations.
  88   - HTML: split output by chapter to improve context, per Akim.
  89     Generate dummy files for all nodes for the sake of cross-references.
  90   - HTML: support thumbnails.
  91   - HTML: make images of math, maybe.
  92   - HTML: allow settable background color, table colors and spacing,
  93     <head> meta tags, etc.  A la http://texi2html.cvshome.org.  In fact:
  94   - HTML: have a library of different CSS styles.
  95     http://mail.gnu.org/archive/html/bug-texinfo/2004-01/msg00025.html
  96   - XML: cannot be loaded directly in a browser; why not?
  97   - Docbook: &euro; and other entities do not work; does anything work?
  98   - Rewrite completely to simplify generation of different formats.
  99
 100 * TeX:
 101   - Use @ as the escape character, and Texinfo syntax generally, in the
 102     table of contents and index files.  Eliminate all the crazy
 103     multiple redefinitions of every Texinfo command in different contexts.
 104   - Support input in any encoding and language, via ec or Latin Modern fonts.
 105   - Reasonable way to change fonts from the default (some work has been
 106     done), to allow for PostScript fonts, for example.
 107   - @multitable: handle @hsep and @vsep.
 108   - @multitable: repeat table headings if multiple pages long.
 109   - @multitable: support a heading line concept (<thead> in HTML).
 110   - Introduce new command to change \bindingoffset.
 111   - How about using latex2html to produce HTML?
 112   - Table of contents gets misaligned if there are 10 or more [sub]sections.
 113   - Use url.sty (or something) to allow linebreak of url's.
 114   - Include hyperlink \special's in the DVI output for xdvi, etc.
 115   - PDF: make each letter of the index (A, B, ...) a section in the TOC.
 116     From Carsten Dominik <dominik@astro.uva.nl>.
 117
 118 * Doc:
 119   - Include a complete functional summary, as in a reference card, in
 120     the manual.
 121   - Improve the manuals, especially for makeinfo, standalone info, etc.
 122   - new section on doing dedication pages. See gawk.texi
 123     for an example of doing it in both the tex and info versions.
 124
 125 * Info:
 126   - Regular expression search.
 127   - Full-text search across all info files installed on the system.
 128   - Support character sets other than ISO Latin 1.
 129   - Perhaps comply with LANGUAGE setting on a per-node basis, to allow
 130     incremental translation of Texinfo files.
 131   - Search all nodes of dir file at startup, then can have
 132     INFO-DIR-SEPARATE-GROUPS and other such.
 133   - Better dir file merging.
 134   - Global dir file (as in /etc/conf/dir) and texinfo config file
 135     specifying which info directories to search.  From Dale Mellor.
 136     http://mail.gnu.org/mailman/private/gnu-prog-discuss/2003q4/000439.html
 137   - Steal interface ideas from Lynx: number links, use color, etc.
 138     Perhaps code from the pinfo viewer can be reused:
 139     http://zeus.polsl.gliwice.pl/~pborys/.
 140   - More sample .infokey files, so people can choose without writing their own.
 141   - q within help should quit help like C-x 0.
 142   - Incorporate an X-based viewer, perhaps saxinfo or tkinfo
 143       http://www.math.ucsb.edu/~boldt/tkinfo/
 144   - Make "info foo bar" search for bar in foo's index(es) if no menu match.
 145   - Handle M-n, C-u m, and C-u g like Emacs Info (opening new windows).
 146   - Write technical definition of Info format.
 147
 148 * install-info:
 149   - be able to copy the info file to compile-time $infodir, to
 150     simplify by-hand installation.
 151   - also support installing HTML files, etc., along with subsidiary
 152     @image (or other) files.  In subdirs.  Or something.
 153   - support info dir entries for other than the current info file name;
 154     see comments in menu_item_equal.
 155   - merge features with Debian install-info, so we can have one program.
 156
 157 * texindex:
 158   - read source file (specified by new option) for @documentlanguage
 159     and/or @documentencoding, and change the sorting appropriately.
 160   From: Wojciech Polak, 26 Apr 2003 11:30:59 +0200.
 161
 162 * Distribution:
 163   - generate txi-??.tex from .po's to make translators' jobs easier.
 164     From Akim and Karl E.
 165
 166 Ideas that will not be implemented:
 167 - Process Texinfo files directly instead of converting to Info:
 168   ftp://ftp.cs.berkeley.edu/ucb/people/phelps/tcltk/tkman.tar.Z, which
 169   uses Tcl/Tk 8.0 from ftp.smli.com in the /pub/tcl directory.
 170   From: phelps@ecstasy.CS.Berkeley.EDU (Tom Phelps)
 171   [This has the disadvantage of needing to be updated when the
 172   Texinfo language changes, so don't.]
 173
 174 - Call Ghostscript to get ASCII/jpg output for the @image command.
 175   [makeinfo should not try to be make, or assume it knows how the user
 176    wants to generate images.  Too many different methods are possible.]
 177
 178 - Change bars.  This is difficult or impossible in TeX,
 179   unfortunately.  To do it right requires device driver support.
 180   wdiff or ediff may be all we can do.  Merely specifying what should be
 181   changed is not obvious.