Fix: docutils/__init__.py __version_info__ must be changed manually
[docutils.git] / sandbox / grubert / latex2e-README.txt
blob8c66007d0ca4021b6b1493393b6c6f932878c7b1
1 latex2e BUGS TODOS and other animals
2 ------------------------------------
4 for processing tools/test.txt use pdflatex because it will handle png-images.
7 :Author: engelbert gruber
8 :Contact: grubert@users.sourceforge.net
9 :Date: $Date$
11 To do
12 ~~~~~
14 * handle image options : height,width,class.
16 * setting urls: french does put a spcae before ":" and "?".
18   using ``\url`` long urls the url is typeset int tt, but hyphenates.
19   using ``\href`` does typeset in normal font.
21 * dedication is centered italic in html (test.txt).
23 * term: html puts classifier in italic and newline after classifier,
24   latex in parentheses and no newline after it (test.txt).
26 * field lists are indented in latex (test.txt).
28 * literal block is indented in html (test.txt).
30 * doctest block is indented in html.
32 * footnotes donot link back in latex.
34 * quotes for german: {\glqq} {\grqq} {\glq} {\grq} {\dq}.
36 * support embed-stylesheet.
38 * the ^-sign is problematic: using mathmode wedge is usually the wrong font.
40 * Maybe add end of line after term in definition list. see
41     http://roundup.sf.net/doc-0.5/features.pdf
43 * In tools.txt the option tables right column, there should be some more spacing
44   between the description and the next paragraph "Default:".
46   Paragraph separation in tables is hairy. 
47   see http://www.tex.ac.uk/cgi-bin/texfaq2html?label=struttab
49   - The strut solution did not work.
50   - setting extrarowheight added ad top of row not between paragraphs in
51     a cell. ALTHOUGH i set it to 2pt because, text is too close to the topline.
52   - baselineskip/stretch does not help.
54 * two hlines after table head and on table end ?
56 * table: multicol cells are always {l}.
58 * pdfbookmark level 4 (and greater) does not work (might be settable but OTOH).
60 * center subsection{Abstract} gives a latex error here.
61   ``! LaTeX Error: Something's wrong--perhaps a missing \item.``
62   Committed a HACK: centering by hfill
64 * document errors are also too silent.
66 * use optionlist for docinfo.
68 * the title "table of contents" is centered too.
70 * consider peter funk's hooks for TeXpert:
71   
72   * Define his own document preamble (including the choice to
73     choose his own documentclass.  That would make the ``--documentclass``
74     option superfluous).  I suggest to call this option ``--preamble``
76   * Use two additional hooks to put additional stuff just behind the 
77     ``\begin{document}`` and just before the ``\end{document}`` macros.
78     Typical uses would be ``\tableofcontents``, ``\listoffigures`` and
79     ``\appendix``, ``\makeindex``, ``\makeglossary`` and some such 
80     for larger documents.
82 * hyphens: co-developers should be co--developers ?
84 * table heads and footer for longtable (firstpage lastpage ..)
86 * longtable does not work with multirow
88 * tabularx says "do not use any multicolmn which spans any X column.
89   maybe use ltxtable instead of tabularx (Longtable combined with tabularx).
90   but ltxtable disables longtable's multicolumn.
92 * multiple author entries in docinfo (same thing as in html).
94 * the indentional problematic error in test.txt is not referring anywhere.
96 * table cells with multirow and multicolumn
98 * tables have borders, and the border is missing in empty cells.
100 * footnotes are not all on the same page (as in tools/test.txt) and do not link back
101   and forth.
103 * no link to system errors.
105 * hyperlinks are not hyphenated this leads to bad spacing. see tools/test.txt 
106   2.14 directives directives
108 * meta keywords into pdf ?
110 * pagestyle headings does not work, when sections are starred.
112 * additional docinfo items: the field_body is inserted as text.
114 ATTENTION
115 ~~~~~~~~~
116 * put labeling inside (after the begin) environments.
117 * me (e.g.) uses textwidth, julien linewidth see what is what.
119   textwidth: is the normal width of the text on a page. It should generally 
120   be changed only in the preamble. 
122   linewidth: is the width of lines in the current environment. Normally equal to
123     \textwidth, it may be different within an environment such as list or quote 
124     environments.
126 * from http://netra.wustl.edu/links/LaTeX/LaTeX.html
128   - Aligning Images 
130     By default, images align according to their "reference point," which is never 
131     what you want it to be. Put a minipage around an image to make it align 
132     properly (according to its center)::
134       \usepackage{graphicx}
135       \begin{minipage}{2in}
136         \includegraphics[width=2in,angle=-90]{foo}
137       \end{minpage}
139   - 2-Column Images 
141     When in 2-column mode (using either \twocolumn or the multicols environment 
142     (package multicol)), use \begin{figure*} and \begin{table*} to create figures
143     and tables that span the entire width of the page. \begin{figure} and 
144     \begin{table} span only one column.
146   - LaTeX->PDF 
148     I've found that the best way to convert from LaTeX to PDF is to use "pdflatex."
149     The first time that you run it, you'll find that the produced PDF file doesn't
150     include any of your figures.  To fix this, 
152     1. Use "epstopdf" to convert all of your EPS images to PDF 
153     2. Make sure that you are using the "graphicx" package for including images.
154     3. Remove any .eps or .ps extensions from filenames in your LaTeX file 
156     When you run LaTeX, graphicx will use the dvips driver to incorporate EPS 
157     files. When you run pdflatex, it will pick up the pdftex driver and incorporate
158     the PDF files.