ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
org-mode/lisp/org-exp.el

3321 lines
124 KiB
EmacsLisp
Raw Normal View History

Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;;; org-exp.el --- ASCII, HTML, XOXO and iCalendar export for Org-mode
Fix copyright years for elisp files in core and contrib. Also add "This file is not part of GNU Emacs." when this is the case.
2011-08-15 09:23:11 -04:00
;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
;;
;; This file is part of GNU Emacs.
;;
Sync copyright fixes from downstream Emacs
2008-05-06 08:45:52 -04:00
;; GNU Emacs is free software: you can redistribute it and/or modify
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; it under the terms of the GNU General Public License as published by
Sync copyright fixes from downstream Emacs
2008-05-06 08:45:52 -04:00
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
Sync copyright fixes from downstream Emacs
2008-05-06 08:45:52 -04:00
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Commentary:
Correct some docstrings [part 2] This is a second patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil
2010-07-15 18:54:53 -04:00
;;; Code:
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(require 'org)
Add a (require org-macs) in org-exp.el
2009-09-23 09:45:49 -04:00
(require 'org-macs)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(require 'org-agenda)
Move org-exp-blocks.el into the core
2009-06-11 10:17:50 -04:00
(require 'org-exp-blocks)
integrating org-babel into org.el
2010-06-23 14:24:33 -04:00
(require 'ob-exp)
Keep byte compiler happy
2009-11-05 12:43:28 -05:00
(require 'org-src)
Correct some docstrings [part 2] This is a second patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil
2010-07-15 18:54:53 -04:00
Release 6.30a
2009-09-02 03:00:23 -04:00
(eval-when-compile
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(require 'cl))
Rename org-export-latex.el to org-latex.el For consistency, this file gets a new name.
2009-04-09 11:25:44 -04:00
(declare-function org-export-latex-preprocess "org-latex" (parameters))
iCalendar and XOXO export: Functions moved to new files.
2009-04-07 13:08:24 -04:00
(declare-function org-export-ascii-preprocess "org-ascii" (parameters))
HTML export: moved functions to separate file.
2009-04-07 13:55:32 -04:00
(declare-function org-export-html-preprocess "org-html" (parameters))
preparatory work
2009-03-18 08:49:02 -04:00
(declare-function org-export-docbook-preprocess "org-docbook" (parameters))
Cleanup after name change.
2008-05-08 08:45:47 -04:00
(declare-function org-infojs-options-inbuffer-template "org-jsinfo" ())
HTML export: moved functions to separate file.
2009-04-07 13:55:32 -04:00
(declare-function org-export-htmlize-region-for-paste "org-html" (beg end))
Apply fixes from downstream Emacs Patch by Glen Morris
2009-09-30 03:20:28 -04:00
(declare-function htmlize-buffer "ext:htmlize" (&optional buffer))
Minor fixes
2009-10-15 01:59:15 -04:00
(declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
Automatically remove lines with formatting cookies when exporting tables Lines that only contain formatting cookies like <l20> or <10> will now be removed automatically. Optionally, the first field in a row can also be "/".
2010-04-27 06:13:27 -04:00
(declare-function org-table-cookie-line-p "org-table" (line))
(declare-function org-table-colgroup-line-p "org-table" (line))
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
(declare-function org-pop-to-buffer-same-window "org-compat"
Fix (a lot of) compiler warnings. Also introduce `org-pop-to-buffer-same-window' as a compatibility function for Emacs =>24.1.
2011-07-18 13:25:10 -04:00
(&optional buffer-or-name norecord label))
Add Wes Hardaker's generic exporter as a contributed package
2009-06-20 14:53:03 -04:00
(autoload 'org-export-generic "org-export-generic" "Export using the generic exporter" t)
org-export: Reserve a slot for OpenDocumentExporter PATCH-1/5 for org-odt compatibility From 06379ccef996e8dabd8dcced6cbe430aacdef3f0 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 01:53:37 +0530 Subject: [PATCH 1/5] org-export: Reserve a slot for OpenDocumentExporter. * lisp/org-exp.el (org-export): Reserve keys 'o' and 'O' for OpenDocumentText export and bind them to org-export-as-odt and org-export-as-odt-and-open.
2011-06-23 11:52:22 -04:00
(autoload 'org-export-as-odt "org-odt"
org-exp.el: s/OpenDocumentText/OpenDocument Text/
2011-12-04 15:58:13 -05:00
"Export the outline to a OpenDocument Text file." t)
org-export: Reserve a slot for OpenDocumentExporter PATCH-1/5 for org-odt compatibility From 06379ccef996e8dabd8dcced6cbe430aacdef3f0 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 01:53:37 +0530 Subject: [PATCH 1/5] org-export: Reserve a slot for OpenDocumentExporter. * lisp/org-exp.el (org-export): Reserve keys 'o' and 'O' for OpenDocumentText export and bind them to org-export-as-odt and org-export-as-odt-and-open.
2011-06-23 11:52:22 -04:00
(autoload 'org-export-as-odt-and-open "org-odt"
org-exp.el: s/OpenDocumentText/OpenDocument Text/
2011-12-04 15:58:13 -05:00
"Export the outline to a OpenDocument Text file and open it." t)
org-export: Reserve a slot for OpenDocumentExporter PATCH-1/5 for org-odt compatibility From 06379ccef996e8dabd8dcced6cbe430aacdef3f0 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 01:53:37 +0530 Subject: [PATCH 1/5] org-export: Reserve a slot for OpenDocumentExporter. * lisp/org-exp.el (org-export): Reserve keys 'o' and 'O' for OpenDocumentText export and bind them to org-export-as-odt and org-export-as-odt-and-open.
2011-06-23 11:52:22 -04:00
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defgroup org-export nil
"Options for exporting org-listings."
:tag "Org Export"
:group 'org)
(defgroup org-export-general nil
"General options for exporting Org-mode files."
:tag "Org Export General"
:group 'org-export)
Make #+BIND work correctly, and ask the user to confirm using BIND.
2009-08-05 10:30:02 -04:00
(defcustom org-export-allow-BIND 'confirm
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means allow #+BIND to define local variable values for export.
Make #+BIND work correctly, and ask the user to confirm using BIND.
2009-08-05 10:30:02 -04:00
This is a potential security risk, which is why the user must confirm the
use of these lines."
:group 'org-export-general
:type '(choice
(const :tag "Never" nil)
(const :tag "Always" t)
(const :tag "Make the user confirm for each file" confirm)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; FIXME
(defvar org-export-publishing-directory nil)
Export: Make all export commands push the result to the kill ring All export commands now push the result to the kill ring by default. This is subject to the variable `org-export-push-to-kill-ring'. Also, this commit adds a new variable `org-export-show-temporary-export-buffer' which can be used to turn off the display of the temporary buffer containing the exported text. Since this stuff is now automatically pushed onto the kill ring, some people might prefer not to see this buffer.
2009-05-21 03:14:33 -04:00
(defcustom org-export-show-temporary-export-buffer t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means show buffer after exporting to temp buffer.
Export: Make all export commands push the result to the kill ring All export commands now push the result to the kill ring by default. This is subject to the variable `org-export-push-to-kill-ring'. Also, this commit adds a new variable `org-export-show-temporary-export-buffer' which can be used to turn off the display of the temporary buffer containing the exported text. Since this stuff is now automatically pushed onto the kill ring, some people might prefer not to see this buffer.
2009-05-21 03:14:33 -04:00
When Org exports to a file, the buffer visiting that file is ever
shown, but remains buried. However, when exporting to a temporary
buffer, that buffer is popped up in a second window. When this variable
is nil, the buffer remains buried also in these cases."
:group 'org-export-general
:type 'boolean)
(defcustom org-export-copy-to-kill-ring t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means exported stuff will also be pushed onto the kill ring."
Export: Make all export commands push the result to the kill ring All export commands now push the result to the kill ring by default. This is subject to the variable `org-export-push-to-kill-ring'. Also, this commit adds a new variable `org-export-show-temporary-export-buffer' which can be used to turn off the display of the temporary buffer containing the exported text. Since this stuff is now automatically pushed onto the kill ring, some people might prefer not to see this buffer.
2009-05-21 03:14:33 -04:00
:group 'org-export-general
:type 'boolean)
Export: Kill product buffer if it has been displayed directly Request by Livin Stephen Sharma
2010-02-21 03:19:21 -05:00
(defcustom org-export-kill-product-buffer-when-displayed nil
"Non-nil means kill the product buffer if it is displayed immediately.
Fix docstring.
2011-03-04 19:27:13 -05:00
This applied to the commands `org-export-as-html-and-open' and
Export: Kill product buffer if it has been displayed directly Request by Livin Stephen Sharma
2010-02-21 03:19:21 -05:00
`org-export-as-pdf-and-open'."
:group 'org-export-general
:type 'boolean)
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
(defcustom org-export-run-in-background nil
"Non-nil means export and publishing commands will run in background.
This works by starting up a separate Emacs process visiting the same file
and doing the export from there.
Not all export commands are affected by this - only the ones which
actually write to a file, and that do not depend on the buffer state.
Correct some docstrings [part 2] This is a second patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil
2010-07-15 18:54:53 -04:00
\\<org-mode-map>
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
If this option is nil, you can still get background export by calling
Correct some docstrings [part 2] This is a second patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil
2010-07-15 18:54:53 -04:00
`org-export' with a double prefix arg: \
\\[universal-argument] \\[universal-argument] \\[org-export].
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
If this option is t, the double prefix can be used to exceptionally
force an export command into the current process."
:group 'org-export-general
:type 'boolean)
New variable to set the initial export scope. * org-exp.el (org-export-initial-scope): new custom variable. (org-export): Use this new variable. If there is an active region, tell it when prompting the user for an export command. Also change the way the function handles selection of buffer and subtree export. ---- Now `1' switches between subtree/buffer export until the user select an export command. Also, when there is an active region, modify the message so that the user is aware he will only export the surrounding subtree.
2011-02-11 04:44:35 -05:00
(defcustom org-export-initial-scope 'buffer
"The initial scope when exporting with `org-export'.
This variable can be either set to 'buffer or 'subtree."
:group 'org-export-general
:type '(choice
(const :tag "Export current buffer" 'buffer)
(const :tag "Export current subtree" 'subtree)))
Get rid of some compiler messages by fixing bugs and definitions.
2008-09-17 07:55:59 -04:00
(defcustom org-export-select-tags '("export")
"Tags that select a tree for export.
If any such tag is found in a buffer, all trees that do not carry one
of these tags will be deleted before export.
Inside trees that are selected like this, you can still deselect a
Fix typo.
2008-10-26 01:58:28 -04:00
subtree by tagging it with one of the `org-export-exclude-tags'."
Get rid of some compiler messages by fixing bugs and definitions.
2008-09-17 07:55:59 -04:00
:group 'org-export-general
:type '(repeat (string :tag "Tag")))
(defcustom org-export-exclude-tags '("noexport")
"Tags that exclude a tree from export.
All trees carrying any of these tags will be excluded from export.
Fix typos in org-exp.el
2008-12-16 10:30:46 -05:00
This is without condition, so even subtrees inside that carry one of the
Get rid of some compiler messages by fixing bugs and definitions.
2008-09-17 07:55:59 -04:00
`org-export-select-tags' will be removed."
:group 'org-export-general
:type '(repeat (string :tag "Tag")))
HTML export: moved functions to separate file.
2009-04-07 13:55:32 -04:00
;; FIXME: rename, this is a general variable
(defcustom org-export-html-expand t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means for HTML export, treat @<...> as HTML tag.
HTML export: moved functions to separate file.
2009-04-07 13:55:32 -04:00
When nil, these tags will be exported as plain text and therefore
not be interpreted by a browser.
This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
:group 'org-export-html
:group 'org-export-general
:type 'boolean)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defcustom org-export-with-special-strings t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means interpret \"\-\", \"--\" and \"---\" for export.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
When this option is turned on, these strings will be exported as:
Org HTML LaTeX
-----+----------+--------
\\- &shy; \\-
-- &ndash; --
--- &mdash; ---
... &hellip; \ldots
This option can also be set with the +OPTIONS line, e.g. \"-:nil\"."
:group 'org-export-translation
:type 'boolean)
HTML export: moved functions to separate file.
2009-04-07 13:55:32 -04:00
(defcustom org-export-html-link-up ""
"Where should the \"UP\" link of exported HTML pages lead?"
:group 'org-export-html
:group 'org-export-general
:type '(string :tag "File or URL"))
(defcustom org-export-html-link-home ""
"Where should the \"HOME\" link of exported HTML pages lead?"
:group 'org-export-html
:group 'org-export-general
:type '(string :tag "File or URL"))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defcustom org-export-language-setup
More language specifications of HTML export.
2008-11-10 12:01:44 -05:00
'(("en" "Author" "Date" "Table of Contents" "Footnotes")
Add Catalan and Esperanto language entries for HTML export.
2008-11-11 00:46:01 -05:00
("ca" "Autor" "Data" "&Iacute;ndex" "Peus de p&agrave;gina")
More language specifications of HTML export.
2008-11-10 12:01:44 -05:00
("cs" "Autor" "Datum" "Obsah" "Pozn\xe1mky pod carou")
("da" "Ophavsmand" "Dato" "Indhold" "Fodnoter")
("de" "Autor" "Datum" "Inhaltsverzeichnis" "Fu&szlig;noten")
Add Catalan and Esperanto language entries for HTML export.
2008-11-11 00:46:01 -05:00
("eo" "A&#365;toro" "Dato" "Enhavo" "Piednotoj")
More language specifications of HTML export.
2008-11-10 12:01:44 -05:00
("es" "Autor" "Fecha" "&Iacute;ndice" "Pies de p&aacute;gina")
("fi" "Tekij&auml;" "P&auml;iv&auml;m&auml;&auml;r&auml;" "Sis&auml;llysluettelo" "Alaviitteet")
("fr" "Auteur" "Date" "Table des mati&egrave;res" "Notes de bas de page")
("hu" "Szerz&otilde;" "D&aacute;tum" "Tartalomjegyz&eacute;k" "L&aacute;bjegyzet")
Release 6.12
2008-11-11 05:03:17 -05:00
("is" "H&ouml;fundur" "Dagsetning" "Efnisyfirlit" "Aftanm&aacute;lsgreinar")
More language specifications of HTML export.
2008-11-10 12:01:44 -05:00
("it" "Autore" "Data" "Indice" "Note a pi&egrave; di pagina")
("nl" "Auteur" "Datum" "Inhoudsopgave" "Voetnoten")
("no" "Forfatter" "Dato" "Innhold" "Fotnoter")
("nb" "Forfatter" "Dato" "Innhold" "Fotnoter") ;; nb = Norsk (bokm.l)
("nn" "Forfattar" "Dato" "Innhald" "Fotnotar") ;; nn = Norsk (nynorsk)
there is no &sacute; in HTML * lisp/org-exp.el (org-export-language-setup): Fix Polish entries. Hello. There is no such named entity as &sacute;. If you want to be 7bit clean then use &#x015b; (or decimal &#347;).
2010-10-04 17:51:26 -04:00
("pl" "Autor" "Data" "Spis tre&#x015b;ci" "Przypis")
More language specifications of HTML export.
2008-11-10 12:01:44 -05:00
("sv" "F&ouml;rfattare" "Datum" "Inneh&aring;ll" "Fotnoter"))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
"Terms used in export text, translated to different languages.
Use the variable `org-export-default-language' to set the language,
or use the +OPTION lines for a per-file setting."
:group 'org-export-general
:type '(repeat
(list
(string :tag "HTML language tag")
(string :tag "Author")
(string :tag "Date")
Improve Footnote export. Export of Footnotes to HTML now uses a configurable structure. Also the word "Footnotes" has been translated into many languages.
2008-11-08 09:30:19 -05:00
(string :tag "Table of Contents")
(string :tag "Footnotes"))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defcustom org-export-default-language "en"
`org-export-default-language': Better docstring.
2011-02-15 12:25:43 -05:00
"The default language for export and clocktable translations, as a string.
This should have an association in `org-export-language-setup'
and in `org-clock-clocktable-language-setup'."
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
:group 'org-export-general
:type 'string)
New option `org-export-date-timestamp-format'. * org-exp.el (org-export-date-timestamp-format): New option to define the way a timestamp in #+DATE will be exported. (org-infile-export-plist): Use the new option. Thanks to Torsten Wagner for this idea.
2011-12-28 11:12:25 -05:00
(defcustom org-export-date-timestamp-format "%Y-%m-%d"
"Time string format for Org timestamps in the #+DATE option."
:group 'org-export-general
:type 'string)
Export: New in-buffer options to set content of meta tag data New in-buffer options #+DESCRIPTION and #+KEYWORDS can be used to set the corresponding meta tag entries in XHTML export.
2009-03-08 18:10:55 -04:00
(defvar org-export-page-description ""
"The page description, for the XHTML meta tag.
This is best set with the #+DESCRIPTION line in a file, it does not make
sense to set this globally.")
(defvar org-export-page-keywords ""
"The page description, for the XHTML meta tag.
This is best set with the #+KEYWORDS line in a file, it does not make
sense to set this globally.")
Update documentation, to formulate the markup rules more compactly.
2008-05-06 03:32:16 -04:00
(defcustom org-export-skip-text-before-1st-heading nil
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means skip all text before the first headline when exporting.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
When nil, that text is exported as well."
:group 'org-export-general
:type 'boolean)
(defcustom org-export-headline-levels 3
"The last level which is still exported as a headline.
Inferior levels will produce itemize lists when exported.
Note that a numeric prefix argument to an exporter function overrides
this setting.
This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
:group 'org-export-general
Fix customization types: integer instead of number, where appropriate
2009-04-01 07:58:27 -04:00
:type 'integer)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defcustom org-export-with-section-numbers t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means add section numbers to headlines when exporting.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
:group 'org-export-general
:type 'boolean)
Make the format of section number configurable. This was a request by Adam Spiers.
2008-06-10 04:05:15 -04:00
(defcustom org-export-section-number-format '((("1" ".")) . "")
"Format of section numbers for export.
The variable has two components.
1. A list of lists, each indicating a counter type and a separator.
Fix typo
2010-07-11 12:52:47 -04:00
The counter type can be any of \"1\", \"A\", \"a\", \"I\", or \"i\".
Make the format of section number configurable. This was a request by Adam Spiers.
2008-06-10 04:05:15 -04:00
It causes causes numeric, alphabetic, or roman counters, respectively.
The separator is only used if another counter for a subsection is being
added.
If there are more numbered section levels than entries in this lists,
then the last entry will be reused.
2. A terminator string that will be added after the entire
section number."
:group 'org-export-general
:type '(cons
(repeat
(list
(string :tag "Counter Type")
(string :tag "Separator ")))
(string :tag "Terminator")))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defcustom org-export-with-toc t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means create a table of contents in exported files.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
The TOC contains headlines with levels up to`org-export-headline-levels'.
When an integer, include levels up to N in the toc, this may then be
different from `org-export-headline-levels', but it will not be allowed
to be larger than the number of headline levels.
When nil, no table of contents is made.
Headlines which contain any TODO items will be marked with \"(*)\" in
ASCII export, and with red color in HTML output, if the option
`org-export-mark-todo-in-toc' is set.
In HTML output, the TOC will be clickable.
This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"
or \"toc:3\"."
:group 'org-export-general
:type '(choice
(const :tag "No Table of Contents" nil)
(const :tag "Full Table of Contents" t)
(integer :tag "TOC to level")))
(defcustom org-export-mark-todo-in-toc nil
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means mark TOC lines that contain any open TODO items."
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
:group 'org-export-general
:type 'boolean)
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
(defcustom org-export-with-todo-keywords t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means include TODO keywords in export.
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
When nil, remove all these keywords from the export."
:group 'org-export-general
:type 'boolean)
Allow to exclude tasks from being exported * doc/org.texi (Selective export): Document exclusion of any tasks from export. * lisp/org-exp.el (org-export-with-tasks): New option. (org-export-plist-vars): Add :tasks property.
2011-03-29 18:48:29 -04:00
(defcustom org-export-with-tasks t
"Non-nil means include TODO items for export.
Clean up the new options to remove tasks on export
2011-03-29 23:27:43 -04:00
This may have the following values:
t include tasks independent of state.
todo include only tasks that are not yet done.
done include only tasks that are already done.
nil remove all tasks before export
list of TODO kwds keep only tasks with these keywords"
Allow to exclude tasks from being exported * doc/org.texi (Selective export): Document exclusion of any tasks from export. * lisp/org-exp.el (org-export-with-tasks): New option. (org-export-plist-vars): Add :tasks property.
2011-03-29 18:48:29 -04:00
:group 'org-export-general
Clean up the new options to remove tasks on export
2011-03-29 23:27:43 -04:00
:type '(choice
(const :tag "All tasks" t)
(const :tag "No tasks" nil)
(const :tag "Not-done tasks" todo)
(const :tag "Only done tasks" done)
(repeat :tag "Specific TODO keywords"
(string :tag "Keyword"))))
Implement export without DONE tasks * doc/org.texi (Selective export): Document how to exclude DONE tasks from export. (Publishing options): Document the properties to be used to turn off export of DONE tasks. * lisp/org-ascii.el (org-export-as-ascii): * lisp/org-docbook.el (org-export-as-docbook): * lisp/org-html.el (org-export-as-html): * lisp/org-latex.el (org-export-as-latex): Pass the :done-tasks property to the export preprocessor. * lisp/org-exp.el (org-export-with-done-tasks): New option. (org-export-plist-vars): Add entry for :done-tasks. (org-export-preprocess-string): Call `org-export-remove-done-tasks'. (org-export-remove-done-tasks): New function.
2011-03-29 11:29:24 -04:00
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
(defcustom org-export-with-priority nil
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means include priority cookies in export.
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
When nil, remove priority cookies for export."
:group 'org-export-general
:type 'boolean)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defcustom org-export-preserve-breaks nil
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means preserve all line breaks when exporting.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
Normally, in HTML output paragraphs will be reformatted. In ASCII
export, line breaks will always be preserved, regardless of this variable.
This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
:group 'org-export-general
:type 'boolean)
(defcustom org-export-with-archived-trees 'headline
"Whether subtrees with the ARCHIVE tag should be exported.
This can have three different values
nil Do not export, pretend this tree is not present
t Do export the entire tree
headline Only export the headline, but skip the tree below it."
:group 'org-export-general
:group 'org-archive
:type '(choice
(const :tag "not at all" nil)
(const :tag "headline only" 'headline)
(const :tag "entirely" t)))
(defcustom org-export-author-info t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means insert author name and email into the exported file.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
This option can also be set with the +OPTIONS line,
Fix some docstrings Patch by David Maus.
2010-03-26 16:34:25 -04:00
e.g. \"author:nil\"."
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
:group 'org-export-general
:type 'boolean)
New option to turn off export of the email address Default is actually off.
2010-03-26 02:59:10 -04:00
(defcustom org-export-email-info nil
"Non-nil means insert author name and email into the exported file.
This option can also be set with the +OPTIONS line,
Fix some docstrings Patch by David Maus.
2010-03-26 16:34:25 -04:00
e.g. \"email:t\"."
New option to turn off export of the email address Default is actually off.
2010-03-26 02:59:10 -04:00
:group 'org-export-general
:type 'boolean)
New option to turn off creator info.
2008-06-26 00:04:44 -04:00
(defcustom org-export-creator-info t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means the postamble should contain a creator sentence.
New option to turn off creator info.
2008-06-26 00:04:44 -04:00
This sentence is \"HTML generated by org-mode XX in emacs XXX\"."
:group 'org-export-general
:type 'boolean)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defcustom org-export-time-stamp-file t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means insert a time stamp into the exported file.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
The time stamp shows when the file was created.
This option can also be set with the +OPTIONS line,
e.g. \"timestamp:nil\"."
:group 'org-export-general
:type 'boolean)
(defcustom org-export-with-timestamps t
"If nil, do not export time stamps and associated keywords."
:group 'org-export-general
:type 'boolean)
(defcustom org-export-remove-timestamps-from-toc t
Fix typo
2009-07-07 00:08:36 -04:00
"If t, remove timestamps from the table of contents entries."
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
:group 'org-export-general
:type 'boolean)
(defcustom org-export-with-tags 'not-in-toc
"If nil, do not export tags, just remove them from headlines.
If this is the symbol `not-in-toc', tags will be removed from table of
contents entries, but still be shown in the headlines of the document.
This option can also be set with the +OPTIONS line, e.g. \"tags:nil\"."
:group 'org-export-general
:type '(choice
(const :tag "Off" nil)
(const :tag "Not in TOC" not-in-toc)
(const :tag "On" t)))
(defcustom org-export-with-drawers nil
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means export with drawers like the property drawer.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
When t, all drawers are exported. This may also be a list of
drawer names to export."
:group 'org-export-general
:type '(choice
(const :tag "All drawers" t)
(const :tag "None" nil)
(repeat :tag "Selected drawers"
(string :tag "Drawer name"))))
New hook org-export-first-hook
2009-12-11 02:40:19 -05:00
(defvar org-export-first-hook nil
"Hook called as the first thing in each exporter.
Improve some docstrings
2010-01-28 12:52:26 -05:00
Point will be still in the original buffer.
New hook org-export-first-hook
2009-12-11 02:40:19 -05:00
Good for general initialization")
Implementing the eval tags like <lisp> in Muse.
2008-04-28 16:47:04 -04:00
(defvar org-export-preprocess-hook nil
"Hook for preprocessing an export buffer.
Improve some docstrings
2010-01-28 12:52:26 -05:00
Pretty much the first thing when exporting is running this hook.
Point will be in a temporary buffer that contains a copy of
Fix typo.
2011-02-07 10:35:59 -05:00
the original buffer, or of the section that is being exported.
Improve some docstrings
2010-01-28 12:52:26 -05:00
All the other hooks in the org-export-preprocess... category
also work in that temporary buffer, already modified by various
stages of the processing.")
Implementing the eval tags like <lisp> in Muse.
2008-04-28 16:47:04 -04:00
Export: New hooks for preprocessing This patch introduces more hooks for preprocessing the export buffer, at various strategic moments. See the Changes.org file for a description of the hooks.
2008-12-31 12:37:33 -05:00
(defvar org-export-preprocess-after-include-files-hook nil
"Hook for preprocessing an export buffer.
This is run after the contents of included files have been inserted.")
(defvar org-export-preprocess-after-tree-selection-hook nil
"Hook for preprocessing an export buffer.
This is run after selection of trees to be exported has happened.
This selection includes tags-based selection, as well as removal
of commented and archived trees.")
Implement index generation during export This new code will search #+INDEX lines in the buffer. For LaTeX, it will simple convert these into LaTeX \index{} commands. For other backends, it will copy thee entries to a new file, with extension orgx. These files can then later be post-processed to create the index.
2010-02-25 01:31:29 -05:00
(defvar org-export-preprocess-after-headline-targets-hook nil
"Hook for preprocessing export buffer.
This is run just after the headline targets have been defined and
the target-alist has been set up.")
New hook `org-export-preprocess-before-selecting-backend-code-hook'
2009-12-11 02:41:53 -05:00
(defvar org-export-preprocess-before-selecting-backend-code-hook nil
"Hook for preprocessing an export buffer.
This is run just before backend-specific blocks get selected.")
Export: New hooks for Chris Gray's LaTeX/HTML blocks Chris Gray had the idea to have arbitrary blocks turned in LaTeX environments and HTML divs. These three new hooks allow implementation has an add-on rather than a patch.
2009-05-02 02:02:17 -04:00
(defvar org-export-preprocess-after-blockquote-hook nil
"Hook for preprocessing an export buffer.
This is run after blockquote/quote/verse/center have been marked
with cookies.")
Add org-wikinodes.el as a contributed package * contrib/lisp/org-wikinodes.el: New file. * lisp/org-exp.el (org-export-preprocess-after-radio-targets-hook): (org-export-define-heading-targets-headline-hook): New hooks. * lisp/org.el (org-modules): Add entry for org-wikinodes.el. (org-font-lock-set-keywords-hook): New hook. (org-open-at-point-functions): New hook. (org-find-exact-headling-in-buffer): (org-find-exact-heading-in-directory): New functions. (org-mode-flyspell-verify): Better cursor position for checking if flyspell should ignore a word.
2010-07-16 08:15:41 -04:00
(defvar org-export-preprocess-after-radio-targets-hook nil
"Hook for preprocessing an export buffer.
This is run after radio target processing.")
New link types that force special ways of opening the file file+sys:/path/to/file will use the system to open the file, like double-clicking would file+emacs:/path/to/file will force opening by Emacs Also, when using C-c C-o on a headline of get a list of links in the entry, pressing RET will open *all* links. This allows something like projects to be defined, with a number of files that have to be opened by different applications. These were requests by John Wiegley.
2010-01-04 07:04:38 -05:00
(defvar org-export-preprocess-before-normalizing-links-hook nil
"Hook for preprocessing an export buffer.
This hook is run before links are normalized.")
Export: New hooks for preprocessing This patch introduces more hooks for preprocessing the export buffer, at various strategic moments. See the Changes.org file for a description of the hooks.
2008-12-31 12:37:33 -05:00
(defvar org-export-preprocess-before-backend-specifics-hook nil
"Hook run before backend-specific functions are called during preprocessing.")
(defvar org-export-preprocess-final-hook nil
"Hook for preprocessing an export buffer.
This is run as the last thing in the preprocessing buffer, just before
returning the buffer string to the backend.")
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defgroup org-export-translation nil
"Options for translating special ascii sequences for the export backends."
:tag "Org Export Translation"
:group 'org-export)
(defcustom org-export-with-emphasize t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means interpret *word*, /word/, and _word_ as emphasized text.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
If the export target supports emphasizing text, the word will be
typeset in bold, italic, or underlined, respectively. Works only for
single words, but you can say: I *really* *mean* *this*.
Not all export backends support this.
This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
:group 'org-export-translation
:type 'boolean)
(defcustom org-export-with-footnotes t
"If nil, export [1] as a footnote marker.
Lines starting with [1] will be formatted as footnotes.
This option can also be set with the +OPTIONS line, e.g. \"f:nil\"."
:group 'org-export-translation
:type 'boolean)
(defcustom org-export-with-TeX-macros t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means interpret simple TeX-like macros when exporting.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
For example, HTML export converts \\alpha to &alpha; and \\AA to &Aring;.
Maintenance: Fix typo.
2009-01-08 06:25:20 -05:00
Not only real TeX macros will work here, but the standard HTML entities
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
for math can be used as macro names as well. For a list of supported
Implement new and better support for entities
2010-03-28 03:48:03 -04:00
names in HTML export, see the constant `org-entities' and the user option
`org-entities-user'.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
Not all export backends support this.
This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
:group 'org-export-translation
:group 'org-export-latex
:type 'boolean)
Implement MathJax support * lisp/org-exp.el (org-export-with-LaTeX-fragments): New default t, which now means to use MathJax processing for HTML. Also allow new value `dvipng' to force the old image processing. (org-infile-export-plist): Parse for MATHJAX setup line. * lisp/org-html.el (org-export-html-mathjax-options): New option. (org-export-html-mathjax-config): New function. (org-export-html-mathjax-template): New option. (org-export-html-preprocess): Call the LaTeX snippet processor with an additional argument to declare special ways of processing. (org-export-as-html): Bind the dynamical variable `org-export-have-math'. Insert the MathJax script template when it is needed by the document. * lisp/org.el (org-preview-latex-fragment): Call `org-format-latex' with the additional processing argument. (org-export-have-math): New variable, for dynamic scoping. (org-format-latex): Implement specific ways of processing. New function argument for processing type. (org-org-menu): Remove the entry to configure LaTeX snippet processing. MathJax is now the default for displaying math in a browser.
2010-08-13 08:22:16 -04:00
(defcustom org-export-with-LaTeX-fragments t
"Non-nil means process LaTeX math fragments for HTML display.
When set, the exporter will find and process LaTeX environments if the
\\begin line is the first non-white thing on a line. It will also find
Quote \[cmd] in docstring of org-export-with-LaTeX-fragments * org-exp.el (org-export-with-LaTeX-fragments): Fix docstring so that \\[ a = b \\] is not interpreted as a keybinding by `substitute-command-keys'. In a docstring \\[text] is used to indicate that text should be interpreted by `substitute-command-keys'. To avoid this interpretation, we need to prefix it with \\=.
2011-01-20 13:13:46 -05:00
and process the math delimiters like $a=b$ and \\( a=b \\) for inline math,
$$a=b$$ and \\=\\[ a=b \\] for display math.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
Implement MathJax support * lisp/org-exp.el (org-export-with-LaTeX-fragments): New default t, which now means to use MathJax processing for HTML. Also allow new value `dvipng' to force the old image processing. (org-infile-export-plist): Parse for MATHJAX setup line. * lisp/org-html.el (org-export-html-mathjax-options): New option. (org-export-html-mathjax-config): New function. (org-export-html-mathjax-template): New option. (org-export-html-preprocess): Call the LaTeX snippet processor with an additional argument to declare special ways of processing. (org-export-as-html): Bind the dynamical variable `org-export-have-math'. Insert the MathJax script template when it is needed by the document. * lisp/org.el (org-preview-latex-fragment): Call `org-format-latex' with the additional processing argument. (org-export-have-math): New variable, for dynamic scoping. (org-format-latex): Implement specific ways of processing. New function argument for processing type. (org-org-menu): Remove the entry to configure LaTeX snippet processing. MathJax is now the default for displaying math in a browser.
2010-08-13 08:22:16 -04:00
This option can also be set with the +OPTIONS line, e.g. \"LaTeX:mathjax\".
Allowed values are:
nil Don't do anything.
Various docstrings typo fixes by Osamu OKANO.
2011-02-01 07:05:13 -05:00
verbatim Keep everything in verbatim
Implement MathJax support * lisp/org-exp.el (org-export-with-LaTeX-fragments): New default t, which now means to use MathJax processing for HTML. Also allow new value `dvipng' to force the old image processing. (org-infile-export-plist): Parse for MATHJAX setup line. * lisp/org-html.el (org-export-html-mathjax-options): New option. (org-export-html-mathjax-config): New function. (org-export-html-mathjax-template): New option. (org-export-html-preprocess): Call the LaTeX snippet processor with an additional argument to declare special ways of processing. (org-export-as-html): Bind the dynamical variable `org-export-have-math'. Insert the MathJax script template when it is needed by the document. * lisp/org.el (org-preview-latex-fragment): Call `org-format-latex' with the additional processing argument. (org-export-have-math): New variable, for dynamic scoping. (org-format-latex): Implement specific ways of processing. New function argument for processing type. (org-org-menu): Remove the entry to configure LaTeX snippet processing. MathJax is now the default for displaying math in a browser.
2010-08-13 08:22:16 -04:00
dvipng Process the LaTeX fragments to images.
This will also include processing of non-math environments.
t Do MathJax preprocessing if there is at least on math snippet,
and arrange for MathJax.js to be loaded.
LaTeX fragments: Better error message when latex/dvipng unavailable Thomas Morgan writes: > I just tried exporting an Org file with LaTeX fragments to HTML > on a computer that doesn't have dvipng. There were error messages > in *Messages* ("Failed to create png file..."), but this wasn't > obvious to me at first glance because those messages were replaced > in the echo area by "Exporting... done" before I could see them. > > So I was wondering, is there a good way to make the user aware of > those errors? Maybe by printing "Exporting... done (with errors)"? There is now a better error message when either the latex or the dvipng program does not exist.
2009-04-30 16:50:47 -04:00
The default is nil, because this option needs the `dvipng' program which
is not available on all systems."
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
:group 'org-export-translation
:group 'org-export-latex
Implement MathJax support * lisp/org-exp.el (org-export-with-LaTeX-fragments): New default t, which now means to use MathJax processing for HTML. Also allow new value `dvipng' to force the old image processing. (org-infile-export-plist): Parse for MATHJAX setup line. * lisp/org-html.el (org-export-html-mathjax-options): New option. (org-export-html-mathjax-config): New function. (org-export-html-mathjax-template): New option. (org-export-html-preprocess): Call the LaTeX snippet processor with an additional argument to declare special ways of processing. (org-export-as-html): Bind the dynamical variable `org-export-have-math'. Insert the MathJax script template when it is needed by the document. * lisp/org.el (org-preview-latex-fragment): Call `org-format-latex' with the additional processing argument. (org-export-have-math): New variable, for dynamic scoping. (org-format-latex): Implement specific ways of processing. New function argument for processing type. (org-org-menu): Remove the entry to configure LaTeX snippet processing. MathJax is now the default for displaying math in a browser.
2010-08-13 08:22:16 -04:00
:type '(choice
(const :tag "Do not process math in any way" nil)
(const :tag "Obsolete, use dvipng setting" t)
(const :tag "Use dvipng to make images" dvipng)
(const :tag "Use MathJax to display math" mathjax)
(const :tag "Leave math verbatim" verbatim)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defcustom org-export-with-fixed-width t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means lines starting with \":\" will be in fixed width font.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
This can be used to have pre-formatted text, fragments of code etc. For
example:
: ;; Some Lisp examples
: (while (defc cnt)
: (ding))
will be looking just like this in also HTML. See also the QUOTE keyword.
Not all export backends support this.
This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
:group 'org-export-translation
:type 'boolean)
(defgroup org-export-tables nil
"Options for exporting tables in Org-mode."
:tag "Org Export Tables"
:group 'org-export)
(defcustom org-export-with-tables t
"If non-nil, lines starting with \"|\" define a table.
For example:
| Name | Address | Birthday |
|-------------+----------+-----------|
| Arthur Dent | England | 29.2.2100 |
Not all export backends support this.
This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
:group 'org-export-tables
:type 'boolean)
(defcustom org-export-highlight-first-table-line t
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means highlight the first table line.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
In HTML export, this means use <th> instead of <td>.
In tables created with table.el, this applies to the first table line.
In Org-mode tables, all lines before the first horizontal separator
line will be formatted with <th> tags."
:group 'org-export-tables
:type 'boolean)
(defcustom org-export-table-remove-special-lines t
"Remove special lines and marking characters in calculating tables.
This removes the special marking character column from tables that are set
up for spreadsheet calculations. It also removes the entire lines
marked with `!', `_', or `^'. The lines with `$' are kept, because
the values of constants may be useful to have."
:group 'org-export-tables
:type 'boolean)
New variable `org-export-table-remove-empty-lines'. * org-exp.el (org-export-table-remove-empty-lines): New custom variable. (org-export-remove-special-table-lines): Use it. This was requested by Eric S Fraga.
2011-03-05 17:35:09 -05:00
(defcustom org-export-table-remove-empty-lines t
"Remove empty lines when exporting tables.
This is the global equivalent of the :remove-nil-lines option
when locally sending a table with #+ORGTBL."
:group 'org-export-tables
:type 'boolean)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defcustom org-export-prefer-native-exporter-for-tables nil
Remove comma after means in many docstrings Stephen Eglen says these commas should not be there.
2010-01-21 10:15:40 -05:00
"Non-nil means always export tables created with table.el natively.
Natively means use the HTML code generator in table.el.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
When nil, Org-mode's own HTML generator is used when possible (i.e. if
the table does not use row- or column-spanning). This has the
advantage, that the automatic HTML conversions for math symbols and
sub/superscripts can be applied. Org-mode's HTML generator is also
LaTeX export: Do not mistake table.el borders for strike-through emphasis.
2010-03-24 13:27:33 -04:00
much faster. The LaTeX exporter always use the native exporter for
table.el tables."
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
:group 'org-export-tables
:type 'boolean)
;;;; Exporting
;;; Variables, constants, and parameter plists
(defconst org-level-max 20)
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(defvar org-export-current-backend nil
"During export, this will be bound to a symbol such as 'html,
'latex, 'docbook, 'ascii, etc, indicating which of the export
backends is in use. Otherwise it has the value nil. Users
should not attempt to change the value of this variable
directly, but it can be used in code to test whether export is
in progress, and if so, what the backend is.")
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defvar org-current-export-file nil) ; dynamically scoped parameter
(defvar org-current-export-dir nil) ; dynamically scoped parameter
Maintenance: Keep compiler happy
2009-02-25 06:43:45 -05:00
(defvar org-export-opt-plist nil
"Contains the current option plist.")
ASCII export: moved functions to new file, org-ascii.el
2009-04-07 12:40:16 -04:00
(defvar org-last-level nil) ; dynamically scoped variable
(defvar org-min-level nil) ; dynamically scoped variable
(defvar org-levels-open nil) ; dynamically scoped parameter
Improve footnotes handling in exporters * lisp/org-exp.el (org-export-footnotes-markers, org-export-footnotes-data): new variables. (org-export-preprocess-string): use a more explicit argument. * lisp/org-html.el (org-export-as-html): initialize new variables. * lisp/org-docbook.el (org-export-as-docbook): initialize new variables. * lisp/org-latex.el (org-export-latex-footmark-seen): new variable. (org-export-as-latex): initialize new variables. (org-export-latex-preprocess): allow to export two or more footnotes in a row. Also permit to have footnotes refering to previously defined footnotes. * lisp/org-ascii.el (org-export-as-ascii): feed org-footnote-normalize with data so it can normalize footnotes before first headline, or footnotes with their definition outside exported region.
2011-05-11 12:02:15 -04:00
(defvar org-export-footnotes-data nil
Rename org-export-footnotes-markers to org-export-footnotes-seen * lisp/org-exp.el (org-export-footnotes-data): change docstring. (org-export-footnotes-seen): renamed from org-export-footnotes-markers. * lisp/org-ascii.el (org-export-as-ascii): apply change. * lisp/org-docbook.el (org-export-as-docbook): apply change. * lisp/org-footnote.el (org-footnote-normalize): apply change. * lisp/org-html.el (org-export-as-html): apply change. * lisp/org-latex.el (org-export-as-latex): apply change.
2011-06-26 12:51:28 -04:00
"Alist of labels used in buffers, along with their definition.")
(defvar org-export-footnotes-seen nil
"Alist of labels encountered so far by the exporter, along with their definition.")
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defconst org-export-plist-vars
Whitespace
2008-12-16 11:57:11 -05:00
'((:link-up nil org-export-html-link-up)
(:link-home nil org-export-html-link-home)
(:language nil org-export-default-language)
Export: New in-buffer options to set content of meta tag data New in-buffer options #+DESCRIPTION and #+KEYWORDS can be used to set the corresponding meta tag entries in XHTML export.
2009-03-08 18:10:55 -04:00
(:keywords nil org-export-page-keywords)
(:description nil org-export-page-description)
Whitespace
2008-12-16 11:57:11 -05:00
(:customtime nil org-display-custom-times)
(:headline-levels "H" org-export-headline-levels)
(:section-numbers "num" org-export-with-section-numbers)
(:section-number-format nil org-export-section-number-format)
(:table-of-contents "toc" org-export-with-toc)
(:preserve-breaks "\\n" org-export-preserve-breaks)
(:archived-trees nil org-export-with-archived-trees)
(:emphasize "*" org-export-with-emphasize)
(:sub-superscript "^" org-export-with-sub-superscripts)
(:special-strings "-" org-export-with-special-strings)
(:footnotes "f" org-export-with-footnotes)
(:drawers "d" org-export-with-drawers)
(:tags "tags" org-export-with-tags)
(:todo-keywords "todo" org-export-with-todo-keywords)
Allow to exclude tasks from being exported * doc/org.texi (Selective export): Document exclusion of any tasks from export. * lisp/org-exp.el (org-export-with-tasks): New option. (org-export-plist-vars): Add :tasks property.
2011-03-29 18:48:29 -04:00
(:tasks "tasks" org-export-with-tasks)
Whitespace
2008-12-16 11:57:11 -05:00
(:priority "pri" org-export-with-priority)
(:TeX-macros "TeX" org-export-with-TeX-macros)
(:LaTeX-fragments "LaTeX" org-export-with-LaTeX-fragments)
LaTeX export: Allow export using the listings package Patch by Eric Schulte, see http://thread.gmane.org/gmane.emacs.orgmode/16269
2009-08-09 08:49:52 -04:00
(:latex-listings nil org-export-latex-listings)
Whitespace
2008-12-16 11:57:11 -05:00
(:skip-before-1st-heading "skip" org-export-skip-text-before-1st-heading)
(:fixed-width ":" org-export-with-fixed-width)
(:timestamps "<" org-export-with-timestamps)
Clean handling :html-pre/postamble options wrt author/email/creator-info. * org-html.el (org-export-html-preamble) (org-export-html-postamble): now default to `nil'. (org-export-as-html): when :html-pre/postamble is nil, fall back on the default pre/postamble, which depends on the :author-info, :email-info, :creator-info options. * org-exp.el (org-export-plist-vars): reorder the alist. * org.texi (Export options): better document :html-preamble and :html-postamble: setting these options will override any :author-info, :email-info and :creator-info options for the HTML export.
2011-03-04 10:32:10 -05:00
(:author nil user-full-name)
(:email nil user-mail-address)
Whitespace
2008-12-16 11:57:11 -05:00
(:author-info "author" org-export-author-info)
Minor post-fixed about author and email information
2010-03-26 04:13:50 -04:00
(:email-info "email" org-export-email-info)
Whitespace
2008-12-16 11:57:11 -05:00
(:creator-info "creator" org-export-creator-info)
(:time-stamp-file "timestamp" org-export-time-stamp-file)
(:tables "|" org-export-with-tables)
(:table-auto-headline nil org-export-highlight-first-table-line)
(:style-include-default nil org-export-html-style-include-default)
HTML export: New option to turn off Javascript inclusion It is now possible to turn off the inclusion of any javascript into the HTML file.
2009-03-06 23:56:17 -05:00
(:style-include-scripts nil org-export-html-style-include-scripts)
Whitespace
2008-12-16 11:57:11 -05:00
(:style nil org-export-html-style)
(:style-extra nil org-export-html-style-extra)
(:agenda-style nil org-agenda-export-html-style)
(:convert-org-links nil org-export-html-link-org-files-as-html)
(:inline-images nil org-export-html-inline-images)
(:html-extension nil org-export-html-extension)
Clean handling :html-pre/postamble options wrt author/email/creator-info. * org-html.el (org-export-html-preamble) (org-export-html-postamble): now default to `nil'. (org-export-as-html): when :html-pre/postamble is nil, fall back on the default pre/postamble, which depends on the :author-info, :email-info, :creator-info options. * org-exp.el (org-export-plist-vars): reorder the alist. * org.texi (Export options): better document :html-preamble and :html-postamble: setting these options will override any :author-info, :email-info and :creator-info options for the HTML export.
2011-03-04 10:32:10 -05:00
(:html-preamble nil org-export-html-preamble)
(:html-postamble nil org-export-html-postamble)
HTML export: Make xml declaration configurable
2009-05-20 02:24:49 -04:00
(:xml-declaration nil org-export-html-xml-declaration)
Whitespace
2008-12-16 11:57:11 -05:00
(:html-table-tag nil org-export-html-table-tag)
(:expand-quoted-html "@" org-export-html-expand)
(:timestamp nil org-export-html-with-timestamp)
(:publishing-directory nil org-export-publishing-directory)
(:select-tags nil org-export-select-tags)
Export: org-export-latex-image-default-option can be buffer-local Jason Riedy writes: > I'm trying to change org-export-latex-image-default-option > to "width=.7\\linewidth" in a file local variable. It's set > correctly as a buffer local variable, and it's having no > effect on the export. My guess is that the buffer-local > property is stopping it as soon as org-export-as-latex runs > set-buffer. > > I can smuggle the value in by adding an entry to org-export-plist-vars > referring to org-export-latex-image-default-option and pulling the value > from the plist, but that feels incorrect. It is actually the correct way to do this, and I have implemented this change.
2009-05-05 03:41:00 -04:00
(:exclude-tags nil org-export-exclude-tags)
(:latex-image-options nil org-export-latex-image-default-option))
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
"List of properties that represent export/publishing variables.
Each element is a list of 3 items:
1. The property that is used internally, and also for org-publish-project-alist
2. The string that can be used in the OPTION lines to set this option,
or nil if this option cannot be changed in this way
3. The customization variable that sets the default for this option."
)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defun org-default-export-plist ()
"Return the property list with default settings for the export variables."
Export: Fix bug with #+BIND
2009-08-05 08:43:55 -04:00
(let* ((infile (org-infile-export-plist))
(letbind (plist-get infile :let-bind))
(l org-export-plist-vars) rtn e s v)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(while (setq e (pop l))
Export: Handle undefined variables. Some of the standard export options are now defined in backend specific files. This commit makes sure that building the options property list will not cause an error because of unneeded (for the backend) undefined variables.
2009-04-12 02:22:39 -04:00
(setq s (nth 2 e)
Export: Fix bug with #+BIND
2009-08-05 08:43:55 -04:00
v (cond
((assq s letbind) (nth 1 (assq s letbind)))
((boundp s) (symbol-value s))
(t nil))
Fix the previous fix.
2009-04-12 14:00:39 -04:00
rtn (cons (car e) (cons v rtn))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
rtn))
Much better integration of org-info.js.
2008-04-07 02:32:00 -04:00
(defvar org-export-inbuffer-options-extra nil
"List of additional in-buffer options that should be detected.
Just before export, the buffer is scanned for options like #+TITLE, #+EMAIL,
etc. Extensions can add to this list to get their options detected, and they
can then add a function to `org-export-options-filters' to process these
options.
Each element in this list must be a list, with the in-buffer keyword as car,
Fix typos in org-exp.el
2008-12-16 10:30:46 -05:00
and a property (a symbol) as the next element. All occurrences of the
Much better integration of org-info.js.
2008-04-07 02:32:00 -04:00
keyword will be found, the values concatenated with a space character
in between, and the result stored in the export options property list.")
(defvar org-export-options-filters nil
"Functions to be called to finalize the export/publishing options.
All these options are stored in a property list, and each of the functions
in this hook gets a chance to modify this property list. Each function
must accept the property list as an argument, and must return the (possibly
modified) list.")
Make note about case-fold-search
2008-10-14 12:41:58 -04:00
;; FIXME: should we fold case here?
New option `org-export-date-timestamp-format'. * org-exp.el (org-export-date-timestamp-format): New option to define the way a timestamp in #+DATE will be exported. (org-infile-export-plist): Use the new option. Thanks to Torsten Wagner for this idea.
2011-12-28 11:12:25 -05:00
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defun org-infile-export-plist ()
"Return the property list with file-local settings for export."
(save-excursion
(save-restriction
(widen)
Implement setup inclusion from external file. The #+STARTUP etc lines that define settings on a per-file basis can now be collected in a separate file and included with a line: #+SETUPFILE: "/path/to/setup.org" This has been a frequent request in the past, now it is finally possible.
2008-05-07 10:26:01 -04:00
(goto-char (point-min))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(let ((re (org-make-options-regexp
Much better integration of org-info.js.
2008-04-07 02:32:00 -04:00
(append
'("TITLE" "AUTHOR" "DATE" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"
Implement MathJax support * lisp/org-exp.el (org-export-with-LaTeX-fragments): New default t, which now means to use MathJax processing for HTML. Also allow new value `dvipng' to force the old image processing. (org-infile-export-plist): Parse for MATHJAX setup line. * lisp/org-html.el (org-export-html-mathjax-options): New option. (org-export-html-mathjax-config): New function. (org-export-html-mathjax-template): New option. (org-export-html-preprocess): Call the LaTeX snippet processor with an additional argument to declare special ways of processing. (org-export-as-html): Bind the dynamical variable `org-export-have-math'. Insert the MathJax script template when it is needed by the document. * lisp/org.el (org-preview-latex-fragment): Call `org-format-latex' with the additional processing argument. (org-export-have-math): New variable, for dynamic scoping. (org-format-latex): Implement specific ways of processing. New function argument for processing type. (org-org-menu): Remove the entry to configure LaTeX snippet processing. MathJax is now the default for displaying math in a browser.
2010-08-13 08:22:16 -04:00
"MATHJAX"
Make LaTeX_CLASS also work in a setup file
2009-09-30 04:08:25 -04:00
"LINK_UP" "LINK_HOME" "SETUPFILE" "STYLE"
support LATEX_CLASS_OPTIONS in #+SETUPFILE * lisp/org-exp.el (org-infile-export-plist): Handle LATEX_CLASS_OPTIONS the same way than LATEX_CLASS.
2011-10-26 11:13:20 -04:00
"LATEX_HEADER" "LATEX_CLASS" "LATEX_CLASS_OPTIONS"
Export: New in-buffer options to set content of meta tag data New in-buffer options #+DESCRIPTION and #+KEYWORDS can be used to set the corresponding meta tag entries in XHTML export.
2009-03-08 18:10:55 -04:00
"EXPORT_SELECT_TAGS" "EXPORT_EXCLUDE_TAGS"
More flexibility for the XSLT command
2010-05-14 07:38:14 -04:00
"KEYWORDS" "DESCRIPTION" "MACRO" "BIND" "XSLT")
Much better integration of org-info.js.
2008-04-07 02:32:00 -04:00
(mapcar 'car org-export-inbuffer-options-extra))))
Remove impact of case-fold-search on LaTeX class setup * lisp/org-exp.el (org-infile-export-plist): Bind case-fold-search to t.
2010-08-20 02:39:55 -04:00
(case-fold-search t)
Implement MathJax support * lisp/org-exp.el (org-export-with-LaTeX-fragments): New default t, which now means to use MathJax processing for HTML. Also allow new value `dvipng' to force the old image processing. (org-infile-export-plist): Parse for MATHJAX setup line. * lisp/org-html.el (org-export-html-mathjax-options): New option. (org-export-html-mathjax-config): New function. (org-export-html-mathjax-template): New option. (org-export-html-preprocess): Call the LaTeX snippet processor with an additional argument to declare special ways of processing. (org-export-as-html): Bind the dynamical variable `org-export-have-math'. Insert the MathJax script template when it is needed by the document. * lisp/org.el (org-preview-latex-fragment): Call `org-format-latex' with the additional processing argument. (org-export-have-math): New variable, for dynamic scoping. (org-format-latex): Implement specific ways of processing. New function argument for processing type. (org-org-menu): Remove the entry to configure LaTeX snippet processing. MathJax is now the default for displaying math in a browser.
2010-08-13 08:22:16 -04:00
p key val text options mathjax a pr style
support LATEX_CLASS_OPTIONS in #+SETUPFILE * lisp/org-exp.el (org-infile-export-plist): Handle LATEX_CLASS_OPTIONS the same way than LATEX_CLASS.
2011-10-26 11:13:20 -04:00
latex-header latex-class latex-class-options macros letbind
org-exp: Handle recursively included setup files correctly. * org-exp.el (org-infile-export-plist): Handle recursively included setup files. The value of the last included file always takes precedence over previous values. Thanks to Stefan Vollmar for signaling this bug.
2011-07-25 09:32:52 -04:00
ext-setup-or-nil setup-file setup-dir setup-contents (start 0))
Implement setup inclusion from external file. The #+STARTUP etc lines that define settings on a per-file basis can now be collected in a separate file and included with a line: #+SETUPFILE: "/path/to/setup.org" This has been a frequent request in the past, now it is finally possible.
2008-05-07 10:26:01 -04:00
(while (or (and ext-setup-or-nil
(string-match re ext-setup-or-nil start)
(setq start (match-end 0)))
(and (setq ext-setup-or-nil nil start 0)
(re-search-forward re nil t)))
(setq key (upcase (org-match-string-no-properties 1 ext-setup-or-nil))
val (org-match-string-no-properties 2 ext-setup-or-nil))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(cond
Much better integration of org-info.js.
2008-04-07 02:32:00 -04:00
((setq a (assoc key org-export-inbuffer-options-extra))
(setq pr (nth 1 a))
(setq p (plist-put p pr (concat (plist-get p pr) " " val))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
((string-equal key "TITLE") (setq p (plist-put p :title val)))
((string-equal key "AUTHOR")(setq p (plist-put p :author val)))
((string-equal key "EMAIL") (setq p (plist-put p :email val)))
New option `org-export-date-timestamp-format'. * org-exp.el (org-export-date-timestamp-format): New option to define the way a timestamp in #+DATE will be exported. (org-infile-export-plist): Use the new option. Thanks to Torsten Wagner for this idea.
2011-12-28 11:12:25 -05:00
((string-equal key "DATE")
;; If date is an Org timestamp, convert it to a time
;; string using `org-export-date-timestamp-format'
(when (string-match org-ts-regexp3 val)
(setq val (format-time-string
org-export-date-timestamp-format
(apply 'encode-time (org-parse-time-string
(match-string 0 val))))))
(setq p (plist-put p :date val)))
Export: New in-buffer options to set content of meta tag data New in-buffer options #+DESCRIPTION and #+KEYWORDS can be used to set the corresponding meta tag entries in XHTML export.
2009-03-08 18:10:55 -04:00
((string-equal key "KEYWORDS") (setq p (plist-put p :keywords val)))
((string-equal key "DESCRIPTION")
(setq p (plist-put p :description val)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
((string-equal key "LANGUAGE") (setq p (plist-put p :language val)))
Allow multiple #+STYLE lines in the buffer.
2008-10-01 05:41:00 -04:00
((string-equal key "STYLE")
(setq style (concat style "\n" val)))
Implement #+LATEX_HEADER special. Proposed by Austin Frank and apparently also by Russel Adams.
2008-10-02 09:00:14 -04:00
((string-equal key "LATEX_HEADER")
(setq latex-header (concat latex-header "\n" val)))
Make LaTeX_CLASS also work in a setup file
2009-09-30 04:08:25 -04:00
((string-equal key "LATEX_CLASS")
(setq latex-class val))
support LATEX_CLASS_OPTIONS in #+SETUPFILE * lisp/org-exp.el (org-infile-export-plist): Handle LATEX_CLASS_OPTIONS the same way than LATEX_CLASS.
2011-10-26 11:13:20 -04:00
((string-equal key "LATEX_CLASS_OPTIONS")
(setq latex-class-options val))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
((string-equal key "TEXT")
(setq text (if text (concat text "\n" val) val)))
Much better integration of org-info.js.
2008-04-07 02:32:00 -04:00
((string-equal key "OPTIONS")
Implement setup inclusion from external file. The #+STARTUP etc lines that define settings on a per-file basis can now be collected in a separate file and included with a line: #+SETUPFILE: "/path/to/setup.org" This has been a frequent request in the past, now it is finally possible.
2008-05-07 10:26:01 -04:00
(setq options (concat val " " options)))
Implement MathJax support * lisp/org-exp.el (org-export-with-LaTeX-fragments): New default t, which now means to use MathJax processing for HTML. Also allow new value `dvipng' to force the old image processing. (org-infile-export-plist): Parse for MATHJAX setup line. * lisp/org-html.el (org-export-html-mathjax-options): New option. (org-export-html-mathjax-config): New function. (org-export-html-mathjax-template): New option. (org-export-html-preprocess): Call the LaTeX snippet processor with an additional argument to declare special ways of processing. (org-export-as-html): Bind the dynamical variable `org-export-have-math'. Insert the MathJax script template when it is needed by the document. * lisp/org.el (org-preview-latex-fragment): Call `org-format-latex' with the additional processing argument. (org-export-have-math): New variable, for dynamic scoping. (org-format-latex): Implement specific ways of processing. New function argument for processing type. (org-org-menu): Remove the entry to configure LaTeX snippet processing. MathJax is now the default for displaying math in a browser.
2010-08-13 08:22:16 -04:00
((string-equal key "MATHJAX")
(setq mathjax (concat val " " mathjax)))
Export: General mechanism for local settings Many different people want to set many different variables in a buffer-local way for export. This cannot be done with file variables, because the Org buffer is not current while the exporter is running. Lots of variables can be set with the #+OPTIONS lines, but finding abbreviations goes only so far. Therefore we have now a general mechanism that can be used to bind variables during export operations. a line like: #+BIND: variable value will bind the variable to value. For example, the line >> #+OPTIONS: toc:nil can now equivalently be written as >> #+BIND: org-export-with-toc nil
2009-07-06 11:00:03 -04:00
((string-equal key "BIND")
(push (read (concat "(" val ")")) letbind))
More flexibility for the XSLT command
2010-05-14 07:38:14 -04:00
((string-equal key "XSLT")
(setq p (plist-put p :xslt val)))
Much better integration of org-info.js.
2008-04-07 02:32:00 -04:00
((string-equal key "LINK_UP")
(setq p (plist-put p :link-up val)))
((string-equal key "LINK_HOME")
Implement setup inclusion from external file. The #+STARTUP etc lines that define settings on a per-file basis can now be collected in a separate file and included with a line: #+SETUPFILE: "/path/to/setup.org" This has been a frequent request in the past, now it is finally possible.
2008-05-07 10:26:01 -04:00
(setq p (plist-put p :link-home val)))
Intermediate
2008-09-16 10:52:21 -04:00
((string-equal key "EXPORT_SELECT_TAGS")
(setq p (plist-put p :select-tags (org-split-string val))))
((string-equal key "EXPORT_EXCLUDE_TAGS")
(setq p (plist-put p :exclude-tags (org-split-string val))))
Export: Find macro definitions in #+SETUPFILE definitions Macro definitions can now be included in a file linked to by a directive #+SETUPFILE.
2009-06-19 01:39:26 -04:00
((string-equal key "MACRO")
(push val macros))
Implement setup inclusion from external file. The #+STARTUP etc lines that define settings on a per-file basis can now be collected in a separate file and included with a line: #+SETUPFILE: "/path/to/setup.org" This has been a frequent request in the past, now it is finally possible.
2008-05-07 10:26:01 -04:00
((equal key "SETUPFILE")
org-exp: Handle recursively included setup files correctly. * org-exp.el (org-infile-export-plist): Handle recursively included setup files. The value of the last included file always takes precedence over previous values. Thanks to Stefan Vollmar for signaling this bug.
2011-07-25 09:32:52 -04:00
(setq setup-file (org-remove-double-quotes (org-trim val))
;; take care of recursive inclusion of setupfiles
setup-file (if (or (file-name-absolute-p val) (not setup-dir))
(expand-file-name setup-file)
(let ((default-directory setup-dir))
(expand-file-name setup-file))))
(setq setup-dir (file-name-directory setup-file))
(setq setup-contents (org-file-contents setup-file 'noerror))
Implement setup inclusion from external file. The #+STARTUP etc lines that define settings on a per-file basis can now be collected in a separate file and included with a line: #+SETUPFILE: "/path/to/setup.org" This has been a frequent request in the past, now it is finally possible.
2008-05-07 10:26:01 -04:00
(if (not ext-setup-or-nil)
(setq ext-setup-or-nil setup-contents start 0)
(setq ext-setup-or-nil
(concat (substring ext-setup-or-nil 0 start)
"\n" setup-contents "\n"
(substring ext-setup-or-nil start)))))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(setq p (plist-put p :text text))
Make #+BIND work correctly, and ask the user to confirm using BIND.
2009-08-05 10:30:02 -04:00
(when (and letbind (org-export-confirm-letbind))
(setq p (plist-put p :let-bind letbind)))
Implement #+LATEX_HEADER special. Proposed by Austin Frank and apparently also by Russel Adams.
2008-10-02 09:00:14 -04:00
(when style (setq p (plist-put p :style-extra style)))
(when latex-header
(setq p (plist-put p :latex-header-extra (substring latex-header 1))))
Make LaTeX_CLASS also work in a setup file
2009-09-30 04:08:25 -04:00
(when latex-class
(setq p (plist-put p :latex-class latex-class)))
support LATEX_CLASS_OPTIONS in #+SETUPFILE * lisp/org-exp.el (org-infile-export-plist): Handle LATEX_CLASS_OPTIONS the same way than LATEX_CLASS.
2011-10-26 11:13:20 -04:00
(when latex-class-options
(setq p (plist-put p :latex-class-options latex-class-options)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(when options
Properties can be used to confiugre subtree export.
2008-05-21 03:49:04 -04:00
(setq p (org-export-add-options-to-plist p options)))
Implement MathJax support * lisp/org-exp.el (org-export-with-LaTeX-fragments): New default t, which now means to use MathJax processing for HTML. Also allow new value `dvipng' to force the old image processing. (org-infile-export-plist): Parse for MATHJAX setup line. * lisp/org-html.el (org-export-html-mathjax-options): New option. (org-export-html-mathjax-config): New function. (org-export-html-mathjax-template): New option. (org-export-html-preprocess): Call the LaTeX snippet processor with an additional argument to declare special ways of processing. (org-export-as-html): Bind the dynamical variable `org-export-have-math'. Insert the MathJax script template when it is needed by the document. * lisp/org.el (org-preview-latex-fragment): Call `org-format-latex' with the additional processing argument. (org-export-have-math): New variable, for dynamic scoping. (org-format-latex): Implement specific ways of processing. New function argument for processing type. (org-org-menu): Remove the entry to configure LaTeX snippet processing. MathJax is now the default for displaying math in a browser.
2010-08-13 08:22:16 -04:00
(when mathjax
(setq p (plist-put p :mathjax mathjax)))
Export: Implement macro replacement during export A line: #+MARCO: name replacement text can be referenced by {{{name}}}. As special cases, {{{title}}} will reference #+TITLE, and similar with similar lines.
2009-02-23 08:15:52 -05:00
;; Add macro definitions
Export: More default macros. This commit adds: {{{date(FORMAT)}}} current date/time, formatted with `format-time-string' {{{modification-time(FORMAT)}}} date/time of last modification of file, formatted with `format-time-string' {{{input-file}}} the file name of the source Org file.
2009-05-11 01:57:29 -04:00
(setq p (plist-put p :macro-date "(eval (format-time-string \"$1\"))"))
(setq p (plist-put p :macro-time "(eval (format-time-string \"$1\"))"))
Add macro to insert property values into exported text Example: {{{property(id)}}} Will insert the ID property of current subtree if the Org buffer is exported. * lisp/org-exp.el (org-infile-export-plist): Define property macro TINYCHANGE
2010-09-09 14:44:05 -04:00
(setq p (plist-put p :macro-property "(eval (org-entry-get nil \"$1\" 'selective))"))
Export: More default macros. This commit adds: {{{date(FORMAT)}}} current date/time, formatted with `format-time-string' {{{modification-time(FORMAT)}}} date/time of last modification of file, formatted with `format-time-string' {{{input-file}}} the file name of the source Org file.
2009-05-11 01:57:29 -04:00
(setq p (plist-put
p :macro-modification-time
(and (buffer-file-name)
(file-exists-p (buffer-file-name))
(concat
"(eval (format-time-string \"$1\" '"
(prin1-to-string (nth 5 (file-attributes
(buffer-file-name))))
"))"))))
(setq p (plist-put p :macro-input-file (and (buffer-file-name)
(file-name-nondirectory
(buffer-file-name)))))
Export: Find macro definitions in #+SETUPFILE definitions Macro definitions can now be included in a file linked to by a directive #+SETUPFILE.
2009-06-19 01:39:26 -04:00
(while (setq val (pop macros))
(when (string-match "^\\([-a-zA-Z0-9_]+\\)[ \t]+\\(.*?[ \t]*$\\)" val)
(setq p (plist-put
p (intern
(concat ":macro-" (downcase (match-string 1 val))))
Newlines in macros can de defined using \n
2009-08-12 05:10:30 -04:00
(org-export-interpolate-newlines (match-string 2 val))))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
p))))
Newlines in macros can de defined using \n
2009-08-12 05:10:30 -04:00
(defun org-export-interpolate-newlines (s)
(while (string-match "\\\\n" s)
(setq s (replace-match "\n" t t s)))
s)
Make #+BIND work correctly, and ask the user to confirm using BIND.
2009-08-05 10:30:02 -04:00
(defvar org-export-allow-BIND-local nil)
(defun org-export-confirm-letbind ()
Minor changes
2009-08-05 11:02:42 -04:00
"Can we use #+BIND values during export?
Fix small typos in docstrings.
2011-02-19 06:52:26 -05:00
By default this will ask for confirmation by the user, to divert possible
Minor changes
2009-08-05 11:02:42 -04:00
security risks."
Make #+BIND work correctly, and ask the user to confirm using BIND.
2009-08-05 10:30:02 -04:00
(cond
((not org-export-allow-BIND) nil)
((eq org-export-allow-BIND t) t)
Minor changes
2009-08-05 11:02:42 -04:00
((local-variable-p 'org-export-allow-BIND-local (current-buffer))
org-export-allow-BIND-local)
(t (org-set-local 'org-export-allow-BIND-local
(yes-or-no-p "Allow BIND values in this buffer? ")))))
Make #+BIND work correctly, and ask the user to confirm using BIND.
2009-08-05 10:30:02 -04:00
Export: General mechanism for local settings Many different people want to set many different variables in a buffer-local way for export. This cannot be done with file variables, because the Org buffer is not current while the exporter is running. Lots of variables can be set with the #+OPTIONS lines, but finding abbreviations goes only so far. Therefore we have now a general mechanism that can be used to bind variables during export operations. a line like: #+BIND: variable value will bind the variable to value. For example, the line >> #+OPTIONS: toc:nil can now equivalently be written as >> #+BIND: org-export-with-toc nil
2009-07-06 11:00:03 -04:00
(defun org-install-letbind ()
"Install the values from #+BIND lines as local variables."
Fix bug with #+BIND during LaTeX export Christopher Suckling writes: > Thank you, but not quite working yet: > > ,---- > | #+BIND: org-export-latex-title-command "" > `---- > > now appears to be having the *effect* of setting a global variable. > > I load Emacs then visit the below test org file. I then export the file. > > I get a \maketitle line. > > I then C-c C-c on the #+BIND: line and re-export. > > \maketitle is removed. > > I then export another org file without the #+BIND: line. > > There is no \maketitle, even though there should be. > > I add > > ,---- > | #+BIND: org-export-latex-title-command "\foobar" > `---- > > to the new org file, C-c C-c and export: > > \foobar is added to the exported file. > > Finally, I re-export the original test org file (without C-c C-c on the > #+BIND: line): > > \foobar is added to the exported file. > > However, > > ,---- > | C-h v org-export-latex-title-command > `---- > > always returns the value "\\maketitle", no matter what the value of the > #+BIND: line. > > Best, Christopher
2010-01-04 11:48:47 -05:00
(let ((letbind (plist-get org-export-opt-plist :let-bind))
pair)
(while (setq pair (pop letbind))
(org-set-local (car pair) (nth 1 pair)))))
Export: General mechanism for local settings Many different people want to set many different variables in a buffer-local way for export. This cannot be done with file variables, because the Org buffer is not current while the exporter is running. Lots of variables can be set with the #+OPTIONS lines, but finding abbreviations goes only so far. Therefore we have now a general mechanism that can be used to bind variables during export operations. a line like: #+BIND: variable value will bind the variable to value. For example, the line >> #+OPTIONS: toc:nil can now equivalently be written as >> #+BIND: org-export-with-toc nil
2009-07-06 11:00:03 -04:00
Properties can be used to confiugre subtree export.
2008-05-21 03:49:04 -04:00
(defun org-export-add-options-to-plist (p options)
Fix typos in org-exp.el
2008-12-16 10:30:46 -05:00
"Parse an OPTIONS line and set values in the property list P."
Properties can be used to confiugre subtree export.
2008-05-21 03:49:04 -04:00
(let (o)
(when options
Maintenance: Remove unused variables.
2009-01-26 03:42:33 -05:00
(let ((op org-export-plist-vars))
Properties can be used to confiugre subtree export.
2008-05-21 03:49:04 -04:00
(while (setq o (pop op))
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
(if (and (nth 1 o)
EXPORT: Fix the options parser * lisp/org-exp.el (org-export-add-options-to-plist): Fix the option parser This fixes up commit aa6dba8a74016587755c250bb8cc4743a4082ea1. Instead of looking for the start of a word (which does not work for the options that are characters), it looks for the beginning of the line or a whitespace character preceding the option.
2011-05-05 03:08:13 -04:00
(string-match (concat "\\(\\`\\|[ \t]\\)"
(regexp-quote (nth 1 o))
Clean up the new options to remove tasks on export
2011-03-29 23:27:43 -04:00
":\\(([^)\n]+)\\|[^ \t\n\r;,.]*\\)")
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
options))
(setq p (plist-put p (car o)
Properties can be used to confiugre subtree export.
2008-05-21 03:49:04 -04:00
(car (read-from-string
Fix another option parsing bug * lisp/org-exp.el (org-export-add-options-to-plist): Use the right match group.
2011-05-05 06:48:23 -04:00
(match-string 2 options))))))))))
Properties can be used to confiugre subtree export.
2008-05-21 03:49:04 -04:00
p)
Remove unnecessary whitespace.
2008-12-04 09:33:43 -05:00
Properties can be used to confiugre subtree export.
2008-05-21 03:49:04 -04:00
(defun org-export-add-subtree-options (p pos)
"Add options in subtree at position POS to property list P."
(save-excursion
(goto-char pos)
(when (org-at-heading-p)
(let (a)
;; This is actually read in `org-export-get-title-from-subtree'
;; (when (setq a (org-entry-get pos "EXPORT_TITLE"))
;; (setq p (plist-put p :title a)))
(when (setq a (org-entry-get pos "EXPORT_TEXT"))
(setq p (plist-put p :text a)))
EXPORT: Additional properties for setting export options Matt Lundin writes: > If it's not too much trouble, I was wondering if I could > request the following properties to set export options for > subtrees: > > EXPORT_AUTHOR > EXPORT_DATE > > In addition to specifying an EXPORT_FILE and EXPORT_TITLE > for a subtree, I often find myself wanting to change the > date and author lines.
2009-04-18 12:23:40 -04:00
(when (setq a (org-entry-get pos "EXPORT_AUTHOR"))
(setq p (plist-put p :author a)))
(when (setq a (org-entry-get pos "EXPORT_DATE"))
(setq p (plist-put p :date a)))
Properties can be used to confiugre subtree export.
2008-05-21 03:49:04 -04:00
(when (setq a (org-entry-get pos "EXPORT_OPTIONS"))
(setq p (org-export-add-options-to-plist p a)))))
p))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defun org-export-directory (type plist)
(let* ((val (plist-get plist :publishing-directory))
(dir (if (listp val)
(or (cdr (assoc type val)) ".")
val)))
dir))
Arch-tag lines and declaration fixes from upstream Emacs.
2008-04-29 01:15:41 -04:00
(defun org-export-process-option-filters (plist)
(let ((functions org-export-options-filters) f)
(while (setq f (pop functions))
(setq plist (funcall f plist))))
plist)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;;;###autoload
(defun org-export (&optional arg)
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
"Export dispatcher for Org-mode.
When `org-export-run-in-background' is non-nil, try to run the command
in the background. This will be done only for commands that write
to a file. For details see the docstring of `org-export-run-in-background'.
The prefix argument ARG will be passed to the exporter. However, if
Correct some docstrings [part 2] This is a second patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil
2010-07-15 18:54:53 -04:00
ARG is a double universal prefix \\[universal-argument] \\[universal-argument], \
that means to inverse the
New variable to set the initial export scope. * org-exp.el (org-export-initial-scope): new custom variable. (org-export): Use this new variable. If there is an active region, tell it when prompting the user for an export command. Also change the way the function handles selection of buffer and subtree export. ---- Now `1' switches between subtree/buffer export until the user select an export command. Also, when there is an active region, modify the message so that the user is aware he will only export the surrounding subtree.
2011-02-11 04:44:35 -05:00
value of `org-export-run-in-background'.
If `org-export-initial-scope' is set to 'subtree, try to export
the current subtree, otherwise try to export the whole buffer.
Pressing `1' will switch between these two options."
Final changes before release. This implements executing export commands in the background. Also, the documentation has been updated.
2008-04-14 01:47:32 -04:00
(interactive "P")
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
(let* ((bg (org-xor (equal arg '(16)) org-export-run-in-background))
New variable to set the initial export scope. * org-exp.el (org-export-initial-scope): new custom variable. (org-export): Use this new variable. If there is an active region, tell it when prompting the user for an export command. Also change the way the function handles selection of buffer and subtree export. ---- Now `1' switches between subtree/buffer export until the user select an export command. Also, when there is an active region, modify the message so that the user is aware he will only export the surrounding subtree.
2011-02-11 04:44:35 -05:00
(subtree-p (or (org-region-active-p)
(eq org-export-initial-scope 'subtree)))
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
(help "[t] insert the export option template
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
\[v] limit export to visible part of outline tree
New variable to set the initial export scope. * org-exp.el (org-export-initial-scope): new custom variable. (org-export): Use this new variable. If there is an active region, tell it when prompting the user for an export command. Also change the way the function handles selection of buffer and subtree export. ---- Now `1' switches between subtree/buffer export until the user select an export command. Also, when there is an active region, modify the message so that the user is aware he will only export the surrounding subtree.
2011-02-11 04:44:35 -05:00
\[1] switch buffer/subtree export
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
\[SPC] publish enclosing subtree (with LaTeX_CLASS or EXPORT_FILE_NAME prop)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
Fix typo Patch by Julien Danjou
2010-05-18 02:01:15 -04:00
\[a/n/u] export as ASCII/Latin-1/UTF-8 [A/N/U] to temporary buffer
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
\[h] export as HTML [H] to temporary buffer [R] export region
preparatory work
2009-03-18 08:49:02 -04:00
\[b] export as HTML and open in browser
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
\[l] export as LaTeX [L] to temporary buffer
\[p] export as LaTeX and process to PDF [d] ... and open PDF file
preparatory work
2009-03-18 08:49:02 -04:00
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
\[D] export as DocBook [V] export as DocBook, process to PDF, and open
preparatory work
2009-03-18 08:49:02 -04:00
org-exp.el: s/OpenDocumentText/OpenDocument Text/
2011-12-04 15:58:13 -05:00
\[o] export as OpenDocument Text [O] ... and open
org-export: Reserve a slot for OpenDocumentExporter PATCH-1/5 for org-odt compatibility From 06379ccef996e8dabd8dcced6cbe430aacdef3f0 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 01:53:37 +0530 Subject: [PATCH 1/5] org-export: Reserve a slot for OpenDocumentExporter. * lisp/org-exp.el (org-export): Reserve keys 'o' and 'O' for OpenDocumentText export and bind them to org-export-as-odt and org-export-as-odt-and-open.
2011-06-23 11:52:22 -04:00
Added taskjuggler export to the export dispatcher
2010-06-07 11:09:12 -04:00
\[j] export as TaskJuggler [J] ... and open
Install the Lennart Borgman's freemind exporter
2009-10-27 11:28:03 -04:00
\[m] export as Freemind mind map
preparatory work
2009-03-18 08:49:02 -04:00
\[x] export as XOXO
Add Wes Hardaker's generic exporter as a contributed package
2009-06-20 14:53:03 -04:00
\[g] export using Wes Hardaker's generic exporter
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
\[i] export current file as iCalendar file
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
\[I] export all agenda files as iCalendar files [c] ...as one combined file
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
preparatory work
2009-03-18 08:49:02 -04:00
\[F] publish current file [P] publish current project
ASCII Export: Implement export to buffer Samuel Wales writes: > I frequently export to ascii without wanting a file to be created, > especially not in a useful directory, as the files are temporary. > > Is there a way to export ascii to just a buffer? There is now, `C-c C-e A'. This commit also implements commands - org-export-as-ascii-to-buffer - org-replace-region-by-ascii - org-export-region-as-ascii which are similar to what is available for HTML and LaTeX. `C-c C-e A' used to be the key for publishing all projects. This functionality has now been moved to `C-c C-e E'.
2009-05-04 12:26:42 -04:00
\[X] publish a project... [E] publish every projects")
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
(cmds
'((?t org-insert-export-options-template nil)
(?v org-export-visible nil)
(?a org-export-as-ascii t)
ASCII Export: Implement export to buffer Samuel Wales writes: > I frequently export to ascii without wanting a file to be created, > especially not in a useful directory, as the files are temporary. > > Is there a way to export ascii to just a buffer? There is now, `C-c C-e A'. This commit also implements commands - org-export-as-ascii-to-buffer - org-replace-region-by-ascii - org-export-region-as-ascii which are similar to what is available for HTML and LaTeX. `C-c C-e A' used to be the key for publishing all projects. This functionality has now been moved to `C-c C-e E'.
2009-05-04 12:26:42 -04:00
(?A org-export-as-ascii-to-buffer t)
Add special commands for latin1 and utf8 export
2010-03-29 09:10:56 -04:00
(?n org-export-as-latin1 t)
(?N org-export-as-latin1-to-buffer t)
(?u org-export-as-utf8 t)
(?U org-export-as-utf8-to-buffer t)
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
(?h org-export-as-html t)
(?b org-export-as-html-and-open t)
(?H org-export-as-html-to-buffer nil)
(?R org-export-region-as-html nil)
(?x org-export-as-xoxo t)
Add Wes Hardaker's generic exporter as a contributed package
2009-06-20 14:53:03 -04:00
(?g org-export-generic t)
preparatory work
2009-03-18 08:49:02 -04:00
(?D org-export-as-docbook t)
DocBook export: Installed the new DocBook exporter by Baoqiu Cui
2009-03-30 01:17:09 -04:00
(?V org-export-as-docbook-pdf-and-open t)
org-export: Reserve a slot for OpenDocumentExporter PATCH-1/5 for org-odt compatibility From 06379ccef996e8dabd8dcced6cbe430aacdef3f0 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 01:53:37 +0530 Subject: [PATCH 1/5] org-export: Reserve a slot for OpenDocumentExporter. * lisp/org-exp.el (org-export): Reserve keys 'o' and 'O' for OpenDocumentText export and bind them to org-export-as-odt and org-export-as-odt-and-open.
2011-06-23 11:52:22 -04:00
(?o org-export-as-odt t)
(?O org-export-as-odt-and-open t)
Added taskjuggler export to the export dispatcher
2010-06-07 11:09:12 -04:00
(?j org-export-as-taskjuggler t)
(?J org-export-as-taskjuggler-and-open t)
Install the Lennart Borgman's freemind exporter
2009-10-27 11:28:03 -04:00
(?m org-export-as-freemind t)
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
(?l org-export-as-latex t)
Add commands to export to PDF. This works by creating LaTeX first, and then processing it.
2008-10-15 11:21:52 -04:00
(?p org-export-as-pdf t)
(?d org-export-as-pdf-and-open t)
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
(?L org-export-as-latex-to-buffer nil)
(?i org-export-icalendar-this-file t)
(?I org-export-icalendar-all-agenda-files t)
(?c org-export-icalendar-combine-agenda-files t)
(?F org-publish-current-file t)
(?P org-publish-current-project t)
(?X org-publish t)
ASCII Export: Implement export to buffer Samuel Wales writes: > I frequently export to ascii without wanting a file to be created, > especially not in a useful directory, as the files are temporary. > > Is there a way to export ascii to just a buffer? There is now, `C-c C-e A'. This commit also implements commands - org-export-as-ascii-to-buffer - org-replace-region-by-ascii - org-export-region-as-ascii which are similar to what is available for HTML and LaTeX. `C-c C-e A' used to be the key for publishing all projects. This functionality has now been moved to `C-c C-e E'.
2009-05-04 12:26:42 -04:00
(?E org-publish-all t)))
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
r1 r2 ass
(cpos (point)) (cbuf (current-buffer)) bpos)
Export: Count levels relative when doing subtree export. William Henney writes: Consider a structure like this: * first ** second *** third **** fourth Currently, if I export the "third" sub-tree to html (via "C-c @ C-x C-e h"), then "third" becomes an <h1> heading, but "fourth" becomes an <h5> heading. I would rather it were <h2>, i.e. that all heading levels be relative to the root of the sub-tree. Is there any way to achieve this? This was not possible so far, but this commit measures the first headline of the subtree and applies an offset to all level values.
2009-02-06 12:07:26 -05:00
(save-excursion
(save-window-excursion
New variable to set the initial export scope. * org-exp.el (org-export-initial-scope): new custom variable. (org-export): Use this new variable. If there is an active region, tell it when prompting the user for an export command. Also change the way the function handles selection of buffer and subtree export. ---- Now `1' switches between subtree/buffer export until the user select an export command. Also, when there is an active region, modify the message so that the user is aware he will only export the surrounding subtree.
2011-02-11 04:44:35 -05:00
(if subtree-p
(message "Export subtree: ")
(message "Export buffer: "))
Export: Count levels relative when doing subtree export. William Henney writes: Consider a structure like this: * first ** second *** third **** fourth Currently, if I export the "third" sub-tree to html (via "C-c @ C-x C-e h"), then "third" becomes an <h1> heading, but "fourth" becomes an <h5> heading. I would rather it were <h2>, i.e. that all heading levels be relative to the root of the sub-tree. Is there any way to achieve this? This was not possible so far, but this commit measures the first headline of the subtree and applies an offset to all level values.
2009-02-06 12:07:26 -05:00
(delete-other-windows)
(with-output-to-temp-buffer "*Org Export/Publishing Help*"
(princ help))
(org-fit-window-to-buffer (get-buffer-window
"*Org Export/Publishing Help*"))
New variable to set the initial export scope. * org-exp.el (org-export-initial-scope): new custom variable. (org-export): Use this new variable. If there is an active region, tell it when prompting the user for an export command. Also change the way the function handles selection of buffer and subtree export. ---- Now `1' switches between subtree/buffer export until the user select an export command. Also, when there is an active region, modify the message so that the user is aware he will only export the surrounding subtree.
2011-02-11 04:44:35 -05:00
(while (eq (setq r1 (read-char-exclusive)) ?1)
(cond (subtree-p
(setq subtree-p nil)
(message "Export buffer: "))
Code cleanup: use a generic :for-backend parameter.
2011-02-15 05:07:46 -05:00
((not subtree-p)
New variable to set the initial export scope. * org-exp.el (org-export-initial-scope): new custom variable. (org-export): Use this new variable. If there is an active region, tell it when prompting the user for an export command. Also change the way the function handles selection of buffer and subtree export. ---- Now `1' switches between subtree/buffer export until the user select an export command. Also, when there is an active region, modify the message so that the user is aware he will only export the surrounding subtree.
2011-02-11 04:44:35 -05:00
(setq subtree-p t)
Restore point when exporting a subtree * lisp/org-exp.el (org-export): Restore point when exporting a subtree.
2011-09-14 01:48:49 -04:00
(setq bpos (point))
New variable to set the initial export scope. * org-exp.el (org-export-initial-scope): new custom variable. (org-export): Use this new variable. If there is an active region, tell it when prompting the user for an export command. Also change the way the function handles selection of buffer and subtree export. ---- Now `1' switches between subtree/buffer export until the user select an export command. Also, when there is an active region, modify the message so that the user is aware he will only export the surrounding subtree.
2011-02-11 04:44:35 -05:00
(message "Export subtree: "))))
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
(when (eq r1 ?\ )
Another fix for exporting enclosing class/title piece in buffer * lisp/org-exp.el (org-export): Define a bound for finding enclosing tree with class/title definition.
2011-04-21 12:03:05 -04:00
(let ((case-fold-search t)
(end (save-excursion (while (org-up-heading-safe)) (point))))
Make exporting the enclosing entry with CLASS/TITLE property work better * lisp/org-exp.el (org-export): Go to next heading before searching backward, so make this also work if we are on the headline of the entry with the property...
2011-04-21 11:55:18 -04:00
(outline-next-heading)
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
(if (re-search-backward
Export: Add EXPORT_FILE_NAME to the enclosing tree properties * lisp/org-exp.el (org-export): Add EXPORT_FILE_NAME to the enclosing tree properties
2011-04-22 05:23:18 -04:00
"^[ \t]+\\(:latex_class:\\|:export_title:\\|:export_file_name:\\)[ \t]+\\S-"
Another fix for exporting enclosing class/title piece in buffer * lisp/org-exp.el (org-export): Define a bound for finding enclosing tree with class/title definition.
2011-04-21 12:03:05 -04:00
end t)
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
(progn
(org-back-to-heading t)
(setq subtree-p t)
(setq bpos (point))
(message "Select command (for subtree): ")
(setq r1 (read-char-exclusive)))
Export: Add EXPORT_FILE_NAME to the enclosing tree properties * lisp/org-exp.el (org-export): Add EXPORT_FILE_NAME to the enclosing tree properties
2011-04-22 05:23:18 -04:00
(error "No enclosing node with LaTeX_CLASS or EXPORT_TITLE or EXPORT_FILE_NAME")
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
)))))
Maintain XEmacs compatibility * lisp/ob-calc.el (featurep): Require calc-store. * lisp/org-agenda.el (org-agenda-list-stuck-projects): Fix regexp special handling. * lisp/org-compat.el (fboundp): Support for XEmacs. * lisp/org-exp.el (org-export): Protect XEmacs from `(redisplay)' call. * lisp/org-footnote.el (org-footnote-re): Optimize macro processing. * lisp/org.el (org-set-autofill-regexps): Xemacs compatibility. Patch by Michael Sperber, checked and slightly modified by Carsten.
2011-10-21 16:36:53 -04:00
(if (fboundp 'redisplay) (redisplay)) ;; XEmacs does not have/need (redisplay)
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
(and bpos (goto-char bpos))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(setq r2 (if (< r1 27) (+ r1 96) r1))
Final changes before release. This implements executing export commands in the background. Also, the documentation has been updated.
2008-04-14 01:47:32 -04:00
(unless (setq ass (assq r2 cmds))
(error "No command associated with key %c" r1))
Fix a giant, horrible bug in org-publish. When publishing, org was more or less trying to export random files.
2008-10-21 12:21:52 -04:00
(if (and bg (nth 2 ass)
(not (buffer-base-buffer))
(not (org-region-active-p)))
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
;; execute in background
(let ((p (start-process
(concat "Exporting " (file-name-nondirectory (buffer-file-name)))
"*Org Processes*"
(expand-file-name invocation-name invocation-directory)
"-batch"
"-l" user-init-file
"--eval" "(require 'org-exp)"
"--eval" "(setq org-wait .2)"
(buffer-file-name)
"-f" (symbol-name (nth 1 ass)))))
(set-process-sentinel p 'org-export-process-sentinel)
(message "Background process \"%s\": started" p))
;; background processing not requested, or not possible
Provide compatibility function for `activate-mark' * org-exp.el (org-export): Use new compatibility function `org-activate-mark'. * org-compat.el (org-activate-mark): New function. Provide `activate-mark' if not present (e.g. Emacs22). Emacs 22 misses this function. Defun copied from Emac23's `active-mark' but removed reference to customization variable `select-active-regions' which is not present in Emacs22.
2011-05-29 14:50:18 -04:00
(if subtree-p (progn (org-mark-subtree) (org-activate-mark)))
New way to export the enclosing subtree Press SPC after `C-c C-e' to export the enclosing subtree. That subtree is assumes to start at a node with LaTeX_CLASS or EXPORT_FILE_NAME property.
2010-01-10 02:34:20 -05:00
(call-interactively (nth 1 ass))
(when (and bpos (get-buffer-window cbuf))
(let ((cw (selected-window)))
(select-window (get-buffer-window cbuf))
(goto-char cpos)
(deactivate-mark)
(select-window cw))))))
Final changes before release. This implements executing export commands in the background. Also, the documentation has been updated.
2008-04-14 01:47:32 -04:00
(defun org-export-process-sentinel (process status)
(if (string-match "\n+\\'" status)
(setq status (substring status 0 -1)))
Correct dependencies in the Makefile. Also a new variable and better implementation around export processing in the background.
2008-04-14 08:59:37 -04:00
(message "Background process \"%s\": %s" process status))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;;; General functions for all backends
Make invisible targets anchors in the headlines or items. Org allows to define invisible anchors in a document in comment lines like If such a line is directly before or after a headline, previously this anchor was removed, and all references to it were replaced with references to the anchor that the headline had anyway. Matthew Lundin pointed out that this makes it impossible to have permanent links to headlines that can also be used from outside the current page. This patch changes his situation by adding the additional targets as empty anchors to the section heading. If works by creating, during preprocessing, an alist with targets that do have aliases. During publishing, these aliases are looked up and converted into anchors. In LaTeX export, these additional targets become additional labels.
2008-11-16 16:12:57 -05:00
(defvar org-export-target-aliases nil
"Alist of targets with invisible aliases.")
Export: Use custom IDs. Users can now define custom IDs for use in HTML export. These IDs are stores as property CUSTOM_ID. When present, HTML will prefer using these over automatic targets like "sec-N.M".
2009-04-16 12:19:20 -04:00
(defvar org-export-preferred-target-alist nil
"Alist of section id's with preferred aliases.")
Implement index generation during export This new code will search #+INDEX lines in the buffer. For LaTeX, it will simple convert these into LaTeX \index{} commands. For other backends, it will copy thee entries to a new file, with extension orgx. These files can then later be post-processed to create the index.
2010-02-25 01:31:29 -05:00
(defvar org-export-id-target-alist nil
"Alist of section id's with preferred aliases.")
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(defvar org-export-code-refs nil
Correct some docstrings [part 2] This is a second patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil
2010-07-15 18:54:53 -04:00
"Alist of code references and line numbers.")
Make invisible targets anchors in the headlines or items. Org allows to define invisible anchors in a document in comment lines like If such a line is directly before or after a headline, previously this anchor was removed, and all references to it were replaced with references to the anchor that the headline had anyway. Matthew Lundin pointed out that this makes it impossible to have permanent links to headlines that can also be used from outside the current page. This patch changes his situation by adding the additional targets as empty anchors to the section heading. If works by creating, during preprocessing, an alist with targets that do have aliases. During publishing, these aliases are looked up and converted into anchors. In LaTeX export, these additional targets become additional labels.
2008-11-16 16:12:57 -05:00
Improved the treatment of internal links during export. So far only internal links that lead to a dedicated target where converted correctly during HTML export. Now, also heuristic links create a working jump in a file.
2008-04-13 13:26:31 -04:00
(defun org-export-preprocess-string (string &rest parameters)
Docstring fix for org-export-preprocess-string Hi, I found a trivial error with this docstring. --8<---------------cut here---------------start------------->8--- --8<---------------cut here---------------end--------------->8--- Best regards, Seb
2011-03-10 17:13:30 -05:00
"Cleanup STRING so that the true exported has a more consistent source.
Improved the treatment of internal links during export. So far only internal links that lead to a dedicated target where converted correctly during HTML export. Now, also heuristic links create a working jump in a file.
2008-04-13 13:26:31 -04:00
This function takes STRING, which should be a buffer-string of an org-file
to export. It then creates a temporary buffer where it does its job.
The result is then again returned as a string, and the exporter works
on this string to produce the exported version."
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(interactive)
EXPERIMENTAL/org-export.el: Delete redundant function. `org-export-export-preprocess-string' was a dummy copy of `org-export-preprocess-string', adapted for specific needs of org-mw-export. We now use `org-export-preprocess-string' directly. This requires a minor change in this latter function: if :for-backend is not explicitely passed, then the let binding of `org-export-current-backend' falls back on the previous value of org-export-current-backend'.
2011-07-06 06:56:53 -04:00
(let* ((org-export-current-backend (or (plist-get parameters :for-backend)
org-export-current-backend))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(archived-trees (plist-get parameters :archived-trees))
(inhibit-read-only t)
(drawers org-drawers)
New function `org-clone-local-variables'. * org-exp.el (org-export-preprocess-string): Set the source buffer and use `org-clone-local-variables' to get local variables from it. * org.el (org-clone-local-variables): New function.
2011-01-31 20:00:44 -05:00
(source-buffer (current-buffer))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
target-alist rtn)
Bug fix. Regular expression needed an anchor.
2008-04-13 16:47:08 -04:00
Implement index generation during export This new code will search #+INDEX lines in the buffer. For LaTeX, it will simple convert these into LaTeX \index{} commands. For other backends, it will copy thee entries to a new file, with extension orgx. These files can then later be post-processed to create the index.
2010-02-25 01:31:29 -05:00
(setq org-export-target-aliases nil
org-export-preferred-target-alist nil
org-export-id-target-alist nil
org-export-code-refs nil)
Make invisible targets anchors in the headlines or items. Org allows to define invisible anchors in a document in comment lines like If such a line is directly before or after a headline, previously this anchor was removed, and all references to it were replaced with references to the anchor that the headline had anyway. Matthew Lundin pointed out that this makes it impossible to have permanent links to headlines that can also be used from outside the current page. This patch changes his situation by adding the additional targets as empty anchors to the section heading. If works by creating, during preprocessing, an alist with targets that do have aliases. During publishing, these aliases are looked up and converted into anchors. In LaTeX export, these additional targets become additional labels.
2008-11-16 16:12:57 -05:00
Correctly export lists in footnotes (take 2) * lisp/org-exp.el (org-export-preprocess-string): add the possibility to call recursively the function. Also change order of some function calls. Comment export process for footnotes. * lisp/org-footnote.el (org-footnote-normalize): change the export specific parameter to hold properties of export. Thus, the function can send every footnote definition in the buffer through `org-export-process-string'.
2011-07-12 13:33:52 -04:00
(with-temp-buffer
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(erase-buffer)
(insert string)
Make sure structure commands can be either case.
2008-05-14 08:23:44 -04:00
(setq case-fold-search t)
Implementing the eval tags like <lisp> in Muse.
2008-04-28 16:47:04 -04:00
Allow to export to LaTeX while in column view
2009-12-16 05:12:05 -05:00
(let ((inhibit-read-only t))
(remove-text-properties (point-min) (point-max)
'(read-only t)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; Remove license-to-kill stuff
Fix typos in org-exp.el
2008-12-16 10:30:46 -05:00
;; The caller marks some stuff for killing, stuff that has been
Improved the treatment of internal links during export. So far only internal links that lead to a dedicated target where converted correctly during HTML export. Now, also heuristic links create a working jump in a file.
2008-04-13 13:26:31 -04:00
;; used to create the page title, for example.
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(org-export-kill-licensed-text)
Remove unnecessary whitespace.
2008-12-04 09:33:43 -05:00
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(let ((org-inhibit-startup t)) (org-mode))
Make sure structure commands can be either case.
2008-05-14 08:23:44 -04:00
(setq case-fold-search t)
New function `org-clone-local-variables'. * org-exp.el (org-export-preprocess-string): Set the source buffer and use `org-clone-local-variables' to get local variables from it. * org.el (org-clone-local-variables): New function.
2011-01-31 20:00:44 -05:00
(org-clone-local-variables source-buffer "^\\(org-\\|orgtbl-\\)")
Export: General mechanism for local settings Many different people want to set many different variables in a buffer-local way for export. This cannot be done with file variables, because the Org buffer is not current while the exporter is running. Lots of variables can be set with the #+OPTIONS lines, but finding abbreviations goes only so far. Therefore we have now a general mechanism that can be used to bind variables during export operations. a line like: #+BIND: variable value will bind the variable to value. For example, the line >> #+OPTIONS: toc:nil can now equivalently be written as >> #+BIND: org-export-with-toc nil
2009-07-06 11:00:03 -04:00
(org-install-letbind)
Export: New hooks for preprocessing This patch introduces more hooks for preprocessing the export buffer, at various strategic moments. See the Changes.org file for a description of the hooks.
2008-12-31 12:37:33 -05:00
;; Call the hook
(run-hooks 'org-export-preprocess-hook)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(untabify (point-min) (point-max))
Remove unnecessary whitespace.
2008-12-04 09:33:43 -05:00
Export: New hooks for preprocessing This patch introduces more hooks for preprocessing the export buffer, at various strategic moments. See the Changes.org file for a description of the hooks.
2008-12-31 12:37:33 -05:00
;; Handle include files, and call a hook
org-exp: now recursively resolve #+INCLUDE: files in a safe way * lisp/org-exp.el (org-export-preprocess-string): now using `org-export-handle-include-files-recurse' to resolve included files (org-export-handle-include-files): now returns a list of the included files (org-export-handle-include-files-recurse): recursively calls `org-export-handle-include-files' while checking to see if the process has entered an infinite loop. Thanks to Eric Schulte for this patch.
2010-06-16 12:13:13 -04:00
(org-export-handle-include-files-recurse)
Export: New hooks for preprocessing This patch introduces more hooks for preprocessing the export buffer, at various strategic moments. See the Changes.org file for a description of the hooks.
2008-12-31 12:37:33 -05:00
(run-hooks 'org-export-preprocess-after-include-files-hook)
Remove unnecessary whitespace.
2008-12-04 09:33:43 -05:00
Export: New hooks for preprocessing This patch introduces more hooks for preprocessing the export buffer, at various strategic moments. See the Changes.org file for a description of the hooks.
2008-12-31 12:37:33 -05:00
;; Get rid of archived trees
(org-export-remove-archived-trees archived-trees)
;; Remove comment environment and comment subtrees
(org-export-remove-comment-blocks-and-subtrees)
;; Get rid of excluded trees, and call a hook
Intermediate
2008-09-16 10:52:21 -04:00
(org-export-handle-export-tags (plist-get parameters :select-tags)
(plist-get parameters :exclude-tags))
Export: New hooks for preprocessing This patch introduces more hooks for preprocessing the export buffer, at various strategic moments. See the Changes.org file for a description of the hooks.
2008-12-31 12:37:33 -05:00
(run-hooks 'org-export-preprocess-after-tree-selection-hook)
Intermediate
2008-09-16 10:52:21 -04:00
org-exp: remove tasks before normalizing footnotes * lisp/org-exp.el (org-export-preprocess-string): if the last subtree is a task, footnotes may be removed along with the subtree. This patch ensures footnotes are put at the end of the buffer after the subtree has been removed.
2011-07-05 14:42:15 -04:00
;; Get rid of tasks, depending on configuration
(org-export-remove-tasks (plist-get parameters :tasks))
Correctly export lists in footnotes (take 2) * lisp/org-exp.el (org-export-preprocess-string): add the possibility to call recursively the function. Also change order of some function calls. Comment export process for footnotes. * lisp/org-footnote.el (org-footnote-normalize): change the export specific parameter to hold properties of export. Thus, the function can send every footnote definition in the buffer through `org-export-process-string'.
2011-07-12 13:33:52 -04:00
;; Prepare footnotes for export. During that process, footnotes
;; actually included in the exported part of the buffer go
;; though some transformations:
;; 1. They have their label normalized (like "[N]");
;; 2. They get moved at the same place in the buffer (usually at
;; its end, but backends may define another place via
;; `org-footnote-insert-pos-for-preprocessor');
;; 3. The are stored in `org-export-footnotes-seen', while
;; `org-export-preprocess-string' is applied to their
;; definition.
;; Line-wise exporters ignore `org-export-footnotes-seen', as
;; they interpret footnotes at the moment they see them in the
;; buffer. Context-wise exporters grab all the info needed in
;; that variable and delete moved definitions (as described in
;; 2nd step).
org-exp: normalize footnotes after removing commented subtrees * lisp/org-exp.el (org-export-preprocess-string): if the last subtree is commented, footnotes inserted during normalizing at the end of the buffer may get deleted. This patch ensures deletion comes first, normalization second.
2011-06-28 11:07:37 -04:00
(when (plist-get parameters :footnotes)
Correctly export lists in footnotes (take 2) * lisp/org-exp.el (org-export-preprocess-string): add the possibility to call recursively the function. Also change order of some function calls. Comment export process for footnotes. * lisp/org-footnote.el (org-footnote-normalize): change the export specific parameter to hold properties of export. Thus, the function can send every footnote definition in the buffer through `org-export-process-string'.
2011-07-12 13:33:52 -04:00
(org-footnote-normalize nil parameters))
;; Change lists ending. Other parts of export may insert blank
;; lines and lists' structure could be altered.
(org-export-mark-list-end)
;; Process the macros
(org-export-preprocess-apply-macros)
(run-hooks 'org-export-preprocess-after-macros-hook)
org-exp: normalize footnotes after removing commented subtrees * lisp/org-exp.el (org-export-preprocess-string): if the last subtree is commented, footnotes inserted during normalizing at the end of the buffer may get deleted. This patch ensures deletion comes first, normalization second.
2011-06-28 11:07:37 -04:00
babel: delay call to `org-export-blocks-preprocess' in export * lisp/org-exp.el (org-export-preprocess-string): delaying code block processing a bit to allow correct list parsing in the export string
2010-11-11 21:08:09 -05:00
;; Export code blocks
(org-export-blocks-preprocess)
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
;; Mark lists with properties
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(org-export-mark-list-properties)
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
Implement color formatting of code examples during HTML export.
2008-05-03 10:17:43 -04:00
;; Handle source code snippets
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(org-export-replace-src-segments-and-examples)
Whitespace
2008-12-16 11:57:11 -05:00
Export: Better handling of colon examples. Lines preceded by a colon are treated as fixed-width examples. This commit improves the moment when the protection of these lines happens during preprocessing. And it enforces that a space must follow the colon for the line to be treated in this way.
2009-01-09 02:28:43 -05:00
;; Protect short examples marked by a leading colon
(org-export-protect-colon-examples)
Rewrite of the clock table code * lisp/org.el (org-shorten-string): New function. * lisp/org-exp.el (org-export-convert-protected-spaces): New function. (org-export-preprocess-string): Call `org-export-convert-protected-spaces' to handle new hard spaces. * lisp/org-clock.el (org-clocktable): New customization group. (org-clocktable-defaults): New option. (org-clock-clocktable-formatter): New option. (org-clock-clocktable-default-properties): New option. (org-dblock-write:clocktable): Rewrite to split out functionality into separate functions. (org-clocktable-write-default): (org-clocktable-indent-string): (org-clock-get-table-data): New functions. * lisp/org-agenda.el (org-agenda-list): (org-agenda-redo): (org-agenda-clockreport-mode): (org-agenda-set-mode-name): Rewrite to implement filtered clock tables. * doc/org.texi (Clocking commands): (The clock table): New sections. (Agenda commands): Document filtered clock reports.
2010-11-01 08:30:44 -04:00
;; Protected spaces
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(org-export-convert-protected-spaces)
Rewrite of the clock table code * lisp/org.el (org-shorten-string): New function. * lisp/org-exp.el (org-export-convert-protected-spaces): New function. (org-export-preprocess-string): Call `org-export-convert-protected-spaces' to handle new hard spaces. * lisp/org-clock.el (org-clocktable): New customization group. (org-clocktable-defaults): New option. (org-clock-clocktable-formatter): New option. (org-clock-clocktable-default-properties): New option. (org-dblock-write:clocktable): Rewrite to split out functionality into separate functions. (org-clocktable-write-default): (org-clocktable-indent-string): (org-clock-get-table-data): New functions. * lisp/org-agenda.el (org-agenda-list): (org-agenda-redo): (org-agenda-clockreport-mode): (org-agenda-set-mode-name): Rewrite to implement filtered clock tables. * doc/org.texi (Clocking commands): (The clock table): New sections. (Agenda commands): Document filtered clock reports.
2010-11-01 08:30:44 -04:00
Implement a new link type "id:" to link to entry ids.
2008-11-17 04:27:44 -05:00
;; Find all headings and compute the targets for them
(setq target-alist (org-export-define-heading-targets target-alist))
Remove unnecessary whitespace.
2008-12-04 09:33:43 -05:00
Implement index generation during export This new code will search #+INDEX lines in the buffer. For LaTeX, it will simple convert these into LaTeX \index{} commands. For other backends, it will copy thee entries to a new file, with extension orgx. These files can then later be post-processed to create the index.
2010-02-25 01:31:29 -05:00
(run-hooks 'org-export-preprocess-after-headline-targets-hook)
HTML export: Add class to outline containers using property The HTML_CONTAINER_CLASS property can now be used to add a property to the outline container of a node.
2010-02-01 03:37:35 -05:00
;; Find HTML special classes for headlines
(org-export-remember-html-container-classes)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; Get rid of drawers
Fix the export of drawers Exporting drawers was not really supported, now it is. Drawers that are selected for export are formatted using the function specified in the variable `org-export-format-drawer-function'. If that is nil, the default `org-export-format-drawer' will publish the drawer as a colon example, i.e. verbatim and in fixed-width.
2009-11-11 13:14:43 -05:00
(org-export-remove-or-extract-drawers
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
drawers (plist-get parameters :drawers))
Remove unnecessary whitespace.
2008-12-04 09:33:43 -05:00
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; Get the correct stuff before the first headline
(when (plist-get parameters :skip-before-1st-heading)
(goto-char (point-min))
Export: Fix bug with exporting text before first heading Skipping text before the first heading was broken, now it works again.
2009-02-06 06:44:52 -05:00
(when (re-search-forward "^\\(#.*\n\\)?\\*+[ \t]" nil t)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(delete-region (point-min) (match-beginning 0))
(goto-char (point-min))
(insert "\n")))
(when (plist-get parameters :add-text)
(goto-char (point-min))
(insert (plist-get parameters :add-text) "\n"))
Remove unnecessary whitespace.
2008-12-04 09:33:43 -05:00
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
;; Remove todo-keywords before exporting, if the user has requested so
(org-export-remove-headline-metadata parameters)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; Find targets in comments and move them out of comments,
;; but mark them as targets that should be invisible
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(setq target-alist (org-export-handle-invisible-targets target-alist))
Export: Better handling of colon examples. Lines preceded by a colon are treated as fixed-width examples. This commit improves the moment when the protection of these lines happens during preprocessing. And it enforces that a space must follow the colon for the line to be treated in this way.
2009-01-09 02:28:43 -05:00
;; Select and protect backend specific stuff, throw away stuff
;; that is specific for other backends
New hook `org-export-preprocess-before-selecting-backend-code-hook'
2009-12-11 02:41:53 -05:00
(run-hooks 'org-export-preprocess-before-selecting-backend-code-hook)
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(org-export-select-backend-specific-text)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; Protect quoted subtrees
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(org-export-protect-quoted-subtrees)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
Export: Fix problem with => in clock lines triggering verbatim text. Reported by Daniel Clemente.
2009-02-07 06:33:37 -05:00
;; Remove clock lines
(org-export-remove-clock-lines)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; Protect verbatim elements
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(org-export-protect-verbatim)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
Centering: Implement markup for centered text.
2009-03-16 17:14:15 -04:00
;; Blockquotes, verse, and center
(org-export-mark-blockquote-verse-center)
Export: New hooks for Chris Gray's LaTeX/HTML blocks Chris Gray had the idea to have arbitrary blocks turned in LaTeX environments and HTML divs. These three new hooks allow implementation has an add-on rather than a patch.
2009-05-02 02:02:17 -04:00
(run-hooks 'org-export-preprocess-after-blockquote-hook)
Implement the verse environment.
2008-05-13 09:57:23 -04:00
Export: Better handling of colon examples. Lines preceded by a colon are treated as fixed-width examples. This commit improves the moment when the protection of these lines happens during preprocessing. And it enforces that a space must follow the colon for the line to be treated in this way.
2009-01-09 02:28:43 -05:00
;; Remove timestamps, if the user has requested so
(unless (plist-get parameters :timestamps)
(org-export-remove-timestamps))
Fix typos in org-exp.el
2008-12-16 10:30:46 -05:00
;; Attach captions to the correct object
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(setq target-alist (org-export-attach-captions-and-attributes target-alist))
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; Find matches for radio targets and turn them into internal links
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(org-export-mark-radio-links)
Add org-wikinodes.el as a contributed package * contrib/lisp/org-wikinodes.el: New file. * lisp/org-exp.el (org-export-preprocess-after-radio-targets-hook): (org-export-define-heading-targets-headline-hook): New hooks. * lisp/org.el (org-modules): Add entry for org-wikinodes.el. (org-font-lock-set-keywords-hook): New hook. (org-open-at-point-functions): New hook. (org-find-exact-headling-in-buffer): (org-find-exact-heading-in-directory): New functions. (org-mode-flyspell-verify): Better cursor position for checking if flyspell should ignore a word.
2010-07-16 08:15:41 -04:00
(run-hooks 'org-export-preprocess-after-radio-targets-hook)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; Find all links that contain a newline and put them into a single line
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(org-export-concatenate-multiline-links)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
Fix bug with link normalization and link abbrev expansion.
2008-07-05 11:06:10 -04:00
;; Normalize links: Convert angle and plain links into bracket links
;; and expand link abbreviations
New link types that force special ways of opening the file file+sys:/path/to/file will use the system to open the file, like double-clicking would file+emacs:/path/to/file will force opening by Emacs Also, when using C-c C-o on a headline of get a list of links in the entry, pressing RET will open *all* links. This allows something like projects to be defined, with a number of files that have to be opened by different applications. These were requests by John Wiegley.
2010-01-04 07:04:38 -05:00
(run-hooks 'org-export-preprocess-before-normalizing-links-hook)
Fix bug with link normalization and link abbrev expansion.
2008-07-05 11:06:10 -04:00
(org-export-normalize-links)
Improved the treatment of internal links during export. So far only internal links that lead to a dedicated target where converted correctly during HTML export. Now, also heuristic links create a working jump in a file.
2008-04-13 13:26:31 -04:00
;; Find all internal links. If they have a fuzzy match (i.e. not
;; a *dedicated* target match, let the link point to the
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
;; corresponding section.
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(org-export-target-internal-links target-alist)
Release 6.02.
2008-04-24 04:29:47 -04:00
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; Find multiline emphasis and put them into single line
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(when (plist-get parameters :emph-multiline)
(org-export-concatenate-multiline-emphasis))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
HTML export: Use forced alignment like <l> or <r> in tables * lisp/org-table.el (org-table-cookie-line-p): Fix indentation. * lisp/org-exp.el (org-store-forced-table-alignment): New function. (org-export-preprocess-string): Call `org-store-forced-table-alignment'. * lisp/org-html.el (org-format-org-table-html): Use stored alignment information.
2010-10-21 10:28:06 -04:00
;; Remove special table lines, and store alignment information
(org-store-forced-table-alignment)
intermediate
2008-10-10 02:46:05 -04:00
(when org-export-table-remove-special-lines
(org-export-remove-special-table-lines))
Export: New hooks for preprocessing This patch introduces more hooks for preprocessing the export buffer, at various strategic moments. See the Changes.org file for a description of the hooks.
2008-12-31 12:37:33 -05:00
;; Another hook
(run-hooks 'org-export-preprocess-before-backend-specifics-hook)
org-export-preprocess-string: Use backend var
2011-02-19 11:56:10 -05:00
;; Backend-specific preprocessing
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(let* ((backend-name (symbol-name org-export-current-backend))
org-export-preprocess-string: Use backend var
2011-02-19 11:56:10 -05:00
(f (intern (format "org-export-%s-preprocess" backend-name))))
(require (intern (concat "org-" backend-name)) nil)
(funcall f parameters))
Docbook export: Make changes to support docbook export
2009-03-08 01:49:51 -05:00
intermediate
2008-10-10 02:46:05 -04:00
;; Remove or replace comments
(org-export-handle-comments (plist-get parameters :comments))
org-exp: now removing table meta (e.g. #+TBLNAME, #+TBLFM) from export * lisp/org-exp.el (org-export-handle-table-metalines): this function removes table specific meta-lines, now that we aren't wiping everything that looks remotely like a comment at the end of the export process we have to be sure to catch all of the specific lines in org-exp.el
2010-06-30 19:01:38 -04:00
;; Remove #+TBLFM and #+TBLNAME lines
(org-export-handle-table-metalines)
Code cleanup: use a generic :for-backend parameter.
2011-02-15 05:07:46 -05:00
org-export: Cleanup #+name and #+results * lisp/org-exp.el (org-export-res/src-name-cleanup): Remove #+name and #+results lines during preprocess. Now Babel doesn't handle anymore those keywords cleanup (as #+name may be used for other thing than code evaluation), that task is moved to org-export.el. See commit 25a0a0212193ecc5e910696301b3a64a51f837e0.
2011-12-04 11:00:46 -05:00
;; Remove #+results and #+name lines
(org-export-res/src-name-cleanup)
Export: New hooks for preprocessing This patch introduces more hooks for preprocessing the export buffer, at various strategic moments. See the Changes.org file for a description of the hooks.
2008-12-31 12:37:33 -05:00
;; Run the final hook
(run-hooks 'org-export-preprocess-final-hook)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(setq rtn (buffer-string)))
rtn))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(defun org-export-kill-licensed-text ()
"Remove all text that is marked with a :org-license-to-kill property."
Maintenance: Remove unused variables.
2009-01-26 03:42:33 -05:00
(let (p)
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(while (setq p (text-property-any (point-min) (point-max)
:org-license-to-kill t))
Allow omitting the "file:" prefix in some file links. The file path must be absolute, or it must start with "./" or "../".
2008-06-24 02:37:50 -04:00
(delete-region
p (or (next-single-property-change p :org-license-to-kill)
(point-max))))))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
Add org-wikinodes.el as a contributed package * contrib/lisp/org-wikinodes.el: New file. * lisp/org-exp.el (org-export-preprocess-after-radio-targets-hook): (org-export-define-heading-targets-headline-hook): New hooks. * lisp/org.el (org-modules): Add entry for org-wikinodes.el. (org-font-lock-set-keywords-hook): New hook. (org-open-at-point-functions): New hook. (org-find-exact-headling-in-buffer): (org-find-exact-heading-in-directory): New functions. (org-mode-flyspell-verify): Better cursor position for checking if flyspell should ignore a word.
2010-07-16 08:15:41 -04:00
(defvar org-export-define-heading-targets-headline-hook nil
"Hook that is run when a headline was matched during target search.
This is part of the preprocessing for export.")
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(defun org-export-define-heading-targets (target-alist)
"Find all headings and define the targets for them.
Export: Fix bug with ID property search Jan Bcker writes: > If you have a headline with an elisp code block containing the following > line: > > " :ID:" > > the HTML code will be garbled at the beginning of the headline. > > I have attached a minimal test case and the resulting HTML file. The > #+OPTIONS: line is not needed, but is included to make the HTML file > less cluttered. > > There has to be whitespace between the " and :ID: and the string must be > ended on the same line. For example, these lines trigger the bug: > > " :ID:" > " :ID:" > " :ID: garble-my-html" > > while these do not: > > ":ID:" > ":ID: garble-my-html" > " :ID: >
2010-04-15 23:12:19 -04:00
The new targets are added to TARGET-ALIST, which is also returned.
Correct some docstrings [part 2] This is a second patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil
2010-07-15 18:54:53 -04:00
Also find all ID and CUSTOM_ID properties and store them."
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(goto-char (point-min))
(org-init-section-numbers)
Implement a new link type "id:" to link to entry ids.
2008-11-17 04:27:44 -05:00
(let ((re (concat "^" org-outline-regexp
Export: Fix bug with ID property search Jan Bcker writes: > If you have a headline with an elisp code block containing the following > line: > > " :ID:" > > the HTML code will be garbled at the beginning of the headline. > > I have attached a minimal test case and the resulting HTML file. The > #+OPTIONS: line is not needed, but is included to make the HTML file > less cluttered. > > There has to be whitespace between the " and :ID: and the string must be > ended on the same line. For example, these lines trigger the bug: > > " :ID:" > " :ID:" > " :ID: garble-my-html" > > while these do not: > > ":ID:" > ":ID: garble-my-html" > " :ID: >
2010-04-15 23:12:19 -04:00
"\\|"
"^[ \t]*:\\(ID\\|CUSTOM_ID\\):[ \t]*\\([^ \t\r\n]+\\)"))
Export: Use custom IDs. Users can now define custom IDs for use in HTML export. These IDs are stores as property CUSTOM_ID. When present, HTML will prefer using these over automatic targets like "sec-N.M".
2009-04-16 12:19:20 -04:00
level target last-section-target a id)
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(while (re-search-forward re nil t)
Export: Fix bug with ID property search Jan Bcker writes: > If you have a headline with an elisp code block containing the following > line: > > " :ID:" > > the HTML code will be garbled at the beginning of the headline. > > I have attached a minimal test case and the resulting HTML file. The > #+OPTIONS: line is not needed, but is included to make the HTML file > less cluttered. > > There has to be whitespace between the " and :ID: and the string must be > ended on the same line. For example, these lines trigger the bug: > > " :ID:" > " :ID:" > " :ID: garble-my-html" > > while these do not: > > ":ID:" > ":ID: garble-my-html" > " :ID: >
2010-04-15 23:12:19 -04:00
(org-if-unprotected-at (match-beginning 0)
(if (match-end 2)
(progn
(setq id (org-match-string-no-properties 2))
(push (cons id target) target-alist)
(setq a (or (assoc last-section-target org-export-target-aliases)
(progn
(push (list last-section-target)
org-export-target-aliases)
(car org-export-target-aliases))))
(push (caar target-alist) (cdr a))
(when (equal (match-string 1) "CUSTOM_ID")
(if (not (assoc last-section-target
org-export-preferred-target-alist))
(push (cons last-section-target id)
org-export-preferred-target-alist)))
(when (equal (match-string 1) "ID")
(if (not (assoc last-section-target
org-export-id-target-alist))
(push (cons last-section-target (concat "ID-" id))
org-export-id-target-alist))))
(setq level (org-reduced-level
(save-excursion (goto-char (point-at-bol))
(org-outline-level))))
(setq target (org-solidify-link-text
Modify xhtml IDs to comply with CSS standards
2010-04-24 11:37:39 -04:00
(format "sec-%s" (replace-regexp-in-string
Change underscores to hyphens in section labels * lisp/org-exp.el (org-export-define-heading-targets): Use dash instead of underscore to make labels valid. Currently, the section number (a string of the form "X.Y.Z") is used to manufacture a section label of the form sec-X_Y_Z. Underscores are overloaded however, both in org and in LaTeX, and cause conflicts with some packages. This patch changes underscores to hyphens in section labels. TINYCHANGE
2011-05-18 20:58:40 -04:00
"\\." "-"
Modify xhtml IDs to comply with CSS standards
2010-04-24 11:37:39 -04:00
(org-section-number level)))))
Export: Fix bug with ID property search Jan Bcker writes: > If you have a headline with an elisp code block containing the following > line: > > " :ID:" > > the HTML code will be garbled at the beginning of the headline. > > I have attached a minimal test case and the resulting HTML file. The > #+OPTIONS: line is not needed, but is included to make the HTML file > less cluttered. > > There has to be whitespace between the " and :ID: and the string must be > ended on the same line. For example, these lines trigger the bug: > > " :ID:" > " :ID:" > " :ID: garble-my-html" > > while these do not: > > ":ID:" > ":ID: garble-my-html" > " :ID: >
2010-04-15 23:12:19 -04:00
(setq last-section-target target)
(push (cons target target) target-alist)
(add-text-properties
(point-at-bol) (point-at-eol)
Add org-wikinodes.el as a contributed package * contrib/lisp/org-wikinodes.el: New file. * lisp/org-exp.el (org-export-preprocess-after-radio-targets-hook): (org-export-define-heading-targets-headline-hook): New hooks. * lisp/org.el (org-modules): Add entry for org-wikinodes.el. (org-font-lock-set-keywords-hook): New hook. (org-open-at-point-functions): New hook. (org-find-exact-headling-in-buffer): (org-find-exact-heading-in-directory): New functions. (org-mode-flyspell-verify): Better cursor position for checking if flyspell should ignore a word.
2010-07-16 08:15:41 -04:00
(list 'target target))
(run-hooks 'org-export-define-heading-targets-headline-hook)))))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
target-alist)
(defun org-export-handle-invisible-targets (target-alist)
"Find targets in comments and move them out of comments.
Mark them as invisible targets."
Make invisible targets anchors in the headlines or items. Org allows to define invisible anchors in a document in comment lines like If such a line is directly before or after a headline, previously this anchor was removed, and all references to it were replaced with references to the anchor that the headline had anyway. Matthew Lundin pointed out that this makes it impossible to have permanent links to headlines that can also be used from outside the current page. This patch changes his situation by adding the additional targets as empty anchors to the section heading. If works by creating, during preprocessing, an alist with targets that do have aliases. During publishing, these aliases are looked up and converted into anchors. In LaTeX export, these additional targets become additional labels.
2008-11-16 16:12:57 -05:00
(let (target tmp a)
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(goto-char (point-min))
(while (re-search-forward "^#.*?\\(<<<?\\([^>\r\n]+\\)>>>?\\).*" nil t)
;; Check if the line before or after is a headline with a target
(if (setq target (or (get-text-property (point-at-bol 0) 'target)
(get-text-property (point-at-bol 2) 'target)))
(progn
;; use the existing target in a neighboring line
(setq tmp (match-string 2))
(replace-match "")
(and (looking-at "\n") (delete-char 1))
Make invisible targets anchors in the headlines or items. Org allows to define invisible anchors in a document in comment lines like If such a line is directly before or after a headline, previously this anchor was removed, and all references to it were replaced with references to the anchor that the headline had anyway. Matthew Lundin pointed out that this makes it impossible to have permanent links to headlines that can also be used from outside the current page. This patch changes his situation by adding the additional targets as empty anchors to the section heading. If works by creating, during preprocessing, an alist with targets that do have aliases. During publishing, these aliases are looked up and converted into anchors. In LaTeX export, these additional targets become additional labels.
2008-11-16 16:12:57 -05:00
(push (cons (setq tmp (org-solidify-link-text tmp)) target)
target-alist)
(setq a (or (assoc target org-export-target-aliases)
(progn
(push (list target) org-export-target-aliases)
(car org-export-target-aliases))))
(push tmp (cdr a)))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
;; Make an invisible target
(replace-match "\\1(INVISIBLE)"))))
target-alist)
(defun org-export-target-internal-links (target-alist)
Implement a new link type "id:" to link to entry ids.
2008-11-17 04:27:44 -05:00
"Find all internal links and assign targets to them.
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
If a link has a fuzzy match (i.e. not a *dedicated* target match),
Implement a new link type "id:" to link to entry ids.
2008-11-17 04:27:44 -05:00
let the link point to the corresponding section.
This function also handles the id links, if they have a match in
the current file."
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(goto-char (point-min))
(while (re-search-forward org-bracket-link-regexp nil t)
Repair the export of source code line references in LaTeX Marting G. Skjaeveland writes: > I pulled a fresh copy of org-mode this morning and noticed that > references to source code line numbers no longer work as they used > to. Instead of displaying the number of the line with the label, the > label is displayed. > > Exporting the following example, retrieved from the online > documentation (http://orgmode.org/manual/Literal-examples.html), > > -------------------------------------start > #+BEGIN_SRC emacs-lisp -n -r > (save-excursion (ref:sc) > (goto-char (point-min)) (ref:jump) > #+END_SRC > > In line [[(sc)]] we remember the current position. [[(jump)][Line > (jump)]] jumps to point-min. > > -------------------------------------end > > gives me in latex export > > -------------------------------------start > \begin{verbatim} > 1: (save-excursion > 2: (goto-char (point-min)) > \end{verbatim} > > In line \hyperref[(sc)]{(sc)} we remember the current > position. \hyperref[(jump)]{Line (jump)} jumps to point-min. > -------------------------------------end >
2010-01-14 12:06:22 -05:00
(org-if-unprotected-at (1+ (match-beginning 0))
Fix bug in org-export-target-internal-links. * org-exp.el (org-export-target-internal-links): Locally turn on `org-link-search-must-match-exact-headline' to match exact internal links. Thanks to Jambunathan K for spotting this.
2011-02-03 11:59:56 -05:00
(let* ((org-link-search-must-match-exact-headline t)
(md (match-data))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(desc (match-end 2))
(link (org-link-unescape (match-string 1)))
(slink (org-solidify-link-text link))
Coderefs: Insert links in export backends This patch covers the three main backends, html, latex, and ascii. It adds the code to make sure the coderef links identified by the preprocessing will be implemented correctly when a backend does its work.
2008-12-26 11:37:53 -05:00
found props pos cref
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(target
Allow omitting the "file:" prefix in some file links. The file path must be absolute, or it must start with "./" or "../".
2008-06-24 02:37:50 -04:00
(cond
HTML export: Protect explicit target links If a link is [[#name][desc]], the href wil be exacty href="#name". So starting a link target with # will indicate that there will be an explicit target for this.
2009-03-12 06:38:44 -04:00
((= (string-to-char link) ?#)
;; user wants exactly this link
link)
Export: Use custom IDs. Users can now define custom IDs for use in HTML export. These IDs are stores as property CUSTOM_ID. When present, HTML will prefer using these over automatic targets like "sec-N.M".
2009-04-16 12:19:20 -04:00
((cdr (assoc slink target-alist))
(or (cdr (assoc (assoc slink target-alist)
org-export-preferred-target-alist))
(cdr (assoc slink target-alist))))
Implement a new link type "id:" to link to entry ids.
2008-11-17 04:27:44 -05:00
((and (string-match "^id:" link)
(cdr (assoc (substring link 3) target-alist))))
Coderefs: Revamp label syntax. This commit revamps the syntax used for code line references in literal examples. See the documentation for details about the new format.
2009-01-05 07:23:42 -05:00
((string-match "^(\\(.*\\))$" link)
Coderefs: Insert links in export backends This patch covers the three main backends, html, latex, and ascii. It adds the code to make sure the coderef links identified by the preprocessing will be implemented correctly when a backend does its work.
2008-12-26 11:37:53 -05:00
(setq cref (match-string 1 link))
(concat "coderef:" cref))
Allow omitting the "file:" prefix in some file links. The file path must be absolute, or it must start with "./" or "../".
2008-06-24 02:37:50 -04:00
((string-match org-link-types-re link) nil)
((or (file-name-absolute-p link)
(string-match "^\\." link))
nil)
(t
Make internal links in Org files search for an exact headline match * lisp/org.el (org-link-search-must-match-exact-headline): New option. (org-link-search-inhibit-query): New variable. (org-link-search): Search for exact headline match in Org files * doc/org.texi (Internal links): Document the changes in internal links. Internal links used to do a fuzzy text search for the link text. This patch changes the behavior for Org files. Here a link [[My Target]] now searches for an exact headline match, i.e. for a headline that does look like "* My Target", optionally with TODO keyword, priority cookie and tags. The new option `org-link-search-must-match-exact-headline' is `query-to-create' by default. This means that a failed link search will offer to create the headline as a top-level headline at the end of the buffer. This corresponds to a wiki-like behavior where missing targets are automatically created. If you do not like this behavior, change the option to t.
2010-08-06 02:34:33 -04:00
(let ((org-link-search-inhibit-query t))
(save-excursion
(setq found (condition-case nil (org-link-search link)
(error nil)))
(when (and found
Code cleanup up: rename org-on-*-p to org-at-*-p. Rename `org-on-heading-p' and `org-on-target-p' to `org-at-heading-p' and `org-at-target-p' to be more consistent with the org-at-*-p family. Also define two aliases.
2012-01-02 13:52:35 -05:00
(or (org-at-heading-p)
Make internal links in Org files search for an exact headline match * lisp/org.el (org-link-search-must-match-exact-headline): New option. (org-link-search-inhibit-query): New variable. (org-link-search): Search for exact headline match in Org files * doc/org.texi (Internal links): Document the changes in internal links. Internal links used to do a fuzzy text search for the link text. This patch changes the behavior for Org files. Here a link [[My Target]] now searches for an exact headline match, i.e. for a headline that does look like "* My Target", optionally with TODO keyword, priority cookie and tags. The new option `org-link-search-must-match-exact-headline' is `query-to-create' by default. This means that a failed link search will offer to create the headline as a top-level headline at the end of the buffer. This corresponds to a wiki-like behavior where missing targets are automatically created. If you do not like this behavior, change the option to t.
2010-08-06 02:34:33 -04:00
(not (eq found 'dedicated))))
(or (get-text-property (point) 'target)
(get-text-property
(max (point-min)
(1- (or (previous-single-property-change
(point) 'target) 0)))
'target)))))))))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(when target
(set-match-data md)
(goto-char (match-beginning 1))
(setq props (text-properties-at (point)))
(delete-region (match-beginning 1) (match-end 1))
(setq pos (point))
(insert target)
(unless desc (insert "][" link))
(add-text-properties pos (point) props))))))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
HTML export: Add class to outline containers using property The HTML_CONTAINER_CLASS property can now be used to add a property to the outline container of a node.
2010-02-01 03:37:35 -05:00
(defun org-export-remember-html-container-classes ()
"Store the HTML_CONTAINER_CLASS properties in a text property."
(goto-char (point-min))
(let (class)
(while (re-search-forward
Allow for multiple classes in HTML_CONTAINER_CLASS. Based on a patch submitted by David Maus: http://patchwork.newartisans.com/patch/178/
2010-08-01 05:32:17 -04:00
"^[ \t]*:HTML_CONTAINER_CLASS:[ \t]+\\(.+\\)$" nil t)
HTML export: Add class to outline containers using property The HTML_CONTAINER_CLASS property can now be used to add a property to the outline container of a node.
2010-02-01 03:37:35 -05:00
(setq class (match-string 1))
(save-excursion
(org-back-to-heading t)
(put-text-property (point-at-bol) (point-at-eol) 'html-container-class class)))))
Keep byte compiler happy
2009-11-13 01:09:47 -05:00
(defvar org-export-format-drawer-function nil
"Function to be called to format the contents of a drawer.
org-exp: fix a doc-string
2011-07-29 09:46:03 -04:00
The function must accept two parameters:
Keep byte compiler happy
2009-11-13 01:09:47 -05:00
NAME the drawer name, like \"PROPERTIES\"
CONTENT the content of the drawer.
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
You can check the export backend through `org-export-current-backend'.
Keep byte compiler happy
2009-11-13 01:09:47 -05:00
The function should return the text to be inserted into the buffer.
If this is nil, `org-export-format-drawer' is used as a default.")
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(defun org-export-remove-or-extract-drawers (all-drawers exp-drawers)
Fix the export of drawers Exporting drawers was not really supported, now it is. Drawers that are selected for export are formatted using the function specified in the variable `org-export-format-drawer-function'. If that is nil, the default `org-export-format-drawer' will publish the drawer as a colon example, i.e. verbatim and in fixed-width.
2009-11-11 13:14:43 -05:00
"Remove drawers, or extract and format the content.
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
ALL-DRAWERS is a list of all drawer names valid in the current buffer.
EXP-DRAWERS can be t to keep all drawer contents, or a list of drawers
Fix the export of drawers Exporting drawers was not really supported, now it is. Drawers that are selected for export are formatted using the function specified in the variable `org-export-format-drawer-function'. If that is nil, the default `org-export-format-drawer' will publish the drawer as a colon example, i.e. verbatim and in fixed-width.
2009-11-11 13:14:43 -05:00
whose content to keep. Any drawers that are in ALL-DRAWERS but not in
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
EXP-DRAWERS will be removed."
Fix the export of drawers Exporting drawers was not really supported, now it is. Drawers that are selected for export are formatted using the function specified in the variable `org-export-format-drawer-function'. If that is nil, the default `org-export-format-drawer' will publish the drawer as a colon example, i.e. verbatim and in fixed-width.
2009-11-11 13:14:43 -05:00
(goto-char (point-min))
(let ((re (concat "^[ \t]*:\\("
(mapconcat 'identity all-drawers "\\|")
"\\):[ \t]*$"))
Keep byte compiler happy
2009-11-13 01:09:47 -05:00
name beg beg-content eol content)
Fix the export of drawers Exporting drawers was not really supported, now it is. Drawers that are selected for export are formatted using the function specified in the variable `org-export-format-drawer-function'. If that is nil, the default `org-export-format-drawer' will publish the drawer as a colon example, i.e. verbatim and in fixed-width.
2009-11-11 13:14:43 -05:00
(while (re-search-forward re nil t)
(org-if-unprotected
(setq name (match-string 1))
(setq beg (match-beginning 0)
beg-content (1+ (point-at-eol))
eol (point-at-eol))
(if (not (and (re-search-forward
"^\\([ \t]*:END:[ \t]*\n?\\)\\|^\\*+[ \t]" nil t)
(match-end 1)))
(goto-char eol)
(goto-char (match-beginning 0))
(and (looking-at ".*\n?") (replace-match ""))
(setq content (buffer-substring beg-content (point)))
(delete-region beg (point))
(when (or (eq exp-drawers t)
(member name exp-drawers))
(setq content (funcall (or org-export-format-drawer-function
'org-export-format-drawer)
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
name content))
Fix the export of drawers Exporting drawers was not really supported, now it is. Drawers that are selected for export are formatted using the function specified in the variable `org-export-format-drawer-function'. If that is nil, the default `org-export-format-drawer' will publish the drawer as a colon example, i.e. verbatim and in fixed-width.
2009-11-11 13:14:43 -05:00
(insert content)))))))
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(defun org-export-format-drawer (name content)
Fix the export of drawers Exporting drawers was not really supported, now it is. Drawers that are selected for export are formatted using the function specified in the variable `org-export-format-drawer-function'. If that is nil, the default `org-export-format-drawer' will publish the drawer as a colon example, i.e. verbatim and in fixed-width.
2009-11-11 13:14:43 -05:00
"Format the content of a drawer as a colon example."
(if (string-match "[ \t]+\\'" content)
(setq content (substring content (match-beginning 0))))
(while (string-match "\\`[ \t]*\n" content)
Keep byte compiler happy
2009-11-13 01:09:47 -05:00
(setq content (substring content (match-end 0))))
Fix the export of drawers Exporting drawers was not really supported, now it is. Drawers that are selected for export are formatted using the function specified in the variable `org-export-format-drawer-function'. If that is nil, the default `org-export-format-drawer' will publish the drawer as a colon example, i.e. verbatim and in fixed-width.
2009-11-11 13:14:43 -05:00
(setq content (org-remove-indentation content))
(setq content (concat ": " (mapconcat 'identity
(org-split-string content "\n")
"\n: ")
"\n"))
(setq content (concat " : " (upcase name) "\n" content))
(org-add-props content nil 'org-protected t))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
Allow tags to select parts of a document for export.
2008-09-17 07:47:18 -04:00
(defun org-export-handle-export-tags (select-tags exclude-tags)
"Modify the buffer, honoring SELECT-TAGS and EXCLUDE-TAGS.
Both arguments are lists of tags.
If any of SELECT-TAGS is found, all trees not marked by a SELECT-TAG
will be removed.
After that, all subtrees that are marked by EXCLUDE-TAGS will be
removed as well."
(remove-text-properties (point-min) (point-max) '(:org-delete t))
(let* ((re-sel (concat ":\\(" (mapconcat 'regexp-quote
select-tags "\\|")
"\\):"))
(re-excl (concat ":\\(" (mapconcat 'regexp-quote
exclude-tags "\\|")
"\\):"))
Get rid of some compiler messages by fixing bugs and definitions.
2008-09-17 07:55:59 -04:00
beg end cont)
Allow tags to select parts of a document for export.
2008-09-17 07:47:18 -04:00
(goto-char (point-min))
(when (and select-tags
(re-search-forward
(concat "^\\*+[ \t].*" re-sel "[^ \t\n]*[ \t]*$") nil t))
;; At least one tree is marked for export, this means
;; all the unmarked stuff needs to go.
;; Dig out the trees that should be exported
(goto-char (point-min))
(outline-next-heading)
(setq beg (point))
(put-text-property beg (point-max) :org-delete t)
(while (re-search-forward re-sel nil t)
Code cleanup up: rename org-on-*-p to org-at-*-p. Rename `org-on-heading-p' and `org-on-target-p' to `org-at-heading-p' and `org-at-target-p' to be more consistent with the org-at-*-p family. Also define two aliases.
2012-01-02 13:52:35 -05:00
(when (org-at-heading-p)
Allow tags to select parts of a document for export.
2008-09-17 07:47:18 -04:00
(org-back-to-heading)
(remove-text-properties
(max (1- (point)) (point-min))
(setq cont (save-excursion (org-end-of-subtree t t)))
'(:org-delete t))
(while (and (org-up-heading-safe)
(get-text-property (point) :org-delete))
(remove-text-properties (max (1- (point)) (point-min))
(point-at-eol) '(:org-delete t)))
(goto-char cont))))
;; Remove the trees explicitly marked for noexport
(when exclude-tags
(goto-char (point-min))
(while (re-search-forward re-excl nil t)
(when (org-at-heading-p)
(org-back-to-heading t)
(setq beg (point))
Remove inlinetask END line when excluded from export
2009-10-10 10:54:13 -04:00
(org-end-of-subtree t t)
(delete-region beg (point))
(when (featurep 'org-inlinetask)
(org-inlinetask-remove-END-maybe)))))
Allow tags to select parts of a document for export.
2008-09-17 07:47:18 -04:00
;; Remove everything that is now still marked for deletion
(goto-char (point-min))
(while (setq beg (text-property-any (point-min) (point-max) :org-delete t))
(setq end (or (next-single-property-change beg :org-delete)
(point-max)))
(delete-region beg end))))
Clean up the new options to remove tasks on export
2011-03-29 23:27:43 -04:00
(defun org-export-remove-tasks (keep)
Allow to exclude tasks from being exported * doc/org.texi (Selective export): Document exclusion of any tasks from export. * lisp/org-exp.el (org-export-with-tasks): New option. (org-export-plist-vars): Add :tasks property.
2011-03-29 18:48:29 -04:00
"Remove tasks depending on configuration.
Clean up the new options to remove tasks on export
2011-03-29 23:27:43 -04:00
When KEEP is nil, remove all tasks.
When KEEP is `todo', remove the tasks that are DONE.
When KEEP is `done', remove the tasks that are not yet done.
When it is a list of strings, keep only tasks with these TODO keywords."
(when (or (listp keep) (memq keep '(todo done nil)))
Allow to exclude tasks from being exported * doc/org.texi (Selective export): Document exclusion of any tasks from export. * lisp/org-exp.el (org-export-with-tasks): New option. (org-export-plist-vars): Add :tasks property.
2011-03-29 18:48:29 -04:00
(let ((re (concat "^\\*+[ \t]+\\("
(mapconcat
'regexp-quote
Clean up the new options to remove tasks on export
2011-03-29 23:27:43 -04:00
(cond ((not keep) org-todo-keywords-1)
((eq keep 'todo) org-done-keywords)
((eq keep 'done) org-not-done-keywords)
((listp keep)
(org-delete-all keep (copy-sequence
org-todo-keywords-1))))
Allow to exclude tasks from being exported * doc/org.texi (Selective export): Document exclusion of any tasks from export. * lisp/org-exp.el (org-export-with-tasks): New option. (org-export-plist-vars): Add :tasks property.
2011-03-29 18:48:29 -04:00
"\\|")
"\\)\\($\\|[ \t]\\)"))
Implement export without DONE tasks * doc/org.texi (Selective export): Document how to exclude DONE tasks from export. (Publishing options): Document the properties to be used to turn off export of DONE tasks. * lisp/org-ascii.el (org-export-as-ascii): * lisp/org-docbook.el (org-export-as-docbook): * lisp/org-html.el (org-export-as-html): * lisp/org-latex.el (org-export-as-latex): Pass the :done-tasks property to the export preprocessor. * lisp/org-exp.el (org-export-with-done-tasks): New option. (org-export-plist-vars): Add entry for :done-tasks. (org-export-preprocess-string): Call `org-export-remove-done-tasks'. (org-export-remove-done-tasks): New function.
2011-03-29 11:29:24 -04:00
(case-fold-search nil)
beg)
Allow to exclude tasks from being exported * doc/org.texi (Selective export): Document exclusion of any tasks from export. * lisp/org-exp.el (org-export-with-tasks): New option. (org-export-plist-vars): Add :tasks property.
2011-03-29 18:48:29 -04:00
(goto-char (point-min))
(while (re-search-forward re nil t)
(org-if-unprotected
(setq beg (match-beginning 0))
(org-end-of-subtree t t)
(if (looking-at "^\\*+[ \t]+END[ \t]*$")
;; Kill the END line of the inline task
(goto-char (min (point-max) (1+ (match-end 0)))))
(delete-region beg (point)))))))
Implement export without DONE tasks * doc/org.texi (Selective export): Document how to exclude DONE tasks from export. (Publishing options): Document the properties to be used to turn off export of DONE tasks. * lisp/org-ascii.el (org-export-as-ascii): * lisp/org-docbook.el (org-export-as-docbook): * lisp/org-html.el (org-export-as-html): * lisp/org-latex.el (org-export-as-latex): Pass the :done-tasks property to the export preprocessor. * lisp/org-exp.el (org-export-with-done-tasks): New option. (org-export-plist-vars): Add entry for :done-tasks. (org-export-preprocess-string): Call `org-export-remove-done-tasks'. (org-export-remove-done-tasks): New function.
2011-03-29 11:29:24 -04:00
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(defun org-export-remove-archived-trees (export-archived-trees)
"Remove archived trees.
When EXPORT-ARCHIVED-TREES is `headline;, only the headline will be exported.
When it is t, the entire archived tree will be exported.
When it is nil the entire tree including the headline will be removed
from the buffer."
(let ((re-archive (concat ":" org-archive-tag ":"))
a b)
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(when (not (eq export-archived-trees t))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(goto-char (point-min))
(while (re-search-forward re-archive nil t)
Code cleanup up: rename org-on-*-p to org-at-*-p. Rename `org-on-heading-p' and `org-on-target-p' to `org-at-heading-p' and `org-at-target-p' to be more consistent with the org-at-*-p family. Also define two aliases.
2012-01-02 13:52:35 -05:00
(if (not (org-at-heading-p t))
Fix export bug of a region with an ARCHIVE property set
2010-11-01 08:57:02 -04:00
(goto-char (point-at-eol))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(beginning-of-line 1)
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(setq a (if export-archived-trees
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(1+ (point-at-eol)) (point))
b (org-end-of-subtree t))
(if (> b a) (delete-region a b)))))))
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
(defun org-export-remove-headline-metadata (opts)
Document a function.
2008-12-03 03:33:24 -05:00
"Remove meta data from the headline, according to user options."
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
(let ((re org-complex-heading-regexp)
(todo (plist-get opts :todo-keywords))
(tags (plist-get opts :tags))
(pri (plist-get opts :priority))
Better implementation of unique entry IDs. Unique identifiers for entries can now be used more efficiently. Internally, a hash array has replaced the alist used so far to keep track of the files in which an ID is defined. This makes it quite fast to find an entry by ID. There is now a new link type which looks like this: id:GLOBALLY-UNIQUE-IDENTIFIER This link points to a specific entry. When you move the entry to a different file, for example if you move it to an archive file, this link will continue to work. The file /org-id.el/ contains an API that can be used to write code using these identifiers, including creating IDs and finding them wherever they are. Org has its own method to create unique identifiers, but if the system has /uuidgen/ command installed (Mac's and Linux systems generally do), it will be used by default. You an also select the method by hand, using the variable =org-id-method=. If the ID system ever gets confused about where a certain ID is, it initiates a global scan of all agenda files with associated archives, all files previously known containing any IDs, and all currently visited Org-mode files to rebuild the hash. You can also initiate this by hand: =M-x org-id-update-id-locations=. Running this command will also dump into the =*Messages*= buffer information about any duplicate IDs. These should not exist, but if you /copy/ an entry with its properties, duplicate IDs will inevitably be produced. This is unavoidable in a plain text system that allows you to edit the text in arbitrary ways, and a portion of care on your side is needed to keep this system clean. The hash is stored in the file =~/.emacs.d/.org-id-locations=. This is also a change from previous versions where the file was =~/.org=id-locations=. Therefore, you can remove this old file if you have it. I am not sure what will happen if the =.emacs.d= directory does not exists in your setup, but in modern Emacsen, I believe it should exist. If you do not want to use IDs across files, you can avoid the overhead with tracking IDs by customizing the variable =org-id-track-globally=. IDs can then still be used for links inside a single file. IDs will also be used when you create a new link to an Org-mode buffer. If you use =org-store-link= (normally at =C-c l=) inside en entry in an Org-mode buffer, and ID property will be created if it does not exist, and the stored link will be an =id:= link. If you prefer the much less secure linking to headline text, you can configure the variable =org-link-to-org-use-id=. The default setting for this variable is =create-if-interactive=, meaning that an ID will be created when you store a link interactively, but not if you happen to be in an Org-mode file while you create a remember note (which usually has a link to the place where you were when starting remember).
2008-12-05 17:35:26 -05:00
(elts '(1 2 3 4 5))
Bugfix when exporting TODO keywords from the headline. * org-exp.el (org-export-remove-headline-metadata): bugfix: don't case-fold-search to avoid mixing TODO keywords with real headline words. Thanks to Samuel Wales for spotting and reporting this.
2011-03-02 12:43:50 -05:00
(case-fold-search nil)
Maintenance: Remove unused variables.
2009-01-26 03:42:33 -05:00
rpl)
Better implementation of unique entry IDs. Unique identifiers for entries can now be used more efficiently. Internally, a hash array has replaced the alist used so far to keep track of the files in which an ID is defined. This makes it quite fast to find an entry by ID. There is now a new link type which looks like this: id:GLOBALLY-UNIQUE-IDENTIFIER This link points to a specific entry. When you move the entry to a different file, for example if you move it to an archive file, this link will continue to work. The file /org-id.el/ contains an API that can be used to write code using these identifiers, including creating IDs and finding them wherever they are. Org has its own method to create unique identifiers, but if the system has /uuidgen/ command installed (Mac's and Linux systems generally do), it will be used by default. You an also select the method by hand, using the variable =org-id-method=. If the ID system ever gets confused about where a certain ID is, it initiates a global scan of all agenda files with associated archives, all files previously known containing any IDs, and all currently visited Org-mode files to rebuild the hash. You can also initiate this by hand: =M-x org-id-update-id-locations=. Running this command will also dump into the =*Messages*= buffer information about any duplicate IDs. These should not exist, but if you /copy/ an entry with its properties, duplicate IDs will inevitably be produced. This is unavoidable in a plain text system that allows you to edit the text in arbitrary ways, and a portion of care on your side is needed to keep this system clean. The hash is stored in the file =~/.emacs.d/.org-id-locations=. This is also a change from previous versions where the file was =~/.org=id-locations=. Therefore, you can remove this old file if you have it. I am not sure what will happen if the =.emacs.d= directory does not exists in your setup, but in modern Emacsen, I believe it should exist. If you do not want to use IDs across files, you can avoid the overhead with tracking IDs by customizing the variable =org-id-track-globally=. IDs can then still be used for links inside a single file. IDs will also be used when you create a new link to an Org-mode buffer. If you use =org-store-link= (normally at =C-c l=) inside en entry in an Org-mode buffer, and ID property will be created if it does not exist, and the stored link will be an =id:= link. If you prefer the much less secure linking to headline text, you can configure the variable =org-link-to-org-use-id=. The default setting for this variable is =create-if-interactive=, meaning that an ID will be created when you store a link interactively, but not if you happen to be in an Org-mode file while you create a remember note (which usually has a link to the place where you were when starting remember).
2008-12-05 17:35:26 -05:00
(setq elts (delq nil (list 1 (if todo 2) (if pri 3) 4 (if tags 5))))
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
(when (or (not todo) (not tags) (not pri))
(goto-char (point-min))
(while (re-search-forward re nil t)
Export: Protect examples from headline processing Lines that looked like headlines in examples could still be processes as headings. This commit make sure all converted examples are protected.
2009-01-06 03:36:38 -05:00
(org-if-unprotected
(setq rpl (mapconcat (lambda (i) (if (match-end i) (match-string i) ""))
elts " "))
(replace-match rpl t t))))))
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
LaTeX Export: More standardization This commit removes some of the stuff that was specific for the LaTeX exporter, and falls back to the default configuration that works for all backends. Here is what the commit does: - The variable `org-export-latex-remove-from-headlines' is now obsolete. Instead, also LaTeX export now responds to the settings in the variables org-export-with-todo-keywords', `org-export-with-priority', and `org-export-with-tags' and in the corresponding OPTION settings. - Removal of time stamps and related keywords now already happens in the preprocessor, so that it will be perfectly the same for all backends. - The list functions have been extended to accept an additional parameter list, to overrule the default setting for a particular list function. This is used to make the checkbox appearance in LaTeX configurable, through the new variable `org-export-latex-list-parameters'.
2009-01-06 11:23:36 -05:00
(defun org-export-remove-timestamps ()
"Remove timestamps and keywords for export."
Export: Make sure all preprocessor functions see the whole buffer
2009-04-09 03:32:11 -04:00
(goto-char (point-min))
LaTeX Export: More standardization This commit removes some of the stuff that was specific for the LaTeX exporter, and falls back to the default configuration that works for all backends. Here is what the commit does: - The variable `org-export-latex-remove-from-headlines' is now obsolete. Instead, also LaTeX export now responds to the settings in the variables org-export-with-todo-keywords', `org-export-with-priority', and `org-export-with-tags' and in the corresponding OPTION settings. - Removal of time stamps and related keywords now already happens in the preprocessor, so that it will be perfectly the same for all backends. - The list functions have been extended to accept an additional parameter list, to overrule the default setting for a particular list function. This is used to make the checkbox appearance in LaTeX configurable, through the new variable `org-export-latex-list-parameters'.
2009-01-06 11:23:36 -05:00
(while (re-search-forward org-maybe-keyword-time-regexp nil t)
Bugfix: Do not check for protection at the end of the line. The end of the last line of a colon example is not protected, and this caused the time stamp removal protection to fail if a time stamp was the last thing in such an example.
2009-01-09 02:30:17 -05:00
(backward-char 1)
LaTeX Export: More standardization This commit removes some of the stuff that was specific for the LaTeX exporter, and falls back to the default configuration that works for all backends. Here is what the commit does: - The variable `org-export-latex-remove-from-headlines' is now obsolete. Instead, also LaTeX export now responds to the settings in the variables org-export-with-todo-keywords', `org-export-with-priority', and `org-export-with-tags' and in the corresponding OPTION settings. - Removal of time stamps and related keywords now already happens in the preprocessor, so that it will be perfectly the same for all backends. - The list functions have been extended to accept an additional parameter list, to overrule the default setting for a particular list function. This is used to make the checkbox appearance in LaTeX configurable, through the new variable `org-export-latex-list-parameters'.
2009-01-06 11:23:36 -05:00
(org-if-unprotected
Export: Fix timestamp processing There were two bugs: 1. Timestamp processing did not honor the setting of `org-export-with-timestamps' in the text before the first headline. 2. When `org-export-with-timestamps' was nil, time stamps were removed even in tables. I think this is incorrect, so in tables, time stamps are now never removed.
2009-01-26 01:36:01 -05:00
(unless (save-match-data (org-at-table-p))
(replace-match "")
(beginning-of-line 1)
(if (looking-at "[- \t]*\\(=>[- \t0-9:]*\\)?[ \t]*\n")
(replace-match ""))))))
LaTeX Export: More standardization This commit removes some of the stuff that was specific for the LaTeX exporter, and falls back to the default configuration that works for all backends. Here is what the commit does: - The variable `org-export-latex-remove-from-headlines' is now obsolete. Instead, also LaTeX export now responds to the settings in the variables org-export-with-todo-keywords', `org-export-with-priority', and `org-export-with-tags' and in the corresponding OPTION settings. - Removal of time stamps and related keywords now already happens in the preprocessor, so that it will be perfectly the same for all backends. - The list functions have been extended to accept an additional parameter list, to overrule the default setting for a particular list function. This is used to make the checkbox appearance in LaTeX configurable, through the new variable `org-export-latex-list-parameters'.
2009-01-06 11:23:36 -05:00
(defun org-export-remove-clock-lines ()
Clocking: Capture clock in LOGBOOK drawer, abandon CLOCK drawer Clock lines are now by default captured into the drawer LOGBOOK. This means that, if state notes are also captured into a drawer, they will be mixed with notes.
2009-02-14 19:15:37 -05:00
"Remove clock lines for export."
Export: Make sure all preprocessor functions see the whole buffer
2009-04-09 03:32:11 -04:00
(goto-char (point-min))
LaTeX Export: More standardization This commit removes some of the stuff that was specific for the LaTeX exporter, and falls back to the default configuration that works for all backends. Here is what the commit does: - The variable `org-export-latex-remove-from-headlines' is now obsolete. Instead, also LaTeX export now responds to the settings in the variables org-export-with-todo-keywords', `org-export-with-priority', and `org-export-with-tags' and in the corresponding OPTION settings. - Removal of time stamps and related keywords now already happens in the preprocessor, so that it will be perfectly the same for all backends. - The list functions have been extended to accept an additional parameter list, to overrule the default setting for a particular list function. This is used to make the checkbox appearance in LaTeX configurable, through the new variable `org-export-latex-list-parameters'.
2009-01-06 11:23:36 -05:00
(let ((re (concat "^[ \t]*" org-clock-string ".*\n?")))
(while (re-search-forward re nil t)
(org-if-unprotected
(replace-match "")))))
Fix compiler warnings.
2011-10-28 11:26:22 -04:00
(defvar org-heading-keyword-regexp-format) ; defined in org.el
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(defun org-export-protect-quoted-subtrees ()
"Mark quoted subtrees with the protection property."
Provide more consistent regexps for headlines * lisp/org-agenda.el (org-search-view): Simplify regexp. (org-agenda-get-todos): Use new format string. * lisp/org-archive.el (org-archive-all-done): Simplify regexp. * lisp/org-ascii.el (org-export-as-ascii): More accurate regexp. * lisp/org-colview-xemacs.el (org-columns-capture-view): Use new format string and new string. * lisp/org-colview.el (org-columns-capture-view): Use new format string and new string. * lisp/org-docbook.el (org-export-as-docbook): More accurate regexp. Also use new regexp to match generic headlines. * lisp/org-exp.el (org-export-protect-quoted-subtrees): More accurate regexp. Also use new regexp to match generic headlines. * lisp/org-html.el (org-export-as-html): More accurate regexp. Also use new regexp to match generic headlines. * lisp/org-mouse.el (org-mouse-match-todo-keyword): Removed unused and now erroneous function. * lisp/org.el (org-heading-regexp, org-heading-keyword-regexp-format): New variables. (org-set-regexps-and-options): Create regexps according to the following rule: use spaces only to separate elements from an headline, while allowing mixed tabs and spaces for any indentation job. (org-nl-done-regexp, org-looking-at-done-regexp): Removed variables. (org-set-font-lock-defaults): Fontify again headlines with a keyword and no other text. Use new format strings. (org-get-heading, org-toggle-comment, org-prepare-agenda-buffers, org-toggle-fixed-width-section): Use new format string. (org-todo): More accurate regexps. (org-point-at-end-of-empty-headline): Simplify regexp. (org-insert-heading): Headline can sometimes be nil. This patch attempts to reduce the number of hard-coded headlines, by providing two format strings and one generic string to cover most of the cases of headline construction.
2011-08-24 19:58:29 -04:00
(let ((org-re-quote (format org-heading-keyword-regexp-format
org-quote-string)))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(goto-char (point-min))
Fix (a lot of) compiler warnings. Also introduce `org-pop-to-buffer-same-window' as a compatibility function for Emacs =>24.1.
2011-07-18 13:25:10 -04:00
(while (re-search-forward org-re-quote nil t)
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(goto-char (match-beginning 0))
(end-of-line 1)
(add-text-properties (point) (org-end-of-subtree t)
'(org-protected t)))))
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(defun org-export-convert-protected-spaces ()
Rewrite of the clock table code * lisp/org.el (org-shorten-string): New function. * lisp/org-exp.el (org-export-convert-protected-spaces): New function. (org-export-preprocess-string): Call `org-export-convert-protected-spaces' to handle new hard spaces. * lisp/org-clock.el (org-clocktable): New customization group. (org-clocktable-defaults): New option. (org-clock-clocktable-formatter): New option. (org-clock-clocktable-default-properties): New option. (org-dblock-write:clocktable): Rewrite to split out functionality into separate functions. (org-clocktable-write-default): (org-clocktable-indent-string): (org-clock-get-table-data): New functions. * lisp/org-agenda.el (org-agenda-list): (org-agenda-redo): (org-agenda-clockreport-mode): (org-agenda-set-mode-name): Rewrite to implement filtered clock tables. * doc/org.texi (Clocking commands): (The clock table): New sections. (Agenda commands): Document filtered clock reports.
2010-11-01 08:30:44 -04:00
"Convert strings like \\____ to protected spaces in all backends."
(goto-char (point-min))
(while (re-search-forward "\\\\__+" nil t)
(org-if-unprotected-1
(replace-match
(org-add-props
(cond
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
((eq org-export-current-backend 'latex)
Rewrite of the clock table code * lisp/org.el (org-shorten-string): New function. * lisp/org-exp.el (org-export-convert-protected-spaces): New function. (org-export-preprocess-string): Call `org-export-convert-protected-spaces' to handle new hard spaces. * lisp/org-clock.el (org-clocktable): New customization group. (org-clocktable-defaults): New option. (org-clock-clocktable-formatter): New option. (org-clock-clocktable-default-properties): New option. (org-dblock-write:clocktable): Rewrite to split out functionality into separate functions. (org-clocktable-write-default): (org-clocktable-indent-string): (org-clock-get-table-data): New functions. * lisp/org-agenda.el (org-agenda-list): (org-agenda-redo): (org-agenda-clockreport-mode): (org-agenda-set-mode-name): Rewrite to implement filtered clock tables. * doc/org.texi (Clocking commands): (The clock table): New sections. (Agenda commands): Document filtered clock reports.
2010-11-01 08:30:44 -04:00
(format "\\hspace{%dex}" (- (match-end 0) (match-beginning 0))))
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
((eq org-export-current-backend 'html)
Rewrite of the clock table code * lisp/org.el (org-shorten-string): New function. * lisp/org-exp.el (org-export-convert-protected-spaces): New function. (org-export-preprocess-string): Call `org-export-convert-protected-spaces' to handle new hard spaces. * lisp/org-clock.el (org-clocktable): New customization group. (org-clocktable-defaults): New option. (org-clock-clocktable-formatter): New option. (org-clock-clocktable-default-properties): New option. (org-dblock-write:clocktable): Rewrite to split out functionality into separate functions. (org-clocktable-write-default): (org-clocktable-indent-string): (org-clock-get-table-data): New functions. * lisp/org-agenda.el (org-agenda-list): (org-agenda-redo): (org-agenda-clockreport-mode): (org-agenda-set-mode-name): Rewrite to implement filtered clock tables. * doc/org.texi (Clocking commands): (The clock table): New sections. (Agenda commands): Document filtered clock reports.
2010-11-01 08:30:44 -04:00
(org-add-props (match-string 0) nil
'org-whitespace (- (match-end 0) (match-beginning 0))))
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
;; ((eq org-export-current-backend 'docbook))
((eq org-export-current-backend 'ascii)
Rewrite of the clock table code * lisp/org.el (org-shorten-string): New function. * lisp/org-exp.el (org-export-convert-protected-spaces): New function. (org-export-preprocess-string): Call `org-export-convert-protected-spaces' to handle new hard spaces. * lisp/org-clock.el (org-clocktable): New customization group. (org-clocktable-defaults): New option. (org-clock-clocktable-formatter): New option. (org-clock-clocktable-default-properties): New option. (org-dblock-write:clocktable): Rewrite to split out functionality into separate functions. (org-clocktable-write-default): (org-clocktable-indent-string): (org-clock-get-table-data): New functions. * lisp/org-agenda.el (org-agenda-list): (org-agenda-redo): (org-agenda-clockreport-mode): (org-agenda-set-mode-name): Rewrite to implement filtered clock tables. * doc/org.texi (Clocking commands): (The clock table): New sections. (Agenda commands): Document filtered clock reports.
2010-11-01 08:30:44 -04:00
(org-add-props (match-string 0) '(org-whitespace t)))
(t (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
'(org-protected t))
t t))))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(defun org-export-protect-verbatim ()
"Mark verbatim snippets with the protection property."
(goto-char (point-min))
(while (re-search-forward org-verbatim-re nil t)
Fix bug with emphasis-like expressions in example blocks Martin Skjaeveland writes: > Hi all, > > when I import the file > > --8<---------------cut here---------------start------------->8--- > ----------------- > | grandmother | > ================= > | sim:Jackeline | > | sim:Mona | > ----------------- > --8<---------------cut here---------------end------------->8--- > > using the command > > #+INCLUDE "grandmothers.txt" example > > and export to latex it turns into > > > \begin{verbatim} > ----------------- > | grandmother | > \texttt{===============} > | sim:Jackeline | > | sim:Mona | > ----------------- > \end{verbatim} > > > I would like to remove \texttt{ }. I have tried different export > option settings, but I can't make it work. >
2009-11-05 01:48:07 -05:00
(org-if-unprotected
(add-text-properties (match-beginning 4) (match-end 4)
'(org-protected t org-verbatim-emph t))
(goto-char (1+ (match-end 4))))))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
Export: Fix some problems with protection. The previous changes had created problems with lines stating with a colon, there where no longer protected. They are now again.
2009-01-01 03:55:54 -05:00
(defun org-export-protect-colon-examples ()
"Protect lines starting with a colon."
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(goto-char (point-min))
Maintenance: Remove unused variables.
2009-01-26 03:42:33 -05:00
(let ((re "^[ \t]*:\\([ \t]\\|$\\)") beg)
Export: Better handling of colon examples. Lines preceded by a colon are treated as fixed-width examples. This commit improves the moment when the protection of these lines happens during preprocessing. And it enforces that a space must follow the colon for the line to be treated in this way.
2009-01-09 02:28:43 -05:00
(while (re-search-forward re nil t)
(beginning-of-line 1)
(setq beg (point))
(while (looking-at re)
(end-of-line 1)
(or (eobp) (forward-char 1)))
(add-text-properties beg (if (bolp) (1- (point)) (point))
'(org-protected t)))))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
(defvar org-export-backends
'(docbook html beamer ascii latex)
"List of Org supported export backends.")
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(defun org-export-select-backend-specific-text ()
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
(let ((formatters org-export-backends)
Coderefs: Insert links in export backends This patch covers the three main backends, html, latex, and ascii. It adds the code to make sure the coderef links identified by the preprocessing will be implemented correctly when a backend does its work.
2008-12-26 11:37:53 -05:00
(case-fold-search t)
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
backend backend-name beg beg-content end end-content ind)
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(while formatters
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
(setq backend (pop formatters)
backend-name (symbol-name backend))
;; Handle #+BACKEND: stuff
Remove unwanted #+ATTR_Backend and #+Backend during export. * lisp/org-exp.el: (org-export-select-backend-specific-text) Properly get rid of #+Backend and #+ATTR_Backend specifics to backends not matching the one we're exporting to.
2010-06-30 06:28:32 -04:00
(goto-char (point-min))
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
(while (re-search-forward (concat "^\\([ \t]*\\)#\\+" backend-name
Remove unwanted #+ATTR_Backend and #+Backend during export. * lisp/org-exp.el: (org-export-select-backend-specific-text) Properly get rid of #+Backend and #+ATTR_Backend specifics to backends not matching the one we're exporting to.
2010-06-30 06:28:32 -04:00
":[ \t]*\\(.*\\)") nil t)
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
(if (not (eq backend org-export-current-backend))
Remove unwanted #+ATTR_Backend and #+Backend during export. * lisp/org-exp.el: (org-export-select-backend-specific-text) Properly get rid of #+Backend and #+ATTR_Backend specifics to backends not matching the one we're exporting to.
2010-06-30 06:28:32 -04:00
(delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
org-exp: Fix export error with code blocks within lists * lisp/org-exp.el (org-export-select-backend-specific-text): Always preserve original indentation as a text property so that lists do not get broken by indentation at column 0.
2012-01-31 14:21:44 -05:00
(let ((ind (get-text-property (point-at-bol) 'original-indentation)))
(replace-match "\\1\\2" t)
(add-text-properties
(point-at-bol) (min (1+ (point-at-eol)) (point-max))
`(org-protected t original-indentation ,ind org-native-text t)))))
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
;; Delete #+ATTR_BACKEND: stuff of another backend. Those
Remove unwanted #+ATTR_Backend and #+Backend during export. * lisp/org-exp.el: (org-export-select-backend-specific-text) Properly get rid of #+Backend and #+ATTR_Backend specifics to backends not matching the one we're exporting to.
2010-06-30 06:28:32 -04:00
;; matching the current backend will be taken care of by
;; `org-export-attach-captions-and-attributes'
(goto-char (point-min))
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
(while (re-search-forward (concat "^\\([ \t]*\\)#\\+ATTR_" backend-name
Remove unwanted #+ATTR_Backend and #+Backend during export. * lisp/org-exp.el: (org-export-select-backend-specific-text) Properly get rid of #+Backend and #+ATTR_Backend specifics to backends not matching the one we're exporting to.
2010-06-30 06:28:32 -04:00
":[ \t]*\\(.*\\)") nil t)
org-exp: set correct text properties when replacing special blocks * lisp/org-exp.el (org-export-select-backend-specific-text): add `original-indentation' property when replacing #+begin_backend and #+backend blocks with their content. This is needed for lists, as they must know if the block belonged to them.
2011-02-06 11:17:11 -05:00
(setq ind (org-get-indentation))
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
(when (not (eq backend org-export-current-backend))
Remove unwanted #+ATTR_Backend and #+Backend during export. * lisp/org-exp.el: (org-export-select-backend-specific-text) Properly get rid of #+Backend and #+ATTR_Backend specifics to backends not matching the one we're exporting to.
2010-06-30 06:28:32 -04:00
(delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
;; Handle #+BEGIN_BACKEND and #+END_BACKEND stuff
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(goto-char (point-min))
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
(while (re-search-forward (concat "^[ \t]*#\\+BEGIN_" backend-name "\\>.*\n?")
Fix regexp match issue when exporting large source code snippets
2009-08-31 06:17:58 -04:00
nil t)
(setq beg (match-beginning 0) beg-content (match-end 0))
org-exp: Fix export error with code blocks within lists * lisp/org-exp.el (org-export-select-backend-specific-text): Always preserve original indentation as a text property so that lists do not get broken by indentation at column 0.
2012-01-31 14:21:44 -05:00
(setq ind (or (get-text-property beg 'original-indentation)
(save-excursion (goto-char beg) (org-get-indentation))))
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
(when (re-search-forward (concat "^[ \t]*#\\+END_" backend-name "\\>.*\n?")
Fix regexp match issue when exporting large source code snippets
2009-08-31 06:17:58 -04:00
nil t)
(setq end (match-end 0) end-content (match-beginning 0))
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
(if (eq backend org-export-current-backend)
Fix regexp match issue when exporting large source code snippets
2009-08-31 06:17:58 -04:00
;; yes, keep this
Remove backend-specific markers after selecting text When a backend selects its #+begin_backend ... #+end_backend code, the markers need to be removed so that a package like org-special-blocks.el does not try to work on the block again.
2009-10-02 06:02:56 -04:00
(progn
org-exp: set correct text properties when replacing special blocks * lisp/org-exp.el (org-export-select-backend-specific-text): add `original-indentation' property when replacing #+begin_backend and #+backend blocks with their content. This is needed for lists, as they must know if the block belonged to them.
2011-02-06 11:17:11 -05:00
(add-text-properties
beg-content end-content
org-exp.el: Allow easy plugging in of new backends PATCH-2/5: org-odt compatibility From 2bc4854fb86a96b69e53db00603e0b2f8f47fe08 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 02:16:30 +0530 Subject: [PATCH 2/5] org-exp.el: Allow easy plugging in of new backends. * lisp/org-exp.el (org-export-backends): New variable. (org-export-select-backend-specific-text): Use above variable. Also mark text between #+BACKEND and #+BEGIN_BACKEND...#+END_BACKEND with org-native-text property. This text property is currently used only by the new line-oriented generic exporter (which is not yet part of the repo).
2011-06-23 11:53:26 -04:00
`(org-protected t original-indentation ,ind org-native-text t))
exp: strip protective commas from literal code blocks * lisp/org-exp.el (org-export-select-backend-specific-text): Strip protective commas from literal code blocks.
2011-06-28 18:43:20 -04:00
;; strip protective commas
unified stripping of protective commas -- idempotent org-edit-src-code * lisp/ob.el (org-babel-strip-protective-commas): Use `org-strip-protective-commas'. * lisp/org-exp.el (org-export-select-backend-specific-text): Use `org-strip-protective-commas'. * lisp/org-src.el (org-edit-src-code): Use `org-strip-protective-commas'. * lisp/org.el (org-strip-protective-commas): Single definition for this functionality.
2012-02-18 12:35:33 -05:00
(org-strip-protective-commas beg-content end-content)
Remove backend-specific markers after selecting text When a backend selects its #+begin_backend ... #+end_backend code, the markers need to be removed so that a package like org-special-blocks.el does not try to work on the block again.
2009-10-02 06:02:56 -04:00
(delete-region (match-beginning 0) (match-end 0))
(save-excursion
(goto-char beg)
(delete-region (point) (1+ (point-at-eol)))))
Fix regexp match issue when exporting large source code snippets
2009-08-31 06:17:58 -04:00
;; No, this is for a different backend, kill it
(delete-region beg end)))))))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
Centering: Implement markup for centered text.
2009-03-16 17:14:15 -04:00
(defun org-export-mark-blockquote-verse-center ()
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
"Mark block quote and verse environments with special cookies.
These special cookies will later be interpreted by the backend."
;; Blockquotes
Keep byte compiler happy
2009-06-07 11:07:07 -04:00
(let (type t1 ind beg end beg1 end1 content)
New indentation treatment for blocks during export Now we also deal with center, quote, and verse blocks.
2009-06-07 10:11:14 -04:00
(goto-char (point-min))
(while (re-search-forward
"^\\([ \t]*\\)#\\+\\(begin_\\(\\(block\\)?quote\\|verse\\|center\\)\\>.*\\)"
nil t)
(setq ind (length (match-string 1))
type (downcase (match-string 3))
t1 (if (equal type "quote") "blockquote" type))
(setq beg (match-beginning 0)
beg1 (1+ (match-end 0)))
(when (re-search-forward (concat "^[ \t]*#\\+end_" type "\\>.*") nil t)
org-exp: fixed small bug, use match data before it's overwritten by looking-at Patch by Carsten * lisp/org-exp.el (org-export-mark-blockquote-verse-center): fixed small bug, now grabbing match data before overwritten by looking-at this fixes a problem with remainders of #+end_quote lines appearing in exported output
2010-06-29 01:06:49 -04:00
(setq end1 (1- (match-beginning 0))
end (+ (point-at-eol) (if (looking-at "\n$") 1 0)))
New indentation treatment for blocks during export Now we also deal with center, quote, and verse blocks.
2009-06-07 10:11:14 -04:00
(setq content (org-remove-indentation (buffer-substring beg1 end1)))
Fix blockquote support
2009-06-07 16:10:05 -04:00
(setq content (concat "ORG-" (upcase t1) "-START\n"
New indentation treatment for blocks during export Now we also deal with center, quote, and verse blocks.
2009-06-07 10:11:14 -04:00
content "\n"
Fix blockquote support
2009-06-07 16:10:05 -04:00
"ORG-" (upcase t1) "-END\n"))
New indentation treatment for blocks during export Now we also deal with center, quote, and verse blocks.
2009-06-07 10:11:14 -04:00
(delete-region beg end)
(insert (org-add-props content nil 'original-indentation ind))))))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(defun org-export-mark-list-end ()
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
"Mark all list endings with a special string."
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(unless (eq org-export-current-backend 'ascii)
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
(mapc
(lambda (e)
;; For each type allowing list export, find every list, remove
;; ending regexp if needed, and insert org-list-end.
(goto-char (point-min))
org-list: implement alphabetical lists * lisp/org-list.el (org-alphabetical-lists): new variable (org-item-re, org-list-full-item, org-cycle-list-bullet, org-list-struct-fix-bul, org-list-inc-bullet-maybe): reflect introduction of the new variable. (org-item-beginning-re): changed into a function, so any modification of `org-alphabetical-lists' will not require reloading Org. (org-at-item-p, org-toggle-checkbox, org-update-checkbox-count, org-list-parse-list, org-list-send-list): reflect changes to `org-item-beginning-re'. (org-list-use-alpha-bul-p): new function. * lisp/org.el (org-check-for-hidden): reflect changes to `org-item-beginning-re'. * lisp/org-capture.el (org-capture-place-item): reflect changes to `org-item-beginning-re'. * lisp/org-docbook.el (org-export-docbook-list-line): handle new type of items. * lisp/org-exp.el (org-export-mark-list-end, org-export-mark-list-properties): reflect changes to `org-item-beginning-re'. * lisp/org-html.el (org-html-export-list-line): handle new type of items. * lisp/org-latex.el (org-export-latex-lists): handle new type of items and reflect changes to `org-item-beginning-re'. * lisp/org-ascii.el (org-export-ascii-preprocess): handle new counters. Modified from a patch by Nathaniel Flath.
2011-01-13 17:25:55 -05:00
(while (re-search-forward (org-item-beginning-re) nil t)
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
(when (eq (nth 2 (org-list-context)) e)
(let* ((struct (org-list-struct))
(bottom (org-list-get-bottom-point struct))
org-list: implement alphabetical lists * lisp/org-list.el (org-alphabetical-lists): new variable (org-item-re, org-list-full-item, org-cycle-list-bullet, org-list-struct-fix-bul, org-list-inc-bullet-maybe): reflect introduction of the new variable. (org-item-beginning-re): changed into a function, so any modification of `org-alphabetical-lists' will not require reloading Org. (org-at-item-p, org-toggle-checkbox, org-update-checkbox-count, org-list-parse-list, org-list-send-list): reflect changes to `org-item-beginning-re'. (org-list-use-alpha-bul-p): new function. * lisp/org.el (org-check-for-hidden): reflect changes to `org-item-beginning-re'. * lisp/org-capture.el (org-capture-place-item): reflect changes to `org-item-beginning-re'. * lisp/org-docbook.el (org-export-docbook-list-line): handle new type of items. * lisp/org-exp.el (org-export-mark-list-end, org-export-mark-list-properties): reflect changes to `org-item-beginning-re'. * lisp/org-html.el (org-html-export-list-line): handle new type of items. * lisp/org-latex.el (org-export-latex-lists): handle new type of items and reflect changes to `org-item-beginning-re'. * lisp/org-ascii.el (org-export-ascii-preprocess): handle new counters. Modified from a patch by Nathaniel Flath.
2011-01-13 17:25:55 -05:00
(top (point-at-bol))
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
(top-ind (org-list-get-ind top struct)))
(goto-char bottom)
org-list: Remove two defcustoms * lisp/org-list.el (org-list-ending-method, org-list-end-regexp): Removed variables. (org-in-item-p, org-list-separating-blank-lines-number, org-list-parse-list, org-list-struct): Apply changes. * lisp/org-exp.el (org-export-mark-list-end, org-export-mark-list-properties): Apply changes. * lisp/org-latex.el (org-export-latex-lists): Apply changes. * doc/org.texi (Plain lists): Document removal. Conflicts: lisp/org-list.el
2012-02-16 17:47:43 -05:00
(when (and (not (looking-at "[ \t]*$"))
Change function org-list-end-re into a variable * lisp/org-list.el (org-list-end-re): removed function and made it a variable. There's no need for the overhead of calling the function every at every line in a list. User will have to reload Org if he change value of either `org-list-end-regexp' or `org-empty-line-terminates-plain-lists'. (org-in-item-p,org-list-struct,org-list-parse-list): apply change. * lisp/org-exp.el (org-export-mark-list-end, org-export-mark-list-properties): apply change * lisp/org-latex.el (org-export-latex-lists): apply change. Also prevent items with org-example property to be considered as real items.
2011-01-10 14:01:51 -05:00
(looking-at org-list-end-re))
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
(replace-match ""))
(unless (bolp) (insert "\n"))
;; As org-list-end is inserted at column 0, it would end
;; by indentation any list. It can be problematic when
;; there are lists within lists: the inner list end would
;; also become the outer list end. To avoid this, text
;; property `original-indentation' is added, as
org-list: implement alphabetical lists * lisp/org-list.el (org-alphabetical-lists): new variable (org-item-re, org-list-full-item, org-cycle-list-bullet, org-list-struct-fix-bul, org-list-inc-bullet-maybe): reflect introduction of the new variable. (org-item-beginning-re): changed into a function, so any modification of `org-alphabetical-lists' will not require reloading Org. (org-at-item-p, org-toggle-checkbox, org-update-checkbox-count, org-list-parse-list, org-list-send-list): reflect changes to `org-item-beginning-re'. (org-list-use-alpha-bul-p): new function. * lisp/org.el (org-check-for-hidden): reflect changes to `org-item-beginning-re'. * lisp/org-capture.el (org-capture-place-item): reflect changes to `org-item-beginning-re'. * lisp/org-docbook.el (org-export-docbook-list-line): handle new type of items. * lisp/org-exp.el (org-export-mark-list-end, org-export-mark-list-properties): reflect changes to `org-item-beginning-re'. * lisp/org-html.el (org-html-export-list-line): handle new type of items. * lisp/org-latex.el (org-export-latex-lists): handle new type of items and reflect changes to `org-item-beginning-re'. * lisp/org-ascii.el (org-export-ascii-preprocess): handle new counters. Modified from a patch by Nathaniel Flath.
2011-01-13 17:25:55 -05:00
;; `org-list-struct' pays attention to it when reading a
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
;; list.
(insert (org-add-props
Change internal list end marker to avoid confusing special blocks * lisp/org-exp.el (org-export-mark-list-end): change end marker * lisp/org-docbook.el (org-export-docbook-list-line): use new marker. * lisp/org-html.el (org-html-export-list-line): use new marker * lisp/org-latex.el (org-export-latex-lists): use new marker
2011-02-28 05:20:06 -05:00
"ORG-LIST-END-MARKER\n"
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
(list 'original-indentation top-ind)))))))
(cons nil org-list-export-context))))
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(defun org-export-mark-list-properties ()
Modified export engines for lists * lisp/org-exp.el (org-export-mark-lists): new function, replacing org-export-mark-list-ending. It adds information as text properties to every list, before changes done by exporter destruct them. * lisp/org-html.el (org-export-as-html): delegate list handling to external function org-html-export-list-line. (org-html-export-list-line): new function. * lisp/org-latex.el (org-export-latex-lists): small modification.
2011-01-02 07:52:16 -05:00
"Mark list with special properties.
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
These special properties will later be interpreted by the backend."
Modified export engines for lists * lisp/org-exp.el (org-export-mark-lists): new function, replacing org-export-mark-list-ending. It adds information as text properties to every list, before changes done by exporter destruct them. * lisp/org-html.el (org-export-as-html): delegate list handling to external function org-html-export-list-line. (org-html-export-list-line): new function. * lisp/org-latex.el (org-export-latex-lists): small modification.
2011-01-02 07:52:16 -05:00
(let ((mark-list
(function
;; Mark a list with 3 properties: `list-item' which is
;; position at beginning of line, `list-struct' which is
;; list structure, and `list-prevs' which is the alist of
;; item and its predecessor. Leave point at list ending.
(lambda (ctxt)
(let* ((struct (org-list-struct))
(top (org-list-get-top-point struct))
(bottom (org-list-get-bottom-point struct))
org-list: reorder file, rename functions, improve comments * lisp/ob.el (org-babel-result-end): apply renaming. * lisp/org-exp.el (org-export-mark-list-properties): apply renaming. * lisp/org-list.el (org-list-prevs-alist): renamed from org-list-struct-prev-alist. (org-list-parents-alist): renamed from org-list-struct-parent-alist. (org-list-write-struct): renamed from org-list-struct-fix-struct. (org-list-parse-list, org-sort-list, org-list-indent-item-generic, org-toggle-checkbox, org-update-checkbox-count, org-cycle-list-bullet, org-list-repair, org-insert-item, org-move-item-up, org-move-item-up, org-move-item-down, org-next-item, org-previous-item, org-end-of-item-list, org-beginning-of-item-list, org-apply-on-list): apply renaming. (org-get-bullet): removed function, as it is not needed anymore.
2011-01-20 13:28:23 -05:00
(prevs (org-list-prevs-alist struct))
Modified export engines for lists * lisp/org-exp.el (org-export-mark-lists): new function, replacing org-export-mark-list-ending. It adds information as text properties to every list, before changes done by exporter destruct them. * lisp/org-html.el (org-export-as-html): delegate list handling to external function org-html-export-list-line. (org-html-export-list-line): new function. * lisp/org-latex.el (org-export-latex-lists): small modification.
2011-01-02 07:52:16 -05:00
poi)
;; Get every item and ending position, without dups and
;; without bottom point of list.
(mapc (lambda (e)
(let ((pos (car e))
(end (nth 6 e)))
(unless (memq pos poi)
(push pos poi))
(unless (or (= end bottom) (memq end poi))
(push end poi))))
struct)
(setq poi (sort poi '<))
;; For every point of interest, mark the whole line with
;; its position in list.
(mapc
(lambda (e)
(goto-char e)
(add-text-properties (point-at-bol) (point-at-eol)
(list 'list-item (point-at-bol)
'list-struct struct
'list-prevs prevs)))
poi)
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
;; Take care of bottom point. As babel may have inserted
;; a new list in buffer, list ending isn't always
;; marked. Now mark every list ending and add properties
;; useful to line processing exporters.
Modified export engines for lists * lisp/org-exp.el (org-export-mark-lists): new function, replacing org-export-mark-list-ending. It adds information as text properties to every list, before changes done by exporter destruct them. * lisp/org-html.el (org-export-as-html): delegate list handling to external function org-html-export-list-line. (org-html-export-list-line): new function. * lisp/org-latex.el (org-export-latex-lists): small modification.
2011-01-02 07:52:16 -05:00
(goto-char bottom)
Change internal list end marker to avoid confusing special blocks * lisp/org-exp.el (org-export-mark-list-end): change end marker * lisp/org-docbook.el (org-export-docbook-list-line): use new marker. * lisp/org-html.el (org-html-export-list-line): use new marker * lisp/org-latex.el (org-export-latex-lists): use new marker
2011-02-28 05:20:06 -05:00
(when (or (looking-at "^ORG-LIST-END-MARKER\n")
org-list: Remove two defcustoms * lisp/org-list.el (org-list-ending-method, org-list-end-regexp): Removed variables. (org-in-item-p, org-list-separating-blank-lines-number, org-list-parse-list, org-list-struct): Apply changes. * lisp/org-exp.el (org-export-mark-list-end, org-export-mark-list-properties): Apply changes. * lisp/org-latex.el (org-export-latex-lists): Apply changes. * doc/org.texi (Plain lists): Document removal. Conflicts: lisp/org-list.el
2012-02-16 17:47:43 -05:00
(and (not (looking-at "[ \t]*$"))
Change function org-list-end-re into a variable * lisp/org-list.el (org-list-end-re): removed function and made it a variable. There's no need for the overhead of calling the function every at every line in a list. User will have to reload Org if he change value of either `org-list-end-regexp' or `org-empty-line-terminates-plain-lists'. (org-in-item-p,org-list-struct,org-list-parse-list): apply change. * lisp/org-exp.el (org-export-mark-list-end, org-export-mark-list-properties): apply change * lisp/org-latex.el (org-export-latex-lists): apply change. Also prevent items with org-example property to be considered as real items.
2011-01-10 14:01:51 -05:00
(looking-at org-list-end-re)))
Modified export engines for lists * lisp/org-exp.el (org-export-mark-lists): new function, replacing org-export-mark-list-ending. It adds information as text properties to every list, before changes done by exporter destruct them. * lisp/org-html.el (org-export-as-html): delegate list handling to external function org-html-export-list-line. (org-html-export-list-line): new function. * lisp/org-latex.el (org-export-latex-lists): small modification.
2011-01-02 07:52:16 -05:00
(replace-match ""))
(unless (bolp) (insert "\n"))
(insert
Change internal list end marker to avoid confusing special blocks * lisp/org-exp.el (org-export-mark-list-end): change end marker * lisp/org-docbook.el (org-export-docbook-list-line): use new marker. * lisp/org-html.el (org-html-export-list-line): use new marker * lisp/org-latex.el (org-export-latex-lists): use new marker
2011-02-28 05:20:06 -05:00
(org-add-props "ORG-LIST-END-MARKER\n" (list 'list-item bottom
Modified export engines for lists * lisp/org-exp.el (org-export-mark-lists): new function, replacing org-export-mark-list-ending. It adds information as text properties to every list, before changes done by exporter destruct them. * lisp/org-html.el (org-export-as-html): delegate list handling to external function org-html-export-list-line. (org-html-export-list-line): new function. * lisp/org-latex.el (org-export-latex-lists): small modification.
2011-01-02 07:52:16 -05:00
'list-struct struct
'list-prevs prevs)))
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
;; Following property is used by LaTeX exporter.
Modified export engines for lists * lisp/org-exp.el (org-export-mark-lists): new function, replacing org-export-mark-list-ending. It adds information as text properties to every list, before changes done by exporter destruct them. * lisp/org-html.el (org-export-as-html): delegate list handling to external function org-html-export-list-line. (org-html-export-list-line): new function. * lisp/org-latex.el (org-export-latex-lists): small modification.
2011-01-02 07:52:16 -05:00
(add-text-properties top (point) (list 'list-context ctxt)))))))
;; Mark lists except for backends not interpreting them.
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(unless (eq org-export-current-backend 'ascii)
Change internal list end marker to avoid confusing special blocks * lisp/org-exp.el (org-export-mark-list-end): change end marker * lisp/org-docbook.el (org-export-docbook-list-line): use new marker. * lisp/org-html.el (org-html-export-list-line): use new marker * lisp/org-latex.el (org-export-latex-lists): use new marker
2011-02-28 05:20:06 -05:00
(let ((org-list-end-re "^ORG-LIST-END-MARKER\n"))
Change function org-list-end-re into a variable * lisp/org-list.el (org-list-end-re): removed function and made it a variable. There's no need for the overhead of calling the function every at every line in a list. User will have to reload Org if he change value of either `org-list-end-regexp' or `org-empty-line-terminates-plain-lists'. (org-in-item-p,org-list-struct,org-list-parse-list): apply change. * lisp/org-exp.el (org-export-mark-list-end, org-export-mark-list-properties): apply change * lisp/org-latex.el (org-export-latex-lists): apply change. Also prevent items with org-example property to be considered as real items.
2011-01-10 14:01:51 -05:00
(mapc
(lambda (e)
org-exp: split list processing in two parts to better handle org-babel * lisp/org-exp.el (org-export-preprocess-string): mark list endings before babel blocks preprocessing starts, so blank lines that may be inserted do not break list's structure. Then, mark list with special properties required by exporters. Thus output from babel can easily be included in lists. (org-export-mark-list-end): new function (org-export-mark-list-properties): new function (org-export-mark-lists): removed function. It was split into the two preceding functions.
2011-01-06 11:07:27 -05:00
(goto-char (point-min))
org-list: implement alphabetical lists * lisp/org-list.el (org-alphabetical-lists): new variable (org-item-re, org-list-full-item, org-cycle-list-bullet, org-list-struct-fix-bul, org-list-inc-bullet-maybe): reflect introduction of the new variable. (org-item-beginning-re): changed into a function, so any modification of `org-alphabetical-lists' will not require reloading Org. (org-at-item-p, org-toggle-checkbox, org-update-checkbox-count, org-list-parse-list, org-list-send-list): reflect changes to `org-item-beginning-re'. (org-list-use-alpha-bul-p): new function. * lisp/org.el (org-check-for-hidden): reflect changes to `org-item-beginning-re'. * lisp/org-capture.el (org-capture-place-item): reflect changes to `org-item-beginning-re'. * lisp/org-docbook.el (org-export-docbook-list-line): handle new type of items. * lisp/org-exp.el (org-export-mark-list-end, org-export-mark-list-properties): reflect changes to `org-item-beginning-re'. * lisp/org-html.el (org-html-export-list-line): handle new type of items. * lisp/org-latex.el (org-export-latex-lists): handle new type of items and reflect changes to `org-item-beginning-re'. * lisp/org-ascii.el (org-export-ascii-preprocess): handle new counters. Modified from a patch by Nathaniel Flath.
2011-01-13 17:25:55 -05:00
(while (re-search-forward (org-item-beginning-re) nil t)
Ignore lists within exporters specific blocks * lisp/org-exp.el (org-export-mark-list-properties): even if context is invalid, mark list item with `list-context' property. * lisp/org-list.el (org-list-forbidden-blocks): add exporters specific blocks to the list of forbidden blocks. Thanks to Jai Bharat Patel for reporting this.
2011-05-27 10:53:54 -04:00
(let ((context (nth 2 (org-list-context))))
(if (eq context e)
(funcall mark-list e)
(put-text-property (point-at-bol) (point-at-eol)
'list-context context)))))
Change function org-list-end-re into a variable * lisp/org-list.el (org-list-end-re): removed function and made it a variable. There's no need for the overhead of calling the function every at every line in a list. User will have to reload Org if he change value of either `org-list-end-regexp' or `org-empty-line-terminates-plain-lists'. (org-in-item-p,org-list-struct,org-list-parse-list): apply change. * lisp/org-exp.el (org-export-mark-list-end, org-export-mark-list-properties): apply change * lisp/org-latex.el (org-export-latex-lists): apply change. Also prevent items with org-example property to be considered as real items.
2011-01-10 14:01:51 -05:00
(cons nil org-list-export-context))))))
Both latex and html should now export correctly. * org-html.el (org-export-html-preprocess): Remove unneeded insertion of list end marker, as it is now handled by `org-export-mark-list-ending'. * org-html.el (org-export-as-html): Cleaner termination of lists. * org-exp.el (org-export-mark-list-ending): New function to insert specific markers at the end of lists when exporting to a backend not using `org-list-parse-list'. This function is called early in `org-export-preprocess-string', while it is still able to recognize lists. * org-latex.el (org-export-latex-lists): Better search for lists. It now only finds items not enclosed and not protected.
2010-07-13 05:46:51 -04:00
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(defun org-export-attach-captions-and-attributes (target-alist)
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
"Move #+CAPTION, #+ATTR_BACKEND, and #+LABEL text into text properties.
If the next thing following is a table, add the text properties to the first
table line. If it is a link, add it to the line containing the link."
(goto-char (point-min))
(remove-text-properties (point-min) (point-max)
'(org-caption nil org-attributes nil))
(let ((case-fold-search t)
Export: Allow #+label, #+caption, and #_attr_... to be indented.
2009-05-27 10:38:19 -04:00
(re (concat "^[ \t]*#\\+caption:[ \t]+\\(.*\\)"
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
"\\|"
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
"^[ \t]*#\\+attr_" (symbol-name org-export-current-backend) ":[ \t]+\\(.*\\)"
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
"\\|"
Export: Allow #+label, #+caption, and #_attr_... to be indented.
2009-05-27 10:38:19 -04:00
"^[ \t]*#\\+label:[ \t]+\\(.*\\)"
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
"\\|"
HTML export: Fix problem with table attributes when first table line is special Eric Fraga writes: > What am I missing? I tried exporting the following to HTML and the > caption and HTML attributes seem to be ignored completely. Also, the > alignment directives are ignored as well. > > --8<---------------cut here---------------start------------->8--- > #+TITLE: test file for org mode > #+DESCRIPTION: used for bug reports > #+AUTHOR: Eric S Fraga > #+EMAIL: Eric S Fraga <e.fraga@ucl.ac.uk> > #+DATE: 2010-03-11 Thu > #+KEYWORDS: > #+LANGUAGE: en > #+OPTIONS: H:3 num:t toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t > #+OPTIONS: TeX:t LaTeX:t skip:nil d:nil todo:t pri:nil tags:not-in-toc > #+INFOJS_OPT: view:nil toc:nil ltoc:t mouse:underline buttons:0 path:http://orgmode.org/org-info.js > #+EXPORT_SELECT_TAGS: export > #+EXPORT_EXCLUDE_TAGS: noexport > #+LINK_UP: > #+LINK_HOME: > > * tables > > #+caption: A very interesting table > #+attr_html: border="1" rules="all" frame="all" align="center" > | <r> | <l> | > | Id | Description | > |-----+--------------------------------| > | 1. | The first item | > | 2. | the second | > | 4. | we don't have a third one | > | 10. | a longer id to check alignment | > |-----+--------------------------------| > --8<---------------cut here---------------end--------------->8--- > > I'm using org current as of yesterday Org-mode version 6.34trans > (release_6.34c.186.g1902) and with GNU Emacs 23.1.1 > (i486-pc-linux-gnu, GTK+ Version 2.18.2) of 2009-11-02 on raven, > modified by Debian
2010-03-11 06:27:42 -05:00
"^[ \t]*\\(|[^-]\\)"
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
"\\|"
"^[ \t]*\\[\\[.*\\]\\][ \t]*$"))
a better way with babel Of course, an updated patch is attached. Best -- Eric Carsten Dominik <carsten.dominik@gmail.com> writes: > Hi Eric, > > I tried to apply the patch, but it does not apply cleanly, maybe due > to other changes. Can I ask you to update and resubmit? > > Thanks! > > - Carsten > > On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote: > >> Hi Robert, >> >> Thanks for the thoughtful message. >> >> I present a couple of solutions below. >> >> Robert Cunningham <robut@iinet.net.au> writes: >> >>> G'day All, >>> >>> I wonder if I've missed something and there is a better way. >>> >>> Essentially I'm trying to use org babel with R and LaTeX to create >>> figures >>> with both long and short captions (for contents) >>> >>> I'd started with: >>> >>> #+CAPTION: Nice data (filled points indicate less nice data) >>> #+LABEL: fig:nicedata >>> #+ATTR_LaTeX: width=0.98\textwidth >>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports >>> results >>> dotchart(data$ndata) >>> #+end_src >>> >>> which pointed to the need for long/short captions... >>> >>> feeling hopeful I tried: >>> >>> #+CAPTION: Nice data [Nice data (filled points indicate less nice >>> data)] >>> #+LABEL: fig:nicedata >>> #+ATTR_LaTeX: width=0.98\textwidth >>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports >>> results >>> dotchart(data$ndata) >>> #+end_src >>> >> >> I'm attaching a patch [1] which adds shortname support for captions. >> Once >> applied, the following syntax will result in a caption with a >> shortname >> and a longname. >> >> --8<---------------cut here---------------start------------->8--- >> some pre-table text >> >> #+source: g-nicedata >> #+begin_src gnuplot :file graph.png :exports results >> plot sin(x) >> #+end_src >> >> #+Caption: [nice data]{a longer description of the niceness of the >> data} >> #+results: g-nicedata >> [[file:graph.png]] >> >> some post-table text >> --8<---------------cut here---------------end--------------->8--- >> >> however, while this patch is still pending there is an Org-babel >> solution below which should work immediately. >> >>> >>> >>> but no luck there. >>> >>> Next effort was to try to use R and LaTex more directly with >>> noweb. I tried >>> this: >>> >>> >>> >>> #+srcname: r-nicedata >>> #+begin_src R :session :file ndata.pdf :results output :exports >>> results >>> dotchart(data$ndata) >>> #+end_src >>> >>> >>> #+begin_src latex :noweb yes >>> \begin{figure}[htb!] >>> \centering >>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>} >>> \caption[Nice data]{Nice data (filled points indicate less nice >>> data)} >>> \label{fig:nicedata} >>> \end{figure} >>> #+end_src >>> >>> >>> >>> This does produce the figure and long/short contents BUT ALSO >>> produces this: >>> >>> #+results: r-nicedata >>> [[file:ndata.pdf]] >>> >>> which upon export results in a link and consequently the plot >>> appearing both >>> in the figure and elsewhere. This second plot is unwelcome. >>> >>> I've tried assorted :results and :output options but have not found >>> how to >>> suppress the #+results: but still obtain the figure. I've always used >>> the :session option. >>> >>> I've also tried twigging an org-export option to suppress pdf >>> export but the >>> link is still exported so that is not a solution. >>> >>> The current "working" solution is to use the noweb approach and >>> then use sed >>> to clean out the links to the second image-ugly to say the least! >>> >> >> You were very close with the noweb approach. The following >> combination >> should work -- notice the ":results silent" header argument to the >> source block. >> >> --8<---------------cut here---------------start------------->8--- >> some pre-table text >> >> #+source: g-nicedata >> #+begin_src gnuplot :file graph.png :results silent :exports none >> plot sin(x) >> #+end_src >> >> #+begin_src latex :noweb yes >> \begin{figure}[htb!] >> \centering >> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>} >> \caption[Nice data]{some nice data -- filled points indicate less >> nice data} >> \label{fig:nicedata} >> \end{figure} >> #+end_src >> >> some post-table text >> --8<---------------cut here---------------end--------------->8--- >> >> is exported to the following latex, >> >> --8<---------------cut here---------------start------------->8--- >> some pre-table text >> >> >> >> \begin{figure}[htb!] >> \centering >> \includegraphics[width=0.98\textwidth]{graph.png} >> \caption[Nice data]{some nice data -- filled points indicate less >> nice data} >> \label{fig:nicedata} >> \end{figure} >> >> some post-table text >> --8<---------------cut here---------------end--------------->8--- >> >> Hope this helps, >> >> Best -- Eric >> >>> >>> >>> >>> All this with org version 6.36c >>> >>> >>> What have I missed? What is the best way to do this? >>> >>> >>> Cheers, >>> >>> Robert Cunningham >>> >>> >>> >>> >>> >>> _______________________________________________ >>> Emacs-orgmode mailing list >>> Please use `Reply All' to send replies to the list. >>> Emacs-orgmode@gnu.org >>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode >> >> Footnotes: >> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17 >> 00:00:00 2001 >> From: Eric Schulte <schulte.eric@gmail.com> >> Date: Mon, 21 Jun 2010 09:02:37 -0700 >> Subject: [PATCH] add short-names to #+captions with support for >> latex export >> >> captions specified with the following syntax >> #+CAPTION: [shortname]{longname} >> will have their short and longnames handled appropriately. >> >> Thanks to Robert Cunningham for suggesting this feature. >> >> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding >> a shortname attribute to caption strings under the symbol name >> org-caption-shortn. >> >> * lisp/org-latex.el (org-export-latex-tables): handling caption short >> names on table export >> >> (org-export-latex-convert-table.el-table): handling caption short >> names on table.el type table export >> >> (org-export-latex-links): handling caption short names on link/image >> export >> >> (org-export-latex-format-image): now takes an optional argument >> specifying a caption short name >> --- >> lisp/org-exp.el | 14 +++++++++----- >> lisp/org-latex.el | 21 ++++++++++++++------- >> 2 files changed, 23 insertions(+), 12 deletions(-) >> >> diff --git a/lisp/org-exp.el b/lisp/org-exp.el >> index 029e4d7..466d7da 100644 >> --- a/lisp/org-exp.el >> +++ b/lisp/org-exp.el >> @@ -1256,7 +1256,7 @@ the current file." >> (goto-char (point-min)) >> (while (re-search-forward org-bracket-link-regexp nil t) >> (org-if-unprotected-at (1+ (match-beginning 0)) >> - (let* ((md (match-data)) >> + (let* ((md (match-data)) >> (desc (match-end 2)) >> (link (org-link-unescape (match-string 1))) >> (slink (org-solidify-link-text link)) >> @@ -1381,8 +1381,8 @@ removed as well." >> select-tags "\\|") >> "\\):")) >> (re-excl (concat ":\\(" (mapconcat 'regexp-quote >> - exclude-tags "\\|") >> - "\\):")) >> + exclude-tags "\\|") >> + "\\):")) >> beg end cont) >> (goto-char (point-min)) >> (when (and select-tags >> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the >> line containing the link." >> "^[ \t]*\\(|[^-]\\)" >> "\\|" >> "^[ \t]*\\[\\[.*\\]\\][ \t]*$")) >> - cap attr label end) >> + cap shortn attr label end) >> (while (re-search-forward re nil t) >> (cond >> ((match-end 1) >> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))) >> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))) >> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap) >> + (setq shortn (match-string 1 cap) >> + cap (match-string 2 cap)))) >> ((match-end 2) >> (setq attr (concat attr (if attr " " "") (org-trim >> (match-string 2))))) >> ((match-end 3) >> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the >> line containing the link." >> (point-at-eol))) >> (add-text-properties (point-at-bol) end >> (list 'org-caption cap >> + 'org-caption-shortn shortn >> 'org-attributes attr >> 'org-label label)) >> (if label (push (cons label label) target-alist)) >> diff --git a/lisp/org-latex.el b/lisp/org-latex.el >> index 01a4b05..6c2aab2 100644 >> --- a/lisp/org-latex.el >> +++ b/lisp/org-latex.el >> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (org-table-last-column-widths (copy-sequence >> org-table-last-column- >> widths)) >> fnum fields line lines olines gr colgropen line-fmt align >> - caption label attr floatp longtblp) >> + caption shortn label attr floatp longtblp) >> (if org-export-latex-tables-verbatim >> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table >> "\\end{verbatim}\n"))) >> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (progn >> (setq caption (org-find-text-property-in-string >> 'org-caption raw-table) >> + shortn (org-find-text-property-in-string >> + 'org-caption-shortn raw-table) >> attr (org-find-text-property-in-string >> 'org-attributes raw-table) >> label (org-find-text-property-in-string >> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (if floatp "\\begin{table}[htb]\n")) >> (if floatp >> (format >> - "\\caption{%s%s}" >> + "\\caption%s{%s%s}" >> + (if shortn (concat "[" shortn "]") "") >> (if label (concat "\\\label{" label >> "}") "") >> (or caption ""))) >> (if (and longtblp caption) "\\\\\n" "\n") >> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> >> (defun org-export-latex-convert-table.el-table () >> "Replace table.el table at point with LaTeX code." >> - (let (tbl caption label line floatp attr align rmlines) >> + (let (tbl caption shortn label line floatp attr align rmlines) >> (setq line (buffer-substring (point-at-bol) (point-at-eol)) >> label (org-get-text-property-any 0 'org-label line) >> caption (org-get-text-property-any 0 'org-caption line) >> + shortn (org-get-text-property-any 0 'org-caption-shortn line) >> attr (org-get-text-property-any 0 'org-attributes line) >> align (and attr (stringp attr) >> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr) >> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}"))) >> (when floatp >> (setq tbl (concat "\\begin{table}\n" >> - (format "\\caption{%s%s}\n" >> + (format "\\caption%s{%s%s}\n" >> + (if shortn (format "[%s]" shortn) "") >> (if label (format "\\label{%s}" label) "") >> (or caption "")) >> tbl >> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> "file"))) >> (coderefp (equal type "coderef")) >> (caption (org-find-text-property-in-string 'org-caption >> raw- >> path)) >> + (shortn (org-find-text-property-in-string >> org-caption-shortn raw-path)) >> (attr (or (org-find-text-property-in-string >> org-attributes raw- >> path) >> (plist-get org-export-latex-options-plist >> :latex-image- >> options))) >> (label (org-find-text-property-in-string 'org-label raw-path)) >> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (plist-get org-export-latex-options-plist :inline-images)) >> ;; OK, we need to inline an image >> (insert >> - (org-export-latex-format-image raw-path caption label attr))) >> + (org-export-latex-format-image raw-path caption label >> attr shortn))) >> (coderefp >> (insert (format >> (org-export-get-coderef-format path desc) >> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (t (insert "\\texttt{" desc "}"))))))) >> >> >> -(defun org-export-latex-format-image (path caption label attr) >> +(defun org-export-latex-format-image (path caption label attr >> &optional shortn) >> "Format the image element, depending on user settings." >> (let (ind floatp wrapp multicolumnp placement figenv) >> (setq floatp (or caption label)) >> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (floatp "\\begin{figure}%placement >> \\centering >> \\includegraphics[%attr]{%path} >> -\\caption{%labelcmd%caption} >> +\\caption%shortn{%labelcmd%caption} >> \\end{figure}") >> (t "\\includegraphics[%attr]{%path}"))) >> >> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (expand-file-name path) >> path)) >> (cons "attr" attr) >> + (cons "shortn" (if shortn (format "[%s]" shortn) "")) >> (cons "labelcmd" (if label (format "\\label{%s}" >> label)"")) >> (cons "caption" (or caption "")) >> -- >> 1.7.0.4 >> >> _______________________________________________ >> Emacs-orgmode mailing list >> Please use `Reply All' to send replies to the list. >> Emacs-orgmode@gnu.org >> http://lists.gnu.org/mailman/listinfo/emacs-orgmode > > - Carsten >From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001 From: Eric Schulte <schulte.eric@gmail.com> Date: Thu, 1 Jul 2010 08:07:17 -0700 Subject: [PATCH] add short-names to #+captions with support for latex export captions specified with the following syntax #+CAPTION: [shortname]{longname} will have their short and longnames handled appropriately. Thanks to Robert Cunningham for suggesting this feature. * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding a shortname attribute to caption strings under the symbol name org-caption-shortn. * lisp/org-latex.el (org-export-latex-tables): handling caption short names on table export (org-export-latex-convert-table.el-table): handling caption short names on table.el type table export (org-export-latex-links): handling caption short names on link/image export (org-export-latex-format-image): now takes an optional argument specifying a caption short name
2010-07-01 16:19:14 -04:00
cap shortn attr label end)
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
(while (re-search-forward re nil t)
(cond
`org-export-default-language': Better docstring.
2011-02-15 12:25:43 -05:00
;; there is a caption
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
((match-end 1)
Remove unwanted #+ATTR_Backend and #+Backend during export. * lisp/org-exp.el: (org-export-select-backend-specific-text) Properly get rid of #+Backend and #+ATTR_Backend specifics to backends not matching the one we're exporting to.
2010-06-30 06:28:32 -04:00
(progn
(setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))
a better way with babel Of course, an updated patch is attached. Best -- Eric Carsten Dominik <carsten.dominik@gmail.com> writes: > Hi Eric, > > I tried to apply the patch, but it does not apply cleanly, maybe due > to other changes. Can I ask you to update and resubmit? > > Thanks! > > - Carsten > > On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote: > >> Hi Robert, >> >> Thanks for the thoughtful message. >> >> I present a couple of solutions below. >> >> Robert Cunningham <robut@iinet.net.au> writes: >> >>> G'day All, >>> >>> I wonder if I've missed something and there is a better way. >>> >>> Essentially I'm trying to use org babel with R and LaTeX to create >>> figures >>> with both long and short captions (for contents) >>> >>> I'd started with: >>> >>> #+CAPTION: Nice data (filled points indicate less nice data) >>> #+LABEL: fig:nicedata >>> #+ATTR_LaTeX: width=0.98\textwidth >>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports >>> results >>> dotchart(data$ndata) >>> #+end_src >>> >>> which pointed to the need for long/short captions... >>> >>> feeling hopeful I tried: >>> >>> #+CAPTION: Nice data [Nice data (filled points indicate less nice >>> data)] >>> #+LABEL: fig:nicedata >>> #+ATTR_LaTeX: width=0.98\textwidth >>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports >>> results >>> dotchart(data$ndata) >>> #+end_src >>> >> >> I'm attaching a patch [1] which adds shortname support for captions. >> Once >> applied, the following syntax will result in a caption with a >> shortname >> and a longname. >> >> --8<---------------cut here---------------start------------->8--- >> some pre-table text >> >> #+source: g-nicedata >> #+begin_src gnuplot :file graph.png :exports results >> plot sin(x) >> #+end_src >> >> #+Caption: [nice data]{a longer description of the niceness of the >> data} >> #+results: g-nicedata >> [[file:graph.png]] >> >> some post-table text >> --8<---------------cut here---------------end--------------->8--- >> >> however, while this patch is still pending there is an Org-babel >> solution below which should work immediately. >> >>> >>> >>> but no luck there. >>> >>> Next effort was to try to use R and LaTex more directly with >>> noweb. I tried >>> this: >>> >>> >>> >>> #+srcname: r-nicedata >>> #+begin_src R :session :file ndata.pdf :results output :exports >>> results >>> dotchart(data$ndata) >>> #+end_src >>> >>> >>> #+begin_src latex :noweb yes >>> \begin{figure}[htb!] >>> \centering >>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>} >>> \caption[Nice data]{Nice data (filled points indicate less nice >>> data)} >>> \label{fig:nicedata} >>> \end{figure} >>> #+end_src >>> >>> >>> >>> This does produce the figure and long/short contents BUT ALSO >>> produces this: >>> >>> #+results: r-nicedata >>> [[file:ndata.pdf]] >>> >>> which upon export results in a link and consequently the plot >>> appearing both >>> in the figure and elsewhere. This second plot is unwelcome. >>> >>> I've tried assorted :results and :output options but have not found >>> how to >>> suppress the #+results: but still obtain the figure. I've always used >>> the :session option. >>> >>> I've also tried twigging an org-export option to suppress pdf >>> export but the >>> link is still exported so that is not a solution. >>> >>> The current "working" solution is to use the noweb approach and >>> then use sed >>> to clean out the links to the second image-ugly to say the least! >>> >> >> You were very close with the noweb approach. The following >> combination >> should work -- notice the ":results silent" header argument to the >> source block. >> >> --8<---------------cut here---------------start------------->8--- >> some pre-table text >> >> #+source: g-nicedata >> #+begin_src gnuplot :file graph.png :results silent :exports none >> plot sin(x) >> #+end_src >> >> #+begin_src latex :noweb yes >> \begin{figure}[htb!] >> \centering >> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>} >> \caption[Nice data]{some nice data -- filled points indicate less >> nice data} >> \label{fig:nicedata} >> \end{figure} >> #+end_src >> >> some post-table text >> --8<---------------cut here---------------end--------------->8--- >> >> is exported to the following latex, >> >> --8<---------------cut here---------------start------------->8--- >> some pre-table text >> >> >> >> \begin{figure}[htb!] >> \centering >> \includegraphics[width=0.98\textwidth]{graph.png} >> \caption[Nice data]{some nice data -- filled points indicate less >> nice data} >> \label{fig:nicedata} >> \end{figure} >> >> some post-table text >> --8<---------------cut here---------------end--------------->8--- >> >> Hope this helps, >> >> Best -- Eric >> >>> >>> >>> >>> All this with org version 6.36c >>> >>> >>> What have I missed? What is the best way to do this? >>> >>> >>> Cheers, >>> >>> Robert Cunningham >>> >>> >>> >>> >>> >>> _______________________________________________ >>> Emacs-orgmode mailing list >>> Please use `Reply All' to send replies to the list. >>> Emacs-orgmode@gnu.org >>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode >> >> Footnotes: >> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17 >> 00:00:00 2001 >> From: Eric Schulte <schulte.eric@gmail.com> >> Date: Mon, 21 Jun 2010 09:02:37 -0700 >> Subject: [PATCH] add short-names to #+captions with support for >> latex export >> >> captions specified with the following syntax >> #+CAPTION: [shortname]{longname} >> will have their short and longnames handled appropriately. >> >> Thanks to Robert Cunningham for suggesting this feature. >> >> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding >> a shortname attribute to caption strings under the symbol name >> org-caption-shortn. >> >> * lisp/org-latex.el (org-export-latex-tables): handling caption short >> names on table export >> >> (org-export-latex-convert-table.el-table): handling caption short >> names on table.el type table export >> >> (org-export-latex-links): handling caption short names on link/image >> export >> >> (org-export-latex-format-image): now takes an optional argument >> specifying a caption short name >> --- >> lisp/org-exp.el | 14 +++++++++----- >> lisp/org-latex.el | 21 ++++++++++++++------- >> 2 files changed, 23 insertions(+), 12 deletions(-) >> >> diff --git a/lisp/org-exp.el b/lisp/org-exp.el >> index 029e4d7..466d7da 100644 >> --- a/lisp/org-exp.el >> +++ b/lisp/org-exp.el >> @@ -1256,7 +1256,7 @@ the current file." >> (goto-char (point-min)) >> (while (re-search-forward org-bracket-link-regexp nil t) >> (org-if-unprotected-at (1+ (match-beginning 0)) >> - (let* ((md (match-data)) >> + (let* ((md (match-data)) >> (desc (match-end 2)) >> (link (org-link-unescape (match-string 1))) >> (slink (org-solidify-link-text link)) >> @@ -1381,8 +1381,8 @@ removed as well." >> select-tags "\\|") >> "\\):")) >> (re-excl (concat ":\\(" (mapconcat 'regexp-quote >> - exclude-tags "\\|") >> - "\\):")) >> + exclude-tags "\\|") >> + "\\):")) >> beg end cont) >> (goto-char (point-min)) >> (when (and select-tags >> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the >> line containing the link." >> "^[ \t]*\\(|[^-]\\)" >> "\\|" >> "^[ \t]*\\[\\[.*\\]\\][ \t]*$")) >> - cap attr label end) >> + cap shortn attr label end) >> (while (re-search-forward re nil t) >> (cond >> ((match-end 1) >> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))) >> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))) >> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap) >> + (setq shortn (match-string 1 cap) >> + cap (match-string 2 cap)))) >> ((match-end 2) >> (setq attr (concat attr (if attr " " "") (org-trim >> (match-string 2))))) >> ((match-end 3) >> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the >> line containing the link." >> (point-at-eol))) >> (add-text-properties (point-at-bol) end >> (list 'org-caption cap >> + 'org-caption-shortn shortn >> 'org-attributes attr >> 'org-label label)) >> (if label (push (cons label label) target-alist)) >> diff --git a/lisp/org-latex.el b/lisp/org-latex.el >> index 01a4b05..6c2aab2 100644 >> --- a/lisp/org-latex.el >> +++ b/lisp/org-latex.el >> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (org-table-last-column-widths (copy-sequence >> org-table-last-column- >> widths)) >> fnum fields line lines olines gr colgropen line-fmt align >> - caption label attr floatp longtblp) >> + caption shortn label attr floatp longtblp) >> (if org-export-latex-tables-verbatim >> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table >> "\\end{verbatim}\n"))) >> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (progn >> (setq caption (org-find-text-property-in-string >> 'org-caption raw-table) >> + shortn (org-find-text-property-in-string >> + 'org-caption-shortn raw-table) >> attr (org-find-text-property-in-string >> 'org-attributes raw-table) >> label (org-find-text-property-in-string >> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (if floatp "\\begin{table}[htb]\n")) >> (if floatp >> (format >> - "\\caption{%s%s}" >> + "\\caption%s{%s%s}" >> + (if shortn (concat "[" shortn "]") "") >> (if label (concat "\\\label{" label >> "}") "") >> (or caption ""))) >> (if (and longtblp caption) "\\\\\n" "\n") >> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> >> (defun org-export-latex-convert-table.el-table () >> "Replace table.el table at point with LaTeX code." >> - (let (tbl caption label line floatp attr align rmlines) >> + (let (tbl caption shortn label line floatp attr align rmlines) >> (setq line (buffer-substring (point-at-bol) (point-at-eol)) >> label (org-get-text-property-any 0 'org-label line) >> caption (org-get-text-property-any 0 'org-caption line) >> + shortn (org-get-text-property-any 0 'org-caption-shortn line) >> attr (org-get-text-property-any 0 'org-attributes line) >> align (and attr (stringp attr) >> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr) >> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}"))) >> (when floatp >> (setq tbl (concat "\\begin{table}\n" >> - (format "\\caption{%s%s}\n" >> + (format "\\caption%s{%s%s}\n" >> + (if shortn (format "[%s]" shortn) "") >> (if label (format "\\label{%s}" label) "") >> (or caption "")) >> tbl >> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> "file"))) >> (coderefp (equal type "coderef")) >> (caption (org-find-text-property-in-string 'org-caption >> raw- >> path)) >> + (shortn (org-find-text-property-in-string >> org-caption-shortn raw-path)) >> (attr (or (org-find-text-property-in-string >> org-attributes raw- >> path) >> (plist-get org-export-latex-options-plist >> :latex-image- >> options))) >> (label (org-find-text-property-in-string 'org-label raw-path)) >> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (plist-get org-export-latex-options-plist :inline-images)) >> ;; OK, we need to inline an image >> (insert >> - (org-export-latex-format-image raw-path caption label attr))) >> + (org-export-latex-format-image raw-path caption label >> attr shortn))) >> (coderefp >> (insert (format >> (org-export-get-coderef-format path desc) >> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (t (insert "\\texttt{" desc "}"))))))) >> >> >> -(defun org-export-latex-format-image (path caption label attr) >> +(defun org-export-latex-format-image (path caption label attr >> &optional shortn) >> "Format the image element, depending on user settings." >> (let (ind floatp wrapp multicolumnp placement figenv) >> (setq floatp (or caption label)) >> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (floatp "\\begin{figure}%placement >> \\centering >> \\includegraphics[%attr]{%path} >> -\\caption{%labelcmd%caption} >> +\\caption%shortn{%labelcmd%caption} >> \\end{figure}") >> (t "\\includegraphics[%attr]{%path}"))) >> >> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (expand-file-name path) >> path)) >> (cons "attr" attr) >> + (cons "shortn" (if shortn (format "[%s]" shortn) "")) >> (cons "labelcmd" (if label (format "\\label{%s}" >> label)"")) >> (cons "caption" (or caption "")) >> -- >> 1.7.0.4 >> >> _______________________________________________ >> Emacs-orgmode mailing list >> Please use `Reply All' to send replies to the list. >> Emacs-orgmode@gnu.org >> http://lists.gnu.org/mailman/listinfo/emacs-orgmode > > - Carsten >From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001 From: Eric Schulte <schulte.eric@gmail.com> Date: Thu, 1 Jul 2010 08:07:17 -0700 Subject: [PATCH] add short-names to #+captions with support for latex export captions specified with the following syntax #+CAPTION: [shortname]{longname} will have their short and longnames handled appropriately. Thanks to Robert Cunningham for suggesting this feature. * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding a shortname attribute to caption strings under the symbol name org-caption-shortn. * lisp/org-latex.el (org-export-latex-tables): handling caption short names on table export (org-export-latex-convert-table.el-table): handling caption short names on table.el type table export (org-export-latex-links): handling caption short names on link/image export (org-export-latex-format-image): now takes an optional argument specifying a caption short name
2010-07-01 16:19:14 -04:00
(when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap)
(setq shortn (match-string 1 cap)
cap (match-string 2 cap)))
Remove unwanted #+ATTR_Backend and #+Backend during export. * lisp/org-exp.el: (org-export-select-backend-specific-text) Properly get rid of #+Backend and #+ATTR_Backend specifics to backends not matching the one we're exporting to.
2010-06-30 06:28:32 -04:00
(delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
`org-export-default-language': Better docstring.
2011-02-15 12:25:43 -05:00
;; there is an attribute
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
((match-end 2)
Remove unwanted #+ATTR_Backend and #+Backend during export. * lisp/org-exp.el: (org-export-select-backend-specific-text) Properly get rid of #+Backend and #+ATTR_Backend specifics to backends not matching the one we're exporting to.
2010-06-30 06:28:32 -04:00
(progn
(setq attr (concat attr (if attr " " "") (org-trim (match-string 2))))
(delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
`org-export-default-language': Better docstring.
2011-02-15 12:25:43 -05:00
;; there is a label
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
((match-end 3)
Remove unwanted #+ATTR_Backend and #+Backend during export. * lisp/org-exp.el: (org-export-select-backend-specific-text) Properly get rid of #+Backend and #+ATTR_Backend specifics to backends not matching the one we're exporting to.
2010-06-30 06:28:32 -04:00
(progn
(setq label (org-trim (match-string 3)))
(delete-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))))
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
(t
HTML export: Fix problem with table attributes when first table line is special Eric Fraga writes: > What am I missing? I tried exporting the following to HTML and the > caption and HTML attributes seem to be ignored completely. Also, the > alignment directives are ignored as well. > > --8<---------------cut here---------------start------------->8--- > #+TITLE: test file for org mode > #+DESCRIPTION: used for bug reports > #+AUTHOR: Eric S Fraga > #+EMAIL: Eric S Fraga <e.fraga@ucl.ac.uk> > #+DATE: 2010-03-11 Thu > #+KEYWORDS: > #+LANGUAGE: en > #+OPTIONS: H:3 num:t toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t > #+OPTIONS: TeX:t LaTeX:t skip:nil d:nil todo:t pri:nil tags:not-in-toc > #+INFOJS_OPT: view:nil toc:nil ltoc:t mouse:underline buttons:0 path:http://orgmode.org/org-info.js > #+EXPORT_SELECT_TAGS: export > #+EXPORT_EXCLUDE_TAGS: noexport > #+LINK_UP: > #+LINK_HOME: > > * tables > > #+caption: A very interesting table > #+attr_html: border="1" rules="all" frame="all" align="center" > | <r> | <l> | > | Id | Description | > |-----+--------------------------------| > | 1. | The first item | > | 2. | the second | > | 4. | we don't have a third one | > | 10. | a longer id to check alignment | > |-----+--------------------------------| > --8<---------------cut here---------------end--------------->8--- > > I'm using org current as of yesterday Org-mode version 6.34trans > (release_6.34c.186.g1902) and with GNU Emacs 23.1.1 > (i486-pc-linux-gnu, GTK+ Version 2.18.2) of 2009-11-02 on raven, > modified by Debian
2010-03-11 06:27:42 -05:00
(setq end (if (match-end 4)
(let ((ee (org-table-end)))
(prog1 (1- (marker-position ee)) (move-marker ee nil)))
(point-at-eol)))
(add-text-properties (point-at-bol) end
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
(list 'org-caption cap
a better way with babel Of course, an updated patch is attached. Best -- Eric Carsten Dominik <carsten.dominik@gmail.com> writes: > Hi Eric, > > I tried to apply the patch, but it does not apply cleanly, maybe due > to other changes. Can I ask you to update and resubmit? > > Thanks! > > - Carsten > > On Jun 21, 2010, at 6:37 PM, Eric Schulte wrote: > >> Hi Robert, >> >> Thanks for the thoughtful message. >> >> I present a couple of solutions below. >> >> Robert Cunningham <robut@iinet.net.au> writes: >> >>> G'day All, >>> >>> I wonder if I've missed something and there is a better way. >>> >>> Essentially I'm trying to use org babel with R and LaTeX to create >>> figures >>> with both long and short captions (for contents) >>> >>> I'd started with: >>> >>> #+CAPTION: Nice data (filled points indicate less nice data) >>> #+LABEL: fig:nicedata >>> #+ATTR_LaTeX: width=0.98\textwidth >>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports >>> results >>> dotchart(data$ndata) >>> #+end_src >>> >>> which pointed to the need for long/short captions... >>> >>> feeling hopeful I tried: >>> >>> #+CAPTION: Nice data [Nice data (filled points indicate less nice >>> data)] >>> #+LABEL: fig:nicedata >>> #+ATTR_LaTeX: width=0.98\textwidth >>> #+begin_src R :file ndata.pdf :width 1000 :height 617 :exports >>> results >>> dotchart(data$ndata) >>> #+end_src >>> >> >> I'm attaching a patch [1] which adds shortname support for captions. >> Once >> applied, the following syntax will result in a caption with a >> shortname >> and a longname. >> >> --8<---------------cut here---------------start------------->8--- >> some pre-table text >> >> #+source: g-nicedata >> #+begin_src gnuplot :file graph.png :exports results >> plot sin(x) >> #+end_src >> >> #+Caption: [nice data]{a longer description of the niceness of the >> data} >> #+results: g-nicedata >> [[file:graph.png]] >> >> some post-table text >> --8<---------------cut here---------------end--------------->8--- >> >> however, while this patch is still pending there is an Org-babel >> solution below which should work immediately. >> >>> >>> >>> but no luck there. >>> >>> Next effort was to try to use R and LaTex more directly with >>> noweb. I tried >>> this: >>> >>> >>> >>> #+srcname: r-nicedata >>> #+begin_src R :session :file ndata.pdf :results output :exports >>> results >>> dotchart(data$ndata) >>> #+end_src >>> >>> >>> #+begin_src latex :noweb yes >>> \begin{figure}[htb!] >>> \centering >>> \includegraphics[width=0.98\textwidth]{<<r-nicedata()>>} >>> \caption[Nice data]{Nice data (filled points indicate less nice >>> data)} >>> \label{fig:nicedata} >>> \end{figure} >>> #+end_src >>> >>> >>> >>> This does produce the figure and long/short contents BUT ALSO >>> produces this: >>> >>> #+results: r-nicedata >>> [[file:ndata.pdf]] >>> >>> which upon export results in a link and consequently the plot >>> appearing both >>> in the figure and elsewhere. This second plot is unwelcome. >>> >>> I've tried assorted :results and :output options but have not found >>> how to >>> suppress the #+results: but still obtain the figure. I've always used >>> the :session option. >>> >>> I've also tried twigging an org-export option to suppress pdf >>> export but the >>> link is still exported so that is not a solution. >>> >>> The current "working" solution is to use the noweb approach and >>> then use sed >>> to clean out the links to the second image-ugly to say the least! >>> >> >> You were very close with the noweb approach. The following >> combination >> should work -- notice the ":results silent" header argument to the >> source block. >> >> --8<---------------cut here---------------start------------->8--- >> some pre-table text >> >> #+source: g-nicedata >> #+begin_src gnuplot :file graph.png :results silent :exports none >> plot sin(x) >> #+end_src >> >> #+begin_src latex :noweb yes >> \begin{figure}[htb!] >> \centering >> \includegraphics[width=0.98\textwidth]{<<g-nicedata()>>} >> \caption[Nice data]{some nice data -- filled points indicate less >> nice data} >> \label{fig:nicedata} >> \end{figure} >> #+end_src >> >> some post-table text >> --8<---------------cut here---------------end--------------->8--- >> >> is exported to the following latex, >> >> --8<---------------cut here---------------start------------->8--- >> some pre-table text >> >> >> >> \begin{figure}[htb!] >> \centering >> \includegraphics[width=0.98\textwidth]{graph.png} >> \caption[Nice data]{some nice data -- filled points indicate less >> nice data} >> \label{fig:nicedata} >> \end{figure} >> >> some post-table text >> --8<---------------cut here---------------end--------------->8--- >> >> Hope this helps, >> >> Best -- Eric >> >>> >>> >>> >>> All this with org version 6.36c >>> >>> >>> What have I missed? What is the best way to do this? >>> >>> >>> Cheers, >>> >>> Robert Cunningham >>> >>> >>> >>> >>> >>> _______________________________________________ >>> Emacs-orgmode mailing list >>> Please use `Reply All' to send replies to the list. >>> Emacs-orgmode@gnu.org >>> http://lists.gnu.org/mailman/listinfo/emacs-orgmode >> >> Footnotes: >> [1] From 6a55dcab99bbd7840117b8390ab5db347d2573ef Mon Sep 17 >> 00:00:00 2001 >> From: Eric Schulte <schulte.eric@gmail.com> >> Date: Mon, 21 Jun 2010 09:02:37 -0700 >> Subject: [PATCH] add short-names to #+captions with support for >> latex export >> >> captions specified with the following syntax >> #+CAPTION: [shortname]{longname} >> will have their short and longnames handled appropriately. >> >> Thanks to Robert Cunningham for suggesting this feature. >> >> * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding >> a shortname attribute to caption strings under the symbol name >> org-caption-shortn. >> >> * lisp/org-latex.el (org-export-latex-tables): handling caption short >> names on table export >> >> (org-export-latex-convert-table.el-table): handling caption short >> names on table.el type table export >> >> (org-export-latex-links): handling caption short names on link/image >> export >> >> (org-export-latex-format-image): now takes an optional argument >> specifying a caption short name >> --- >> lisp/org-exp.el | 14 +++++++++----- >> lisp/org-latex.el | 21 ++++++++++++++------- >> 2 files changed, 23 insertions(+), 12 deletions(-) >> >> diff --git a/lisp/org-exp.el b/lisp/org-exp.el >> index 029e4d7..466d7da 100644 >> --- a/lisp/org-exp.el >> +++ b/lisp/org-exp.el >> @@ -1256,7 +1256,7 @@ the current file." >> (goto-char (point-min)) >> (while (re-search-forward org-bracket-link-regexp nil t) >> (org-if-unprotected-at (1+ (match-beginning 0)) >> - (let* ((md (match-data)) >> + (let* ((md (match-data)) >> (desc (match-end 2)) >> (link (org-link-unescape (match-string 1))) >> (slink (org-solidify-link-text link)) >> @@ -1381,8 +1381,8 @@ removed as well." >> select-tags "\\|") >> "\\):")) >> (re-excl (concat ":\\(" (mapconcat 'regexp-quote >> - exclude-tags "\\|") >> - "\\):")) >> + exclude-tags "\\|") >> + "\\):")) >> beg end cont) >> (goto-char (point-min)) >> (when (and select-tags >> @@ -1593,11 +1593,14 @@ table line. If it is a link, add it to the >> line containing the link." >> "^[ \t]*\\(|[^-]\\)" >> "\\|" >> "^[ \t]*\\[\\[.*\\]\\][ \t]*$")) >> - cap attr label end) >> + cap shortn attr label end) >> (while (re-search-forward re nil t) >> (cond >> ((match-end 1) >> - (setq cap (concat cap (if cap " " "") (org-trim (match-string 1))))) >> + (setq cap (concat cap (if cap " " "") (org-trim (match-string 1)))) >> + (when (string-match "\\[\\(.*\\)\\]{\\(.*\\)}" cap) >> + (setq shortn (match-string 1 cap) >> + cap (match-string 2 cap)))) >> ((match-end 2) >> (setq attr (concat attr (if attr " " "") (org-trim >> (match-string 2))))) >> ((match-end 3) >> @@ -1609,6 +1612,7 @@ table line. If it is a link, add it to the >> line containing the link." >> (point-at-eol))) >> (add-text-properties (point-at-bol) end >> (list 'org-caption cap >> + 'org-caption-shortn shortn >> 'org-attributes attr >> 'org-label label)) >> (if label (push (cons label label) target-alist)) >> diff --git a/lisp/org-latex.el b/lisp/org-latex.el >> index 01a4b05..6c2aab2 100644 >> --- a/lisp/org-latex.el >> +++ b/lisp/org-latex.el >> @@ -1576,7 +1576,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (org-table-last-column-widths (copy-sequence >> org-table-last-column- >> widths)) >> fnum fields line lines olines gr colgropen line-fmt align >> - caption label attr floatp longtblp) >> + caption shortn label attr floatp longtblp) >> (if org-export-latex-tables-verbatim >> (let* ((tbl (concat "\\begin{verbatim}\n" raw-table >> "\\end{verbatim}\n"))) >> @@ -1585,6 +1585,8 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (progn >> (setq caption (org-find-text-property-in-string >> 'org-caption raw-table) >> + shortn (org-find-text-property-in-string >> + 'org-caption-shortn raw-table) >> attr (org-find-text-property-in-string >> 'org-attributes raw-table) >> label (org-find-text-property-in-string >> @@ -1652,7 +1654,8 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (if floatp "\\begin{table}[htb]\n")) >> (if floatp >> (format >> - "\\caption{%s%s}" >> + "\\caption%s{%s%s}" >> + (if shortn (concat "[" shortn "]") "") >> (if label (concat "\\\label{" label >> "}") "") >> (or caption ""))) >> (if (and longtblp caption) "\\\\\n" "\n") >> @@ -1680,10 +1683,11 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> >> (defun org-export-latex-convert-table.el-table () >> "Replace table.el table at point with LaTeX code." >> - (let (tbl caption label line floatp attr align rmlines) >> + (let (tbl caption shortn label line floatp attr align rmlines) >> (setq line (buffer-substring (point-at-bol) (point-at-eol)) >> label (org-get-text-property-any 0 'org-label line) >> caption (org-get-text-property-any 0 'org-caption line) >> + shortn (org-get-text-property-any 0 'org-caption-shortn line) >> attr (org-get-text-property-any 0 'org-attributes line) >> align (and attr (stringp attr) >> (string-match "\\<align=\\([^ \t\n\r,]+\\)" attr) >> @@ -1721,7 +1725,8 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (setq tbl (concat "\\begin{center}\n" tbl "\\end{center}"))) >> (when floatp >> (setq tbl (concat "\\begin{table}\n" >> - (format "\\caption{%s%s}\n" >> + (format "\\caption%s{%s%s}\n" >> + (if shortn (format "[%s]" shortn) "") >> (if label (format "\\label{%s}" label) "") >> (or caption "")) >> tbl >> @@ -1822,6 +1827,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> "file"))) >> (coderefp (equal type "coderef")) >> (caption (org-find-text-property-in-string 'org-caption >> raw- >> path)) >> + (shortn (org-find-text-property-in-string >> org-caption-shortn raw-path)) >> (attr (or (org-find-text-property-in-string >> org-attributes raw- >> path) >> (plist-get org-export-latex-options-plist >> :latex-image- >> options))) >> (label (org-find-text-property-in-string 'org-label raw-path)) >> @@ -1859,7 +1865,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (plist-get org-export-latex-options-plist :inline-images)) >> ;; OK, we need to inline an image >> (insert >> - (org-export-latex-format-image raw-path caption label attr))) >> + (org-export-latex-format-image raw-path caption label >> attr shortn))) >> (coderefp >> (insert (format >> (org-export-get-coderef-format path desc) >> @@ -1889,7 +1895,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (t (insert "\\texttt{" desc "}"))))))) >> >> >> -(defun org-export-latex-format-image (path caption label attr) >> +(defun org-export-latex-format-image (path caption label attr >> &optional shortn) >> "Format the image element, depending on user settings." >> (let (ind floatp wrapp multicolumnp placement figenv) >> (setq floatp (or caption label)) >> @@ -1932,7 +1938,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (floatp "\\begin{figure}%placement >> \\centering >> \\includegraphics[%attr]{%path} >> -\\caption{%labelcmd%caption} >> +\\caption%shortn{%labelcmd%caption} >> \\end{figure}") >> (t "\\includegraphics[%attr]{%path}"))) >> >> @@ -1953,6 +1959,7 @@ The conversion is made depending of STRING- >> BEFORE and STRING-AFTER." >> (expand-file-name path) >> path)) >> (cons "attr" attr) >> + (cons "shortn" (if shortn (format "[%s]" shortn) "")) >> (cons "labelcmd" (if label (format "\\label{%s}" >> label)"")) >> (cons "caption" (or caption "")) >> -- >> 1.7.0.4 >> >> _______________________________________________ >> Emacs-orgmode mailing list >> Please use `Reply All' to send replies to the list. >> Emacs-orgmode@gnu.org >> http://lists.gnu.org/mailman/listinfo/emacs-orgmode > > - Carsten >From 5cbb38e25a2d2eae7c3c688d347f80619ecb8463 Mon Sep 17 00:00:00 2001 From: Eric Schulte <schulte.eric@gmail.com> Date: Thu, 1 Jul 2010 08:07:17 -0700 Subject: [PATCH] add short-names to #+captions with support for latex export captions specified with the following syntax #+CAPTION: [shortname]{longname} will have their short and longnames handled appropriately. Thanks to Robert Cunningham for suggesting this feature. * lisp/org-exp.el (org-export-attach-captions-and-attributes): adding a shortname attribute to caption strings under the symbol name org-caption-shortn. * lisp/org-latex.el (org-export-latex-tables): handling caption short names on table export (org-export-latex-convert-table.el-table): handling caption short names on table.el type table export (org-export-latex-links): handling caption short names on link/image export (org-export-latex-format-image): now takes an optional argument specifying a caption short name
2010-07-01 16:19:14 -04:00
'org-caption-shortn shortn
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
'org-attributes attr
'org-label label))
(if label (push (cons label label) target-alist))
HTML export: Fix problem with table attributes when first table line is special Eric Fraga writes: > What am I missing? I tried exporting the following to HTML and the > caption and HTML attributes seem to be ignored completely. Also, the > alignment directives are ignored as well. > > --8<---------------cut here---------------start------------->8--- > #+TITLE: test file for org mode > #+DESCRIPTION: used for bug reports > #+AUTHOR: Eric S Fraga > #+EMAIL: Eric S Fraga <e.fraga@ucl.ac.uk> > #+DATE: 2010-03-11 Thu > #+KEYWORDS: > #+LANGUAGE: en > #+OPTIONS: H:3 num:t toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t <:t > #+OPTIONS: TeX:t LaTeX:t skip:nil d:nil todo:t pri:nil tags:not-in-toc > #+INFOJS_OPT: view:nil toc:nil ltoc:t mouse:underline buttons:0 path:http://orgmode.org/org-info.js > #+EXPORT_SELECT_TAGS: export > #+EXPORT_EXCLUDE_TAGS: noexport > #+LINK_UP: > #+LINK_HOME: > > * tables > > #+caption: A very interesting table > #+attr_html: border="1" rules="all" frame="all" align="center" > | <r> | <l> | > | Id | Description | > |-----+--------------------------------| > | 1. | The first item | > | 2. | the second | > | 4. | we don't have a third one | > | 10. | a longer id to check alignment | > |-----+--------------------------------| > --8<---------------cut here---------------end--------------->8--- > > I'm using org current as of yesterday Org-mode version 6.34trans > (release_6.34c.186.g1902) and with GNU Emacs 23.1.1 > (i486-pc-linux-gnu, GTK+ Version 2.18.2) of 2009-11-02 on raven, > modified by Debian
2010-03-11 06:27:42 -05:00
(goto-char end)
Optional \caption argument for LaTeX export Aloha all, The attached patch initializes the existing variable shortn, adds it to two caption situations in addition to the one already coded, and adds some description to the manual. With this patch, #+CAPTION: [Short caption]{Long caption.} in the Org-mode source exports to \caption[Short caption]{Long caption.} in the LaTeX export, which is, I think, as it should be. Many thanks to Nick Dokos who made me understand why earlier patches hadn't shown up on the patchwork server (wrong mime type, evil mail client). This one sent with gnus and fingers crossed. All the best, Tom >From 9dc65f7e598dd171ebce9448cd39c4062f7cafff Mon Sep 17 00:00:00 2001 From: Tom Dye <tsd@tsdye.com> Date: Sun, 8 May 2011 06:56:25 -1000 Subject: [PATCH] optional caption arguments in LaTeX export
2011-05-08 21:11:39 -04:00
(setq cap nil shortn nil attr nil label nil)))))
Captions and attributes for images and tables during export Tables, and Hyperlinks that represent inlined images, can now be equipped with additional information that will be used during export. The information will be taken from the following special lines in the buffer and apply to the first following table or link. - #+CAPTION: :: The caption of the image or table. This string should be processed according to the export backend, but this is not yet done. - #+LABEL: :: A label to identify the figure/table for cross references. For HTML export, this string will become the ID for the `<div class="figure">' element that encapsulates the image tag and the caption. For LaTeX export, this string will be used as the argument of a `\label{...}' macro. These lables will be available for internal links like `[[label][Table] ]'. - #+ATTR_HTML: :: Attributes for HTML export of image, to be added as attributes into the `<img...>' tag. This string will not be processed, so it should have immediately the right format. - #+ATTR_LaTeX: :: Attributes for LaTeX export of images, to be inserted into the optional argument of the `\includegraphics[...]{file}' command, to specify scaling, clipping and other options. This string will not be processed, so it should have immediately the right format, like `width=5cm,angle=90' For LaTeX export, if either a caption or a label is given, the element will be exported as a float, i.e. wrapped into a figure or table environment.
2008-12-10 06:50:07 -05:00
target-alist)
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(defun org-export-remove-comment-blocks-and-subtrees ()
"Remove the comment environment, and also commented subtrees."
Provide more consistent regexps for headlines * lisp/org-agenda.el (org-search-view): Simplify regexp. (org-agenda-get-todos): Use new format string. * lisp/org-archive.el (org-archive-all-done): Simplify regexp. * lisp/org-ascii.el (org-export-as-ascii): More accurate regexp. * lisp/org-colview-xemacs.el (org-columns-capture-view): Use new format string and new string. * lisp/org-colview.el (org-columns-capture-view): Use new format string and new string. * lisp/org-docbook.el (org-export-as-docbook): More accurate regexp. Also use new regexp to match generic headlines. * lisp/org-exp.el (org-export-protect-quoted-subtrees): More accurate regexp. Also use new regexp to match generic headlines. * lisp/org-html.el (org-export-as-html): More accurate regexp. Also use new regexp to match generic headlines. * lisp/org-mouse.el (org-mouse-match-todo-keyword): Removed unused and now erroneous function. * lisp/org.el (org-heading-regexp, org-heading-keyword-regexp-format): New variables. (org-set-regexps-and-options): Create regexps according to the following rule: use spaces only to separate elements from an headline, while allowing mixed tabs and spaces for any indentation job. (org-nl-done-regexp, org-looking-at-done-regexp): Removed variables. (org-set-font-lock-defaults): Fontify again headlines with a keyword and no other text. Use new format strings. (org-get-heading, org-toggle-comment, org-prepare-agenda-buffers, org-toggle-fixed-width-section): Use new format string. (org-todo): More accurate regexps. (org-point-at-end-of-empty-headline): Simplify regexp. (org-insert-heading): Headline can sometimes be nil. This patch attempts to reduce the number of hard-coded headlines, by providing two format strings and one generic string to cover most of the cases of headline construction.
2011-08-24 19:58:29 -04:00
(let ((re-commented (format org-heading-keyword-regexp-format
org-comment-string))
Fix some case issues with comment processing during export
2010-01-06 03:55:52 -05:00
case-fold-search)
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
;; Remove comment environment
(goto-char (point-min))
Fix some case issues with comment processing during export
2010-01-06 03:55:52 -05:00
(setq case-fold-search t)
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(while (re-search-forward
Fix begin/end comment * lisp/org-exp.el (org-export-remove-comment-blocks-and-subtrees): Fix regexp. Rasmus <rasmus.pank@gmail.com> wrote: > Hi, > It seems that > > ,---- > | #+BEGIN_COMMENT > | ... > | #+END_COMMENT > `---- > > Might be broken in Org-mode 7.5. According to the manual, > > ,---- > | Finally, regions surrounded by > | #+BEGIN_COMMENT ... #+END_COMMENT will not be exported. > `---- > > Consider the following example generated with Org-mode 7.5 in Emacs 24.0.50 > (started without config files). > > ,---- > | #+TITLE: this is a test > | > | #+BEGIN_COMMENT > | Don't export me > | #+END_COMMENT > | > | I'd like to be exposed > `---- > > The HTML export is: > > ,---- > | <snip> > | <h1 class="title">this is a test</h1> > | > | <div class="org-comment"> > | </br> > | <p> > | <p> > | Don't export me > | </p> > | </div> > | > | I'd like to be exposed > | <snip> > `---- > > The LaTeX export is: > > ,---- > | \begin{verbatim} > | Don't export me > | \end{verbatim} > | I'd like to be exposed > `---- > Indeed. It seems that one of the hair-raising regexps that Carsten manages to come up with is not quite right. Try this patch for now: --8<---------------cut here---------------start------------->8--- --8<---------------cut here---------------end--------------->8--- Nick
2011-03-14 01:48:15 -04:00
"^#\\+begin_comment[ \t]*\n[^\000]*?\n#\\+end_comment\\>.*" nil t)
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(replace-match "" t t))
;; Remove subtrees that are commented
(goto-char (point-min))
Fix some case issues with comment processing during export
2010-01-06 03:55:52 -05:00
(setq case-fold-search nil)
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(while (re-search-forward re-commented nil t)
(goto-char (match-beginning 0))
(delete-region (point) (org-end-of-subtree t)))))
Fix (a lot of) compiler warnings. Also introduce `org-pop-to-buffer-same-window' as a compatibility function for Emacs =>24.1.
2011-07-18 13:25:10 -04:00
(defun org-export-handle-comments (org-commentsp)
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
"Remove comments, or convert to backend-specific format.
Fix (a lot of) compiler warnings. Also introduce `org-pop-to-buffer-same-window' as a compatibility function for Emacs =>24.1.
2011-07-18 13:25:10 -04:00
ORG-COMMENTSP can be a format string for publishing comments.
Fix bug with removing xomments during export. Reported by Adam Spiers.
2008-06-10 03:02:57 -04:00
When it is nil, all comments will be removed."
Fix comments export in latex. * lisp/org-exp.el: comment regexp now matches documentation. No more protection check when deleting comments before export. Thanks to Nicolas Goaziou <n.goaziou@gmail.com> for this patch.
2010-06-16 12:14:28 -04:00
(let ((re "^\\(#\\|[ \t]*#\\+ \\)\\(.*\n?\\)")
Fix bug with removing xomments during export. Reported by Adam Spiers.
2008-06-10 03:02:57 -04:00
pos)
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(goto-char (point-min))
Fix bug with removing xomments during export. Reported by Adam Spiers.
2008-06-10 03:02:57 -04:00
(while (or (looking-at re)
(re-search-forward re nil t))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(setq pos (match-beginning 0))
Fix comment protection issue * lisp/org-exp.el (org-export-handle-comments): Make sure to check for protection in the comment line, and not in the line after it.
2010-07-01 05:02:13 -04:00
(if (get-text-property pos 'org-protected)
org-exp: check for protection before removing comments * lisp/org-exp.el (org-export-handle-comments): check for protection before removing comments
2010-06-27 22:35:34 -04:00
(goto-char (1+ pos))
Fix (a lot of) compiler warnings. Also introduce `org-pop-to-buffer-same-window' as a compatibility function for Emacs =>24.1.
2011-07-18 13:25:10 -04:00
(if (and org-commentsp
org-exp: check for protection before removing comments * lisp/org-exp.el (org-export-handle-comments): check for protection before removing comments
2010-06-27 22:35:34 -04:00
(not (equal (char-before (match-end 1)) ?+)))
(progn (add-text-properties
(match-beginning 0) (match-end 0) '(org-protected t))
Ensure org-export-handle-comments protects its insertions * lisp/org-exp.el (org-export-handle-comments): Add the org-protected property to the replacement string. Although org-export-handle-comments adds the org-protected property to the matched string, the subsequent `replace-match' call to change the comment character does not add this property to the entire format string. Fix this by propertizing the entirety of the newtext argument to replace-match.
2011-03-28 16:20:47 -04:00
(replace-match (org-add-props
Fix (a lot of) compiler warnings. Also introduce `org-pop-to-buffer-same-window' as a compatibility function for Emacs =>24.1.
2011-07-18 13:25:10 -04:00
(format org-commentsp (match-string 2))
Ensure org-export-handle-comments protects its insertions * lisp/org-exp.el (org-export-handle-comments): Add the org-protected property to the replacement string. Although org-export-handle-comments adds the org-protected property to the matched string, the subsequent `replace-match' call to change the comment character does not add this property to the entire format string. Fix this by propertizing the entirety of the newtext argument to replace-match.
2011-03-28 16:20:47 -04:00
nil 'org-protected t)
t t))
org-exp: check for protection before removing comments * lisp/org-exp.el (org-export-handle-comments): check for protection before removing comments
2010-06-27 22:35:34 -04:00
(goto-char (1+ pos))
(replace-match "")
(goto-char (max (point-min) (1- pos))))))))
org-exp: now removing table meta (e.g. #+TBLNAME, #+TBLFM) from export * lisp/org-exp.el (org-export-handle-table-metalines): this function removes table specific meta-lines, now that we aren't wiping everything that looks remotely like a comment at the end of the export process we have to be sure to catch all of the specific lines in org-exp.el
2010-06-30 19:01:38 -04:00
(defun org-export-handle-table-metalines ()
"Remove table specific metalines #+TBLNAME: and #+TBLFM:."
(let ((re "^[ \t]*#\\+TBL\\(NAME\\|FM\\):\\(.*\n?\\)")
pos)
(goto-char (point-min))
(while (or (looking-at re)
(re-search-forward re nil t))
(setq pos (match-beginning 0))
Fix bug with exporting table metalines to LaTeX/PDF * lisp/org-exp.el (org-export-handle-table-metalines): Choose a better position for checking protectedness.
2010-07-20 11:44:54 -04:00
(if (get-text-property (match-beginning 1) 'org-protected)
org-exp: now removing table meta (e.g. #+TBLNAME, #+TBLFM) from export * lisp/org-exp.el (org-export-handle-table-metalines): this function removes table specific meta-lines, now that we aren't wiping everything that looks remotely like a comment at the end of the export process we have to be sure to catch all of the specific lines in org-exp.el
2010-06-30 19:01:38 -04:00
(goto-char (1+ pos))
(goto-char (1+ pos))
(replace-match "")
(goto-char (max (point-min) (1- pos)))))))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
org-export: Cleanup #+name and #+results * lisp/org-exp.el (org-export-res/src-name-cleanup): Remove #+name and #+results lines during preprocess. Now Babel doesn't handle anymore those keywords cleanup (as #+name may be used for other thing than code evaluation), that task is moved to org-export.el. See commit 25a0a0212193ecc5e910696301b3a64a51f837e0.
2011-12-04 11:00:46 -05:00
(defun org-export-res/src-name-cleanup ()
"Clean up #+results and #+name lines for export.
This function should only be called after all block processing
has taken place."
(interactive)
(save-excursion
(goto-char (point-min))
(let ((case-fold-search t))
(while (org-re-search-forward-unprotected
"#\\+\\(name\\|results\\(\\[[a-z0-9]+\\]\\)?\\):" nil t)
(delete-region (match-beginning 0) (progn (forward-line) (point)))))))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
(defun org-export-mark-radio-links ()
"Find all matches for radio targets and turn them into internal links."
(let ((re-radio (and org-target-link-regexp
(concat "\\([^<]\\)\\(" org-target-link-regexp "\\)"))))
(goto-char (point-min))
(when re-radio
(while (re-search-forward re-radio nil t)
Export: Ignore radio matches in links
2009-07-19 02:35:31 -04:00
(unless
(save-match-data
(or (org-in-regexp org-bracket-link-regexp)
Fix export bug with radio links matching inside <<target>>
2010-01-01 08:27:07 -05:00
(org-in-regexp org-plain-link-re)
(org-in-regexp "<<[^<>]+>>")))
Export: Ignore radio matches in links
2009-07-19 02:35:31 -04:00
(org-if-unprotected
(replace-match "\\1[[\\2]]")))))))
Split the export pre-processor into a zillion small functions.
2008-05-28 10:59:17 -04:00
HTML export: Use forced alignment like <l> or <r> in tables * lisp/org-table.el (org-table-cookie-line-p): Fix indentation. * lisp/org-exp.el (org-store-forced-table-alignment): New function. (org-export-preprocess-string): Call `org-store-forced-table-alignment'. * lisp/org-html.el (org-format-org-table-html): Use stored alignment information.
2010-10-21 10:28:06 -04:00
(defun org-store-forced-table-alignment ()
"Find table lines which force alignment, store the results in properties."
Parse and store both col align and col width spec for later use * lisp/org-exp.el (org-store-forced-table-alignment): Parse the column cookie for both alignment and width specification. Store the resulting value in `org-col-cookies' property. Retire the previously used `org-forced-aligns' property for consistency. Renamed local variable `aligns' to `cookies'. * lisp/org-html.el (org-format-org-table-html): Use `org-col-cookies'. Renamed local variable forced-aligns to col-cookies. This is a preparatory patch. A backend can look at the colwidth specification and (at it's discretion) use it to control relative sizes of individual columns in a table. At this moment, it is unclear whether the widths used to control the display of table in Org buffer can be overloaded to also control the formatting of table in a backend. Refer following discussion with Matt Price: http://lists.gnu.org/archive/html/emacs-orgmode/2011-08/msg01053.html
2011-10-16 04:54:20 -04:00
(let (line cnt cookies)
HTML export: Use forced alignment like <l> or <r> in tables * lisp/org-table.el (org-table-cookie-line-p): Fix indentation. * lisp/org-exp.el (org-store-forced-table-alignment): New function. (org-export-preprocess-string): Call `org-store-forced-table-alignment'. * lisp/org-html.el (org-format-org-table-html): Use stored alignment information.
2010-10-21 10:28:06 -04:00
(goto-char (point-min))
Parse and store both col align and col width spec for later use * lisp/org-exp.el (org-store-forced-table-alignment): Parse the column cookie for both alignment and width specification. Store the resulting value in `org-col-cookies' property. Retire the previously used `org-forced-aligns' property for consistency. Renamed local variable `aligns' to `cookies'. * lisp/org-html.el (org-format-org-table-html): Use `org-col-cookies'. Renamed local variable forced-aligns to col-cookies. This is a preparatory patch. A backend can look at the colwidth specification and (at it's discretion) use it to control relative sizes of individual columns in a table. At this moment, it is unclear whether the widths used to control the display of table in Org buffer can be overloaded to also control the formatting of table in a backend. Refer following discussion with Matt Price: http://lists.gnu.org/archive/html/emacs-orgmode/2011-08/msg01053.html
2011-10-16 04:54:20 -04:00
(while (re-search-forward "|[ \t]*<\\([lrc]?[0-9]+\\|[lrc]\\)>[ \t]*|"
nil t)
HTML export: Use forced alignment like <l> or <r> in tables * lisp/org-table.el (org-table-cookie-line-p): Fix indentation. * lisp/org-exp.el (org-store-forced-table-alignment): New function. (org-export-preprocess-string): Call `org-store-forced-table-alignment'. * lisp/org-html.el (org-format-org-table-html): Use stored alignment information.
2010-10-21 10:28:06 -04:00
;; OK, this looks like a table line with an alignment cookie
(org-if-unprotected
(setq line (buffer-substring (point-at-bol) (point-at-eol)))
(when (and (org-at-table-p)
(org-table-cookie-line-p line))
Parse and store both col align and col width spec for later use * lisp/org-exp.el (org-store-forced-table-alignment): Parse the column cookie for both alignment and width specification. Store the resulting value in `org-col-cookies' property. Retire the previously used `org-forced-aligns' property for consistency. Renamed local variable `aligns' to `cookies'. * lisp/org-html.el (org-format-org-table-html): Use `org-col-cookies'. Renamed local variable forced-aligns to col-cookies. This is a preparatory patch. A backend can look at the colwidth specification and (at it's discretion) use it to control relative sizes of individual columns in a table. At this moment, it is unclear whether the widths used to control the display of table in Org buffer can be overloaded to also control the formatting of table in a backend. Refer following discussion with Matt Price: http://lists.gnu.org/archive/html/emacs-orgmode/2011-08/msg01053.html
2011-10-16 04:54:20 -04:00
(setq cnt 0 cookies nil)
HTML export: Improved support for field alignment, including centering * doc/org.texi: Document the <c> cookie. * lisp/org-exp.el (org-store-forced-table-alignment): (org-export-remove-special-table-lines): Allow the "c" cookie for table alignment. * lisp/org-html.el (org-export-table-header-tags): (org-export-table-data-tags): Add another %s format for the alignment. (org-export-html-table-align-individual-fields): New option. (org-format-org-table-html): Implement field-by-field alignment and support centering. (org-format-table-table-html): Make sure the new table tag formats don't break this function. * lisp/org-table.el (org-table-cookie-line-p): (org-table-align): Allow for the <c> cookie. * lisp/org.el (org-set-font-lock-defaults): Allow for the <c> cookie.
2010-10-22 03:19:04 -04:00
(mapc
HTML export: Use forced alignment like <l> or <r> in tables * lisp/org-table.el (org-table-cookie-line-p): Fix indentation. * lisp/org-exp.el (org-store-forced-table-alignment): New function. (org-export-preprocess-string): Call `org-store-forced-table-alignment'. * lisp/org-html.el (org-format-org-table-html): Use stored alignment information.
2010-10-21 10:28:06 -04:00
(lambda (x)
(setq cnt (1+ cnt))
Parse and store both col align and col width spec for later use * lisp/org-exp.el (org-store-forced-table-alignment): Parse the column cookie for both alignment and width specification. Store the resulting value in `org-col-cookies' property. Retire the previously used `org-forced-aligns' property for consistency. Renamed local variable `aligns' to `cookies'. * lisp/org-html.el (org-format-org-table-html): Use `org-col-cookies'. Renamed local variable forced-aligns to col-cookies. This is a preparatory patch. A backend can look at the colwidth specification and (at it's discretion) use it to control relative sizes of individual columns in a table. At this moment, it is unclear whether the widths used to control the display of table in Org buffer can be overloaded to also control the formatting of table in a backend. Refer following discussion with Matt Price: http://lists.gnu.org/archive/html/emacs-orgmode/2011-08/msg01053.html
2011-10-16 04:54:20 -04:00
(when (string-match "\\`<\\([lrc]\\)?\\([0-9]+\\)?>\\'" x)
(let ((align (and (match-end 1)
(downcase (match-string 1 x))))
(width (and (match-end 2)
(string-to-number (match-string 2 x)))))
(push (cons cnt (list align width)) cookies))))
HTML export: Use forced alignment like <l> or <r> in tables * lisp/org-table.el (org-table-cookie-line-p): Fix indentation. * lisp/org-exp.el (org-store-forced-table-alignment): New function. (org-export-preprocess-string): Call `org-store-forced-table-alignment'. * lisp/org-html.el (org-format-org-table-html): Use stored alignment information.
2010-10-21 10:28:06 -04:00
(org-split-string line "[ \t]*|[ \t]*"))
(add-text-properties (org-table-begin) (org-table-end)
Parse and store both col align and col width spec for later use * lisp/org-exp.el (org-store-forced-table-alignment): Parse the column cookie for both alignment and width specification. Store the resulting value in `org-col-cookies' property. Retire the previously used `org-forced-aligns' property for consistency. Renamed local variable `aligns' to `cookies'. * lisp/org-html.el (org-format-org-table-html): Use `org-col-cookies'. Renamed local variable forced-aligns to col-cookies. This is a preparatory patch. A backend can look at the colwidth specification and (at it's discretion) use it to control relative sizes of individual columns in a table. At this moment, it is unclear whether the widths used to control the display of table in Org buffer can be overloaded to also control the formatting of table in a backend. Refer following discussion with Matt Price: http://lists.gnu.org/archive/html/emacs-orgmode/2011-08/msg01053.html
2011-10-16 04:54:20 -04:00
(list 'org-col-cookies cookies))))
HTML export: Use forced alignment like <l> or <r> in tables * lisp/org-table.el (org-table-cookie-line-p): Fix indentation. * lisp/org-exp.el (org-store-forced-table-alignment): New function. (org-export-preprocess-string): Call `org-store-forced-table-alignment'. * lisp/org-html.el (org-format-org-table-html): Use stored alignment information.
2010-10-21 10:28:06 -04:00
(goto-char (point-at-eol)))))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(defun org-export-remove-special-table-lines ()
HTML export: Use forced alignment like <l> or <r> in tables * lisp/org-table.el (org-table-cookie-line-p): Fix indentation. * lisp/org-exp.el (org-store-forced-table-alignment): New function. (org-export-preprocess-string): Call `org-store-forced-table-alignment'. * lisp/org-html.el (org-format-org-table-html): Use stored alignment information.
2010-10-21 10:28:06 -04:00
"Remove tables lines that are used for internal purposes.
New variable `org-export-table-remove-empty-lines'. * org-exp.el (org-export-table-remove-empty-lines): New custom variable. (org-export-remove-special-table-lines): Use it. This was requested by Eric S Fraga.
2011-03-05 17:35:09 -05:00
Also, store forced alignment information found in such lines."
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(goto-char (point-min))
(while (re-search-forward "^[ \t]*|" nil t)
Fix bug with protected examples that look like table lines * lisp/org-exp.el (org-export-remove-special-table-lines): Only fix table lines that are not protected text. Giovanni Moretti writes: > I'm working up a presentation on orgmode for a local club and needed > to prefix it with a brief emacs overview, and so included this: > > #+BEGIN_EXAMPLE > ctrl-P (previous line) > | > | > Ctrl-A <<< Ctrl-B <---- o ----> Ctrl-F >>> Ctrl-E > Col 1 back char ! fwd char EOL > ! > ctrl-N (next line) > #+END_EXAMPLE > > : ctrl-P (previous line) > : | > : | > : Ctrl-A <<< Ctrl-B <---- o ----> Ctrl-F >>> Ctrl-E > : Col 1 back char | fwd char EOL > : | > : ctrl-N (next line) > > I'm using Orgmode v6.36c and when exporting to HTML (and LaTex > Beamer), the two lines containing the single vertical bar immediately > below the "ctrl-P" line in the #+EXAMPLE block vanish, whereas using > the alternate colon at the beginning of the line notation, the > rendering is as expected. > > Interestingly, enabling the +n option (#+BEGIN_EXAMPLE +n) causes the > missing lines (lines 2 & 3) to reappear.
2010-06-06 23:31:44 -04:00
(org-if-unprotected-at (1- (point))
(beginning-of-line 1)
(if (or (looking-at "[ \t]*| *[!_^] *|")
(not
(memq
nil
(mapcar
(lambda (f)
New variable `org-export-table-remove-empty-lines'. * org-exp.el (org-export-table-remove-empty-lines): New custom variable. (org-export-remove-special-table-lines): Use it. This was requested by Eric S Fraga.
2011-03-05 17:35:09 -05:00
(or (and org-export-table-remove-empty-lines (= (length f) 0))
Fix bug with protected examples that look like table lines * lisp/org-exp.el (org-export-remove-special-table-lines): Only fix table lines that are not protected text. Giovanni Moretti writes: > I'm working up a presentation on orgmode for a local club and needed > to prefix it with a brief emacs overview, and so included this: > > #+BEGIN_EXAMPLE > ctrl-P (previous line) > | > | > Ctrl-A <<< Ctrl-B <---- o ----> Ctrl-F >>> Ctrl-E > Col 1 back char ! fwd char EOL > ! > ctrl-N (next line) > #+END_EXAMPLE > > : ctrl-P (previous line) > : | > : | > : Ctrl-A <<< Ctrl-B <---- o ----> Ctrl-F >>> Ctrl-E > : Col 1 back char | fwd char EOL > : | > : ctrl-N (next line) > > I'm using Orgmode v6.36c and when exporting to HTML (and LaTex > Beamer), the two lines containing the single vertical bar immediately > below the "ctrl-P" line in the #+EXAMPLE block vanish, whereas using > the alternate colon at the beginning of the line notation, the > rendering is as expected. > > Interestingly, enabling the +n option (#+BEGIN_EXAMPLE +n) causes the > missing lines (lines 2 & 3) to reappear.
2010-06-06 23:31:44 -04:00
(string-match
HTML export: Improved support for field alignment, including centering * doc/org.texi: Document the <c> cookie. * lisp/org-exp.el (org-store-forced-table-alignment): (org-export-remove-special-table-lines): Allow the "c" cookie for table alignment. * lisp/org-html.el (org-export-table-header-tags): (org-export-table-data-tags): Add another %s format for the alignment. (org-export-html-table-align-individual-fields): New option. (org-format-org-table-html): Implement field-by-field alignment and support centering. (org-format-table-table-html): Make sure the new table tag formats don't break this function. * lisp/org-table.el (org-table-cookie-line-p): (org-table-align): Allow for the <c> cookie. * lisp/org.el (org-set-font-lock-defaults): Allow for the <c> cookie.
2010-10-22 03:19:04 -04:00
"\\`<\\([0-9]\\|[lrc]\\|[lrc][0-9]+\\)>\\'" f)))
Fix bug with protected examples that look like table lines * lisp/org-exp.el (org-export-remove-special-table-lines): Only fix table lines that are not protected text. Giovanni Moretti writes: > I'm working up a presentation on orgmode for a local club and needed > to prefix it with a brief emacs overview, and so included this: > > #+BEGIN_EXAMPLE > ctrl-P (previous line) > | > | > Ctrl-A <<< Ctrl-B <---- o ----> Ctrl-F >>> Ctrl-E > Col 1 back char ! fwd char EOL > ! > ctrl-N (next line) > #+END_EXAMPLE > > : ctrl-P (previous line) > : | > : | > : Ctrl-A <<< Ctrl-B <---- o ----> Ctrl-F >>> Ctrl-E > : Col 1 back char | fwd char EOL > : | > : ctrl-N (next line) > > I'm using Orgmode v6.36c and when exporting to HTML (and LaTex > Beamer), the two lines containing the single vertical bar immediately > below the "ctrl-P" line in the #+EXAMPLE block vanish, whereas using > the alternate colon at the beginning of the line notation, the > rendering is as expected. > > Interestingly, enabling the +n option (#+BEGIN_EXAMPLE +n) causes the > missing lines (lines 2 & 3) to reappear.
2010-06-06 23:31:44 -04:00
(org-split-string ;; FIXME, can't we do without splitting???
(buffer-substring (point-at-bol) (point-at-eol))
"[ \t]*|[ \t]*")))))
(delete-region (max (point-min) (1- (point-at-bol)))
(point-at-eol))
(end-of-line 1)))))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
Fix plain link export
2009-08-24 05:13:00 -04:00
(defun org-export-protect-sub-super (s)
(save-match-data
(while (string-match "\\([^\\\\]\\)\\([_^]\\)" s)
(setq s (replace-match "\\1\\\\\\2" nil nil s)))
s))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(defun org-export-normalize-links ()
"Convert all links to bracket links, and expand link abbreviations."
(let ((re-plain-link (concat "\\([^[<]\\)" org-plain-link-re))
LaTeX export: Fix problem with image names containing underscore Reported by Arne Freyberger.
2009-06-23 00:15:01 -04:00
(re-angle-link (concat "\\([^[]\\)" org-angle-link-re))
nodesc)
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(goto-char (point-min))
Avoid erroneous normalization of bracket link parts * org-exp.el (org-export-normalize-links): Mark bracket links before normalization to avoid erroneous normalization of bracket link parts. This fixes a bug reported by M. Bauer at <http://thread.gmane.org/gmane.emacs.orgmode/49756> and allows proper normalization of bracket links with a link in the query part, e.g. [[http://example.tld?q=http://example.tld][Example]]
2011-12-11 04:53:14 -05:00
(while (re-search-forward org-bracket-link-regexp nil t)
(put-text-property (match-beginning 0) (match-end 0) 'org-normalized-link t))
(goto-char (point-min))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(while (re-search-forward re-plain-link nil t)
Avoid erroneous normalization of bracket link parts * org-exp.el (org-export-normalize-links): Mark bracket links before normalization to avoid erroneous normalization of bracket link parts. This fixes a bug reported by M. Bauer at <http://thread.gmane.org/gmane.emacs.orgmode/49756> and allows proper normalization of bracket links with a link in the query part, e.g. [[http://example.tld?q=http://example.tld][Example]]
2011-12-11 04:53:14 -05:00
(unless (get-text-property (match-beginning 0) 'org-normalized-link)
Skip normalization of plain links that are part of another link * org-exp.el (org-export-normalize-links): Skip normalization of plain links that are part of another link.
2010-10-22 00:22:41 -04:00
(goto-char (1- (match-end 0)))
(org-if-unprotected-at (1+ (match-beginning 0))
(let* ((s (concat (match-string 1)
"[[" (match-string 2) ":" (match-string 3)
"][" (match-string 2) ":" (org-export-protect-sub-super
(match-string 3))
"]]")))
;; added 'org-link face to links
(put-text-property 0 (length s) 'face 'org-link s)
(replace-match s t t)))))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(goto-char (point-min))
(while (re-search-forward re-angle-link nil t)
(goto-char (1- (match-end 0)))
(org-if-unprotected
Fix plain link export
2009-08-24 05:13:00 -04:00
(let* ((s (concat (match-string 1)
"[[" (match-string 2) ":" (match-string 3)
"][" (match-string 2) ":" (org-export-protect-sub-super
Keep byte compiler happy
2009-08-27 09:18:25 -04:00
(match-string 3))
Fix plain link export
2009-08-24 05:13:00 -04:00
"]]")))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(put-text-property 0 (length s) 'face 'org-link s)
(replace-match s t t))))
(goto-char (point-min))
(while (re-search-forward org-bracket-link-regexp nil t)
Fix bug when exporting links with attributes.
2008-07-23 19:04:01 -04:00
(goto-char (1- (match-end 0)))
LaTeX export: Fix problem with image names containing underscore Reported by Arne Freyberger.
2009-06-23 00:15:01 -04:00
(setq nodesc (not (match-end 3)))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(org-if-unprotected
(let* ((xx (save-match-data
Implement link translation. This patch implements the possibility to translate links. It can be useful if use both planner and Org-mode, if you sometimes copy text from one side to the other and you do not want to worry about link syntax. This patch allows links created with planner to function correctly in Org-mode. I would probably be simple to implement the reverse conversion in planner as well. This patch is a first shot at this functionality and very likely can be improved.
2008-11-14 08:13:48 -05:00
(org-translate-link
(org-link-expand-abbrev (match-string 1)))))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(s (concat
Export: Fix bugs with LaTeX export. 1. Export hangs during LaTeX export. That was a bug using an empty regular expression that was defined only locally in Org files, but not in the buffer used by the LaTeX exporter. 2. Underscores in links can get special treatment by the LaTeX exporter. Now the link is protected from this.
2009-01-08 08:25:26 -05:00
"[[" (org-add-props (copy-sequence xx)
LaTeX export: Fix problem with image names containing underscore Reported by Arne Freyberger.
2009-06-23 00:15:01 -04:00
nil 'org-protected t 'org-no-description nodesc)
Export: Fix bugs with LaTeX export. 1. Export hangs during LaTeX export. That was a bug using an empty regular expression that was defined only locally in Org files, but not in the buffer used by the LaTeX exporter. 2. Underscores in links can get special treatment by the LaTeX exporter. Now the link is protected from this.
2009-01-08 08:25:26 -05:00
"]"
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(if (match-end 3)
(match-string 2)
HTML export: Treat explicit links description better
2009-05-04 15:05:43 -04:00
(concat "[" (copy-sequence xx)
Export: Do not HTML process URLs when they are also used as descriptions.
2009-01-07 07:25:46 -05:00
"]"))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
"]")))
(put-text-property 0 (length s) 'face 'org-link s)
(replace-match s t t))))))
Remove unnecessary whitespace.
2008-12-04 09:33:43 -05:00
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(defun org-export-concatenate-multiline-links ()
"Find multi-line links and put it all into a single line.
This is to make sure that the line-processing export backends
can work correctly."
(goto-char (point-min))
(while (re-search-forward "\\(\\(\\[\\|\\]\\)\\[[^]]*?\\)[ \t]*\n[ \t]*\\([^]]*\\]\\(\\[\\|\\]\\)\\)" nil t)
Fix export of long links in code examples
2010-02-02 00:32:26 -05:00
(org-if-unprotected-at (match-beginning 1)
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(replace-match "\\1 \\3")
(goto-char (match-beginning 0)))))
(defun org-export-concatenate-multiline-emphasis ()
"Find multi-line emphasis and put it all into a single line.
This is to make sure that the line-processing export backends
can work correctly."
(goto-char (point-min))
(while (re-search-forward org-emph-re nil t)
Bugfix: Avoid emphasis processing across lines and fields in tables. Emphasis processing could cause problems in tables, with spurious matches for the emphasis regexp across field boundaries and even lines. Fixed now.
2009-01-09 03:53:17 -05:00
(if (and (not (= (char-after (match-beginning 3))
(char-after (match-beginning 4))))
(save-excursion (goto-char (match-beginning 0))
Avoid a star in a headline to be interpreted as multiline emphasis * lisp/org-exp.el (org-export-concatenate-multiline-emphasis): Ignore matches that start in a headline.
2010-08-30 03:39:52 -04:00
(save-match-data
(and (not (org-at-table-p))
(not (org-at-heading-p))))))
Fix typo in Changes.org.
2008-05-28 08:11:57 -04:00
(org-if-unprotected
(subst-char-in-region (match-beginning 0) (match-end 0)
?\n ?\ t)
(goto-char (1- (match-end 0))))
(goto-char (1+ (match-beginning 0))))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defun org-export-grab-title-from-buffer ()
"Get a title for the current document, from looking at the buffer."
(let ((inhibit-read-only t))
(save-excursion
(goto-char (point-min))
Fix bug with title extraction during export when first line is headline.
2008-10-03 05:51:42 -04:00
(let ((end (if (looking-at org-outline-regexp)
(point)
(save-excursion (outline-next-heading) (point)))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(when (re-search-forward "^[ \t]*[^|# \t\r\n].*\n" end t)
;; Mark the line so that it will not be exported as normal text.
Don't license to kill text inside blocks when getting a title * lisp/org-exp.el (org-export-grab-title-from-buffer): Don't license to kill text inside blocks when getting a title.
2011-11-22 09:56:00 -05:00
(unless (org-in-block-p org-list-forbidden-blocks)
(org-unmodified
(add-text-properties (match-beginning 0) (match-end 0)
(list :org-license-to-kill t))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; Return the title string
(org-trim (match-string 0)))))))
(defun org-export-get-title-from-subtree ()
"Return subtree title and exclude it from export."
org-exp.el: Inhibit read-only when grabbing the title from a subtree. Eric S. Fraga found this problem while trying to export a subtree from a read-only file.
2011-01-04 11:03:14 -05:00
(let ((rbeg (region-beginning)) (rend (region-end))
Respect export options for subtree export title * org-exp.el (org-solidify-link-text): Respect org-export-with-tags when forming the export title during subtree export. TINY CHANGE
2011-11-01 19:26:07 -04:00
(inhibit-read-only t)
(tags (plist-get (org-infile-export-plist) :tags))
title)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(save-excursion
Implement EXPORT_TITLE property.
2008-05-20 13:22:00 -04:00
(goto-char rbeg)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(when (and (org-at-heading-p)
Implement EXPORT_TITLE property.
2008-05-20 13:22:00 -04:00
(>= (org-end-of-subtree t t) rend))
Respect export options for subtree export title * org-exp.el (org-solidify-link-text): Respect org-export-with-tags when forming the export title during subtree export. TINY CHANGE
2011-11-01 19:26:07 -04:00
(when (plist-member org-export-opt-plist :tags)
(setq tags (or (plist-get org-export-opt-plist :tags) tags)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
;; This is a subtree, we take the title from the first heading
Implement EXPORT_TITLE property.
2008-05-20 13:22:00 -04:00
(goto-char rbeg)
Respect export options for subtree export title * org-exp.el (org-solidify-link-text): Respect org-export-with-tags when forming the export title during subtree export. TINY CHANGE
2011-11-01 19:26:07 -04:00
(looking-at org-todo-line-tags-regexp)
Don't format tags in title if title headline does not have tags * org-exp.el (org-export-get-title-from-subtree): Don't format tags in title if title headline does not have tags. Fixes a bug reported by John Hendy in <CA+M2ft_UnBVfUbmoUX6J2MY7e_9w+7an5n23rAarpnnQnaV=ZA@mail.gmail.com>.
2012-02-08 13:27:32 -05:00
(setq title (if (and (eq tags t) (match-string 4))
Respect export options for subtree export title * org-exp.el (org-solidify-link-text): Respect org-export-with-tags when forming the export title during subtree export. TINY CHANGE
2011-11-01 19:26:07 -04:00
(format "%s\t%s" (match-string 3) (match-string 4))
(match-string 3)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(org-unmodified
(add-text-properties (point) (1+ (point-at-eol))
Implement EXPORT_TITLE property.
2008-05-20 13:22:00 -04:00
(list :org-license-to-kill t)))
(setq title (or (org-entry-get nil "EXPORT_TITLE") title))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
title))
(defun org-solidify-link-text (s &optional alist)
"Take link text and make a safe target out of it."
(save-match-data
(let* ((rtn
(mapconcat
'identity
org-html.el: correct HTML export of dedicated target. * org-html.el (org-format-org-table-html): fix anchors in HTML export (thanks to <aankhen@gmail.com>) (org-html-protect): fix a bug that prevents some target to be rendered correctly. * org-exp.el (org-solidify-link-text): a single "-" to avoid a "&ndash" rewrite in HTML export later.
2011-03-09 15:06:37 -05:00
(org-split-string s "[^a-zA-Z0-9_\\.-]+") "-"))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(a (assoc rtn alist)))
(or (cdr a) rtn))))
Export: Count levels relative when doing subtree export. William Henney writes: Consider a structure like this: * first ** second *** third **** fourth Currently, if I export the "third" sub-tree to html (via "C-c @ C-x C-e h"), then "third" becomes an <h1> heading, but "fourth" becomes an <h5> heading. I would rather it were <h2>, i.e. that all heading levels be relative to the root of the sub-tree. Is there any way to achieve this? This was not possible so far, but this commit measures the first headline of the subtree and applies an offset to all level values.
2009-02-06 12:07:26 -05:00
(defun org-get-min-level (lines &optional offset)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
"Get the minimum level in LINES."
Maintenance: Remove unused variables.
2009-01-26 03:42:33 -05:00
(let ((re "^\\(\\*+\\) ") l)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(catch 'exit
(while (setq l (pop lines))
(if (string-match re l)
Export: Count levels relative when doing subtree export. William Henney writes: Consider a structure like this: * first ** second *** third **** fourth Currently, if I export the "third" sub-tree to html (via "C-c @ C-x C-e h"), then "third" becomes an <h1> heading, but "fourth" becomes an <h5> heading. I would rather it were <h2>, i.e. that all heading levels be relative to the root of the sub-tree. Is there any way to achieve this? This was not possible so far, but this commit measures the first headline of the subtree and applies an offset to all level values.
2009-02-06 12:07:26 -05:00
(throw 'exit (org-tr-level (- (length (match-string 1 l))
(or offset 0))))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
1)))
;; Variable holding the vector with section numbers
(defvar org-section-numbers (make-vector org-level-max 0))
(defun org-init-section-numbers ()
"Initialize the vector for the section numbers."
(let* ((level -1)
(numbers (nreverse (org-split-string "" "\\.")))
(depth (1- (length org-section-numbers)))
(i depth) number-string)
(while (>= i 0)
(if (> i level)
(aset org-section-numbers i 0)
(setq number-string (or (car numbers) "0"))
(if (string-match "\\`[A-Z]\\'" number-string)
(aset org-section-numbers i
(- (string-to-char number-string) ?A -1))
Bug fixed.
2008-06-12 06:46:52 -04:00
(aset org-section-numbers i (string-to-number number-string)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(pop numbers))
(setq i (1- i)))))
(defun org-section-number (&optional level)
"Return a string with the current section number.
When LEVEL is non-nil, increase section numbers on that level."
Make the format of section number configurable. This was a request by Adam Spiers.
2008-06-10 04:05:15 -04:00
(let* ((depth (1- (length org-section-numbers)))
(string "")
(fmts (car org-export-section-number-format))
(term (cdr org-export-section-number-format))
(sep "")
ctype fmt idx n)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(when level
(when (> level -1)
(aset org-section-numbers
level (1+ (aref org-section-numbers level))))
(setq idx (1+ level))
(while (<= idx depth)
(if (not (= idx 1))
(aset org-section-numbers idx 0))
(setq idx (1+ idx))))
(setq idx 0)
(while (<= idx depth)
Make the format of section number configurable. This was a request by Adam Spiers.
2008-06-10 04:05:15 -04:00
(when (> (aref org-section-numbers idx) 0)
(setq fmt (or (pop fmts) fmt)
ctype (car fmt)
n (aref org-section-numbers idx)
string (if (> n 0)
(concat string sep (org-number-to-counter n ctype))
Bug fixed.
2008-06-12 06:46:52 -04:00
(concat string ".0"))
Make the format of section number configurable. This was a request by Adam Spiers.
2008-06-10 04:05:15 -04:00
sep (nth 1 fmt)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(setq idx (1+ idx)))
(save-match-data
(if (string-match "\\`\\([@0]\\.\\)+" string)
(setq string (replace-match "" t nil string)))
(if (string-match "\\(\\.0\\)+\\'" string)
(setq string (replace-match "" t nil string))))
Make the format of section number configurable. This was a request by Adam Spiers.
2008-06-10 04:05:15 -04:00
(concat string term)))
(defun org-number-to-counter (n type)
"Concert number N to a string counter, according to TYPE.
TYPE must be a string, any of:
1 number
A A,B,....
a a,b,....
Fix typos in org-exp.el
2008-12-16 10:30:46 -05:00
I upper case roman numeral
Make the format of section number configurable. This was a request by Adam Spiers.
2008-06-10 04:05:15 -04:00
i lower case roman numeral"
(cond
((equal type "1") (number-to-string n))
((equal type "A") (char-to-string (+ ?A n -1)))
((equal type "a") (char-to-string (+ ?a n -1)))
((equal type "I") (org-number-to-roman n))
((equal type "i") (downcase (org-number-to-roman n)))
(t (error "Invalid counter type `%s'" type))))
(defun org-number-to-roman (n)
"Convert integer N into a roman numeral."
(let ((roman '((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD")
( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
( 10 . "X") ( 9 . "IX") ( 5 . "V") ( 4 . "IV")
( 1 . "I")))
(res ""))
(if (<= n 0)
(number-to-string n)
(while roman
(if (>= n (caar roman))
(setq n (- n (caar roman))
res (concat res (cdar roman)))
(pop roman)))
res)))
Export: Implement macro replacement during export A line: #+MARCO: name replacement text can be referenced by {{{name}}}. As special cases, {{{title}}} will reference #+TITLE, and similar with similar lines.
2009-02-23 08:15:52 -05:00
;;; Macros
Remove unnecessary whitespace.
2008-12-04 09:33:43 -05:00
Export: Implement macro replacement during export A line: #+MARCO: name replacement text can be referenced by {{{name}}}. As special cases, {{{title}}} will reference #+TITLE, and similar with similar lines.
2009-02-23 08:15:52 -05:00
(defun org-export-preprocess-apply-macros ()
"Replace macro references."
(goto-char (point-min))
org-exp: make lists more robust wrt macros expansion * lisp/org-exp.el (org-export-preprocess-string): mark list end before expanding macros. Thus, a macro inside a list and containing blank lines cannot break the list structure. (org-export-preprocess-apply-macros): multi-lines macros get indented with the same indentation as the first line. Thus, we are sure that every line belongs to the same list as the first line, if such list exists. Also add comments in code.
2011-04-24 13:23:57 -04:00
(let (sy val key args args2 ind-str s n)
Export: More default macros. This commit adds: {{{date(FORMAT)}}} current date/time, formatted with `format-time-string' {{{modification-time(FORMAT)}}} date/time of last modification of file, formatted with `format-time-string' {{{input-file}}} the file name of the source Org file.
2009-05-11 01:57:29 -04:00
(while (re-search-forward
Macros: Fix bugs with macro arguments distributed over lines
2009-08-11 09:29:53 -04:00
"{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
Export: More default macros. This commit adds: {{{date(FORMAT)}}} current date/time, formatted with `format-time-string' {{{modification-time(FORMAT)}}} date/time of last modification of file, formatted with `format-time-string' {{{input-file}}} the file name of the source Org file.
2009-05-11 01:57:29 -04:00
nil t)
org-exp: make lists more robust wrt macros expansion * lisp/org-exp.el (org-export-preprocess-string): mark list end before expanding macros. Thus, a macro inside a list and containing blank lines cannot break the list structure. (org-export-preprocess-apply-macros): multi-lines macros get indented with the same indentation as the first line. Thus, we are sure that every line belongs to the same list as the first line, if such list exists. Also add comments in code.
2011-04-24 13:23:57 -04:00
(unless (save-match-data (save-excursion
(goto-char (point-at-bol))
(looking-at "[ \t]*#\\+macro")))
;; Get macro name (KEY), arguments (ARGS), and indentation of
;; current line (IND-STR) as strings.
Export: Allow macro definitions to contain other macros Patch by Daniel Clemente
2009-09-03 02:04:40 -04:00
(setq key (downcase (match-string 1))
org-exp: make lists more robust wrt macros expansion * lisp/org-exp.el (org-export-preprocess-string): mark list end before expanding macros. Thus, a macro inside a list and containing blank lines cannot break the list structure. (org-export-preprocess-apply-macros): multi-lines macros get indented with the same indentation as the first line. Thus, we are sure that every line belongs to the same list as the first line, if such list exists. Also add comments in code.
2011-04-24 13:23:57 -04:00
args (match-string 3)
ind-str (save-match-data (save-excursion
(beginning-of-line)
(looking-at "^\\([ \t]*\\).*")
(match-string 1))))
;; When macro is defined, retrieve replacement text in VAL,
;; and proceed with expansion.
Export: Allow macro definitions to contain other macros Patch by Daniel Clemente
2009-09-03 02:04:40 -04:00
(when (setq val (or (plist-get org-export-opt-plist
(intern (concat ":macro-" key)))
(plist-get org-export-opt-plist
(intern (concat ":" key)))))
(save-match-data
Fix typos. Fixes already done in Emacs by Paul Eggert.
2011-12-30 18:38:06 -05:00
;; If arguments are provided, first retrieve them properly
org-exp: make lists more robust wrt macros expansion * lisp/org-exp.el (org-export-preprocess-string): mark list end before expanding macros. Thus, a macro inside a list and containing blank lines cannot break the list structure. (org-export-preprocess-apply-macros): multi-lines macros get indented with the same indentation as the first line. Thus, we are sure that every line belongs to the same list as the first line, if such list exists. Also add comments in code.
2011-04-24 13:23:57 -04:00
;; (in ARGS, as a list), then replace them in VAL.
Export: Allow macro definitions to contain other macros Patch by Daniel Clemente
2009-09-03 02:04:40 -04:00
(when args
Fix the macro argument parser * lisp/org-exp.el (org-export-preprocess-apply-macros): Fix the macro argument parser. The macro argument parser was swallowing white space after escaped commas.
2010-08-14 10:41:12 -04:00
(setq args (org-split-string args ",") args2 nil)
Export: Allow macro definitions to contain other macros Patch by Daniel Clemente
2009-09-03 02:04:40 -04:00
(while args
(while (string-match "\\\\\\'" (car args))
org-exp: make lists more robust wrt macros expansion * lisp/org-exp.el (org-export-preprocess-string): mark list end before expanding macros. Thus, a macro inside a list and containing blank lines cannot break the list structure. (org-export-preprocess-apply-macros): multi-lines macros get indented with the same indentation as the first line. Thus, we are sure that every line belongs to the same list as the first line, if such list exists. Also add comments in code.
2011-04-24 13:23:57 -04:00
;; Repair bad splits.
Export: Allow macro definitions to contain other macros Patch by Daniel Clemente
2009-09-03 02:04:40 -04:00
(setcar (cdr args) (concat (substring (car args) 0 -1)
Fix bug with escaping commas in macro arguments
2010-08-14 05:34:39 -04:00
"," (nth 1 args)))
Export: Allow macro definitions to contain other macros Patch by Daniel Clemente
2009-09-03 02:04:40 -04:00
(pop args))
(push (pop args) args2))
Fix the macro argument parser * lisp/org-exp.el (org-export-preprocess-apply-macros): Fix the macro argument parser. The macro argument parser was swallowing white space after escaped commas.
2010-08-14 10:41:12 -04:00
(setq args (mapcar 'org-trim (nreverse args2)))
Export: Allow macro definitions to contain other macros Patch by Daniel Clemente
2009-09-03 02:04:40 -04:00
(setq s 0)
(while (string-match "\\$\\([0-9]+\\)" val s)
(setq s (1+ (match-beginning 0))
n (string-to-number (match-string 1 val)))
(and (>= (length args) n)
(setq val (replace-match (nth (1- n) args) t t val)))))
org-exp: make lists more robust wrt macros expansion * lisp/org-exp.el (org-export-preprocess-string): mark list end before expanding macros. Thus, a macro inside a list and containing blank lines cannot break the list structure. (org-export-preprocess-apply-macros): multi-lines macros get indented with the same indentation as the first line. Thus, we are sure that every line belongs to the same list as the first line, if such list exists. Also add comments in code.
2011-04-24 13:23:57 -04:00
;; VAL starts with "(eval": it is a sexp, `eval' it.
Export: Allow macro definitions to contain other macros Patch by Daniel Clemente
2009-09-03 02:04:40 -04:00
(when (string-match "\\`(eval\\>" val)
(setq val (eval (read val))))
org-exp: make lists more robust wrt macros expansion * lisp/org-exp.el (org-export-preprocess-string): mark list end before expanding macros. Thus, a macro inside a list and containing blank lines cannot break the list structure. (org-export-preprocess-apply-macros): multi-lines macros get indented with the same indentation as the first line. Thus, we are sure that every line belongs to the same list as the first line, if such list exists. Also add comments in code.
2011-04-24 13:23:57 -04:00
;; Ensure VAL is a string (or nil) and that each new line
;; is indented as the first one.
(setq val (and val
(mapconcat 'identity
(org-split-string
(if (stringp val) val (format "%s" val))
"\n")
(concat "\n" ind-str)))))
;; Eventually do the replacement, if VAL isn't nil. Move
;; point at beginning of macro for recursive expansions.
(when val
(replace-match val t t)
(goto-char (match-beginning 0))))))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
LaTeX export: Apply macros also in header
2009-03-21 08:39:37 -04:00
(defun org-export-apply-macros-in-string (s)
"Apply the macros in string S."
(when s
(with-temp-buffer
(insert s)
(org-export-preprocess-apply-macros)
(buffer-string))))
Implement include files for export.
2008-05-07 07:57:00 -04:00
;;; Include files
(defun org-export-handle-include-files ()
"Include the contents of include files, with proper formatting."
Make sure structure commands can be either case.
2008-05-14 08:23:44 -04:00
(let ((case-fold-search t)
How do I include text between a range of line numbers with #INCLUDE Hi Carsten, On Sat, Jan 8, 2011 at 11:35 PM, Carsten Dominik <carsten.dominik@gmail.com> wrote: > Hi Puneeth, > > can cou please augment the patch with a propert ChangeLog-like entry, and > with documentation for the manual, and then resubmit? Here is a patch with a ChangeLog entry and documentation for the manual. Please tell me if it looks OK. Also, I hope using git-format-patch is the right way to send this page. If not, what is the right way? Thanks, Puneeth >From 4a9be5b1a7a19c5d092ed14a86d29ad83122e9a8 Mon Sep 17 00:00:00 2001 From: Puneeth Chaganti <punchagan@gmail.com> Date: Sun, 9 Jan 2011 00:48:51 +0530 Subject: [PATCH] Include only specified range of line numbers of a file * doc/org.texi (Include files): Document :lines. * lisp/org-exp.el (org-export-handle-include-files): Support :lines property. (org-get-file-contents): New argument lines to include specify a range of lines to include. On Fri, Jan 7, 2011 at 1:29 PM, Puneeth <punchagan@gmail.com> wrote: > On Fri, Jan 7, 2011 at 10:03 AM, Venkatesh Choppella > <venkatesh.choppella@iiit.ac.in> wrote: >> I would like to include a part of a file (between a given range of >> line numbers) instead of the whole file. Is there a way to do that >> in org-mode? > > It isn't possible to include files using line numbers, as of now. > Here's a quick patch that would add this feature. I have tested it > with small files and works fine. Can somebody tell me if it looks > good? > > :lines "5-10" will include the lines from 5 to 10, 10 excluded. > :lines "-10" will include the lines from 1 to 10, 10 excluded. > :lines "5-" will include the lines from 1 to the end of the file. > > HTH, > Puneeth
2011-01-08 19:28:01 -05:00
params file markup lang start end prefix prefix1 switches all minlevel lines)
Implement include files for export.
2008-05-07 07:57:00 -04:00
(goto-char (point-min))
(while (re-search-forward "^#\\+INCLUDE:?[ \t]+\\(.*\\)" nil t)
(setq params (read (concat "(" (match-string 1) ")"))
Allow prefixes in include file statements.
2008-07-02 16:29:45 -04:00
prefix (org-get-and-remove-property 'params :prefix)
prefix1 (org-get-and-remove-property 'params :prefix1)
Include an .org file and lower the level of all its headers * doc/org.texi (Include files): Document :minlevel. * lisp/org-exp.el (org-export-handle-include-files): Support :minlevel property. (org-get-file-contents): New argument minlevel to demote included content. On Sat, Nov 13, 2010 at 1:12 AM, Carsten Dominik <carsten.dominik@gmail.com> wrote: > > On Nov 10, 2010, at 3:46 AM, Jianshi Huang wrote: > >> Hi, >> >> I know I can include any file using #+INCLUDE. >> >> I need to include several org files, but they were edited >> independently as a complete document. >> >> Now I want to lower the levels of headers in these org files >> automatically during inclusion. Is there a way to do that? > > No. But since #+include accepts arguments, it could be implemented, > something like > > #+include "aaa.org" :minlevel 4 > > or so. I would accept a good patch to this effect. Here's a patch. I tested it with a simple document and works fine. Thanks, Puneeth
2010-11-14 07:01:05 -05:00
minlevel (org-get-and-remove-property 'params :minlevel)
How do I include text between a range of line numbers with #INCLUDE Hi Carsten, On Sat, Jan 8, 2011 at 11:35 PM, Carsten Dominik <carsten.dominik@gmail.com> wrote: > Hi Puneeth, > > can cou please augment the patch with a propert ChangeLog-like entry, and > with documentation for the manual, and then resubmit? Here is a patch with a ChangeLog entry and documentation for the manual. Please tell me if it looks OK. Also, I hope using git-format-patch is the right way to send this page. If not, what is the right way? Thanks, Puneeth >From 4a9be5b1a7a19c5d092ed14a86d29ad83122e9a8 Mon Sep 17 00:00:00 2001 From: Puneeth Chaganti <punchagan@gmail.com> Date: Sun, 9 Jan 2011 00:48:51 +0530 Subject: [PATCH] Include only specified range of line numbers of a file * doc/org.texi (Include files): Document :lines. * lisp/org-exp.el (org-export-handle-include-files): Support :lines property. (org-get-file-contents): New argument lines to include specify a range of lines to include. On Fri, Jan 7, 2011 at 1:29 PM, Puneeth <punchagan@gmail.com> wrote: > On Fri, Jan 7, 2011 at 10:03 AM, Venkatesh Choppella > <venkatesh.choppella@iiit.ac.in> wrote: >> I would like to include a part of a file (between a given range of >> line numbers) instead of the whole file. Is there a way to do that >> in org-mode? > > It isn't possible to include files using line numbers, as of now. > Here's a quick patch that would add this feature. I have tested it > with small files and works fine. Can somebody tell me if it looks > good? > > :lines "5-10" will include the lines from 5 to 10, 10 excluded. > :lines "-10" will include the lines from 1 to 10, 10 excluded. > :lines "5-" will include the lines from 1 to the end of the file. > > HTH, > Puneeth
2011-01-08 19:28:01 -05:00
lines (org-get-and-remove-property 'params :lines)
Implement include files for export.
2008-05-07 07:57:00 -04:00
file (org-symname-or-string (pop params))
markup (org-symname-or-string (pop params))
Export: Make switches for literal examples work in include files. When including s file in example or src markup, you can now also specify the switches for code references and line numbering that work also when directly adding SRC or EXAMPLE blocks. Reported by Manish.
2009-01-08 06:10:47 -05:00
lang (and (member markup '("src" "SRC"))
(org-symname-or-string (pop params)))
Replacing '(λ...) with #'(λ...). * lisp/org-ascii.el (org-export-as-ascii): Replacing '(λ...) with #'(λ...). * lisp/org-attach.el: Replacing '(λ...) with #'(λ...). (org-attach-commit): Replacing '(λ...) with #'(λ...). * lisp/org-exp.el: Replacing '(λ...) with #'(λ...). (org-export-handle-include-files): Replacing '(λ...) with #'(λ...). * lisp/org-html.el: Replacing '(λ...) with #'(λ...). (org-export-as-html): Replacing '(λ...) with #'(λ...). * lisp/org-mouse.el: Replacing '(λ...) with #'(λ...). (org-mouse-popup-global-menu): Replacing '(λ...) with (org-mode-hook): Replacing '(λ...) with #'(λ...). (org-agenda-mode-hook): Replacing '(λ...) with #'(λ...). * #'(λ...).Replacing '(λ...) with #'(λ...). (org-mouse-context-menu): Replacing '(λ...) with #'(λ...). * lisp/org-src.el: Replacing '(λ...) with #'(λ...). (org-src-mode-configure-edit-buffer): Replacing '(λ...) with #'(λ...). * lisp/org-table.el: Replacing '(λ...) with #'(λ...). (org-table-fix-formulas-confirm): Replacing '(λ...) with #'(λ...). * lisp/org.el: Replacing '(λ...) with #'(λ...). (org-confirm-shell-link-function): Replacing '(λ...) with (org-category): Replacing '(λ...) with #'(λ...). * #'(λ...).Replacing '(λ...) with #'(λ...). (org-time-stamp-rounding-minutes): Replacing '(λ...) with #'(λ...).
2011-06-14 15:01:04 -04:00
switches (mapconcat #'(lambda (x) (format "%s" x)) params " ")
Some small fixes
2009-09-01 10:30:33 -04:00
start nil end nil)
Implement include files for export.
2008-05-07 07:57:00 -04:00
(delete-region (match-beginning 0) (match-end 0))
(if (or (not file)
(not (file-exists-p file))
(not (file-readable-p file)))
(insert (format "CANNOT INCLUDE FILE %s" file))
org-exp: now recursively resolve #+INCLUDE: files in a safe way * lisp/org-exp.el (org-export-preprocess-string): now using `org-export-handle-include-files-recurse' to resolve included files (org-export-handle-include-files): now returns a list of the included files (org-export-handle-include-files-recurse): recursively calls `org-export-handle-include-files' while checking to see if the process has entered an infinite loop. Thanks to Eric Schulte for this patch.
2010-06-16 12:13:13 -04:00
(setq all (cons file all))
Implement include files for export.
2008-05-07 07:57:00 -04:00
(when markup
(if (equal (downcase markup) "src")
Export: Make switches for literal examples work in include files. When including s file in example or src markup, you can now also specify the switches for code references and line numbering that work also when directly adding SRC or EXAMPLE blocks. Reported by Manish.
2009-01-08 06:10:47 -05:00
(setq start (format "#+begin_src %s %s\n"
(or lang "fundamental")
(or switches ""))
Implement include files for export.
2008-05-07 07:57:00 -04:00
end "#+end_src")
Export: Make switches for literal examples work in include files. When including s file in example or src markup, you can now also specify the switches for code references and line numbering that work also when directly adding SRC or EXAMPLE blocks. Reported by Manish.
2009-01-08 06:10:47 -05:00
(setq start (format "#+begin_%s %s\n" markup switches)
Implement include files for export.
2008-05-07 07:57:00 -04:00
end (format "#+end_%s" markup))))
(insert (or start ""))
Some small fixes
2009-09-01 10:30:33 -04:00
(insert (org-get-file-contents (expand-file-name file)
How do I include text between a range of line numbers with #INCLUDE Hi Carsten, On Sat, Jan 8, 2011 at 11:35 PM, Carsten Dominik <carsten.dominik@gmail.com> wrote: > Hi Puneeth, > > can cou please augment the patch with a propert ChangeLog-like entry, and > with documentation for the manual, and then resubmit? Here is a patch with a ChangeLog entry and documentation for the manual. Please tell me if it looks OK. Also, I hope using git-format-patch is the right way to send this page. If not, what is the right way? Thanks, Puneeth >From 4a9be5b1a7a19c5d092ed14a86d29ad83122e9a8 Mon Sep 17 00:00:00 2001 From: Puneeth Chaganti <punchagan@gmail.com> Date: Sun, 9 Jan 2011 00:48:51 +0530 Subject: [PATCH] Include only specified range of line numbers of a file * doc/org.texi (Include files): Document :lines. * lisp/org-exp.el (org-export-handle-include-files): Support :lines property. (org-get-file-contents): New argument lines to include specify a range of lines to include. On Fri, Jan 7, 2011 at 1:29 PM, Puneeth <punchagan@gmail.com> wrote: > On Fri, Jan 7, 2011 at 10:03 AM, Venkatesh Choppella > <venkatesh.choppella@iiit.ac.in> wrote: >> I would like to include a part of a file (between a given range of >> line numbers) instead of the whole file. Is there a way to do that >> in org-mode? > > It isn't possible to include files using line numbers, as of now. > Here's a quick patch that would add this feature. I have tested it > with small files and works fine. Can somebody tell me if it looks > good? > > :lines "5-10" will include the lines from 5 to 10, 10 excluded. > :lines "-10" will include the lines from 1 to 10, 10 excluded. > :lines "5-" will include the lines from 1 to the end of the file. > > HTH, > Puneeth
2011-01-08 19:28:01 -05:00
prefix prefix1 markup minlevel lines))
Implement include files for export.
2008-05-07 07:57:00 -04:00
(or (bolp) (newline))
org-exp: now recursively resolve #+INCLUDE: files in a safe way * lisp/org-exp.el (org-export-preprocess-string): now using `org-export-handle-include-files-recurse' to resolve included files (org-export-handle-include-files): now returns a list of the included files (org-export-handle-include-files-recurse): recursively calls `org-export-handle-include-files' while checking to see if the process has entered an infinite loop. Thanks to Eric Schulte for this patch.
2010-06-16 12:13:13 -04:00
(insert (or end ""))))
all))
(defun org-export-handle-include-files-recurse ()
"Recursively include files aborting on circular inclusion."
(let ((now (list org-current-export-file)) all)
(while now
removed 'cl functions from org-exp.el to assuage elisp compiler
2010-06-17 13:27:58 -04:00
(setq all (append now all))
org-exp: now recursively resolve #+INCLUDE: files in a safe way * lisp/org-exp.el (org-export-preprocess-string): now using `org-export-handle-include-files-recurse' to resolve included files (org-export-handle-include-files): now returns a list of the included files (org-export-handle-include-files-recurse): recursively calls `org-export-handle-include-files' while checking to see if the process has entered an infinite loop. Thanks to Eric Schulte for this patch.
2010-06-16 12:13:13 -04:00
(setq now (org-export-handle-include-files))
(let ((intersection
(delq nil
removed 'cl functions from org-exp.el to assuage elisp compiler
2010-06-17 13:27:58 -04:00
(mapcar (lambda (el) (when (member el all) el)) now))))
(when intersection
Correct some docstrings [part 2] This is a second patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil
2010-07-15 18:54:53 -04:00
(error "Recursive #+INCLUDE: %S" intersection))))))
Implement include files for export.
2008-05-07 07:57:00 -04:00
How do I include text between a range of line numbers with #INCLUDE Hi Carsten, On Sat, Jan 8, 2011 at 11:35 PM, Carsten Dominik <carsten.dominik@gmail.com> wrote: > Hi Puneeth, > > can cou please augment the patch with a propert ChangeLog-like entry, and > with documentation for the manual, and then resubmit? Here is a patch with a ChangeLog entry and documentation for the manual. Please tell me if it looks OK. Also, I hope using git-format-patch is the right way to send this page. If not, what is the right way? Thanks, Puneeth >From 4a9be5b1a7a19c5d092ed14a86d29ad83122e9a8 Mon Sep 17 00:00:00 2001 From: Puneeth Chaganti <punchagan@gmail.com> Date: Sun, 9 Jan 2011 00:48:51 +0530 Subject: [PATCH] Include only specified range of line numbers of a file * doc/org.texi (Include files): Document :lines. * lisp/org-exp.el (org-export-handle-include-files): Support :lines property. (org-get-file-contents): New argument lines to include specify a range of lines to include. On Fri, Jan 7, 2011 at 1:29 PM, Puneeth <punchagan@gmail.com> wrote: > On Fri, Jan 7, 2011 at 10:03 AM, Venkatesh Choppella > <venkatesh.choppella@iiit.ac.in> wrote: >> I would like to include a part of a file (between a given range of >> line numbers) instead of the whole file. Is there a way to do that >> in org-mode? > > It isn't possible to include files using line numbers, as of now. > Here's a quick patch that would add this feature. I have tested it > with small files and works fine. Can somebody tell me if it looks > good? > > :lines "5-10" will include the lines from 5 to 10, 10 excluded. > :lines "-10" will include the lines from 1 to 10, 10 excluded. > :lines "5-" will include the lines from 1 to the end of the file. > > HTH, > Puneeth
2011-01-08 19:28:01 -05:00
(defun org-get-file-contents (file &optional prefix prefix1 markup minlevel lines)
Allow prefixes in include file statements.
2008-07-02 16:29:45 -04:00
"Get the contents of FILE and return them as a string.
If PREFIX is a string, prepend it to each line. If PREFIX1
org-get-file-contents: Use a new argument: markup. When markup is passed to org-get-file-contents then this function does not protect org-like lines, since the exporter should handle them.
2009-07-23 21:16:19 -04:00
is a string, prepend it to the first line instead of PREFIX.
If MARKUP, don't protect org-like lines, the exporter will
org-exp.el: cosmetic change to `org-get-file-contents'
2011-01-17 19:24:12 -05:00
take care of the block they are in. If LINES is a string
specifying a range of lines, include only those lines ."
Fix bug with including files without markup File contents that are included with "#+include: file" should be processed as normal Org stuff. This used to be so, and it is so now again.
2009-08-07 18:14:54 -04:00
(if (stringp markup) (setq markup (downcase markup)))
Allow prefixes in include file statements.
2008-07-02 16:29:45 -04:00
(with-temp-buffer
(insert-file-contents file)
How do I include text between a range of line numbers with #INCLUDE Hi Carsten, On Sat, Jan 8, 2011 at 11:35 PM, Carsten Dominik <carsten.dominik@gmail.com> wrote: > Hi Puneeth, > > can cou please augment the patch with a propert ChangeLog-like entry, and > with documentation for the manual, and then resubmit? Here is a patch with a ChangeLog entry and documentation for the manual. Please tell me if it looks OK. Also, I hope using git-format-patch is the right way to send this page. If not, what is the right way? Thanks, Puneeth >From 4a9be5b1a7a19c5d092ed14a86d29ad83122e9a8 Mon Sep 17 00:00:00 2001 From: Puneeth Chaganti <punchagan@gmail.com> Date: Sun, 9 Jan 2011 00:48:51 +0530 Subject: [PATCH] Include only specified range of line numbers of a file * doc/org.texi (Include files): Document :lines. * lisp/org-exp.el (org-export-handle-include-files): Support :lines property. (org-get-file-contents): New argument lines to include specify a range of lines to include. On Fri, Jan 7, 2011 at 1:29 PM, Puneeth <punchagan@gmail.com> wrote: > On Fri, Jan 7, 2011 at 10:03 AM, Venkatesh Choppella > <venkatesh.choppella@iiit.ac.in> wrote: >> I would like to include a part of a file (between a given range of >> line numbers) instead of the whole file. Is there a way to do that >> in org-mode? > > It isn't possible to include files using line numbers, as of now. > Here's a quick patch that would add this feature. I have tested it > with small files and works fine. Can somebody tell me if it looks > good? > > :lines "5-10" will include the lines from 5 to 10, 10 excluded. > :lines "-10" will include the lines from 1 to 10, 10 excluded. > :lines "5-" will include the lines from 1 to the end of the file. > > HTH, > Puneeth
2011-01-08 19:28:01 -05:00
(when lines
org-exp.el: cosmetic change to `org-get-file-contents'
2011-01-17 19:24:12 -05:00
(let* ((lines (split-string lines "-"))
(lbeg (string-to-number (car lines)))
(lend (string-to-number (cadr lines)))
(beg (if (zerop lbeg) (point-min)
Code cleanup: use a generic :for-backend parameter.
2011-02-15 05:07:46 -05:00
(goto-char (point-min))
org-exp.el: cosmetic change to `org-get-file-contents'
2011-01-17 19:24:12 -05:00
(forward-line (1- lbeg))
How do I include text between a range of line numbers with #INCLUDE Hi Carsten, On Sat, Jan 8, 2011 at 11:35 PM, Carsten Dominik <carsten.dominik@gmail.com> wrote: > Hi Puneeth, > > can cou please augment the patch with a propert ChangeLog-like entry, and > with documentation for the manual, and then resubmit? Here is a patch with a ChangeLog entry and documentation for the manual. Please tell me if it looks OK. Also, I hope using git-format-patch is the right way to send this page. If not, what is the right way? Thanks, Puneeth >From 4a9be5b1a7a19c5d092ed14a86d29ad83122e9a8 Mon Sep 17 00:00:00 2001 From: Puneeth Chaganti <punchagan@gmail.com> Date: Sun, 9 Jan 2011 00:48:51 +0530 Subject: [PATCH] Include only specified range of line numbers of a file * doc/org.texi (Include files): Document :lines. * lisp/org-exp.el (org-export-handle-include-files): Support :lines property. (org-get-file-contents): New argument lines to include specify a range of lines to include. On Fri, Jan 7, 2011 at 1:29 PM, Puneeth <punchagan@gmail.com> wrote: > On Fri, Jan 7, 2011 at 10:03 AM, Venkatesh Choppella > <venkatesh.choppella@iiit.ac.in> wrote: >> I would like to include a part of a file (between a given range of >> line numbers) instead of the whole file. Is there a way to do that >> in org-mode? > > It isn't possible to include files using line numbers, as of now. > Here's a quick patch that would add this feature. I have tested it > with small files and works fine. Can somebody tell me if it looks > good? > > :lines "5-10" will include the lines from 5 to 10, 10 excluded. > :lines "-10" will include the lines from 1 to 10, 10 excluded. > :lines "5-" will include the lines from 1 to the end of the file. > > HTH, > Puneeth
2011-01-08 19:28:01 -05:00
(point)))
org-exp.el: cosmetic change to `org-get-file-contents'
2011-01-17 19:24:12 -05:00
(end (if (zerop lend) (point-max)
(goto-char (point-min))
(forward-line (1- lend))
(point))))
How do I include text between a range of line numbers with #INCLUDE Hi Carsten, On Sat, Jan 8, 2011 at 11:35 PM, Carsten Dominik <carsten.dominik@gmail.com> wrote: > Hi Puneeth, > > can cou please augment the patch with a propert ChangeLog-like entry, and > with documentation for the manual, and then resubmit? Here is a patch with a ChangeLog entry and documentation for the manual. Please tell me if it looks OK. Also, I hope using git-format-patch is the right way to send this page. If not, what is the right way? Thanks, Puneeth >From 4a9be5b1a7a19c5d092ed14a86d29ad83122e9a8 Mon Sep 17 00:00:00 2001 From: Puneeth Chaganti <punchagan@gmail.com> Date: Sun, 9 Jan 2011 00:48:51 +0530 Subject: [PATCH] Include only specified range of line numbers of a file * doc/org.texi (Include files): Document :lines. * lisp/org-exp.el (org-export-handle-include-files): Support :lines property. (org-get-file-contents): New argument lines to include specify a range of lines to include. On Fri, Jan 7, 2011 at 1:29 PM, Puneeth <punchagan@gmail.com> wrote: > On Fri, Jan 7, 2011 at 10:03 AM, Venkatesh Choppella > <venkatesh.choppella@iiit.ac.in> wrote: >> I would like to include a part of a file (between a given range of >> line numbers) instead of the whole file. Is there a way to do that >> in org-mode? > > It isn't possible to include files using line numbers, as of now. > Here's a quick patch that would add this feature. I have tested it > with small files and works fine. Can somebody tell me if it looks > good? > > :lines "5-10" will include the lines from 5 to 10, 10 excluded. > :lines "-10" will include the lines from 1 to 10, 10 excluded. > :lines "5-" will include the lines from 1 to the end of the file. > > HTH, > Puneeth
2011-01-08 19:28:01 -05:00
(narrow-to-region beg end)))
Allow prefixes in include file statements.
2008-07-02 16:29:45 -04:00
(when (or prefix prefix1)
(goto-char (point-min))
(while (not (eobp))
(insert (or prefix1 prefix))
fixed #+include file bug when :prefix was nil but :prefix1 was set * lisp/org-exp.el (org-get-file-contents): by un-setting prefix1 to "" instead of to nil we avoid errors when :prefix1 is defined, but prefix is not.
2010-06-13 17:27:49 -04:00
(setq prefix1 "")
Allow prefixes in include file statements.
2008-07-02 16:29:45 -04:00
(beginning-of-line 2)))
Fix bug with including org-file during export. Stefan Vollmar writes: > taking up a nice suggestion from Sebastian Rose, I want to > present some org source with proper syntax highlighting. However, > there is a problem when using "BEGIN_SRC" blocks it seems. > > If one puts this org contents into a file "test.org": > > * One Headline > Some Text > #+BEGIN_SRC python > print "some output" > #+END_SRC > * Another headline > More text > > and renders it from another org-file with: > > #+INCLUDE: "./test.org" src org > > everything will be fine (beautiful, infact) up to and including > the print-line - the rest of the org file is not rendered as > source but interpreted.
2009-06-23 08:12:23 -04:00
(buffer-string)
Fix bug with including files without markup File contents that are included with "#+include: file" should be processed as normal Org stuff. This used to be so, and it is so now again.
2009-08-07 18:14:54 -04:00
(when (member markup '("src" "example"))
org-get-file-contents: Use a new argument: markup. When markup is passed to org-get-file-contents then this function does not protect org-like lines, since the exporter should handle them.
2009-07-23 21:16:19 -04:00
(goto-char (point-min))
Fix bug with line protection while including source code files There was an issue that lines starting with a space followed by # would be protected when importing the file, but not unprotected when formatting the example. The reason for this issue is that we recently changed to protect indented #+ lines.
2009-09-02 04:42:46 -04:00
(while (re-search-forward "^\\([*#]\\|[ \t]*#\\+\\)" nil t)
org-get-file-contents: Use a new argument: markup. When markup is passed to org-get-file-contents then this function does not protect org-like lines, since the exporter should handle them.
2009-07-23 21:16:19 -04:00
(goto-char (match-beginning 0))
(insert ",")
(end-of-line 1)))
Include an .org file and lower the level of all its headers * doc/org.texi (Include files): Document :minlevel. * lisp/org-exp.el (org-export-handle-include-files): Support :minlevel property. (org-get-file-contents): New argument minlevel to demote included content. On Sat, Nov 13, 2010 at 1:12 AM, Carsten Dominik <carsten.dominik@gmail.com> wrote: > > On Nov 10, 2010, at 3:46 AM, Jianshi Huang wrote: > >> Hi, >> >> I know I can include any file using #+INCLUDE. >> >> I need to include several org files, but they were edited >> independently as a complete document. >> >> Now I want to lower the levels of headers in these org files >> automatically during inclusion. Is there a way to do that? > > No. But since #+include accepts arguments, it could be implemented, > something like > > #+include "aaa.org" :minlevel 4 > > or so. I would accept a good patch to this effect. Here's a patch. I tested it with a simple document and works fine. Thanks, Puneeth
2010-11-14 07:01:05 -05:00
(when minlevel
(dotimes (lvl minlevel)
(org-map-region 'org-demote (point-min) (point-max))))
Allow prefixes in include file statements.
2008-07-02 16:29:45 -04:00
(buffer-string)))
(defun org-get-and-remove-property (listvar prop)
"Check if the value of LISTVAR contains PROP as a property.
If yes, return the value of that property (i.e. the element following
in the list) and remove property and value from the list in LISTVAR."
(let ((list (symbol-value listvar)) m v)
(when (setq m (member prop list))
(setq v (nth 1 m))
(if (equal (car list) prop)
(set listvar (cddr list))
(setcdr (nthcdr (- (length list) (length m) 1) list)
(cddr m))
(set listvar list)))
v))
Implement include files for export.
2008-05-07 07:57:00 -04:00
(defun org-symname-or-string (s)
(if (symbolp s)
(if s (symbol-name s) s)
s))
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
;;; Fontification and line numbers for code examples
(defvar org-export-last-code-line-counter-value 0)
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(defun org-export-replace-src-segments-and-examples ()
Implement color formatting of code examples during HTML export.
2008-05-03 10:17:43 -04:00
"Replace source code segments with special code for export."
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(setq org-export-last-code-line-counter-value 0)
Make sure structure commands can be either case.
2008-05-14 08:23:44 -04:00
(let ((case-fold-search t)
babel: now exports source code block names When exporting to html the source-code block name will be included as a <label> immediately preceding the exported code. This <label> is decorated with the 'org-src-name' css class. When exporting to LaTeX with the listings package the source-code block name will be included as a listings \title for the code block. Currently the name will not be exported when the listings package is not in use.
2010-01-04 17:11:19 -05:00
lang code trans opts indent caption)
Implement color formatting of code examples during HTML export.
2008-05-03 10:17:43 -04:00
(goto-char (point-min))
(while (re-search-forward
org-exp: raise an error when trying to export code blocks w/o languages * lisp/ob.el (org-babel-get-src-block-info): ensure that we don't match (and return info for) source blocks without a language * lisp/org-exp.el (org-export-replace-src-segments-and-examples): updated source code block regexp so that the presence of a language can be explicitly checked. Also now raising an error when a source block does not have a language.
2010-07-12 13:42:59 -04:00
"\\(^\\([ \t]*\\)#\\+BEGIN_SRC:?\\([ \t]+\\([^ \t\n]+\\)\\)?\\(.*\\)\n\\([^\000]+?\n\\)[ \t]*#\\+END_SRC.*\n?\\)\\|\\(^\\([ \t]*\\)#\\+BEGIN_EXAMPLE:?\\(?:[ \t]+\\(.*\\)\\)?\n\\([^\000]+?\n\\)[ \t]*#\\+END_EXAMPLE.*\n?\\)"
Implement color formatting of code examples during HTML export.
2008-05-03 10:17:43 -04:00
nil t)
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(if (match-end 1)
org-exp: raise an error when trying to export code blocks w/o languages * lisp/ob.el (org-babel-get-src-block-info): ensure that we don't match (and return info for) source blocks without a language * lisp/org-exp.el (org-export-replace-src-segments-and-examples): updated source code block regexp so that the presence of a language can be explicitly checked. Also now raising an error when a source block does not have a language.
2010-07-12 13:42:59 -04:00
(if (not (match-string 4))
Correct some docstrings [part 2] This is a second patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil
2010-07-15 18:54:53 -04:00
(error "Source block missing language specification: %s"
org-exp: raise an error when trying to export code blocks w/o languages * lisp/ob.el (org-babel-get-src-block-info): ensure that we don't match (and return info for) source blocks without a language * lisp/org-exp.el (org-export-replace-src-segments-and-examples): updated source code block regexp so that the presence of a language can be explicitly checked. Also now raising an error when a source block does not have a language.
2010-07-12 13:42:59 -04:00
(let* ((body (match-string 6))
(nothing (message "body:%s" body))
(preview (or (and (string-match
"^[ \t]*\\([^\n\r]*\\)" body)
(match-string 1 body)) body)))
(if (> (length preview) 35)
(concat (substring preview 0 32) "...")
preview)))
;; src segments
(setq lang (match-string 4)
opts (match-string 5)
code (match-string 6)
indent (length (match-string 2))
caption (get-text-property 0 'org-caption (match-string 0))))
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(setq lang nil
org-exp: raise an error when trying to export code blocks w/o languages * lisp/ob.el (org-babel-get-src-block-info): ensure that we don't match (and return info for) source blocks without a language * lisp/org-exp.el (org-export-replace-src-segments-and-examples): updated source code block regexp so that the presence of a language can be explicitly checked. Also now raising an error when a source block does not have a language.
2010-07-12 13:42:59 -04:00
opts (match-string 9)
code (match-string 10)
indent (length (match-string 8))
babel: now exports source code block names When exporting to html the source-code block name will be included as a <label> immediately preceding the exported code. This <label> is decorated with the 'org-src-name' css class. When exporting to LaTeX with the listings package the source-code block name will be included as a listings \title for the code block. Currently the name will not be exported when the listings package is not in use.
2010-01-04 17:11:19 -05:00
caption (get-text-property 0 'org-caption (match-string 0))))
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(setq trans (org-export-format-source-code-or-example
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
lang code opts indent caption))
Implement color formatting of code examples during HTML export.
2008-05-03 10:17:43 -04:00
(replace-match trans t t))))
LaTeX export: Make the verbatim environment configurable
2009-06-18 03:30:00 -04:00
(defvar org-export-latex-verbatim-wrap) ;; defined in org-latex.el
LaTeX export: Allow export using the listings package Patch by Eric Schulte, see http://thread.gmane.org/gmane.emacs.orgmode/16269
2009-08-09 08:49:52 -04:00
(defvar org-export-latex-listings) ;; defined in org-latex.el
(defvar org-export-latex-listings-langs) ;; defined in org-latex.el
fix compiler warning in org-exp.el * lisp/org-exp.el (org-export-latex-listings-w-names): fix compiler warning in org-exp.el
2010-07-22 14:36:17 -04:00
(defvar org-export-latex-listings-w-names) ;; defined in org-latex.el
LaTeX minted package for fontified source code export * org-exp.el (org-export-format-source-code-or-example): latex formatting of source code blocks using the minted package (org-export-plist-vars): Add :latex-minted property (org-export-latex-minted): Ensure variable is defined (org-export-latex-minted-langs): Ensure variable is defined * org-latex.el (org-export-latex-minted): new variable (org-export-latex-minted-langs): new variable (org-export-latex-minted-with-line-numbers): new variable (org-export-latex-minted):
2010-10-12 18:20:28 -04:00
(defvar org-export-latex-minted-langs) ;; defined in org-latex.el
New UI for configuring latex src code export. Three new user-customizable variables: org-export-latex-listings-options (default nil) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Association list of options for the latex listings package. These options are supplied as a comma-separated list to the \\lstset command. Each element of the association list should be a list containing two strings: the name of the option, and the value. For example, (setq org-export-latex-listings-options '((\"basicstyle\" \"\\small\") (\"keywordstyle\" \"\\color{black}\\bfseries\\underbar\"))) will typeset the code in a small size font with underlined, bold black keywords. Note that the same options will be applied to blocks of all languages. See ftp://ftp.tex.ac.uk/tex-archive/macros/latex/contrib/listings/listings.pdf customization group: org-export-latex org-export-latex-minted-options (default nil) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Association list of options for the latex minted package. These options are supplied within square brackets in \\begin{minted} environments. Each element of the alist should be a list containing two strings: the name of the option, and the value. For example, (setq org-export-latex-minted-options '((\"bgcolor\" \"bg\") (\"frame\" \"lines\"))) will result in src blocks being exported with \\begin{minted}[bgcolor=bg,frame=lines]{<LANG>} as the start of the minted environment. Note that the same options will be applied to blocks of all languages." customization group: org-export-latex See minted.googlecode.com/files/minted.pdf org-export-latex-custom-lang-environments (default nil) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Association list mapping languages to language-specific latex environments used during export of src blocks by the listings and minted latex packages. For example, (setq org-export-latex-custom-lang-environments '((python \"pythoncode\"))) * lisp/org-exp.el (org-export-format-source-code-or-example): Support new user-customizable options (org-export-latex-custom-lang-environments): Ensure new variable is defined (org-export-latex-listings-options): Ensure new variable is defined (org-export-latex-minted-options): Ensure new variable is defined * lisp/org-latex.el (org-export-latex-listings-options): New variable (org-export-latex-minted-options): New variable (org-export-latex-custom-lang-environments): New variable
2010-11-17 04:50:50 -05:00
(defvar org-export-latex-custom-lang-environments) ;; defined in org-latex.el
(defvar org-export-latex-listings-options) ;; defined in org-latex.el
(defvar org-export-latex-minted-options) ;; defined in org-latex.el
Fix markup problems when using references in source fragments * lisp/org-exp.el (org-remove-formatting-on-newlines-in-region): New function. (org-export-format-source-code-or-example): Call `org-remove-formatting-on-newlines-in-region'. TINYCHANGE
2011-05-11 20:41:20 -04:00
(defun org-remove-formatting-on-newlines-in-region (beg end)
"Remove formatting on newline characters"
(interactive "r")
(save-excursion
(goto-char beg)
(while (progn (end-of-line) (< (point) end))
(put-text-property (point) (1+ (point)) 'face nil)
(forward-char 1))))
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
(defun org-export-format-source-code-or-example
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(lang code &optional opts indent caption)
Implement color formatting of code examples during HTML export.
2008-05-03 10:17:43 -04:00
"Format CODE from language LANG and return it formatted for export.
Support custom formatters for marking up source or example blocks PATCH-3/5 org-odt compatibility patch From a7881b8d146ddb27452b00ff19c345899d356536 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 11:24:32 +0530 Subject: [PATCH 3/5] Support custom formatters for marking up source or example blocks. * lisp/org-exp.el (org-export-format-source-code-or-example): Add support for: - custom formatters for existing backends - seamless plugging in of new backends.
2011-06-23 11:54:32 -04:00
The CODE is marked up in `org-export-current-backend' format.
Check if a function by name
\"org-<backend>-format-source-code-or-example\" is bound. If yes,
use it as the custom formatter. Otherwise, use the default
formatter. Default formatters are provided for docbook, html,
latex and ascii backends. For example, use
`org-html-format-source-code-or-example' to provide a custom
formatter for export to \"html\".
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
If LANG is nil, do not add any fontification.
Fix spelling and grammar
2009-11-12 07:39:29 -05:00
OPTS contains formatting options, like `-n' for triggering numbering lines,
and `+n' for continuing previous numbering.
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
Code formatting according to language currently only works for HTML.
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
Numbering lines works for all three major backends (html, latex, and ascii).
INDENT was the original indentation of the block."
Improvements to contrib/lisp/org-eval.el This works now reasonably stable.
2008-05-03 10:29:48 -04:00
(save-match-data
Support custom formatters for marking up source or example blocks PATCH-3/5 org-odt compatibility patch From a7881b8d146ddb27452b00ff19c345899d356536 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 11:24:32 +0530 Subject: [PATCH 3/5] Support custom formatters for marking up source or example blocks. * lisp/org-exp.el (org-export-format-source-code-or-example): Add support for: - custom formatters for existing backends - seamless plugging in of new backends.
2011-06-23 11:54:32 -04:00
(let* ((backend-name (symbol-name org-export-current-backend))
(backend-formatter
(intern (format "org-%s-format-source-code-or-example"
backend-name)))
(backend-feature (intern (concat "org-" backend-name)))
(backend-formatter
(and (require (intern (concat "org-" backend-name)) nil)
(fboundp backend-formatter) backend-formatter))
num cont rtn rpllbl keepp textareap preserve-indentp cols rows fmt)
Coderefs: Revamp label syntax. This commit revamps the syntax used for code line references in literal examples. See the documentation for details about the new format.
2009-01-05 07:23:42 -05:00
(setq opts (or opts "")
num (string-match "[-+]n\\>" opts)
cont (string-match "\\+n\\>" opts)
rpllbl (string-match "-r\\>" opts)
keepp (string-match "-k\\>" opts)
Export: Optionally use <textarea> for example export. Examples and src block can now be exported as <textarea> elements to HTML if this is desired. See the documentation for more details.
2009-01-19 17:13:58 -05:00
textareap (string-match "-t\\>" opts)
Allow code indentation to be preserved on export This is controlled on a per-block basis with a new src block flag -i. It can be controlled globally using the variable org-src-preserve-indentation.
2009-10-31 15:43:42 -04:00
preserve-indentp (or org-src-preserve-indentation
(string-match "-i\\>" opts))
Export: Optionally use <textarea> for example export. Examples and src block can now be exported as <textarea> elements to HTML if this is desired. See the documentation for more details.
2009-01-19 17:13:58 -05:00
cols (if (string-match "-w[ \t]+\\([0-9]+\\)" opts)
(string-to-number (match-string 1 opts))
80)
rows (if (string-match "-h[ \t]+\\([0-9]+\\)" opts)
(string-to-number (match-string 1 opts))
(org-count-lines code))
Coderefs: Revamp label syntax. This commit revamps the syntax used for code line references in literal examples. See the documentation for details about the new format.
2009-01-05 07:23:42 -05:00
fmt (if (string-match "-l[ \t]+\"\\([^\"\n]+\\)\"" opts)
(match-string 1 opts)))
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(when (and textareap (eq org-export-current-backend 'html))
Export: Optionally use <textarea> for example export. Examples and src block can now be exported as <textarea> elements to HTML if this is desired. See the documentation for more details.
2009-01-19 17:13:58 -05:00
;; we cannot use numbering or highlighting.
(setq num nil cont nil lang nil))
Coderefs: Insert links in export backends This patch covers the three main backends, html, latex, and ascii. It adds the code to make sure the coderef links identified by the preprocessing will be implemented correctly when a backend does its work.
2008-12-26 11:37:53 -05:00
(if keepp (setq rpllbl 'keep))
Allow code indentation to be preserved on export This is controlled on a per-block basis with a new src block flag -i. It can be controlled globally using the variable org-src-preserve-indentation.
2009-10-31 15:43:42 -04:00
(setq rtn (if preserve-indentp code (org-remove-indentation code)))
Blocks: Make editing indented blocks work correctly
2009-05-26 01:35:40 -04:00
(when (string-match "^," rtn)
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(setq rtn (with-temp-buffer
(insert rtn)
;; Free up the protected lines
(goto-char (point-min))
(while (re-search-forward "^," nil t)
Blocks: Make editing indented blocks work correctly
2009-05-26 01:35:40 -04:00
(if (or (equal lang "org")
(save-match-data
(looking-at "\\([*#]\\|[ \t]*#\\+\\)")))
(replace-match ""))
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(end-of-line 1))
(buffer-string))))
;; Now backend-specific coding
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
(setq rtn
(cond
Support custom formatters for marking up source or example blocks PATCH-3/5 org-odt compatibility patch From a7881b8d146ddb27452b00ff19c345899d356536 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 11:24:32 +0530 Subject: [PATCH 3/5] Support custom formatters for marking up source or example blocks. * lisp/org-exp.el (org-export-format-source-code-or-example): Add support for: - custom formatters for existing backends - seamless plugging in of new backends.
2011-06-23 11:54:32 -04:00
(backend-formatter
org-export-format-source-code-or-example: Fix commit f0177f (org-odt) * lisp/org-exp.el (org-export-format-source-code-or-example): Fix signature of org-<backend>-format-source-code-or-example function.
2011-06-25 04:53:14 -04:00
(funcall backend-formatter rtn lang caption textareap cols rows num
Support custom formatters for marking up source or example blocks PATCH-3/5 org-odt compatibility patch From a7881b8d146ddb27452b00ff19c345899d356536 Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 11:24:32 +0530 Subject: [PATCH 3/5] Support custom formatters for marking up source or example blocks. * lisp/org-exp.el (org-export-format-source-code-or-example): Add support for: - custom formatters for existing backends - seamless plugging in of new backends.
2011-06-23 11:54:32 -04:00
cont rpllbl fmt))
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
((eq org-export-current-backend 'docbook)
(setq rtn (org-export-number-lines rtn 0 0 num cont rpllbl fmt))
Simplify org-export-format-source-code-or-example PATCH-4/5 org-odt compatibility patch Addtional Note: Diff looks primarily because of un-indentation. Effective changes are just couple of lines. From 923402f12f30a39d54e16c0b105db2b1f20c2a7c Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 12:06:33 +0530 Subject: [PATCH 4/5] Simplify org-export-format-source-code-or-example. * lisp/org-exp.el (org-export-format-source-code-or-example): Simplify. Also add `org-native-text' as a text property to the formatted text and throw error for unknown backends.
2011-06-23 11:56:37 -04:00
(concat "<programlisting><![CDATA["
rtn
"]]></programlisting>\n"))
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
((eq org-export-current-backend 'html)
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
;; We are exporting to HTML
(when lang
XEmacs compatibility
2010-05-14 08:40:44 -04:00
(if (featurep 'xemacs)
(require 'htmlize)
(require 'htmlize nil t))
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
(when (not (fboundp 'htmlize-region-for-paste))
;; we do not have htmlize.el, or an old version of it
(setq lang nil)
(message
"htmlize.el 1.34 or later is needed for source code formatting")))
Fix whitespace issues
2009-06-08 02:00:46 -04:00
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
(if lang
Allow language names where the major mode name seems unrelated to the language Eric Schulte writes: > Attached is a small patch for a small issue. > > Sometimes a language uses a major mode which can't be guessed > from it's name. This patch introduces the `org-src-lang-modes' > variable which can be used to map language names to major modes > when this is the case. This is used when editing a source-code > block, or when exporting fontified source-code with htmlize. > > So far the only instance of this that I know of is ocaml and > tuareg-mode, so that's the only thing that `org-src-lang-modes' > is pre-populated with. Maybe there are other instances as well?
2009-08-23 13:31:47 -04:00
(let* ((lang-m (when lang
(or (cdr (assoc lang org-src-lang-modes))
lang)))
(mode (and lang-m (intern
(concat
(if (symbolp lang-m)
(symbol-name lang-m)
lang-m)
"-mode"))))
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
(org-inhibit-startup t)
(org-startup-folded nil))
(setq rtn
(with-temp-buffer
(insert rtn)
(if (functionp mode)
(funcall mode)
(fundamental-mode))
(font-lock-fontify-buffer)
Fix markup problems when using references in source fragments * lisp/org-exp.el (org-remove-formatting-on-newlines-in-region): New function. (org-export-format-source-code-or-example): Call `org-remove-formatting-on-newlines-in-region'. TINYCHANGE
2011-05-11 20:41:20 -04:00
;; markup each line separately
(org-remove-formatting-on-newlines-in-region (point-min) (point-max))
Minor fixes
2009-06-09 13:23:59 -04:00
(org-src-mode)
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
(set-buffer-modified-p nil)
(org-export-htmlize-region-for-paste
(point-min) (point-max))))
Fix bug with including org-file during export. Stefan Vollmar writes: > taking up a nice suggestion from Sebastian Rose, I want to > present some org source with proper syntax highlighting. However, > there is a problem when using "BEGIN_SRC" blocks it seems. > > If one puts this org contents into a file "test.org": > > * One Headline > Some Text > #+BEGIN_SRC python > print "some output" > #+END_SRC > * Another headline > More text > > and renders it from another org-file with: > > #+INCLUDE: "./test.org" src org > > everything will be fine (beautiful, infact) up to and including > the print-line - the rest of the org file is not rendered as > source but interpreted.
2009-06-23 08:12:23 -04:00
(if (string-match "<pre\\([^>]*\\)>\n*" rtn)
babel: now exports source code block names When exporting to html the source-code block name will be included as a <label> immediately preceding the exported code. This <label> is decorated with the 'org-src-name' css class. When exporting to LaTeX with the listings package the source-code block name will be included as a listings \title for the code block. Currently the name will not be exported when the listings package is not in use.
2010-01-04 17:11:19 -05:00
(setq rtn
(concat
(if caption
babel: now including source code block arguments w/source name on export This change provides for better export of named source-code blocks, with specific support for more attractive html export. The arguments are included with the source code name, and both the source code name and code body are wrapped in a div to support styling with css. For example the following CSS can be used to associate a source-code block name with it's code body, and to slightly indent the body. .org-src-container { border-left: 4px solid gray; padding: 0.5em 0.5em 0.5em 1em; } .org-src-container pre { margin-left: 1em; }
2010-02-10 15:34:00 -05:00
(concat
"<div class=\"org-src-container\">"
(format
"<label class=\"org-src-name\">%s</label>"
caption))
babel: now exports source code block names When exporting to html the source-code block name will be included as a <label> immediately preceding the exported code. This <label> is decorated with the 'org-src-name' css class. When exporting to LaTeX with the listings package the source-code block name will be included as a listings \title for the code block. Currently the name will not be exported when the listings package is not in use.
2010-01-04 17:11:19 -05:00
"")
(replace-match
babel: now including source code block arguments w/source name on export This change provides for better export of named source-code blocks, with specific support for more attractive html export. The arguments are included with the source code name, and both the source code name and code body are wrapped in a div to support styling with css. For example the following CSS can be used to associate a source-code block name with it's code body, and to slightly indent the body. .org-src-container { border-left: 4px solid gray; padding: 0.5em 0.5em 0.5em 1em; } .org-src-container pre { margin-left: 1em; }
2010-02-10 15:34:00 -05:00
(format "<pre class=\"src src-%s\">\n" lang)
t t rtn)
(if caption "</div>" "")))))
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
(if textareap
(setq rtn (concat
HTML export: Fix textareas Textareas no longer have an empty line at the beginning, and the overflow-x stype property has been moved to the CSS section. Patch by Ulf Stegemann
2010-02-25 06:26:10 -05:00
(format "<p>\n<textarea cols=\"%d\" rows=\"%d\">"
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
cols rows)
rtn "</textarea>\n</p>\n"))
(with-temp-buffer
(insert rtn)
(goto-char (point-min))
(while (re-search-forward "[<>&]" nil t)
(replace-match (cdr (assq (char-before)
'((?&."&amp;")(?<."&lt;")(?>."&gt;"))))
t t))
(setq rtn (buffer-string)))
HTML export: Fix bug in example line enumeration code
2009-07-19 02:00:53 -04:00
(setq rtn (concat "<pre class=\"example\">\n" rtn "</pre>\n"))))
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
(unless textareap
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(setq rtn (org-export-number-lines rtn 1 1 num cont rpllbl fmt)))
HTML export: Fix bug in example line enumeration code
2009-07-19 02:00:53 -04:00
(if (string-match "\\(\\`<[^>]*>\\)\n" rtn)
(setq rtn (replace-match "\\1" t nil rtn)))
Simplify org-export-format-source-code-or-example PATCH-4/5 org-odt compatibility patch Addtional Note: Diff looks primarily because of un-indentation. Effective changes are just couple of lines. From 923402f12f30a39d54e16c0b105db2b1f20c2a7c Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 12:06:33 +0530 Subject: [PATCH 4/5] Simplify org-export-format-source-code-or-example. * lisp/org-exp.el (org-export-format-source-code-or-example): Simplify. Also add `org-native-text' as a text property to the formatted text and throw error for unknown backends.
2011-06-23 11:56:37 -04:00
rtn)
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
((eq org-export-current-backend 'latex)
(setq rtn (org-export-number-lines rtn 0 0 num cont rpllbl fmt))
Simplify org-export-format-source-code-or-example PATCH-4/5 org-odt compatibility patch Addtional Note: Diff looks primarily because of un-indentation. Effective changes are just couple of lines. From 923402f12f30a39d54e16c0b105db2b1f20c2a7c Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 12:06:33 +0530 Subject: [PATCH 4/5] Simplify org-export-format-source-code-or-example. * lisp/org-exp.el (org-export-format-source-code-or-example): Simplify. Also add `org-native-text' as a text property to the formatted text and throw error for unknown backends.
2011-06-23 11:56:37 -04:00
(cond
((and lang org-export-latex-listings)
(flet ((make-option-string
(pair)
(concat (first pair)
(if (> (length (second pair)) 0)
(concat "=" (second pair))))))
(let* ((lang-sym (intern lang))
(minted-p (eq org-export-latex-listings 'minted))
(listings-p (not minted-p))
(backend-lang
(or (cadr
(assq
lang-sym
(cond
(minted-p org-export-latex-minted-langs)
(listings-p org-export-latex-listings-langs))))
lang))
(custom-environment
(cadr
(assq
lang-sym
org-export-latex-custom-lang-environments))))
(concat
(when (and listings-p (not custom-environment))
(format
"\\lstset{%s}\n"
(mapconcat
#'make-option-string
(append org-export-latex-listings-options
`(("language" ,backend-lang))) ",")))
(when (and caption org-export-latex-listings-w-names)
(format
"\n%s $\\equiv$ \n"
(replace-regexp-in-string "_" "\\\\_" caption)))
(cond
(custom-environment
(format "\\begin{%s}\n%s\\end{%s}\n"
custom-environment rtn custom-environment))
(listings-p
Get rid of gratuitous newline after listing/minted environment. Signed-off-by: Nick Dokos <nick@dokosmarshall.org>
2011-08-19 18:36:50 -04:00
(format "\\begin{%s}\n%s\\end{%s}"
Simplify org-export-format-source-code-or-example PATCH-4/5 org-odt compatibility patch Addtional Note: Diff looks primarily because of un-indentation. Effective changes are just couple of lines. From 923402f12f30a39d54e16c0b105db2b1f20c2a7c Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 12:06:33 +0530 Subject: [PATCH 4/5] Simplify org-export-format-source-code-or-example. * lisp/org-exp.el (org-export-format-source-code-or-example): Simplify. Also add `org-native-text' as a text property to the formatted text and throw error for unknown backends.
2011-06-23 11:56:37 -04:00
"lstlisting" rtn "lstlisting"))
(minted-p
(format
Get rid of gratuitous newline after listing/minted environment. Signed-off-by: Nick Dokos <nick@dokosmarshall.org>
2011-08-19 18:36:50 -04:00
"\\begin{minted}[%s]{%s}\n%s\\end{minted}"
Simplify org-export-format-source-code-or-example PATCH-4/5 org-odt compatibility patch Addtional Note: Diff looks primarily because of un-indentation. Effective changes are just couple of lines. From 923402f12f30a39d54e16c0b105db2b1f20c2a7c Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 12:06:33 +0530 Subject: [PATCH 4/5] Simplify org-export-format-source-code-or-example. * lisp/org-exp.el (org-export-format-source-code-or-example): Simplify. Also add `org-native-text' as a text property to the formatted text and throw error for unknown backends.
2011-06-23 11:56:37 -04:00
(mapconcat #'make-option-string
org-export-latex-minted-options ",")
backend-lang rtn)))))))
(t (concat (car org-export-latex-verbatim-wrap)
rtn (cdr org-export-latex-verbatim-wrap)))))
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
((eq org-export-current-backend 'ascii)
Allow empty strings in minted/listings latex options * lisp/org-exp.el (org-export-format-source-code-or-example): Allow empty string as second element in minted/listings options Both (setq org-export-latex-minted-options '(("frame" "lines") ("fontsize" "\\scriptsize") ("linenos" ""))) and (setq org-export-latex-minted-options '(("frame" "lines") ("fontsize" "\\scriptsize") ("linenos"))) will result in latex like \begin{minted}[frame=lines,fontsize=\scriptsize,linenos]{common-lisp}
2011-02-02 07:33:58 -05:00
;; This is not HTML or LaTeX, so just make it an example.
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(setq rtn (org-export-number-lines rtn 0 0 num cont rpllbl fmt))
Allow empty strings in minted/listings latex options * lisp/org-exp.el (org-export-format-source-code-or-example): Allow empty string as second element in minted/listings options Both (setq org-export-latex-minted-options '(("frame" "lines") ("fontsize" "\\scriptsize") ("linenos" ""))) and (setq org-export-latex-minted-options '(("frame" "lines") ("fontsize" "\\scriptsize") ("linenos"))) will result in latex like \begin{minted}[frame=lines,fontsize=\scriptsize,linenos]{common-lisp}
2011-02-02 07:33:58 -05:00
(concat caption "\n"
Simplify org-export-format-source-code-or-example PATCH-4/5 org-odt compatibility patch Addtional Note: Diff looks primarily because of un-indentation. Effective changes are just couple of lines. From 923402f12f30a39d54e16c0b105db2b1f20c2a7c Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Thu, 23 Jun 2011 12:06:33 +0530 Subject: [PATCH 4/5] Simplify org-export-format-source-code-or-example. * lisp/org-exp.el (org-export-format-source-code-or-example): Simplify. Also add `org-native-text' as a text property to the formatted text and throw error for unknown backends.
2011-06-23 11:56:37 -04:00
(concat
(mapconcat
(lambda (l) (concat " " l))
(org-split-string rtn "\n")
"\n")
"\n")
))
(t
(error "Don't know how to markup source or example block in %s"
(upcase backend-name)))))
(setq rtn
(concat
"\n#+BEGIN_" backend-name "\n"
(org-add-props rtn
'(org-protected t org-example t org-native-text t))
Eliminate extra newline(s) after example or src block. Signed-off-by: Nick Dokos <nick@dokosmarshall.org>
2011-08-19 05:02:57 -04:00
"\n#+END_" backend-name "\n"))
Remember the original indentation of source code snippets As the export preprocessor removes indentation from indented blocks, this causes conflicts about interpreting indentation as list termination. Now the original indentation is stored in a text property, so hopefully the exporters can make use of this information in due time.
2009-06-05 02:55:40 -04:00
(org-add-props rtn nil 'original-indentation indent))))
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
(defun org-export-number-lines (text &optional skip1 skip2 number cont
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
replace-labels label-format preprocess)
"Apply line numbers to literal examples and handle code references.
Handle user-specified options under info node `(org)Literal
examples' and return the modified source block.
TEXT contains the source or example block.
SKIP1 and SKIP2 are the number of lines that are to be skipped at
the beginning and end of TEXT. Use these to skip over
backend-specific lines pre-pended or appended to the original
source block.
NUMBER is non-nil if the literal example specifies \"+n\" or
\"-n\" switch. If NUMBER is non-nil add line numbers.
CONT is non-nil if the literal example specifies \"+n\" switch.
If CONT is nil, start numbering this block from 1. Otherwise
continue numbering from the last numbered block.
REPLACE-LABELS is dual-purpose.
1. It controls the retention of labels in the exported block.
2. It specifies in what manner the links (or references) to a
Fix typos and spelling mistakes. Thanks to Paul Eggert for this fixes in Emacs trunk.
2012-01-10 05:56:15 -05:00
labeled line be formatted.
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
REPLACE-LABELS is the symbol `keep' if the literal example
specifies \"-k\" option, is numeric if the literal example
specifies \"-r\" option and is nil otherwise.
Handle REPLACE-LABELS as below:
- If nil, retain labels in the exported block and use
Fix typos and spelling mistakes. Thanks to Paul Eggert for this fixes in Emacs trunk.
2012-01-10 05:56:15 -05:00
user-provided labels for referencing the labeled lines.
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
- If it is a number, remove labels in the exported block and use
Fix typos and spelling mistakes. Thanks to Paul Eggert for this fixes in Emacs trunk.
2012-01-10 05:56:15 -05:00
one of line numbers or labels for referencing labeled lines based
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
on NUMBER option.
- If it is a keep, retain labels in the exported block and use
Fix typos and spelling mistakes. Thanks to Paul Eggert for this fixes in Emacs trunk.
2012-01-10 05:56:15 -05:00
one of line numbers or labels for referencing labeled lines
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
based on NUMBER option.
LABEL-FORMAT is the value of \"-l\" switch associated with
literal example. See `org-coderef-label-format'.
PREPROCESS is intended for backend-agnostic handling of source
block numbering. When non-nil do the following:
- do not number the lines
- always strip the labels from exported block
Fix typos and spelling mistakes. Thanks to Paul Eggert for this fixes in Emacs trunk.
2012-01-10 05:56:15 -05:00
- do not make the labeled line a target of an incoming link.
Instead mark the labeled line with `org-coderef' property and
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
store the label in it."
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(setq skip1 (or skip1 0) skip2 (or skip2 0))
Continue numbering from any previous numbered snippet with +n, even when previous numbered snippet does not immediately precede it. * org-mode/lisp/org-exp.el (org-export-number-lines): Check whether number parameter (this is a numbered block!) is non-nil as well as whether cont is nil (this numbered block should *not* continue numbering where we left off before!) before resetting the count to zero. From the docs: If you use a `+n' switch, the numbering from the previous numbered snippet will be continued in the current one. With this change I believe the code complies with the docs.
2011-09-16 16:32:38 -04:00
(if (and number (not cont)) (setq org-export-last-code-line-counter-value 0))
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(with-temp-buffer
(insert text)
(goto-char (point-max))
(skip-chars-backward " \t\n\r")
(delete-region (point) (point-max))
(beginning-of-line (- 1 skip2))
(let* ((last (org-current-line))
(n org-export-last-code-line-counter-value)
(nmax (+ n (- last skip1)))
(fmt (format "%%%dd: " (length (number-to-string nmax))))
(fm
(cond
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
((eq org-export-current-backend 'html) (format "<span class=\"linenr\">%s</span>"
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
fmt))
Use `org-export-current-backend' whenever possible. * org-special-blocks.el (org-special-blocks-make-special-cookies): Use `org-export-current-backend'. * org-publish.el (org-publish-aux-preprocess): Use `org-export-current-backend'. * org-inlinetask.el (org-inlinetask-export-handler): Use `org-export-current-backend'. * org-exp.el (org-export-current-backend): New variable. (org-export-preprocess-string) (org-export-format-drawer-function) (org-export-remove-or-extract-drawers) (org-export-format-drawer) (org-export-convert-protected-spaces) (org-export-select-backend-specific-text) (org-export-mark-list-end, org-export-mark-list-properties) (org-export-attach-captions-and-attributes) (org-export-replace-src-segments-and-examples) (org-export-format-source-code-or-example) (org-export-number-lines): Use the new global variable instead of a local variable. * org-exp-blocks.el (org-export-blocks-format-ditaa) (org-export-blocks-format-dot) (org-export-blocks-format-comment): Use `org-export-current-backend'.
2011-03-01 14:01:42 -05:00
((eq org-export-current-backend 'ascii) fmt)
((eq org-export-current-backend 'latex) fmt)
((eq org-export-current-backend 'docbook) fmt)
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(t "")))
Coderefs: Revamp label syntax. This commit revamps the syntax used for code line references in literal examples. See the documentation for details about the new format.
2009-01-05 07:23:42 -05:00
(label-format (or label-format org-coderef-label-format))
(label-pre (if (string-match "%s" label-format)
(substring label-format 0 (match-beginning 0))
label-format))
(label-post (if (string-match "%s" label-format)
(substring label-format (match-end 0))
""))
(lbl-re
Fix whitespace issues
2009-06-08 02:00:46 -04:00
(concat
Coderefs: Revamp label syntax. This commit revamps the syntax used for code line references in literal examples. See the documentation for details about the new format.
2009-01-05 07:23:42 -05:00
".*?\\S-.*?\\([ \t]*\\("
(regexp-quote label-pre)
Enhance export options for code source examples. Allow whitespace in code references. Allow the -r switch to remove the references in the source code even when the lines are not numbered: the labels can be explicit enough. Note that "-r -k" is the same than no switch - as expected. Thanks to Ulf Stegemann for bring this up.
2009-07-23 15:48:43 -04:00
"\\([-a-zA-Z0-9_ ]+\\)"
Coderefs: Revamp label syntax. This commit revamps the syntax used for code line references in literal examples. See the documentation for details about the new format.
2009-01-05 07:23:42 -05:00
(regexp-quote label-post)
"\\)\\)"))
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
ref)
Avoid calling `goto-line' from lisp programs
2009-08-27 04:24:09 -04:00
(org-goto-line (1+ skip1))
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(while (and (re-search-forward "^" nil t) (not (eobp)) (< n nmax))
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
(when number (incf n))
(if (or preprocess (not number))
(forward-char 1)
(insert (format fm n)))
Fix white-space errors
2009-08-03 11:30:30 -04:00
(when (looking-at lbl-re)
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(setq ref (match-string 3))
Enhance export options for code source examples. Allow whitespace in code references. Allow the -r switch to remove the references in the source code even when the lines are not numbered: the labels can be explicit enough. Note that "-r -k" is the same than no switch - as expected. Thanks to Ulf Stegemann for bring this up.
2009-07-23 15:48:43 -04:00
(cond ((numberp replace-labels)
;; remove labels; use numbers for references when lines
;; are numbered, use labels otherwise
(delete-region (match-beginning 1) (match-end 1))
(push (cons ref (if (> n 0) n ref)) org-export-code-refs))
((eq replace-labels 'keep)
;; don't remove labels; use numbers for references when
;; lines are numbered, use labels otherwise
(goto-char (match-beginning 2))
(delete-region (match-beginning 2) (match-end 2))
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
(unless preprocess
(insert "(" ref ")"))
Fix white-space errors
2009-08-03 11:30:30 -04:00
(push (cons ref (if (> n 0) n (concat "(" ref ")")))
Enhance export options for code source examples. Allow whitespace in code references. Allow the -r switch to remove the references in the source code even when the lines are not numbered: the labels can be explicit enough. Note that "-r -k" is the same than no switch - as expected. Thanks to Ulf Stegemann for bring this up.
2009-07-23 15:48:43 -04:00
org-export-code-refs))
Fix white-space errors
2009-08-03 11:30:30 -04:00
(t
Enhance export options for code source examples. Allow whitespace in code references. Allow the -r switch to remove the references in the source code even when the lines are not numbered: the labels can be explicit enough. Note that "-r -k" is the same than no switch - as expected. Thanks to Ulf Stegemann for bring this up.
2009-07-23 15:48:43 -04:00
;; don't remove labels and don't use numbers for
;; references
(goto-char (match-beginning 2))
(delete-region (match-beginning 2) (match-end 2))
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
(unless preprocess
(insert "(" ref ")"))
Enhance export options for code source examples. Allow whitespace in code references. Allow the -r switch to remove the references in the source code even when the lines are not numbered: the labels can be explicit enough. Note that "-r -k" is the same than no switch - as expected. Thanks to Ulf Stegemann for bring this up.
2009-07-23 15:48:43 -04:00
(push (cons ref (concat "(" ref ")")) org-export-code-refs)))
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
(when (and (eq org-export-current-backend 'html) (not preprocess))
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(save-excursion
(beginning-of-line 1)
(insert (format "<span id=\"coderef-%s\" class=\"coderef-off\">"
ref))
(end-of-line 1)
org-odt help > I would like to submit 2 more patches - one to the manual and other to > org-exp.el. I am attaching the promised patch to org-exp.el. Can someone review and commit this change? Please note that I have withheld the changes to org-odt & co which make use of this change. ps: The patch to org.texi will follow soon - maybe in a day or two. >From 39ab2a263336ba077c7cd6627a3203c55c5bddba Mon Sep 17 00:00:00 2001 From: Jambunathan K <kjambunathan@gmail.com> Date: Tue, 4 Oct 2011 23:32:35 +0530 Subject: [PATCH] org-exp.el: Enhance `org-export-number-lines' to support odt export * lisp/org-exp.el (org-export-number-lines): Modified. Add a new parameter `preprocess' and use this for backend-agnostic handling of literal examples. This parameter is currently exercised only by the odt exporter. Hint: See future commits.
2011-10-04 19:29:04 -04:00
(insert "</span>")))
(when preprocess
(add-text-properties
(point-at-bol) (point-at-eol) (list 'org-coderef ref)))))
Coderefs: Implement line numbering and code references This patch covers the much of the new line numbering and code line referencing. We introduce a new function with the longish name `org-export-replace-src-segments-and-examples'. It is an extension of the earlier `org-export-replace-src-segments'. It now also covers EXAMPLE blocks, not only source code blocks. This was necessary to allow line numbering also in EXAMPLE blocks. Both clock types now accept a string with options which will be given in the BEGIN line. Options currently recognized are -n, +n, and -r. A bit unsatisfactory about this patch may be that LaTeX-specific code is now defined in org-exp.el, maybe eventually we want to think of a way to move this code back to org-export-latex.el. Really, all it does is adding line numbers and wrapping them into a verbatim environment. Besides adding line numbers in a backend specific way, this patch also adds code to search or special cookies in source code, like "((1))" or "((name))". These are labels that can be addressed by links as references to specific line in source code.
2008-12-26 11:32:08 -05:00
(setq org-export-last-code-line-counter-value n)
(goto-char (point-max))
(newline)
(buffer-string))))
Improve running htmlize.el in batch-mode.
2008-05-09 07:38:01 -04:00
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defun org-search-todo-below (line lines level)
"Search the subtree below LINE for any TODO entries."
(let ((rest (cdr (memq line lines)))
(re org-todo-line-regexp)
line lv todo)
(catch 'exit
(while (setq line (pop rest))
(if (string-match re line)
(progn
(setq lv (- (match-end 1) (match-beginning 1))
todo (and (match-beginning 2)
(not (member (match-string 2 line)
org-done-keywords))))
; TODO, not DONE
(if (<= lv level) (throw 'exit nil))
(if todo (throw 'exit t))))))))
;;;###autoload
(defun org-export-visible (type arg)
"Create a copy of the visible part of the current buffer, and export it.
The copy is created in a temporary buffer and removed after use.
Correct some docstrings [part 2] This is a second patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil
2010-07-15 18:54:53 -04:00
TYPE is the final key (as a string) that also selects the export command in
the \\<org-mode-map>\\[org-export] export dispatcher.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
As a special case, if the you type SPC at the prompt, the temporary
org-mode file will not be removed but presented to you so that you can
continue to use it. The prefix arg ARG is passed through to the exporting
command."
(interactive
(list (progn
Allow export of visible buffer content to LaTeX ad PDF
2009-12-31 03:08:07 -05:00
(message "Export visible: [a]SCII [h]tml [b]rowse HTML [H/R]buffer with HTML [D]ocBook [l]atex [p]df [d]view pdf [L]atex buffer [x]OXO [ ]keep buffer")
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(read-char-exclusive))
current-prefix-arg))
Accept keys for org-export-as-html-to-buffer' and `org-export-region-as-html' * org-exp.el (org-export-visible): Accept keys for `org-export-as-html-to-buffer' and `org-export-region-as-html'. H and R were not in the list of allowed keys but bound to the respective function later. Missing keys reported by Samuel Wales <samologist@gmail.com>.
2011-03-06 13:08:42 -05:00
(if (not (member type '(?a ?n ?u ?\C-a ?b ?\C-b ?h ?D ?x ?\ ?l ?p ?d ?L ?H ?R)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(error "Invalid export key"))
(let* ((binding (cdr (assoc type
Add special commands for latin1 and utf8 export
2010-03-29 09:10:56 -04:00
'(
(?a . org-export-as-ascii)
ASCII Export: Implement export to buffer Samuel Wales writes: > I frequently export to ascii without wanting a file to be created, > especially not in a useful directory, as the files are temporary. > > Is there a way to export ascii to just a buffer? There is now, `C-c C-e A'. This commit also implements commands - org-export-as-ascii-to-buffer - org-replace-region-by-ascii - org-export-region-as-ascii which are similar to what is available for HTML and LaTeX. `C-c C-e A' used to be the key for publishing all projects. This functionality has now been moved to `C-c C-e E'.
2009-05-04 12:26:42 -04:00
(?A . org-export-as-ascii-to-buffer)
Add special commands for latin1 and utf8 export
2010-03-29 09:10:56 -04:00
(?n . org-export-as-latin1)
(?N . org-export-as-latin1-to-buffer)
(?u . org-export-as-utf8)
(?U . org-export-as-utf8-to-buffer)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(?\C-a . org-export-as-ascii)
(?b . org-export-as-html-and-open)
(?\C-b . org-export-as-html-and-open)
(?h . org-export-as-html)
(?H . org-export-as-html-to-buffer)
(?R . org-export-region-as-html)
DocBook export: Installed the new DocBook exporter by Baoqiu Cui
2009-03-30 01:17:09 -04:00
(?D . org-export-as-docbook)
Allow export of visible buffer content to LaTeX ad PDF
2009-12-31 03:08:07 -05:00
(?l . org-export-as-latex)
(?p . org-export-as-pdf)
(?d . org-export-as-pdf-and-open)
(?L . org-export-as-latex-to-buffer)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(?x . org-export-as-xoxo)))))
(keepp (equal type ?\ ))
(file buffer-file-name)
(buffer (get-buffer-create "*Org Export Visible*"))
s e)
;; Need to hack the drawers here.
(save-excursion
(goto-char (point-min))
(while (re-search-forward org-drawer-regexp nil t)
(goto-char (match-beginning 1))
org: remove org-invisible-p I just found a left over in org-list.el. :) Updated patch attached. >From bf6c65a42e04d4753c58795442a479685bb5f318 Mon Sep 17 00:00:00 2001 From: Julien Danjou <julien@danjou.info> Date: Wed, 26 Jan 2011 11:14:11 +0100 Subject: [PATCH] org: remove org-invisible-p * org.el: Remove org-invisible-p: outline-invisible-p is available in Emacs 22 and in recent XEmacs 21. Replace in various files. Signed-off-by: Julien Danjou <julien@danjou.info>
2011-01-26 10:21:25 -05:00
(or (outline-invisible-p) (org-flag-drawer nil))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(with-current-buffer buffer (erase-buffer))
(save-excursion
(setq s (goto-char (point-min)))
(while (not (= (point) (point-max)))
(goto-char (org-find-invisible))
(append-to-buffer buffer s (point))
(setq s (goto-char (org-find-visible))))
(org-cycle-hide-drawers 'all)
(goto-char (point-min))
(unless keepp
;; Copy all comment lines to the end, to make sure #+ settings are
;; still available for the second export step. Kind of a hack, but
;; does do the trick.
(if (looking-at "#[^\r\n]*")
(append-to-buffer buffer (match-beginning 0) (1+ (match-end 0))))
Limit search for in-buffer options beginning of first headline * org-exp.el (org-export-visible): Limit search for in-buffer options beginning of first headline.
2010-11-07 14:06:54 -05:00
(when (re-search-forward "^\\*+[ \t]+" nil t)
(while (re-search-backward "[\n\r]#[^\n\r]*" nil t)
(append-to-buffer buffer (1+ (match-beginning 0))
(min (point-max) (1+ (match-end 0)))))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(set-buffer buffer)
(let ((buffer-file-name file)
(org-inhibit-startup t))
(org-mode)
(show-all)
(unless keepp (funcall binding arg))))
(if (not keepp)
(kill-buffer buffer)
(switch-to-buffer-other-window buffer)
(goto-char (point-min)))))
Keep byte compiler happy
2009-05-14 07:35:40 -04:00
(defvar org-export-htmlized-org-css-url) ;; defined in org-html.el
suggesting a new function org-export-string The attached patch adds a new functions org-export-string. ,---- | org-export-string is a Lisp function in `org-exp.el'. | | (org-export-string STRING FMT &optional DIR) | | Export STRING to FMT using existing export facilities. | During export STRING is saved to a temporary file whose location | could vary. Optional argument DIR can be used to force the | directory in which the temporary file is created during export | which can be useful for resolving relative paths. Dir defaults | to the value of `temporary-file-directory'. `---- This function should be useful in user code, and can already reduce the amount of code in ob-org.el and org-mime.el. >From e51017e4d7051aad31384a470f0a695dca0d6716 Mon Sep 17 00:00:00 2001 From: Eric Schulte <schulte.eric@gmail.com> Date: Sun, 17 Oct 2010 15:17:13 -0600 Subject: [PATCH] org-export-string -- exports a string of org-mode markup text * lisp/org-exp.el (org-export-string): new function org-export-string can be used to convert a string of test in org-mode markup to a specified format * contrib/lisp/org-mime.el (org-mime-htmlize): now using new org-export-string function for exportation * lisp/ob-org.el (org-babel-execute:org): now using new org-export-string function for exportation
2010-10-17 22:22:51 -04:00
(defun org-export-string (string fmt &optional dir)
"Export STRING to FMT using existing export facilities.
During export STRING is saved to a temporary file whose location
could vary. Optional argument DIR can be used to force the
directory in which the temporary file is created during export
which can be useful for resolving relative paths. Dir defaults
to the value of `temporary-file-directory'."
(let ((temporary-file-directory (or dir temporary-file-directory))
(tmp-file (make-temp-file "org-")))
(unwind-protect
(with-temp-buffer
Fix reference to wrong symbol * org-exp.el (org-export-string): Fix reference to wrong symbol.
2010-10-24 14:41:26 -04:00
(insert string)
suggesting a new function org-export-string The attached patch adds a new functions org-export-string. ,---- | org-export-string is a Lisp function in `org-exp.el'. | | (org-export-string STRING FMT &optional DIR) | | Export STRING to FMT using existing export facilities. | During export STRING is saved to a temporary file whose location | could vary. Optional argument DIR can be used to force the | directory in which the temporary file is created during export | which can be useful for resolving relative paths. Dir defaults | to the value of `temporary-file-directory'. `---- This function should be useful in user code, and can already reduce the amount of code in ob-org.el and org-mime.el. >From e51017e4d7051aad31384a470f0a695dca0d6716 Mon Sep 17 00:00:00 2001 From: Eric Schulte <schulte.eric@gmail.com> Date: Sun, 17 Oct 2010 15:17:13 -0600 Subject: [PATCH] org-export-string -- exports a string of org-mode markup text * lisp/org-exp.el (org-export-string): new function org-export-string can be used to convert a string of test in org-mode markup to a specified format * contrib/lisp/org-mime.el (org-mime-htmlize): now using new org-export-string function for exportation * lisp/ob-org.el (org-babel-execute:org): now using new org-export-string function for exportation
2010-10-17 22:22:51 -04:00
(write-file tmp-file)
(org-load-modules-maybe)
(unless org-local-vars
(setq org-local-vars (org-get-local-variables)))
Fix typos and spelling mistakes. Thanks to Paul Eggert for this fixes in Emacs trunk.
2012-01-10 05:56:15 -05:00
(eval ;; convert to fmt -- mimicking `org-run-like-in-org-mode'
suggesting a new function org-export-string The attached patch adds a new functions org-export-string. ,---- | org-export-string is a Lisp function in `org-exp.el'. | | (org-export-string STRING FMT &optional DIR) | | Export STRING to FMT using existing export facilities. | During export STRING is saved to a temporary file whose location | could vary. Optional argument DIR can be used to force the | directory in which the temporary file is created during export | which can be useful for resolving relative paths. Dir defaults | to the value of `temporary-file-directory'. `---- This function should be useful in user code, and can already reduce the amount of code in ob-org.el and org-mime.el. >From e51017e4d7051aad31384a470f0a695dca0d6716 Mon Sep 17 00:00:00 2001 From: Eric Schulte <schulte.eric@gmail.com> Date: Sun, 17 Oct 2010 15:17:13 -0600 Subject: [PATCH] org-export-string -- exports a string of org-mode markup text * lisp/org-exp.el (org-export-string): new function org-export-string can be used to convert a string of test in org-mode markup to a specified format * contrib/lisp/org-mime.el (org-mime-htmlize): now using new org-export-string function for exportation * lisp/ob-org.el (org-babel-execute:org): now using new org-export-string function for exportation
2010-10-17 22:22:51 -04:00
(list 'let org-local-vars
org-export-string now accepts symbolic or string fmt argument * lisp/org-exp.el (org-export-string): Use `format' to construct function call to allow symbolic or string arguments.
2010-12-16 20:09:51 -05:00
(list (intern (format "org-export-as-%s" fmt))
suggesting a new function org-export-string The attached patch adds a new functions org-export-string. ,---- | org-export-string is a Lisp function in `org-exp.el'. | | (org-export-string STRING FMT &optional DIR) | | Export STRING to FMT using existing export facilities. | During export STRING is saved to a temporary file whose location | could vary. Optional argument DIR can be used to force the | directory in which the temporary file is created during export | which can be useful for resolving relative paths. Dir defaults | to the value of `temporary-file-directory'. `---- This function should be useful in user code, and can already reduce the amount of code in ob-org.el and org-mime.el. >From e51017e4d7051aad31384a470f0a695dca0d6716 Mon Sep 17 00:00:00 2001 From: Eric Schulte <schulte.eric@gmail.com> Date: Sun, 17 Oct 2010 15:17:13 -0600 Subject: [PATCH] org-export-string -- exports a string of org-mode markup text * lisp/org-exp.el (org-export-string): new function org-export-string can be used to convert a string of test in org-mode markup to a specified format * contrib/lisp/org-mime.el (org-mime-htmlize): now using new org-export-string function for exportation * lisp/ob-org.el (org-babel-execute:org): now using new org-export-string function for exportation
2010-10-17 22:22:51 -04:00
nil nil nil ''string t))))
(delete-file tmp-file))))
Publishing: Allow to publish the Org source file There is now a new export function, `org-export-as-org', which basically creates a copy of the Org file with things like archived trees, commented trees, and trees deselected by export tags, stripped.
2009-05-13 04:51:01 -04:00
;;;###autoload
(defun org-export-as-org (arg &optional hidden ext-plist
to-buffer body-only pub-dir)
Export: General mechanism for local settings Many different people want to set many different variables in a buffer-local way for export. This cannot be done with file variables, because the Org buffer is not current while the exporter is running. Lots of variables can be set with the #+OPTIONS lines, but finding abbreviations goes only so far. Therefore we have now a general mechanism that can be used to bind variables during export operations. a line like: #+BIND: variable value will bind the variable to value. For example, the line >> #+OPTIONS: toc:nil can now equivalently be written as >> #+BIND: org-export-with-toc nil
2009-07-06 11:00:03 -04:00
"Make a copy with not-exporting stuff removed.
Publishing: Allow to publish the Org source file There is now a new export function, `org-export-as-org', which basically creates a copy of the Org file with things like archived trees, commented trees, and trees deselected by export tags, stripped.
2009-05-13 04:51:01 -04:00
The purpose of this function is to provide a way to export the source
Org file of a webpage in Org format, but with sensitive and/or irrelevant
stuff removed. This command will remove the following:
- archived trees (if the variable `org-export-with-archived-trees' is nil)
- comment blocks and trees starting with the COMMENT keyword
- only trees that are consistent with `org-export-select-tags'
and `org-export-exclude-tags'.
The only arguments that will be used are EXT-PLIST and PUB-DIR,
all the others will be ignored (but are present so that the general
mechanism to call publishing functions will work).
EXT-PLIST is a property list with external parameters overriding
org-mode's default settings, but still inferior to file-local
settings. When PUB-DIR is set, use this as the publishing
directory."
(interactive "P")
(let* ((opt-plist (org-combine-plists (org-default-export-plist)
ext-plist
(org-infile-export-plist)))
(bfname (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
(filename (concat (file-name-as-directory
(or pub-dir
(org-export-directory :org opt-plist)))
(file-name-sans-extension
Minor fix
2009-08-03 01:51:01 -04:00
(file-name-nondirectory bfname))
".org"))
Publishing: Allow to publish the Org source file There is now a new export function, `org-export-as-org', which basically creates a copy of the Org file with things like archived trees, commented trees, and trees deselected by export tags, stripped.
2009-05-13 04:51:01 -04:00
(filename (and filename
(if (equal (file-truename filename)
(file-truename bfname))
Fix file name for source export Hsiu-Khuern writes: > Hi all, > > The footnote at the bottom of section 13.1.4 ("Publishing > action") of the Org manual says that publishing org files to > the same directory using org-publish-org-to-org results in > files named like file-source.org. It actually results in > file.org-source, which is not as nice. I believe the > problem is in the org-export-as-org function in org-exp.el.
2009-08-01 17:44:11 -04:00
(concat (file-name-sans-extension filename)
"-source."
Fix parenthesis bug in org-exp.el
2009-08-03 06:18:14 -04:00
(file-name-extension filename))
Publishing: Allow to publish the Org source file There is now a new export function, `org-export-as-org', which basically creates a copy of the Org file with things like archived trees, commented trees, and trees deselected by export tags, stripped.
2009-05-13 04:51:01 -04:00
filename)))
(backup-inhibited t)
(buffer (find-file-noselect filename))
`org-export-as-org' now exports a string when to-buffer equals 'string
2010-04-09 11:08:52 -04:00
(region (buffer-string))
str-ret)
Publishing: Allow to publish the Org source file There is now a new export function, `org-export-as-org', which basically creates a copy of the Org file with things like archived trees, commented trees, and trees deselected by export tags, stripped.
2009-05-13 04:51:01 -04:00
(save-excursion
Fix (a lot of) compiler warnings. Also introduce `org-pop-to-buffer-same-window' as a compatibility function for Emacs =>24.1.
2011-07-18 13:25:10 -04:00
(org-pop-to-buffer-same-window buffer)
Publishing: Allow to publish the Org source file There is now a new export function, `org-export-as-org', which basically creates a copy of the Org file with things like archived trees, commented trees, and trees deselected by export tags, stripped.
2009-05-13 04:51:01 -04:00
(erase-buffer)
(insert region)
(let ((org-inhibit-startup t)) (org-mode))
Export: General mechanism for local settings Many different people want to set many different variables in a buffer-local way for export. This cannot be done with file variables, because the Org buffer is not current while the exporter is running. Lots of variables can be set with the #+OPTIONS lines, but finding abbreviations goes only so far. Therefore we have now a general mechanism that can be used to bind variables during export operations. a line like: #+BIND: variable value will bind the variable to value. For example, the line >> #+OPTIONS: toc:nil can now equivalently be written as >> #+BIND: org-export-with-toc nil
2009-07-06 11:00:03 -04:00
(org-install-letbind)
Fix whitespace issues
2009-06-08 02:00:46 -04:00
Publishing: Allow to publish the Org source file There is now a new export function, `org-export-as-org', which basically creates a copy of the Org file with things like archived trees, commented trees, and trees deselected by export tags, stripped.
2009-05-13 04:51:01 -04:00
;; Get rid of archived trees
(org-export-remove-archived-trees (plist-get opt-plist :archived-trees))
Fix whitespace issues
2009-06-08 02:00:46 -04:00
Publishing: Allow to publish the Org source file There is now a new export function, `org-export-as-org', which basically creates a copy of the Org file with things like archived trees, commented trees, and trees deselected by export tags, stripped.
2009-05-13 04:51:01 -04:00
;; Remove comment environment and comment subtrees
(org-export-remove-comment-blocks-and-subtrees)
Fix whitespace issues
2009-06-08 02:00:46 -04:00
Publishing: Allow to publish the Org source file There is now a new export function, `org-export-as-org', which basically creates a copy of the Org file with things like archived trees, commented trees, and trees deselected by export tags, stripped.
2009-05-13 04:51:01 -04:00
;; Get rid of excluded trees
(org-export-handle-export-tags (plist-get opt-plist :select-tags)
(plist-get opt-plist :exclude-tags))
Fix whitespace issues
2009-06-08 02:00:46 -04:00
Publishing: Allow to publish the Org source file There is now a new export function, `org-export-as-org', which basically creates a copy of the Org file with things like archived trees, commented trees, and trees deselected by export tags, stripped.
2009-05-13 04:51:01 -04:00
(when (or (plist-get opt-plist :plain-source)
(not (or (plist-get opt-plist :plain-source)
(plist-get opt-plist :htmlized-source))))
;; Either nothing special is requested (default call)
;; or the plain source is explicitly requested
;; so: save it
(save-buffer))
(when (plist-get opt-plist :htmlized-source)
;; Make the htmlized version
(require 'htmlize)
(require 'org-html)
(font-lock-fontify-buffer)
(let* ((htmlize-output-type 'css)
(newbuf (htmlize-buffer)))
(with-current-buffer newbuf
(when org-export-htmlized-org-css-url
(goto-char (point-min))
(and (re-search-forward
"<style type=\"text/css\">[^\000]*?\n[ \t]*</style>.*"
nil t)
(replace-match
(format
"<link rel=\"stylesheet\" type=\"text/css\" href=\"%s\">"
org-export-htmlized-org-css-url)
t t)))
(write-file (concat filename ".html")))
(kill-buffer newbuf)))
(set-buffer-modified-p nil)
`org-export-as-org' now exports a string when to-buffer equals 'string
2010-04-09 11:08:52 -04:00
(if (equal to-buffer 'string)
(progn (setq str-ret (buffer-string))
(kill-buffer (current-buffer))
str-ret)
(kill-buffer (current-buffer))))))
Publishing: Allow to publish the Org source file There is now a new export function, `org-export-as-org', which basically creates a copy of the Org file with things like archived trees, commented trees, and trees deselected by export tags, stripped.
2009-05-13 04:51:01 -04:00
Fix typos in org-exp.el
2008-12-16 10:30:46 -05:00
(defvar org-archive-location) ;; gets loaded with the org-archive require.
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(defun org-get-current-options ()
"Return a string with current options as keyword options.
Does include HTML export options as well as TODO and CATEGORY stuff."
Split out org-faces, org-archive.el, org-colview.el from org.el.
2008-04-09 09:42:36 -04:00
(require 'org-archive)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(format
"#+TITLE: %s
#+AUTHOR: %s
#+EMAIL: %s
#+DATE: %s
Code cleanup: use a generic :for-backend parameter.
2011-02-15 05:07:46 -05:00
#+DESCRIPTION:
#+KEYWORDS:
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
#+LANGUAGE: %s
Export: Include "<" in the options template. `C-c C-e t' inserts a template with options. Ian Barton reported that this template was not complete, the timestamp switch "<" was missing.
2009-01-21 11:56:48 -05:00
#+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s -:%s f:%s *:%s <:%s
#+OPTIONS: TeX:%s LaTeX:%s skip:%s d:%s todo:%s pri:%s tags:%s
Completion for INFOJS options, and documentation. Add new faces.
2008-04-09 07:49:51 -04:00
%s
Intermediate
2008-09-16 10:52:21 -04:00
#+EXPORT_SELECT_TAGS: %s
Fix typo.
2008-10-26 01:58:28 -04:00
#+EXPORT_EXCLUDE_TAGS: %s
Completion for INFOJS options, and documentation. Add new faces.
2008-04-09 07:49:51 -04:00
#+LINK_UP: %s
#+LINK_HOME: %s
Code cleanup: use a generic :for-backend parameter.
2011-02-15 05:07:46 -05:00
#+XSLT:
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
#+CATEGORY: %s
#+SEQ_TODO: %s
#+TYP_TODO: %s
#+PRIORITIES: %c %c %c
#+DRAWERS: %s
#+STARTUP: %s %s %s %s %s
#+TAGS: %s
Fixed bug with file tags. This bug was reported by Manuel Hermenegildo. There were really two issues: The parsing of the FILETAGS line was broken, and the function `org-get-tags-at' did ignore these tags. Both problems are fixed now.
2008-06-10 07:42:27 -04:00
#+FILETAGS: %s
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
#+ARCHIVE: %s
#+LINK: %s
"
Release 6.02.
2008-04-24 04:29:47 -04:00
(buffer-name) (user-full-name) user-mail-address
Remove angular brackets from date in export options template.
2008-09-05 11:33:20 -04:00
(format-time-string (substring (car org-time-stamp-formats) 1 -1))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
org-export-default-language
org-export-headline-levels
org-export-with-section-numbers
org-export-with-toc
org-export-preserve-breaks
org-export-html-expand
org-export-with-fixed-width
org-export-with-tables
org-export-with-sub-superscripts
org-export-with-special-strings
org-export-with-footnotes
org-export-with-emphasize
Export: Include "<" in the options template. `C-c C-e t' inserts a template with options. Ian Barton reported that this template was not complete, the timestamp switch "<" was missing.
2009-01-21 11:56:48 -05:00
org-export-with-timestamps
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
org-export-with-TeX-macros
org-export-with-LaTeX-fragments
org-export-skip-text-before-1st-heading
org-export-with-drawers
Better handling of export options. This patch improves the internal handling of the large number of export options that Org-mode has. In particular, it now defines a single constant, `org-export-plist-vars' that contains the full list of options, and how these can be accessed through variables, and through the #+OPTIONS line. Before the patch, there used to be a separate list or the OPTIONS handling, which has gotten out of sync. This now no longer can happen. Also, this patch adds two new variables, `org-export-with-priority', and `org-export-with-todo-keywords', which can be used to turn the export of TODO keywords and priority cookies on and off, so that these can simply disappear and not be shown in the exported file. In fact, the default for the priority cookie is to remove it.
2008-12-03 01:33:05 -05:00
org-export-with-todo-keywords
org-export-with-priority
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
org-export-with-tags
Cleanup after name change.
2008-05-08 08:45:47 -04:00
(if (featurep 'org-jsinfo) (org-infojs-options-inbuffer-template) "")
Intermediate
2008-09-16 10:52:21 -04:00
(mapconcat 'identity org-export-select-tags " ")
(mapconcat 'identity org-export-exclude-tags " ")
Completion for INFOJS options, and documentation. Add new faces.
2008-04-09 07:49:51 -04:00
org-export-html-link-up
org-export-html-link-home
Bugfix: Make option completion work in indirect buffers Reported by Shaun Johnson.
2009-01-28 03:11:21 -05:00
(or (ignore-errors
(file-name-sans-extension
(file-name-nondirectory (buffer-file-name (buffer-base-buffer)))))
"NOFILENAME")
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
"TODO FEEDBACK VERIFY DONE"
"Me Jason Marie DONE"
org-highest-priority org-lowest-priority org-default-priority
(mapconcat 'identity org-drawers " ")
(cdr (assoc org-startup-folded
'((nil . "showall") (t . "overview") (content . "content"))))
(if org-odd-levels-only "odd" "oddeven")
(if org-hide-leading-stars "hidestars" "showstars")
(if org-startup-align-all-tables "align" "noalign")
(cond ((eq org-log-done t) "logdone")
((equal org-log-done 'note) "lognotedone")
((not org-log-done) "nologdone"))
(or (mapconcat (lambda (x)
(cond
Cater for new tag group description in several places Patch by Stephan Schmitt.
2009-11-05 10:08:55 -05:00
((equal :startgroup (car x)) "{")
((equal :endgroup (car x)) "}")
((equal :newline (car x)) "")
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
((cdr x) (format "%s(%c)" (car x) (cdr x)))
(t (car x))))
(or org-tag-alist (org-get-buffer-tags)) " ") "")
Fixed bug with file tags. This bug was reported by Manuel Hermenegildo. There were really two issues: The parsing of the FILETAGS line was broken, and the function `org-get-tags-at' did ignore these tags. Both problems are fixed now.
2008-06-10 07:42:27 -04:00
(mapconcat 'identity org-file-tags " ")
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
org-archive-location
"org file:~/org/%s.org"
))
;;;###autoload
(defun org-insert-export-options-template ()
"Insert into the buffer a template with information for exporting."
(interactive)
(if (not (bolp)) (newline))
(let ((s (org-get-current-options)))
(and (string-match "#\\+CATEGORY" s)
(setq s (substring s 0 (match-beginning 0))))
(insert s)))
(defvar org-table-colgroup-info nil)
Export: Fix bug with LaTeX export of tables. The special first column in some tables was not removed for LaTeX export. This bug was probably introduces recently, while trying to fix problems with special characters in LaTeX tables. Export is now working again properly. Reported by Giovanni Ridolfi.
2009-01-17 09:07:10 -05:00
(defun org-table-clean-before-export (lines &optional maybe-quoted)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
"Check if the table has a marking column.
If yes remove the column and the special lines."
(setq org-table-colgroup-info nil)
(if (memq nil
(mapcar
(lambda (x) (or (string-match "^[ \t]*|-" x)
Export: Fix bug with LaTeX export of tables. The special first column in some tables was not removed for LaTeX export. This bug was probably introduces recently, while trying to fix problems with special characters in LaTeX tables. Export is now working again properly. Reported by Giovanni Ridolfi.
2009-01-17 09:07:10 -05:00
(string-match
(if maybe-quoted
"^[ \t]*| *\\\\?\\([\#!$*_^ /]\\) *|"
"^[ \t]*| *\\([\#!$*_^ /]\\) *|")
x)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
lines))
Automatically remove lines with formatting cookies when exporting tables Lines that only contain formatting cookies like <l20> or <10> will now be removed automatically. Optionally, the first field in a row can also be "/".
2010-04-27 06:13:27 -04:00
;; No special marking column
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(progn
(setq org-table-clean-did-remove-column nil)
(delq nil
(mapcar
(lambda (x)
(cond
Automatically remove lines with formatting cookies when exporting tables Lines that only contain formatting cookies like <l20> or <10> will now be removed automatically. Optionally, the first field in a row can also be "/".
2010-04-27 06:13:27 -04:00
((org-table-colgroup-line-p x)
;; This line contains colgroup info, extract it
;; and then discard the line
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(setq org-table-colgroup-info
(mapcar (lambda (x)
(cond ((member x '("<" "&lt;")) :start)
((member x '(">" "&gt;")) :end)
((member x '("<>" "&lt;&gt;")) :startend)
(t nil)))
(org-split-string x "[ \t]*|[ \t]*")))
nil)
Automatically remove lines with formatting cookies when exporting tables Lines that only contain formatting cookies like <l20> or <10> will now be removed automatically. Optionally, the first field in a row can also be "/".
2010-04-27 06:13:27 -04:00
((org-table-cookie-line-p x)
;; This line contains formatting cookies, discard it
nil)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(t x)))
lines)))
Automatically remove lines with formatting cookies when exporting tables Lines that only contain formatting cookies like <l20> or <10> will now be removed automatically. Optionally, the first field in a row can also be "/".
2010-04-27 06:13:27 -04:00
;; there is a special marking column
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(setq org-table-clean-did-remove-column t)
(delq nil
(mapcar
(lambda (x)
(cond
Automatically remove lines with formatting cookies when exporting tables Lines that only contain formatting cookies like <l20> or <10> will now be removed automatically. Optionally, the first field in a row can also be "/".
2010-04-27 06:13:27 -04:00
((org-table-colgroup-line-p x)
;; This line contains colgroup info, extract it
;; and then discard the line
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(setq org-table-colgroup-info
(mapcar (lambda (x)
(cond ((member x '("<" "&lt;")) :start)
((member x '(">" "&gt;")) :end)
((member x '("<>" "&lt;&gt;")) :startend)
(t nil)))
(cdr (org-split-string x "[ \t]*|[ \t]*"))))
nil)
Automatically remove lines with formatting cookies when exporting tables Lines that only contain formatting cookies like <l20> or <10> will now be removed automatically. Optionally, the first field in a row can also be "/".
2010-04-27 06:13:27 -04:00
((org-table-cookie-line-p x)
;; This line contains formatting cookies, discard it
nil)
org-exp: Ignore table rows defining parameters for formulas during export * lisp/org-exp.el (org-table-clean-before-export): Ignore table rows defining parameters for formulas during export.
2012-02-22 03:29:03 -05:00
((string-match "^[ \t]*| *\\([!_^/$]\\|\\\\\\$\\) *|" x)
Automatically remove lines with formatting cookies when exporting tables Lines that only contain formatting cookies like <l20> or <10> will now be removed automatically. Optionally, the first field in a row can also be "/".
2010-04-27 06:13:27 -04:00
;; ignore this line
nil)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
((or (string-match "^\\([ \t]*\\)|-+\\+" x)
(string-match "^\\([ \t]*\\)|[^|]*|" x))
;; remove the first column
(replace-match "\\1|" t nil x))))
lines))))
(defun org-export-cleanup-toc-line (s)
Fix typos in org-exp.el
2008-12-16 10:30:46 -05:00
"Remove tags and timestamps from lines going into the toc."
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(when (memq org-export-with-tags '(not-in-toc nil))
Allow "#" and "%" in tags Patch largely from Manish, missing points added by Carsten
2010-08-20 20:30:31 -04:00
(if (string-match (org-re " +:[[:alnum:]_@#%:]+: *$") s)
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(setq s (replace-match "" t t s))))
(when org-export-remove-timestamps-from-toc
(while (string-match org-maybe-keyword-time-regexp s)
(setq s (replace-match "" t t s))))
(while (string-match org-bracket-link-regexp s)
(setq s (replace-match (match-string (if (match-end 3) 3 1) s)
t t s)))
Export: Remove footnote references from TOC lines
2009-09-03 02:14:45 -04:00
(while (string-match "\\[\\([0-9]\\|fn:[^]]*\\)\\]" s)
(setq s (replace-match "" t t s)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
s)
Improved the treatment of internal links during export. So far only internal links that lead to a dedicated target where converted correctly during HTML export. Now, also heuristic links create a working jump in a file.
2008-04-13 13:26:31 -04:00
(defun org-get-text-property-any (pos prop &optional object)
(or (get-text-property pos prop object)
(and (setq pos (next-single-property-change pos prop object))
(get-text-property pos prop object))))
HTML export: moved functions to separate file.
2009-04-07 13:55:32 -04:00
(defun org-export-get-coderef-format (path desc)
HTML export: Also wrap tags into classes. Like TODO keywords before, now also tags each get their own CSS class, given by the tag itself. Invalid characters in tags are all replaced by "_" to make sure the resulting HTML remains valid. Two new variables can be used to add a prefix to the class names for TODO keywords and tags.
2009-02-20 17:40:46 -05:00
(save-match-data
HTML export: moved functions to separate file.
2009-04-07 13:55:32 -04:00
(if (and desc (string-match
(regexp-quote (concat "(" path ")"))
desc))
(replace-match "%s" t t desc)
Export: Respect the description in a coderef Shaun Johanson writes: > Consider the following Org file: > > * Test > > See [[(foo)][FOOBIE]] > > #+BEGIN_EXAMPLE > <foo>: blah blah (ref:foo) > #+END_EXAMPLE > > Question 1) > In Org mode the link displays as FOOBIE, in the exported HTML it > displays as (foo). Is there any way to cause the link to use the > description (FOOBIE) in HTML? If not would this be a useful option > to add? This was a bug, fixed now.
2009-05-06 06:17:24 -04:00
(or desc "%s"))))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
Export: Make all export commands push the result to the kill ring All export commands now push the result to the kill ring by default. This is subject to the variable `org-export-push-to-kill-ring'. Also, this commit adds a new variable `org-export-show-temporary-export-buffer' which can be used to turn off the display of the temporary buffer containing the exported text. Since this stuff is now automatically pushed onto the kill ring, some people might prefer not to see this buffer.
2009-05-21 03:14:33 -04:00
(defun org-export-push-to-kill-ring (format)
"Push buffer content to kill ring.
org-exp.el (org-export-push-to-kill-ring): Minor fix to docstring
2011-11-07 16:43:06 -05:00
The depends on the variable `org-export-copy-to-kill-ring'."
Export: Make all export commands push the result to the kill ring All export commands now push the result to the kill ring by default. This is subject to the variable `org-export-push-to-kill-ring'. Also, this commit adds a new variable `org-export-show-temporary-export-buffer' which can be used to turn off the display of the temporary buffer containing the exported text. Since this stuff is now automatically pushed onto the kill ring, some people might prefer not to see this buffer.
2009-05-21 03:14:33 -04:00
(when org-export-copy-to-kill-ring
New minor mode org-indent-mode This mode implements outline indentation similar to clean view, but in a dynamic and virtual way, at display time.
2009-06-30 01:24:57 -04:00
(org-kill-new (buffer-string))
Export: Make all export commands push the result to the kill ring All export commands now push the result to the kill ring by default. This is subject to the variable `org-export-push-to-kill-ring'. Also, this commit adds a new variable `org-export-show-temporary-export-buffer' which can be used to turn off the display of the temporary buffer containing the exported text. Since this stuff is now automatically pushed onto the kill ring, some people might prefer not to see this buffer.
2009-05-21 03:14:33 -04:00
(when (fboundp 'x-set-selection)
Export: Protect pushing to x-selection, for non-x environments
2009-05-22 11:15:06 -04:00
(ignore-errors (x-set-selection 'PRIMARY (buffer-string)))
(ignore-errors (x-set-selection 'CLIPBOARD (buffer-string))))
Export: Make all export commands push the result to the kill ring All export commands now push the result to the kill ring by default. This is subject to the variable `org-export-push-to-kill-ring'. Also, this commit adds a new variable `org-export-show-temporary-export-buffer' which can be used to turn off the display of the temporary buffer containing the exported text. Since this stuff is now automatically pushed onto the kill ring, some people might prefer not to see this buffer.
2009-05-21 03:14:33 -04:00
(message "%s export done, pushed to kill ring and clipboard" format)))
Split out a number of files from org.el, and reorganize the structure of the git repository, using new subdirectories for Lisp and Documentation files.
2008-03-22 11:52:18 -04:00
(provide 'org-exp)
Arch-tag lines and declaration fixes from upstream Emacs.
2008-04-29 01:15:41 -04:00
;;; org-exp.el ends here