org-dependencies.org

   1 #+TODO: TODO STARTED | DONE
   2 #+OPTIONS: toc:t
   3
   4 * Dependencies
   5
   6 Certain parts of org-mode have dependencies on external packages. This
   7 file documents these dependencies. Many sections are placeholders,
   8 waiting for input. If you can, please contribute. If you think that
   9 another section should be added, please add it and fill it out. Also,
  10 if you spot any mistakes, omissions or superfluities, please fix
  11 them. If you have an account, you can clone the Worg tree and make the
  12 additions/fixes (see [[http://orgmode.org/worg/worg-git.html]] for more
  13 information), but if you don't or don't want to do it yourself, that's
  14 fine too: a note to the [[mailto:emacs-orgmode@gnu.org][orgmode mailing list]] will also do
  15 the job. Thanks!
  16
  17 Version: Org-mode version 7.01trans (release_7.01h.224.gf6c09)
  18
  19 ** TODO Exporting in general.
  20 Anything here?
  21
  22 ** STARTED LaTeX export.
  23 The LaTeX class is selected using the construct
  24
  25 :#+LaTeX_CLASS: <class>
  26
  27 org-latex predefines the treatment of the following LaTeX classes
  28 article, report, book, beamer - or you can roll your own. And
  29 you can, of course, customize the treatment to your heart's content.
  30 This assumes a standard LaTeX install.
  31
  32 On Linux/Mac OSX/BSD, the TeXlive distribution is recommended.
  33 On Windows, most people prefer  MikTeX.
  34
  35 ** Where to get packages
  36 The best way to get these packages is by using the package manager
  37 that comes with your operating system. These generally contain many
  38 useful LaTeX packages.
  39
  40 If that is not possible, then you can get individual LaTeX packages
  41 from the CTAN sites (see [[http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives][CTAN archives]] for more information), but the
  42 installation process is less straightforward (but more portable):
  43 generally speaking, a LaTeX package comes in two files: a .ins file
  44 and a .dtx file (usually packed in a zip or tgz archive). Processing
  45 the .ins file through latex separates out the code from the .dtx file
  46 and produces the pieces that need to be installed on your system, but
  47 then it is up to you to figure out where to copy these files on your
  48 system for TeX and friends to find them. Processing the .dtx file
  49 directly through latex produces the documentation of the package:
  50
  51     - latex foo.ins -> foo.sty, etc.
  52     - pdflatex foo.dtx -> foo.pdf
  53
  54 Many questions are answered by the [[http://www.tex.ac.uk/cgi-bin/texfaq2html?introduction=yes][TeX FAQ]] site, although the
  55 search capability is fairly primitive by today's standards: you
  56 will have to search a bit more diligently.
  57
  58 *** STARTED article, book, report
  59 The LaTeX packages included by default are as follows:
  60
  61 | LaTeX package | Ubuntu container package  | Options | Comments                          |
  62 |---------------+---------------------------+---------+-----------------------------------|
  63 | inputenc      | texlive-latex-base        | utf8    |                                   |
  64 | fontenc       | texlive-latex-base        | T1      |                                   |
  65 | fixltx2e      | texlive-latex-base        |         | Various LaTeX fixes - fix-cm too? |
  66 | graphicx      | texlive-latex-base        |         |                                   |
  67 | longtable     | texlive-latex-base        |         |                                   |
  68 | float         | texlive-latex-recommended |         | floating environments             |
  69 | wrapfig       | texlive-latex-extra       |         | text wrapping around figures      |
  70 | soul          | texlive-latex-extra       |         | Underline/strike through          |
  71 | t1enc         | texlive-latex-base        |         | Obsolete - remove?                |
  72 | textcomp      | texlive-latex-base        |         | Misc text symbols                 |
  73 | marvosym      | texlive-fonts-recommended |         | Euro symbol                       |
  74 | wasysym       | texlive-fonts-recommended |         | Misc symbols                      |
  75 | latexsym      | texlive-latex-base        |         | Math symbols                      |
  76 | amssymb       | texlive-base              |         | Math symbols                      |
  77 | hyperref      | texlive-latex-base        |         |                                   |
  78
  79
  80
  81 *** TODO beamer
  82 *** STARTED Symbols
  83
  84 LaTeX syntax can be used to introduce many special symbols into a
  85 document (e.g. mathematical symbols). Most of these symbols are defined
  86 by basic LaTeX, but some require the presence of extra packages.
  87
  88 | LaTeX macro | Rendered Symbol (approx) | LaTeX package | Ubuntu container package  |
  89 |-------------+--------------------------+---------------+---------------------------|
  90 | =\EUR=      | \EUR                     | marvosym      | texlive-fonts-recommended |
  91 | =\euro=     | \euro                    | eurosym       | texlive-fonts-recommended |
  92
  93 Note that marvosym is now included as part of the default setup so you
  94 do not need to include the package explicitly.
  95
  96 ** STARTED PDF export.
  97
  98 PDF export goes through LaTeX export first, so all the LaTeX dependencies
  99 apply here as well.
 100
 101 Certain PDF viewers have been reported to produce more or less
 102 unreadable files if Adobe Type3 fonts are used in the document.
 103 Evince has been identified as one of those. One way around this
 104 problem is to not use Type3 fonts. Another is to use a viewer that
 105 does not mistreat Type 3 fonts.
 106
 107 You can find more information about this problem in the TeX FAQ:
 108
 109 To find out whether a document uses Type3 fonts, open it with Acrobat
 110 Reader/Evince, select Properties from the File menu and then select
 111 the Fonts tab; alternatively, use the pdffonts program (part of the
 112 xpdf-reader package) from the command line.
 113
 114 It is probably impossible to get rid of Type3 fonts completely
 115 (particularly if you are using special symbols or languages that
 116 don't use the Latin alphabet: in such cases, font availability is more
 117 limited and you just might not be able to find Type1 fonts to do the
 118 job).
 119
 120 For standard latin-alphabet languages that use the Computer
 121 Modern fonts (including small variations e.g. Polish and Czech), you
 122 *can* find Type1 versions: (XXX-needs fixing) the texlive-fonts-extra package (on
 123 Ubuntu/Debian) e.g. includes the AMS CM fonts which work well.
 124 Similar packages exist for other Linux distributions and probably
 125 for other operating systems as well.
 126
 127 | Type1 font      | LaTeX package | Ubuntu container package |
 128 |-----------------+---------------+--------------------------|
 129 | Computer Modern | amsfonts      | texlive-base             |
 130 | Euler           |               |                          |
 131
 132 (/XXX-needs fixing)
 133
 134 ** TODO DocBook export.
 135
 136
 137 ** STARTED HTML export.
 138 *** STARTED Exporting LaTeX fragments as images.
 139 LaTeX fragments can be exported as images for inclusion into HTML
 140 documents. For example, complicated mathematical expressions can be
 141 dealt with this way. This is done by creating a LaTeX file that
 142 contains the fragment, processing it through LaTeX to produce a DVI
 143 file and then processing it through dvipng. So, in addition to LaTeX,
 144 you will need dvipng: on Ubuntu, this is available in the "dvipng"
 145 package.
 146
 147 The LaTeX file contains a somewhat different list of LaTeX packages.
 148 Note that this is the default list, determined by the value of the
 149 variable ``org-format-latex-header''.
 150
 151 | LaTeX package | Ubuntu container package | Options  |
 152 |---------------+--------------------------+----------|
 153 | amssymb       | texlive-base             |          |
 154 | color         | texlive-latex-base       | usenames |
 155 | amsmath       | texlive-latex-base       |          |
 156 | latexsym      | texlive-latex-base       |          |
 157 | eucal         | texlive-base             | mathscr  |
 158
 159 ** TODO org-plot.
 160
 161 ** TODO org-babel.