summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <n.goaziou@gmail.com>2013-10-20 10:58:30 +0200
committerNicolas Goaziou <n.goaziou@gmail.com>2013-10-20 11:00:05 +0200
commite5cecc5d341e8d44f29fdd3d27d0441010f8907a (patch)
tree55e3f47bb3eefbb31f6ce47433384a20b4f99aa2
parent5394f15e51af7aa28611b6a9c69e8b2dcdf6f98d (diff)
downloadorg-mode-e5cecc5d341e8d44f29fdd3d27d0441010f8907a.tar.gz
export back-ends: Remove duplicate information
* lisp/ox-ascii.el: Remove comments at the beginning of the file since the library is documented in Org manual. * lisp/ox-beamer.el: Remove comments at the beginning of the file since the library is documented in Org manual. * lisp/ox-html.el: Remove comments at the beginning of the file since the library is documented in Org manual. * lisp/ox-icalendar.el: Remove comments at the beginning of the file since the library is documented in Org manual. * lisp/ox-md.el: Remove comments at the beginning of the file since the library is documented in Org manual.
-rw-r--r--lisp/ox-ascii.el14
-rw-r--r--lisp/ox-beamer.el88
-rw-r--r--lisp/ox-html.el8
-rw-r--r--lisp/ox-icalendar.el18
-rw-r--r--lisp/ox-md.el7
5 files changed, 7 insertions, 128 deletions
diff --git a/lisp/ox-ascii.el b/lisp/ox-ascii.el
index 74a7c64..32262cc 100644
--- a/lisp/ox-ascii.el
+++ b/lisp/ox-ascii.el
@@ -21,19 +21,7 @@
;;; Commentary:
;;
;; This library implements an ASCII back-end for Org generic exporter.
-;;
-;; It provides two commands for export, depending on the desired
-;; output: `org-ascii-export-as-ascii' (temporary buffer) and
-;; `org-ascii-export-to-ascii' ("txt" file). Also, three publishing
-;; functions are available: `org-ascii-publish-to-ascii',
-;; `org-ascii-publish-to-latin1' and `org-ascii-publish-to-utf8'.
-;;
-;; Output encoding is specified through `org-ascii-charset' variable,
-;; among `ascii', `latin1' and `utf-8' symbols.
-;;
-;; By default, horizontal rules span over the full text with, but with
-;; a given width attribute (set though #+ATTR_ASCII: :width <num>)
-;; they can be shortened and centered.
+;; See Org manual for more information.
;;; Code:
diff --git a/lisp/ox-beamer.el b/lisp/ox-beamer.el
index 74d99ed..c5074f6 100644
--- a/lisp/ox-beamer.el
+++ b/lisp/ox-beamer.el
@@ -23,93 +23,7 @@
;;
;; This library implements both a Beamer back-end, derived from the
;; LaTeX one and a minor mode easing structure edition of the
-;; document.
-;;
-;; Depending on the desired output format, three commands are provided
-;; for export: `org-beamer-export-as-latex' (temporary buffer),
-;; `org-beamer-export-to-latex' ("tex" file) and
-;; `org-beamer-export-to-pdf' ("pdf" file).
-;;
-;; This back-end supports every buffer keyword, attribute and options
-;; items (see `org-latex-options-alist') already supported by `latex'
-;; back-end. As such, it is suggested to add an entry in
-;; `org-latex-classes' variable which is appropriate for Beamer
-;; export.
-;;
-;; On top of this, the `beamer' back-end also introduces the following
-;; keywords: "BEAMER_THEME", "BEAMER_COLOR_THEME",
-;; "BEAMER_FONT_THEME", "BEAMER_INNER_THEME", "BEAMER_OUTER_THEME" and
-;; "BEAMER_HEADER". All but the latter accept options in square
-;; brackets.
-;;
-;; Moreover, headlines now fall into three categories: sectioning
-;; elements, frames and blocks.
-;;
-;; - Headlines become frames when their level is equal to
-;; `org-beamer-frame-level' (or "H" value in the OPTIONS line).
-;; Though, if a headline in the current tree has a "BEAMER_env"
-;; (see below) property set to either "frame" or "fullframe", its
-;; level overrides the variable. A "fullframe" is a frame with an
-;; empty (ignored) title.
-;;
-;; - All frames' children become block environments. Special block
-;; types can be enforced by setting headline's "BEAMER_env" property
-;; to an appropriate value (see `org-beamer-environments-default'
-;; for supported value and `org-beamer-environments-extra' for
-;; adding more).
-;;
-;; - As a special case, if the "BEAMER_env" property is set to either
-;; "appendix", "note", "noteNH" or "againframe", the headline will
-;; become, respectively, an appendix, a note (within frame or
-;; between frame, depending on its level), a note with its title
-;; ignored or an againframe command. In the latter case,
-;; a "BEAMER_ref" property is mandatory in order to refer to the
-;; frame being resumed, and contents are ignored.
-;;
-;; Also, a headline with an "ignoreheading" environment will have
-;; its contents only inserted in the output. This special value is
-;; useful to have data between frames, or to properly close
-;; a "column" environment.
-;;
-;; Along with "BEAMER_env", headlines also support the "BEAMER_act"
-;; and "BEAMER_opt" properties. The former is translated as an
-;; overlay/action specification (or a default overlay specification
-;; when enclosed within square brackets) whereas the latter specifies
-;; options for the current frame ("fragile" option is added
-;; automatically, though).
-;;
-;; Moreover, headlines handle the "BEAMER_col" property. Its value
-;; should be a decimal number representing the width of the column as
-;; a fraction of the total text width. If the headline has no
-;; specific environment, its title will be ignored and its contents
-;; will fill the column created. Otherwise, the block will fill the
-;; whole column and the title will be preserved. Two contiguous
-;; headlines with a non-nil "BEAMER_col" value share the same
-;; "columns" LaTeX environment. It will end before the next headline
-;; without such a property. This environment is generated
-;; automatically. Although, it can also be explicitly created, with
-;; a special "columns" value for "BEAMER_env" property (if it needs to
-;; be set up with some specific options, for example).
-;;
-;; Every plain list has support for `:environment', `:overlay' and
-;; `:options' attributes (through ATTR_BEAMER affiliated keyword).
-;; The first one allows to use a different environment, the second
-;; sets overlay specifications and the last one inserts optional
-;; arguments in current list environment.
-;;
-;; Table of contents generated from "toc:t" option item are wrapped
-;; within a "frame" environment. Those generated from a TOC keyword
-;; aren't. TOC keywords accept options enclosed within square
-;; brackets (e.g. #+TOC: headlines [currentsection]).
-;;
-;; Eventually, an export snippet with a value enclosed within angular
-;; brackets put at the beginning of an element or object whose type is
-;; among `bold', `item', `link', `radio-target' and `target' will
-;; control its overlay specifications.
-;;
-;; On the minor mode side, `org-beamer-select-environment' (bound by
-;; default to "C-c C-b") and `org-beamer-insert-options-template' are
-;; the two entry points.
+;; document. See Org manual for more information.
;;; Code:
diff --git a/lisp/ox-html.el b/lisp/ox-html.el
index 14b31b2..afc2437 100644
--- a/lisp/ox-html.el
+++ b/lisp/ox-html.el
@@ -22,13 +22,7 @@
;;; Commentary:
;; This library implements a HTML back-end for Org generic exporter.
-
-;; To test it, run:
-;;
-;; M-x org-html-export-as-html
-;;
-;; in an Org mode buffer. See ox.el for more details on how this
-;; exporter works.
+;; See Org manual for more information.
;;; Code:
diff --git a/lisp/ox-icalendar.el b/lisp/ox-icalendar.el
index 612fd79..8dfe836 100644
--- a/lisp/ox-icalendar.el
+++ b/lisp/ox-icalendar.el
@@ -23,23 +23,9 @@
;;; Commentary:
;;
;; This library implements an iCalendar back-end for Org generic
-;; exporter.
+;; exporter. See Org manual for more information.
;;
-;; It provides three commands for export, depending on the chosen
-;; source and desired output: `org-icalendar-export-to-ics' (current
-;; file), `org-icalendar-export-agenda-files' (agenda files into
-;; separate calendars) and `org-icalendar-combined-agenda-file'
-;; (agenda files into one combined calendar).
-;;
-;; It also provides `org-icalendar-export-current-agenda' function,
-;; which will create a calendar file from current agenda view. It is
-;; meant to be called through `org-agenda-write'.
-;;
-;; This back-end introduces a new keyword, ICALENDAR_EXCLUDE_TAGS,
-;; which allows to specify a different set of exclude tags from other
-;; back-ends.
-;;
-;; It should follow RFC 5545 specifications.
+;; It is expected to conform to RFC 5545.
;;; Code:
diff --git a/lisp/ox-md.el b/lisp/ox-md.el
index f7e4875..7d54078 100644
--- a/lisp/ox-md.el
+++ b/lisp/ox-md.el
@@ -21,11 +21,8 @@
;;; Commentary:
;; This library implements a Markdown back-end (vanilla flavour) for
-;; Org exporter, based on `html' back-end.
-;;
-;; It provides two commands for export, depending on the desired
-;; output: `org-md-export-as-markdown' (temporary buffer) and
-;; `org-md-export-to-markdown' ("md" file).
+;; Org exporter, based on `html' back-end. See Org manual for more
+;; information.
;;; Code: