Latex Writer Variants

Author: Günter Milde <milde@users.berlios.de>
Date: 2014-11-13

This sandbox project is a place to try out and discuss latex2e writer extensions and alternative latex writers for special needs.

Contents

latex2e writer extensions

Questionnaire

  1. Does the latex2e writer need a --stylesheet-path option?
  2. Feature wishes or ideas of improvement for the latex2e writer.

Users of rst2latex2.py are encouraged to respond by mail to the docutils-users list.

Proposed Changes

See also the notes in http://docutils.sourceforge.net/docs/user/latex.html#problems and the TODO list in http://docutils.sourceforge.net/docs/dev/todo.html#latex-writer

Default font

Which default font do you prefer for the output?

Answers:
By default, PDFLaTeX uses embedded computer modern family, which look good on paper but poor on LCDs (even if outlined, due to suboptimal hinting), and result in large PDFs. rst2pdf uses the "standard" PDF fonts by default (Times, Helvetica, Courier) which IMO look reasonable both on screen and on paper. Because they aren't embedded, it also results in a smaller file size.

Font embedding must be configured in the LaTeX installation.

--stylesheet-path option

There are 2 use cases:

  1. files in the TEXINPUTS path ("installed", site-wide style files (standard or local))
    • specify only the filename
    • include literally
  2. files outside the TEXINPUTS path (not installed, local style files)
    • a relative path should be rewritten if the output document is in a different dir than the pwd

Currently, 1) is done with --stylesheet and 2) with --stylesheet-path.

But:

-1 having both --stylesheet and stylesheet-path makes things
complicated:

Explaining the two options and their interaction to the user is not straightforward.

This holds even more if you take into account the third related option, --embed-stylesheet.

-1

it is impossible to have some paths rewritten and some not, as in e.g.

--stylesheet=mathpazo -stylesheet-path=mystyle.tex

"mystyle.tex" would overwrite "mathpazo".

Proposal

Instead of two options, do "the right thing" based on simple rules, e.g:

  1. Use the "package" vs. "custom style sheet" distinction:

    Rewrite, if there is an filename extension and it is not .sty

    --stylesheet='mathpazo,mystyle.tex'
    

    will use 'mathpazo' verbatim and rewrite 'mystyle.tex'.

    -1

    will not work for latex packages in the pwd or outside the TEXINPUTS path.

  2. rewrite paths that have a directory part:

    --stylesheet='mathpazo,./mystyle.sty'
    

    will use 'mathpazo' verbatim and rewrite './mystyle.sty'.

    +1

    explicite and flexible

    +1

    the common case (files in the TEXINPUTS path) is the most simple

    -1

    need to document/learn special syntax

  3. rewrite path if this prevents errors:

    • Check for a given file (or relative path) relative to pwd and output dir.
    • If it is available relative to pwd but not relative to the output dir, rewrite the path.
    +1

    no need to explain any additional syntax

    +1

    does "the right thing" in most usual cases

    -1

    hidden automatism might lead to problems in corner cases

    -1

    mechanism depends on the availability of files at the time of the run, which is harder to explain and less predictable than b)

Require only standard packages

Provide fallback solutions for the use of "exotic" packages in case they do not exist on the target system.

Bibliography directive

Alan suggested a bibliography directive so that BibTex references are not automatically placed at the end (and bibtex for html via ... can be supported)

This would imply supression of the "Bibliography" or "References" header added by LaTeX which is possible with:

From: Martin Scharrer <martin@scharrer-online.de> Subject: Re: Literaturverzeichnis ?berschrift entfernen Date: Sun, 22 Mar 2009 06:30:33 -0700 (PDT)

On Mar 21, 11:10?pm, Elfish26111...@gmail.com wrote: > Hallo, > > ich benutze Bibtex und w?rde gerne die komplette ?berschrift, also > auch die daf?r reservierte Box entfernen. > Hat jemand eine Idee wie ich das machen kann? > > renewcommand{bibname}{} > > habe ich bereits versucht. Aber wie gesagt den reservierten Platz in > der Überschrift behält er immernoch.

Die Ueberschrift ist denk ich mal ein 'chapter*{bibname}' was du dann zu einem 'chapter*{}' machst. Die Loesung ist einfach das chapter macro umzudefinieren:

begingroup renewcommand{chapter}[2]{} % Literaturverzeichnis einbinden: ueber BibTeX oder manuell ... endgroup

Wobei der '*' hier einfach als ein zusaetzliches Argument genommen wird. Dann braucht bibname gar nicht mehr geaendert werden.

Gruesse, Martin

Alternative latex writers

Browse the SVN repository at berlios.de

other latex writers

Currently none.

Tests

Test documents and unit tests highlighting problems with the LaTeX export and testing alternatives.

See tests