07cf9a395612376d1754973142dcd2bccf860e1a
[Worg.git] / org-tutorials / org-publish-html-tutorial.org
blob07cf9a395612376d1754973142dcd2bccf860e1a
1 #+OPTIONS:    H:3 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
2 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
3 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
4 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
5 #+TITLE:      Publishing Org-mode files to HTML
6 #+AUTHOR:     Sebastian Rose
7 #+EMAIL:      sebastian_rose gmx de
8 #+LANGUAGE:   en
9 #+PRIORITIES: A C B
10 #+CATEGORY:   worg-tutorial
13 [[file:../index.org][{Back to Worg's index}]]
15 * Introduction
17   This Tutorial describes one of many ways to publishing Org-mode files to
18   XHTML. We use the publishing mechanism to keep the =*.html= files separated
19   from our =*.org= files and to access them via web browser. Simply exporting the
20   Org-mode files to HTML would leave them in =~/org/=.
22   The XHTML files we create will work every where, on any host, with or without
23   network access, and even when accessed through the =file:///= protocol. To
24   achieve this goal, we use
26   - no absolute paths in HTML,
27   - no server side scripting to navigate our output directories,
28   - no =base= element (which is optional as of XHTML 1.0 strict) and
29   - no software, but emacs, Org-mode and a web browser.
31   All this means, we are able to check and use the result of work immediately,
32   everywhere.
34 * Basics
36   Throughout this tutorial, let's assume that all our Org-mode files live beneath
37   =~/org/= and we publish them to =~/public_html/=.
39   Let's further assume you're already familiar with the note taking basics in
40   org and able to add a little content to the Org-mode files we add to our project
41   during this tutorial. Please add at least one headline to each of the files.
43   The first thing to do is to create the folder =~/org=. This is where our notes
44   files live. Inside =~/org/= we have a folder =css/= for stylesheets and
45   scripts, and a folder called =img/= (guess what's in there).
47   The first file we add to that folder (and to subdirectories later on) is called
48   =index.org=. This name was choosen, since Org will publish the files to those
49   with the basename of the source file plus the extension =.html= [fn:1]. Thus
50   =~/org/index.org= will once be =~/public_html/index.html= -- the startpage.
52   Let's add another file and call it =~/org/remember.org=. After adding a
53   stylesheet, =~/org/= looks like this:
55   : ~/org/
56   :    |- css/
57   :    |  `- stylesheet.css
58   :    |- img/
59   :    |- index.org
60   :    `- remember.org
62   When ever you want to add link to a file, do it the usual way. To link from
63   =index.org= to =remember.org=, just write
64   : [[file:remember.org][remember]]
65   Org will convert those links to HTML links for you on export:
66   : <a href="./remember.html">remember</a>
68   Same is true for images. To add an image, put it in =~/org/img/test.jpg= and
69   refer to it by
70   : [[file:img/test.jpg]]
72   You may test your links by clicking on them. To test image links you may also
73   try to turn on =iimage-mode= [fn:2] which works without problems here.
75   Optionally, set up the stylesheet as shown in section Special comment
76   section. The recommended way is to use a real stylesheet though.
78 * Publishing the /org/ project
80   To publish the =~/org/= project to HTML, we'll have to setup the variable
81   =org-publish-project-alist= [fn:3].  I tend to split each project in three basic
82   /components/ as described in the manual. We need these different components,
83   since we want org to use two different functions to publish dynamic content
84   (org => html) and static content like scripts, images, stylesheets or even
85   .htaccess files (org => copy). The third component is just for convenience and
86   tells org to execute the former ones.
88   =org-publish-project-alist= may be adjusted using customize (=M-x
89   customize-variable RET org-publish-project-alist RET=), but I prefere to
90   use an extra file to setup my projects, since there are quite a few. To follow
91   this tutorial use the =*scratch*= buffer and put all the Lisp in this section
92   in there.
94   First of all, enter this into the =*scratch*= buffer:
96 #+begin_src emacs-lisp
97 (require 'org-publish)
98 (setq org-publish-project-alist
99       '(
101        ;; ... add all the components here (see below)...
103       ))
104 #+end_src
106   Be sure to put all the /components/ below right there where the comment line
107   is now.
109 ** The /notes/ component
111    The /notes/ component publishes all the Org-mode files to HTML. Hence the
112    =publishing-function= is set to =org-publish-org-to-html=. Here is an example
113    of the notes component:
115 #+begin_src emacs-lisp
116 ("org-notes"
117  :base-directory "~/org/"
118  :base-extension "org"
119  :publishing-directory "~/public_html/"
120  :recursive t
121  :publishing-function org-publish-org-to-html
122  :headline-levels 4             ; Just the default for this project.
123  :auto-preamble t
125 #+end_src
127    Note, that =headline-levels= may be adjusted [[Overwrite the defaults][on a per file basis]] to overwrite
128    the default.
130    The most important settings here are:
132    | =base-directory=       | The components root directory.                                                                                                |
133    | =base-extension=       | Filename suffix without the dot.                                                                                              |
134    | =publishing-directory= | The base directory where all our files will be published.                                                                     |
135    | =recursive=            | If =t=, include subdirectories - we want that. Subdirectories in =:publishing-directory= are created if they don't yet exist. |
136    | =publishing-function=  | If and how org should process the files in this component. In this case: convert the Org-mode files to HTML.                  |
138 ** The /static/ component
140    The /static/ component just copies files (and their folders) from
141    =:base-directory= to =:publishing-directory= without changing them. Thus
142    let's tell Org-mode to use the function =org-publish-attachment=:
144 #+begin_src emacs-lisp
145 ("org-static"
146  :base-directory "~/org/"
147  :base-extension "css\\|js\\|png\\|jpg\\|gif\\|pdf\\|mp3\\|ogg\\|swf"
148  :publishing-directory "~/public_html/"
149  :recursive t
150  :publishing-function org-publish-attachment
152 #+end_src
154    *Note* that =:publishing-function= is set to =org-publish-attachment=.
156 ** The /publish/ component
158    To publish all with one command, we add the /publish/ component. For this
159    component I usually drop the suffix and just use the basename of the
160    project.
162 #+begin_src emacs-lisp
163  ("org" :components ("org-notes" "org-static"))
164 #+end_src
166    Now =M-x org-publish-project RET org RET= publishes everything
167    recursively to =~/public_html/=. Target directories are created, if they
168    don't yet exist.
170 ** Pooh - can we publish now?
172    The good message is *yes, we can*. Just one little hump. Since we've put the
173    definition for our publishing components in the =*scratch*= buffer, again,
174    make shure all the /components/ are enclosed by the lines
176 #+begin_src emacs-lisp
177 (require 'org-publish)
178 (setq org-publish-project-alist
179       '(
181        ;; ... all the components ...
183       ))
184 #+end_src
186    Move to the end of the first line and press =C-x C-e= to load
187    =org-publish=. Now go to the end of the last line and press =C-x C-e=
188    again. Repeat the last step after every change to your
189    =org-publish-project-alist=.
191    To publish your Org-mode files just type
192    =M-x org-publish-project RET org RET= or use one of the shortcuts listed in
193    the manual. If nothing went wrong, you should now be able to point your
194    browser to http://localhost/~user/, if =mod_userdir= is set up. If
195    not, simply navigate to file:///home/user/public_html (you might use
196    /file -> open/ from the file menu of your browser.
198 * Adding directories
200   As we add more and more files to =~/org/=, we will soon end up with filenames
201   like '=networking-ssh-sshd-config.org=' or longer. What we need is a
202   directory structure:
204   :~/org/
205   :   |- css/
206   :   |  `- stylesheet.css
207   :   |- Emacs
208   :   |  |- index.org
209   :   |  |- gnus.org
210   :   |  |- org.org
211   :   |  `- snippets.org
212   :   |- img/
213   :   |- index.org
214   :   `- remember.org
216   If we hadn't added
217   :      :recursive t
218   in the /notes/ and /static/ components already, we would have to do it now at
219   the latest to export the subdirectories too.
221 * Overwrite the defaults
223   The defaults set by =org-publish-project-alist= may be overwritten. You might
224   want to justify the export properties for single files. Be it the level of
225   headlines, include extry scripts or different stylesheets. Org offers ways to adjust
226   the settings for a single file.
228 ** The export options template
230    The first choice is the /export options template/ on top of the file. When in
231    an Org-mode file, =M-x org-insert-export-options-template= does the trick for
232    us. This command adds the following lines to the beginning of our file:
235    : #+TITLE:     filename.org
236    : #+AUTHOR:    Firstename Lastname
237    : #+EMAIL:     arthur-dent@example.tld
238    : #+DATE:      <2008-08-25 Mo>
239    : #+LANGUAGE:  en
240    : #+TEXT:      Some descriptive text to be emitted.  Several lines OK.
241    : #+OPTIONS:   H:3 num:t toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:nil skip:nil d:t tags:not-in-toc
242    : #+INFOJS_OPT: view:nil toc:t ltoc:t mouse:underline buttons:0 path:http://orgmode.org/org-info.js
243    : #+LINK_UP:
244    : #+LINK_HOME:
245    : #+STYLE:    <link rel="stylesheet" type="text/css" href="../stylesheet.css" />
247    All we have to do now is to alter the options to match our needs. All the
248    options are listed in the wonderful Org-mode manual. Note though, that these
249    options are only parsed on startup (i.e., when you first open the file). To
250    explicitly apply your new options move on any of those lines and press =C-c=
251    twice.
253 ** <<<Special comment section>>>
255    Also, CSS style variables may be using a special section may be
256    #insert/appended to Org-mode files:
258    : * COMMENT html style specifications
259    :
260    : # Local Variables:
261    : # org-export-html-style: "<link rel=\"stylesheet\" type=\"text/css\" href=\"css/stylesheet.css\" />"
262    : # End:
264    =css/stylesheet.css= suits the needs for a file in the root folder. Use \\
265    =../css/stylesheet.css= in a subfolder (first level), \\
266    =../../css/stylesheet.css= for a file in a sub-sub-folder.
268 * Tired of export templates?
270  If you're like me, you will soon get tired of adding the same export options
271  template to numerous files and adjust the title and paths in it. Luckily,
272  Org-mode supports laziness and offers an additional way to set up files. All
273  we need is a directory (e.g. =~/.emacs.d/org-templates/=) and create the
274  following files there:
276  + =level-0.org= \\
277    This file contains all export options lines. The special comment section
278    will not work for files in subdirectories. Hence we always use the export
279    options line
280    :#+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
281    ...suitable for each file in the projects root folder
282    (=~/org/= or =~/B/= in the examples). Just drop the =#+TITLE= since this
283    will be different for every file and automatically set on export (based on
284    the filename if omitted).
285  + =level-1.org= \\
286    This file contains all export options lines for the stylesheet suitable for
287    each file in a subfolder of the projects root folder (e.g. =~/org/emacs/=
288    or =~/org/networking/=). Just drop the =#+TITLE= again. The options line
289    for the stylesheet looks like this:
290    :#+STYLE: <link rel="stylesheet" type="text/css" href="../stylesheet.css" />
292  + Add more files for more levels.
294  Now remove the special comment section from the end of your Org-mode files in
295  the project folders and change the export options template to
297  : #+SETUPFILE: ~/.emacs.d/org-templates/level-N.org
298  : #+TITLE: My Title
300  Replace =N= with distance to the root folder (=0=, =1= etc.) of your project
301  and press =C-c= twice while still on this line to apply the
302  changes. Subsequent lines still overwrite the settings for just this one file.
305 ** More level files
307   Also, these /level-N/ files give us the chance to easily switch between different
308   export setups. As an example, we could have a separate stylesheet and
309   =org-info.js= setup for presentations, and put the appropriate options in a
310   file named =level-0-slides.org=:
312   : #+INFOJS_OPT: path:org-info.js
313   : #+INFOJS_OPT: toc:nil view:slide
314   : #+STYLE: <link rel="stylesheet" type="text/css" href="slides.css" />
316   Now it's as simple as typing '/-slides/' to change the appearance of any file
317   in our project.
319 * More Projects
321    As we get used to note taking in org, we might add an =org= directory to most
322    of our projects. All those projects are published as well. Project '=~/B/='
323    is published to '=~/public_html/B/=', '=~/C/=' is published to
324    '=~/public_html/C/=', and so on. This leads to the problem of common
325    stylesheets and current JavaScripts --- and to a new /component/.
327 ** The /inherit/ component
329    Once we get tired of copying the static files from one project to another, the
330    following configuration does the trick for us. We simply add the /inherit/
331    component, that imports all the static files from our =~/org/= directory [fn:4].
332    From now on, it will be sufficient to edit stylesheets and scripts just
333    there.
335 #+begin_src emacs-lisp
336  ("B-inherit"
337   :base-directory "~/org/"
338   :recursive t
339   :base-extension "css\\|js"
340   :publishing-directory "~/public_html/B/"
341   :publishing-function org-publish-attachment
344  ("B-org"
345  :base-directory "~/B/"
346  :auto-index t
347  :index-filename "sitemap.org"
348  :index-title "Sitemap"
349  :recursive t
350  :base-extension "org"
351  :publishing-directory "~/public_html/B/"
352  :publishing-function org-publish-org-to-html
353  :headline-levels 3
354  :auto-preamble t
356  ("B-static"
357   :base-directory "~/B/"
358   :recursive t
359   :base-extension "css\\|js\\|png\\|jpg\\|gif\\|pdf\\|mp3\\|ogg\\|swf"
360   :publishing-directory "~/public_html/B/"
361   :publishing-function org-publish-attachment)
363  ("B" :components ("B-inherit" "B-notes" "B-static"))
364 #+end_src
366    *Note*, that the inheritance trick works for non org directories. You might
367    want to keep all your stylesheets and scripts in a single place, or even add
368    more /inheritance/ to your projects, to import sources from upstream.
370    *Note* also, that =B-inherit= exports directly to the web. If you want to track
371    the changes to =~org/*.css= directly in =~/B=, you must ensure, that =B-inherit= is
372    the first component in =B= since the components in =B= are executed in
373    the sequence listed: first get the new stylesheet into =B=, then execute
374    =B-static=.
376 *** One more Example
378     As I use [[file:../code/org-info-js/index.org][org-info.js]] and track Worg git, I use "=inherit-org-info-js=" in all
379     my =org= projects:
381 #+begin_src emacs-lisp
382  ("inherit-org-info-js"
383   :base-directory "~/develop/org/Worg/code/org-info-js/"
384   :recursive t
385   :base-extension "js"
386   :publishing-directory "~/org/"
387   :publishing-function org-publish-attachment)
389  ;; ... all the rest ... ;;
391  ("B" :components ("inherit-org-info-js" "B-inherit" "B-notes" "B-static"))
392  ("C" :components ("inherit-org-info-js" "C-inherit" "C-notes" "C-static"))
393  ("D" :components ("inherit-org-info-js" "D-inherit" "D-notes" "D-static"))
394  ("E" :components ("inherit-org-info-js" "E-inherit" "E-notes" "E-static"))
395 #+end_src
397     ...means, =B= =C= =D= and =E= use my local stylesheets and always the latest
398     version of =org-info.js=.
400 * Overview
402   Once there are lots of files and subdirectories, we're in the need of ways to
403   easily navigate our notes in a browser. What we need now, is an index, an
404   overview of all our note files.
406 ** The sitemap
408    Org-modes great publishing also generates a recursive sitemap. It's name 
409    defaults to =sitemap.org=, which get's in our way, since we have a real 
410    startpage as =sitemap.html= [fn:5]. Fortunately there is a configuration 
411    option to change the name of the generated sitemap. To generate the sitemap,
412    add these lines to the /notes/ component:
414 #+begin_src emacs-lisp
415  :auto-sitemap t                ; Generate sitemap.org automagically...
416  :sitemap-filename "sitemap.org"  ; ... call it sitemap.org (it's the default)...
417  :sitemap-title "Sitemap"         ; ... with title 'Sitemap'.
418 #+end_src
420    The sitemap will reflect the tree structure of the project. To access the
421    sitemap easily, we could do two things:
423    1. Setup the '/UP/' link of the Startpage to link to =sitemap.html= (see next
424       section),
425    2. use the '=#+INCLUDE: sitemap.org=' directive. Most of my Org-mode files
426       contain a chapter called "/Links/" at the end of the file, which contains
427       a subsection /Sitemap/ that in turn just consists of that
428       diretive. For the =index.org= files in the root directory, I include the
429       sitemap as the first section.
431    You can also change the position of folders with =:sitemap-sort-folders=,
432    this can be set to =last= or =first= (default), to display folders last or 
433    first.
435 ** org-info.js
437    Another way to get additional links to navigate the structure is
438    [[file:../code/org-info-js/index.org][org-info.js]]. Let's set it up like this (either in every file, or in
439    =org-level-N.org=, where =N > 0=):
441    : #+LINK_UP: index.html
443    This makes the little /UP/ link ('=h=') point to the =index.html= in the
444    current directory.
446    The =index.org= in the root of the project has the /index file/ as section 2
447    (which I may reach pressing '=n=' then), and the same option set like this:
449    : #+LINK_UP: sitemap.html
451    For an =index.org= in a subdirectory:
453    : #+LINK_UP: ../index.html
455    The =LINK_HOME= always points to the same file:
457    : #+LINK_HOME: http://localhost/~user/index.html
459    Please consider replacing the last one with a relative path (which will be
460    different for every level of subdirectories).
462    No matter where we are, we may always press =H n= and we face the sitemap.
463    No matter where we are, we may always press =h= to move up the tree.
465 * Special symbols
467   This is a list of LaTeX symbols understood by Org-mode. You may use most of
468   those LaTeX symbols to get the desired results (shown in the first column)
469   when exporting to HTML. Note though, that not all symbols are translated to
470   HTML. They are listed anyway, since they may be used for LaTeX export
471   nonetheless. Some characters in the first column are invisible (spaces). To
472   see them, mark the part of the table using the mouse.
474   You may produce special HTML characters for verbatim =#+BEGIN\_HTML= sections
475   using http://www-atm.physics.ox.ac.uk/user/iwi/charmap.html (download link on
476   the bottom of that page).
479   | Symbol      | LaTeX                    |
480   |-------------+--------------------------|
481   | \nbsp       | ~\nbsp~                  |
482   | \iexcl      | ~\iexcl~                 |
483   | \cent       | ~\cent~                  |
484   | \pound      | ~\pound~                 |
485   | \curren     | ~\curren~                |
486   | \yen        | ~\yen~                   |
487   | \brvbar     | ~\brvbar~                |
488   | \vert       | ~\vert~                  |
489   | \sect       | ~\sect~                  |
490   | \uml        | ~\uml~                   |
491   | \copy       | ~\copy~                  |
492   | \ordf       | ~\ordf~                  |
493   | \laquo      | ~\laquo~                 |
494   | \not        | ~\not~                   |
495   | \shy        | ~\shy~                   |
496   | \reg        | ~\reg~                   |
497   | \macr       | ~\macr~                  |
498   | \deg        | ~\deg~                   |
499   | \plusmn     | ~\plusmn~                |
500   | \sup1       | ~\sup1~                  |
501   | \sup2       | ~\sup2~                  |
502   | \sup3       | ~\sup3~                  |
503   | \acute      | ~\acute~                 |
504   | \micro      | ~\micro~                 |
505   | \para       | ~\para~                  |
506   | \middot     | ~\middot~                |
507   | \odot       | ~\odot~                  |
508   | \star       | ~\star~                  |
509   | \cedil      | ~\cedil~                 |
510   | \ordm       | ~\ordm~                  |
511   | \raquo      | ~\raquo~                 |
512   | \frac14     | ~\frac14~                |
513   | \frac12     | ~\frac12~                |
514   | \frac34     | ~\frac34~                |
515   | \iquest     | ~\iquest~                |
516   | \Agrave     | ~\Agrave~                |
517   | \Aacute     | ~\Aacute~                |
518   | \Acirc      | ~\Acirc~                 |
519   | \Atilde     | ~\Atilde~                |
520   | \Auml       | ~\Auml~                  |
521   | \Aring      | ~\Aring~ ~\AA~           |
522   | \AElig      | ~\AElig~                 |
523   | \Ccedil     | ~\Ccedil~                |
524   | \Egrave     | ~\Egrave~                |
525   | \Eacute     | ~\Eacute~                |
526   | \Ecirc      | ~\Ecirc~                 |
527   | \Euml       | ~\Euml~                  |
528   | \Igrave     | ~\Igrave~                |
529   | \Iacute     | ~\Iacute~                |
530   | \Icirc      | ~\Icirc~                 |
531   | \Iuml       | ~\Iuml~                  |
532   | \ETH        | ~\ETH~                   |
533   | \Ntilde     | ~\Ntilde~                |
534   | \Ograve     | ~\Ograve~                |
535   | \Oacute     | ~\Oacute~                |
536   | \Ocirc      | ~\Ocirc~                 |
537   | \Otilde     | ~\Otilde~                |
538   | \Ouml       | ~\Ouml~                  |
539   | \times      | ~\times~                 |
540   | \Oslash     | ~\Oslash~                |
541   | \Ugrave     | ~\Ugrave~                |
542   | \Uacute     | ~\Uacute~                |
543   | \Ucirc      | ~\Ucirc~                 |
544   | \Uuml       | ~\Uuml~                  |
545   | \Yacute     | ~\Yacute~                |
546   | \THORN      | ~\THORN~                 |
547   | \szlig      | ~\szlig~                 |
548   | \agrave     | ~\agrave~                |
549   | \aacute     | ~\aacute~                |
550   | \acirc      | ~\acirc~                 |
551   | \atilde     | ~\atilde~                |
552   | \auml       | ~\auml~                  |
553   | \aring      | ~\aring~                 |
554   | \aelig      | ~\aelig~                 |
555   | \ccedil     | ~\ccedil~                |
556   | \egrave     | ~\egrave~                |
557   | \eacute     | ~\eacute~                |
558   | \ecirc      | ~\ecirc~                 |
559   | \euml       | ~\euml~                  |
560   | \igrave     | ~\igrave~                |
561   | \iacute     | ~\iacute~                |
562   | \icirc      | ~\icirc~                 |
563   | \iuml       | ~\iuml~                  |
564   | \eth        | ~\eth~                   |
565   | \ntilde     | ~\ntilde~                |
566   | \ograve     | ~\ograve~                |
567   | \oacute     | ~\oacute~                |
568   | \ocirc      | ~\ocirc~                 |
569   | \otilde     | ~\otilde~                |
570   | \ouml       | ~\ouml~                  |
571   | \oslash     | ~\oslash~                |
572   | \ugrave     | ~\ugrave~                |
573   | \uacute     | ~\uacute~                |
574   | \ucirc      | ~\ucirc~                 |
575   | \uuml       | ~\uuml~                  |
576   | \yacute     | ~\yacute~                |
577   | \thorn      | ~\thorn~                 |
578   | \yuml       | ~\yuml~                  |
579   | \fnof       | ~\fnof~                  |
580   | \Alpha      | ~\Alpha~                 |
581   | \Beta       | ~\Beta~                  |
582   | \Gamma      | ~\Gamma~                 |
583   | \Delta      | ~\Delta~                 |
584   | \Epsilon    | ~\Epsilon~               |
585   | \Zeta       | ~\Zeta~                  |
586   | \Eta        | ~\Eta~                   |
587   | \Theta      | ~\Theta~                 |
588   | \Iota       | ~\Iota~                  |
589   | \Kappa      | ~\Kappa~                 |
590   | \Lambda     | ~\Lambda~                |
591   | \Mu         | ~\Mu~                    |
592   | \Nu         | ~\Nu~                    |
593   | \Xi         | ~\Xi~                    |
594   | \Omicron    | ~\Omicron~               |
595   | \Pi         | ~\Pi~                    |
596   | \Rho        | ~\Rho~                   |
597   | \Sigma      | ~\Sigma~                 |
598   | \Tau        | ~\Tau~                   |
599   | \Upsilon    | ~\Upsilon~               |
600   | \Phi        | ~\Phi~                   |
601   | \Chi        | ~\Chi~                   |
602   | \Psi        | ~\Psi~                   |
603   | \Omega      | ~\Omega~                 |
604   | \alpha      | ~\alpha~                 |
605   | \beta       | ~\beta~                  |
606   | \gamma      | ~\gamma~                 |
607   | \delta      | ~\delta~                 |
608   | \epsilon    | ~\epsilon~               |
609   | \varepsilon | ~\varepsilon~            |
610   | \zeta       | ~\zeta~                  |
611   | \eta        | ~\eta~                   |
612   | \theta      | ~\theta~                 |
613   | \iota       | ~\iota~                  |
614   | \kappa      | ~\kappa~                 |
615   | \lambda     | ~\lambda~                |
616   | \mu         | ~\mu~                    |
617   | \nu         | ~\nu~                    |
618   | \xi         | ~\xi~                    |
619   | \omicron    | ~\omicron~               |
620   | \pi         | ~\pi~                    |
621   | \rho        | ~\rho~                   |
622   | \sigmaf     | ~\sigmaf~  ~\varsigma~   |
623   | \sigma      | ~\sigma~                 |
624   | \tau        | ~\tau~                   |
625   | \upsilon    | ~\upsilon~               |
626   | \phi        | ~\phi~                   |
627   | \chi        | ~\chi~                   |
628   | \psi        | ~\psi~                   |
629   | \omega      | ~\omega~                 |
630   | \thetasym   | ~\thetasym~  ~\vartheta~ |
631   | \upsih      | ~\upsih~                 |
632   | \piv        | ~\piv~                   |
633   | \bull       | ~\bull~  ~\bullet~       |
634   | \hellip     | ~\hellip~  ~\dots~       |
635   | \prime      | ~\prime~                 |
636   | \Prime      | ~\Prime~                 |
637   | \oline      | ~\oline~                 |
638   | \frasl      | ~\frasl~                 |
639   | \weierp     | ~\weierp~                |
640   | \image      | ~\image~                 |
641   | \real       | ~\real~                  |
642   | \trade      | ~\trade~                 |
643   | \alefsym    | ~\alefsym~               |
644   | \larr       | ~\larr~                  |
645   | \uarr       | ~\uarr~                  |
646   | \rarr       | ~\rarr~                  |
647   | \darr       | ~\darr~                  |
648   | \harr       | ~\harr~                  |
649   | \crarr      | ~\crarr~                 |
650   | \lArr       | ~\lArr~                  |
651   | \uArr       | ~\uArr~                  |
652   | \rArr       | ~\rArr~                  |
653   | \dArr       | ~\dArr~                  |
654   | \hArr       | ~\hArr~                  |
655   | \forall     | ~\forall~                |
656   | \part       | ~\part~                  |
657   | \exist      | ~\exist~                 |
658   | \empty      | ~\empty~                 |
659   | \nabla      | ~\nabla~                 |
660   | \isin       | ~\isin~                  |
661   | \notin      | ~\notin~                 |
662   | \ni         | ~\ni~                    |
663   | \prod       | ~\prod~                  |
664   | \sum        | ~\sum~                   |
665   | \minus      | ~\minus~                 |
666   | \lowast     | ~\lowast~                |
667   | \radic      | ~\radic~                 |
668   | \prop       | ~\prop~                  |
669   | \infin      | ~\infin~                 |
670   | \ang        | ~\ang~                   |
671   | \cap        | ~\cap~                   |
672   | \cup        | ~\cup~                   |
673   | \int        | ~\int~                   |
674   | \there4     | ~\there4~                |
675   | \sim        | ~\sim~                   |
676   | \cong       | ~\cong~                  |
677   | \asymp      | ~\asymp~                 |
678   | \ne         | ~\ne~                    |
679   | \equiv      | ~\equiv~                 |
680   | \le         | ~\le~                    |
681   | \ge         | ~\ge~                    |
682   | \sub        | ~\sub~                   |
683   | \sup        | ~\sup~                   |
684   | \nsub       | ~\nsub~                  |
685   | \sube       | ~\sube~                  |
686   | \supe       | ~\supe~                  |
687   | \oplus      | ~\oplus~                 |
688   | \otimes     | ~\otimes~                |
689   | \perp       | ~\perp~                  |
690   | \sdot       | ~\sdot~                  |
691   | \lceil      | ~\lceil~                 |
692   | \rceil      | ~\rceil~                 |
693   | \lfloor     | ~\lfloor~                |
694   | \rfloor     | ~\rfloor~                |
695   | \lang       | ~\lang~                  |
696   | \rang       | ~\rang~                  |
697   | \loz        | ~\loz~                   |
698   | \spades     | ~\spades~                |
699   | \clubs      | ~\clubs~                 |
700   | \hearts     | ~\hearts~                |
701   | \diams      | ~\diams~                 |
702   | \smile      | ~\smile~                 |
703   | \quot       | ~\quot~                  |
704   | \amp        | ~\amp~                   |
705   | \lt         | ~\lt~                    |
706   | \gt         | ~\gt~                    |
707   | \OElig      | ~\OElig~                 |
708   | \oelig      | ~\oelig~                 |
709   | \Scaron     | ~\Scaron~                |
710   | \scaron     | ~\scaron~                |
711   | \Yuml       | ~\Yuml~                  |
712   | \circ       | ~\circ~                  |
713   | \tilde      | ~\tilde~                 |
714   | \ensp       | ~\ensp~                  |
715   | \emsp       | ~\emsp~                  |
716   | \thinsp     | ~\thinsp~                |
717   | \zwnj       | ~\zwnj~                  |
718   | \zwj        | ~\zwj~                   |
719   | \lrm        | ~\lrm~                   |
720   | \rlm        | ~\rlm~                   |
721   | \ndash      | ~\ndash~                 |
722   | \mdash      | ~\mdash~                 |
723   | \lsquo      | ~\lsquo~                 |
724   | \rsquo      | ~\rsquo~                 |
725   | \sbquo      | ~\sbquo~                 |
726   | \ldquo      | ~\ldquo~                 |
727   | \rdquo      | ~\rdquo~                 |
728   | \bdquo      | ~\bdquo~                 |
729   | \dagger     | ~\dagger~                |
730   | \Dagger     | ~\Dagger~                |
731   | \permil     | ~\permil~                |
732   | \lsaquo     | ~\lsaquo~                |
733   | \rsaquo     | ~\rsaquo~                |
734   | \euro       | ~\euro~                  |
735   | \arccos     | ~\arccos~                |
736   | \arcsin     | ~\arcsin~                |
737   | \arctan     | ~\arctan~                |
738   | \arg        | ~\arg~                   |
739   | \cos        | ~\cos~                   |
740   | \cosh       | ~\cosh~                  |
741   | \cot        | ~\cot~                   |
742   | \coth       | ~\coth~                  |
743   | \csc        | ~\csc~                   |
744   | \deg        | ~\deg~                   |
745   | \det        | ~\det~                   |
746   | \dim        | ~\dim~                   |
747   | \exp        | ~\exp~                   |
748   | \gcd        | ~\gcd~                   |
749   | \hom        | ~\hom~                   |
750   | \inf        | ~\inf~                   |
751   | \ker        | ~\ker~                   |
752   | \lg         | ~\lg~                    |
753   | \lim        | ~\lim~                   |
754   | \liminf     | ~\liminf~                |
755   | \limsup     | ~\limsup~                |
756   | \ln         | ~\ln~                    |
757   | \log        | ~\log~                   |
758   | \max        | ~\max~                   |
759   | \min        | ~\min~                   |
760   | \Pr         | ~\Pr~                    |
761   | \sec        | ~\sec~                   |
762   | \sin        | ~\sin~                   |
763   | \sinh       | ~\sinh~                  |
764   | \tan        | ~\tan~                   |
765   | \tanh       | ~\tanh~                  |
768 * Further reading
770    For more information you might want to read the great [[http://orgmode.org/manual/][Org-mode manual]]
771    ([[http://orgmode.org/#sec-4][download]]). One of the nicest mailing lists on this planet, BTW, is
772    [[http://lists.gnu.org/archive/html/emacs-orgmode/][emacs-orgmode (archive)]] where you might as well find answers to your
773    questions.
776    Have fun!
781 * Footnotes
783 [fn:1]  You may customize the file suffix for exported files like this:
784  =M-x customize RET org-export-html-extension=.
786 [fn:2]  ...by typing =M-x iimage-mode RET=. iimage-mode even shows *.svg images, if
787  =librsvg= was present on compile time. FIXME: is this true for emacs22 ?
789 [fn:3]  All components of =org-publish-projects-alist= are documented in the [[http://orgmode.org/manual/Project-alist.html#Project-alist][Org Mode
790     Manual]].
792 [fn:4]  Files may be copied from arbitrary src directories to any target directory
793  desired.
795 [fn:5]  This is primarily because of the behaviour of servers. When we navigate
796  to http://orgmode.org/worg/ we will face the =index.html= if present.