org-mode/contrib
Eric Schulte 7e93b90f88 Standardized code block keywords
Nick Dokos <nicholas.dokos@hp.com> writes:

> Eric Schulte <schulte.eric@gmail.com> wrote:
>
>> The attached updated patch fixes a bug in the original.
>>
>
> Minor problem in applying:
>
> ,----
> | $ git apply ~/Mail/inbox/724
> | /home/nick/Mail/inbox/724:671: trailing whitespace.
> | #+name:
> | /home/nick/Mail/inbox/724:599: new blank line at EOF.
> | +
> | warning: 2 lines add whitespace errors.
> `----

The attached version fixes these issues, Thanks -- Eric

>From 0e43d59ee8d46a63f86780a502de726271bc39de Mon Sep 17 00:00:00 2001
From: Eric Schulte <schulte.eric@gmail.com>
Date: Fri, 28 Oct 2011 10:44:21 -0600
Subject: [PATCH] removing code block, results and call-line synonyms -- BREAKING CHANGE

Following a round of on-list discussion many code block synonyms have
been removed, moving forward the following syntax is valid.

- call lines are specified with #+call:
- code blocks are named with #+name:
- results are named with #+name:, however results generated by a code
  block may still be labeled with #+results:, and tables named with
  #+tblname: will be considered to be named results

The following function may be used to update an existing Org-mode
buffer to the new syntax.

  (defun update-org-buffer ()
    "Update an Org-mode buffer to the new data, code block and call line syntax."
    (interactive)
    (save-excursion
      (flet ((to-re (lst) (concat "^[ \t]*#\\+" (regexp-opt lst t)
                                  "\\(\\[\\([[:alnum:]]+\\)\\]\\)?\\:[ \t]*"))
             (update (re new)
                     (goto-char (point-min))
                     (while (re-search-forward re nil t)
                       (replace-match new nil nil nil 1))))
        (let ((old-re (to-re '("RESULTS" "DATA" "SRCNAME" "SOURCE")))
              (lob-re (to-re '("LOB")))
              (case-fold-search t))
          (update old-re "name")
          (update lob-re "call")))))

Note: If an old version of Org-mode (e.g., the one shipped with Emacs)
      is installed on your system many of the important variables will
      be pre-defined with a defvar and *will not* have their values
      automatically updated, these include the following.
      - org-babel-data-names
      - org-babel-result-regexp
      - org-babel-src-block-regexp
      - org-babel-src-name-regexp
      - org-babel-src-name-w-name-regexp
      It may be necessary to either remove the source code of older
      versions of Org-mode, or to explicitly evaluate the ob.el file.

* lisp/ob-exp.el (org-exp-res/src-name-cleanup): Updated
  Documentation.
* lisp/ob-lob.el (org-babel-block-lob-one-liner-regexp): Updated
  regular expression.
  (org-babel-inline-lob-one-liner-regexp): Updated regular expression.
* lisp/ob-ref.el (org-babel-ref-resolve): Notice when something that
  looks like a data results may actually be a code block.
* lisp/ob-table.el: Updated documentation.
* lisp/ob.el (org-babel-src-name-regexp): Simplified regexp.
  (org-babel-get-src-block-info): Updated match strings.
  (org-babel-data-names): Simplified acceptable names.
  (org-babel-find-named-block): Indentation.
  (org-babel-find-named-result): Updated to not return a code block as
  a result.
* lisp/org.el (org-fontify-meta-lines-and-blocks-1): Removing
  references to old syntactic elements.
  (org-additional-option-like-keywords): Removing references to old
  syntactic elements.
* contrib/babel/library-of-babel.org: Updated to make use of the new
  syntax.
* testing/examples/babel-dangerous.org: Updated to make use of the new
  syntax.
* testing/examples/babel.org: Updated to make use of the new syntax.
* testing/examples/ob-awk-test.org: Updated to make use of the new
  syntax.
* testing/examples/ob-fortran-test.org: Updated to make use of the new
  syntax.
* testing/lisp/test-ob.el: Removed two bad tests which tested the
  literal values of old regular expressions rather than their
  behavior.
2011-11-15 08:56:24 -07:00
..
babel Standardized code block keywords 2011-11-15 08:56:24 -07:00
doc Remove arch-tag at the bottom of documentation files. 2011-08-15 20:04:55 +02:00
lisp org-xhtml.el: Merge commit 2f50b1 2011-11-14 02:00:56 +05:30
odt OrgOdtContentTemplate.xml: Added custom table styles 2011-10-20 13:59:17 +05:30
scripts updates to the external StartOzServer.oz script 2011-06-13 15:59:50 -07:00
README Add org-sudoku to contrib directory 2011-08-09 18:25:29 +02:00

README

This directory contains add-ons to Org-mode.

These contributions are not part of GNU Emacs or of the official Org-mode
package.  But the git repository for Org-mode is glad to provide useful way
to distribute and develop them as long as they are distributed under a free
software license.

Please put your contribution in one of these three directories:

LISP (emacs-lisp code)
======================
htmlize.el               --- Convert buffer text and decorations to HTML
org2rem.el               --- Convert org appointments into reminders
org-annotate-file.el     --- Annotate a file with org syntax
org-bookmark.el          --- Links to bookmarks
org-checklist.el         --- org functions for checklist handling
org-choose.el            --- Use TODO keywords to mark decision states
org-collector.el         --- Collect properties into tables
org-contacts             --- Contacts management
org-contribdir.el        --- Dummy file to mark the org contrib Lisp directory
org-depend.el            --- TODO dependencies for Org-mode
org-drill.el             --- Self-testing with org-learn
org-depend.el            --- TODO dependencies for Org-mode
org-elisp-symbol.el      --- Org links to emacs-lisp symbols
org-eshell.el            --- Support for links to working directories in eshell
org-eval.el              --- The <lisp> tag, adapted from Muse
org-eval-light.el        --- Evaluate in-buffer code on demand
org-exp-bibtex.el        --- Export citations to LaTeX and HTML
org-expiry.el 	         --- Expiry mechanism for Org entries
org-export-generic.el    --- Export framework for configurable backends
org-git-link.el          --- Provide org links to specific file version
org-interactive-query.el --- Interactive modification of tags query
org-invoice.el           --- Help manage client invoices in OrgMode
org-jira.el              --- Add a jira:ticket protocol to Org
org-learn.el             --- SuperMemo's incremental learning algorithm
org-lparse.el            --- Library for building custom exporters
org-mac-iCal.el          --- Imports events from iCal.app to the Emacs diary
org-mac-link-grabber.el  --- Grab links and URLs from various Mac applications
org-mairix.el 	         --- Hook mairix search into Org for different MUAs
org-man.el 	         --- Support for links to manpages in Org-mode
org-mime.el              --- org html export for text/html MIME emails
org-mtags.el 	         --- Support for some Muse-like tags in Org-mode
org-odt.el 	         --- OpenDocumentText exporter for Org-mode
org-panel.el 	         --- Simple routines for us with bad memory
org-registry.el          --- A registry for Org links
org-screen.el            --- Visit screen sessions through Org-mode links
org-secretary.el         --- Team management with org-mode
org-special-blocks.el    --- Turn blocks into LaTeX envs and HTML divs
org-sudoku.el            --- Create and solve SUDOKU puzzles in Org tables
orgtbl-sqlinsert.el      --- Convert Org-mode tables to SQL insertions
org-toc.el 	         --- Table of contents for Org-mode buffer
org-track.el             --- Keep up with Org development
org-velocity.el          --- something like Notational Velocity for Org
org-wikinodes            --- CamelCase wiki-like links for Org


PACKAGES
========

SCRIPTS (shell, bash, etc.)
===========================

dir2org.zsh          --- Org compatible fs structure output
org2hpda	     --- Generate hipster pda style printouts from Org-mode
ditaa.jar            --- ASCII to PNG converter by Stathis Sideris, GPL