From 92269ce6375d782b05399e733622b313610338ec Mon Sep 17 00:00:00 2001 From: Carsten Dominik Date: Thu, 8 May 2008 17:16:29 +0200 Subject: [PATCH] Add some index entries. --- doc/org.texi | 51 ++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 42 insertions(+), 9 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 0a1104613..6460688dd 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -3962,6 +3962,7 @@ exported or printed directly. If you want to capture a column view, use this @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame of this block looks like this: +@cindex #+BEGIN: columnview @example * The column view #+BEGIN: columnview :hlines 1 :id "label" @@ -4579,6 +4580,7 @@ report as an Org mode table into the current file. When the cursor is at an existing clock table, just update it. When called with a prefix argument, jump to the first clock report in the current document and update it. +@cindex #+BEGIN: clocktable @example #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file #+END: clocktable @@ -6633,6 +6635,7 @@ markup rule used in an Org mode buffer. @node Document title, Headings and sections, Markup rules, Markup rules @subheading Document title +@cindex document title, markup rules @noindent The title of the exported document is taken from the special line @@ -6652,6 +6655,7 @@ of the subtree will become the title of the document. @node Headings and sections, Table of contents, Document title, Markup rules @subheading Headings and sections +@cindex headings and sections, markup rules The outline structure of the document as described in @ref{Document Structure} forms the basis for defining sections of the exported document. @@ -6667,6 +6671,7 @@ per file basis with a line @node Table of contents, Initial text, Headings and sections, Markup rules @subheading Table of contents +@cindex table of contents, markup rules The table of contents is normally inserted directly before the first headline of the file. If you would like to get it to a different location, insert the @@ -6683,6 +6688,8 @@ the table of contents entirely by configuring the variable @node Initial text, Lists, Table of contents, Markup rules @subheading Text before the first headline +@cindex text before first headline, markup rules +@cindex #+TEXT Org mode normally exports the text before the first headline, and even uses the first line as the document title. The text will be fully marked up. If @@ -6708,6 +6715,7 @@ If you still want to have some text before the first headline, use the @node Lists, Paragraphs, Initial text, Markup rules @subheading Lists +@cindex lists, markup rules Plain lists as described in @ref{Plain lists} are translated to the back-ends syntax for such lists. Most back-ends support unordered, ordered, and @@ -6715,6 +6723,7 @@ description lists. @node Paragraphs, Literal examples, Lists, Markup rules @subheading Paragraphs, line breaks, and quoting +@cindex paragraphs, markup rules Paragraphs are separated by at least one empty line. If you need to enforce a line break within a paragraph, use @samp{\\} at the end of a line. @@ -6732,10 +6741,12 @@ but not any simpler -- Albert Einstein @node Literal examples, Include files, Paragraphs, Markup rules @subheading Literal examples +@cindex literal examples, markup rules You can include literal examples that should not be subjected to markup. Such examples will be typeset in monospace, so this is well suited for source code and similar examples. +@cindex #+BEGIN_EXAMPLE @example #+begin_example @@ -6750,6 +6761,7 @@ lines with a colon: : Some example from a text file. @end example +@cindex formatting source code, markup rules If the example is source code from a programming language, or any other text that can be marked up by font-lock in Emacs, you can ask for the example to look like the fontified Emacs buffer@footnote{Currently this works only for @@ -6757,6 +6769,7 @@ the HTML back-end, and requires the @file{htmlize.el} package version 1.34 or later.}. This is done with the @samp{src} block, where you also need to specify the name of the major mode that should be used to fontify the example: +@cindex #+BEGIN_SRC @example #+begin_src emacs-lisp @@ -6768,9 +6781,11 @@ example: @node Include files, Tables exported, Literal examples, Markup rules @subheading Include files +@cindex include files, markup rules During export, you can include the content of another file. For example, to include your .emacs file, you could use: +@cindex #+INCLUDE @example #+include "~/.emacs" src emacs-lisp @@ -6784,6 +6799,7 @@ processed normally. @node Tables exported, Footnotes, Include files, Markup rules @subheading Tables +@cindex tables, markup rules Both the native Org mode tables (@pxref{Tables}) and tables formatted with the @file{table.el} package will be exported properly. For Org mode tables, @@ -6792,7 +6808,7 @@ lines. @node Footnotes, Emphasis and monospace, Tables exported, Markup rules @subheading Footnotes -@cindex footnotes +@cindex footnotes, markup rules @cindex @file{footnote.el} @kindex C-c ! @@ -6815,10 +6831,12 @@ The Org homepage[1] now looks a lot better than it used to. @node Emphasis and monospace, TeX macros and LaTeX fragments, Footnotes, Markup rules @subheading Emphasis and monospace -@cindex underlined text -@cindex bold text -@cindex italic text -@cindex verbatim text +@cindex underlined text, markup rules +@cindex bold text, markup rules +@cindex italic text, markup rules +@cindex verbatim text, markup rules +@cindex code text, markup rules +@cindex strike-through text, markup rules You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=} and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text in the code and verbatim string is not processed for Org mode specific @@ -6826,8 +6844,8 @@ syntax, it is exported verbatim. @node TeX macros and LaTeX fragments, Horizontal rules, Emphasis and monospace, Markup rules @subheading @TeX{} macros and La@TeX{} fragments -@cindex LaTeX fragments, export -@cindex TeX macros, export +@cindex LaTeX fragments, markup rules +@cindex TeX macros, markup rules @cindex HTML entities @cindex LaTeX entities @@ -6851,7 +6869,7 @@ different lengths or a compact set of dots. @node Horizontal rules, Comment lines, TeX macros and LaTeX fragments, Markup rules @subheading Horizontal rules -@cindex horizontal rules, in exported files +@cindex horizontal rules, markup rules A line consisting of only dashes, and at least 5 of them, will be exported as a horizontal line (@samp{
} in HTML). @@ -6888,6 +6906,15 @@ correct is to type @samp{#+} and then use @kbd{M-@key{TAB}} completion Insert template with export options, see example below. @end table +@cindex #+TITLE: +@cindex #+AUTHOR: +@cindex #+DATE: +@cindex #+EMAIL: +@cindex #+LANGUAGE: +@cindex #+TEXT: +@cindex #+OPTIONS: +@cindex #+LINK_UP: +@cindex #+LINK_HOME: @example #+TITLE: the title to be shown (default is the buffer name) #+AUTHOR: the author (default taken from @code{user-full-name}) @@ -6897,6 +6924,8 @@ Insert template with export options, see example below. #+TEXT: Some descriptive text to be inserted at the beginning. #+TEXT: Several lines may be given. #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... +#+LINK_UP: the ``up'' link of an exported page +#+LINK_HOME: the ``home'' link of an exported page @end example @noindent @@ -6944,9 +6973,9 @@ These options take effect in both the HTML and La@TeX{} export, except for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and @code{nil} for the La@TeX{} export. - @node The export dispatcher, ASCII export, Export options, Exporting @section The export dispatcher +@cindex dispatcher, for export commands All export commands can be reached using the export dispatcher, which is a prefix key that prompts for an additional key specifying the command. @@ -7108,6 +7137,7 @@ the exported file use either @end example @noindent or +@cindex #+BEGIN_HTML @example #+BEGIN_HTML @@ -7325,6 +7355,7 @@ constructs: @end example @noindent or +@cindex #+BEGIN_LaTeX @example #+BEGIN_LaTeX @@ -8591,6 +8622,7 @@ modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will be prompted for a table name, lets say we use @samp{salesfigures}. You will then get the following template: +@cindex #+ORGTBL: SEND @example % BEGIN RECEIVE ORGTBL salesfigures % END RECEIVE ORGTBL salesfigures @@ -8814,6 +8846,7 @@ Dynamic block are enclosed by a BEGIN-END structure that assigns a name to the block and can also specify parameters for the function producing the content of the block. +#+BEGIN:dynamic block @example #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...