diff --git a/doc/images/library-of-babel.png b/doc/images/library-of-babel.png index 56fb58ac8..7ec6e64be 100644 Binary files a/doc/images/library-of-babel.png and b/doc/images/library-of-babel.png differ diff --git a/library-of-babel.org b/library-of-babel.org index c067fdf84..ac791d9e4 100644 --- a/library-of-babel.org +++ b/library-of-babel.org @@ -1,7 +1,7 @@ -#+title: The Library of Babel +#+title: The Library of Babel #+SEQ_TODO: TODO PROPOSED | DONE DEFERRED REJECTED -#+OPTIONS: H:3 num:nil toc:t -#+STARTUP: odd hideblocks +#+OPTIONS: H:3 num:nil toc:2 \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc +#+STARTUP: odd hideblocks #+begin_html
@@ -13,12 +13,28 @@ #+end_html +* Introduction + The Library of Babel is an extensible collection of ready-made and + easily-shortcut-callable source-code blocks for handling common + tasks. Org-babel comes pre-populated with the source-code blocks + located in this file. It is possible to add source-code blocks from + any org-mode file to the library by calling + +#+srcname: add-file-to-lob +#+begin_src emacs-lisp +(org-babel-lob-ingest "path/to/file.org") +#+end_src + * Plotting code + +** R Plot column 2 (y axis) against column 1 (x axis). Columns 3 and beyond, if present, are ignored. #+srcname: R-plot(data=R-plot-example-data) @@ -38,7 +54,9 @@ plot(data) #+resname: R-plot(data=R-plot-example-data) : nil -* Etc +** Gnuplot + +* Misc #+srcname: python-identity(a=1) #+begin_src python a diff --git a/org-babel-worg.org b/org-babel-worg.org index 0df82d658..c8646ad2f 100644 --- a/org-babel-worg.org +++ b/org-babel-worg.org @@ -15,7 +15,10 @@ #+end_html @@ -25,6 +28,16 @@ support]] for blocks of source code examples in the org-mode core. 1. source code execution 2. arguments to source code blocks + 3. exportation of source code blocks to files (literate programming) + +* Getting started + Add the following lines to your .emacs, replacing the path as + appropriate. A good place to check that things are up and running + would the examples in [[* Basic org-babel functionality][Basic org-babel functionality]]. +#+begin_src emacs-lisp + (add-to-list 'load-path "/path/to/org-babel/lisp") + (require 'org-babel-init) +#+end_src * Basic org-babel functionality *** Source code execution @@ -85,10 +98,14 @@ c(5, 10) * A meta-programming language for org-mode * Spreadsheet plugins for org-mode in any language * Library of Babel -Org-babel support saving of source-code blocks in a library from which -they can be call in any org-mode file. This library is called the -[[file:library-of-babel.org][Library of Babel]]. It is possible to add source-code blocks from any -org-mode file to the library by calling + What about those source code blocks which are so useful you want to + have them available in every org-mode buffer? + + The [[file:library-of-babel.org][Library of Babel]] is an extensible collection of ready-made and + easily-shortcut-callable source-code blocks for handling common + tasks. Org-babel comes pre-populated with the source-code blocks + located in the [[file:library-of-babel.org][library-of-babel.org]] file. It is possible to add + source-code blocks from any org-mode file to the library by calling #+srcname: add-file-to-lob #+begin_src emacs-lisp diff --git a/org-babel.org b/org-babel.org index 9987dd943..75cb0379d 100644 --- a/org-babel.org +++ b/org-babel.org @@ -1,13 +1,24 @@ #+TITLE: org-babel --- facilitating communication between programming languages and people #+SEQ_TODO: PROPOSED TODO STARTED | DONE DEFERRED REJECTED -#+OPTIONS: H:3 num:nil toc:t +#+OPTIONS: H:3 num:nil toc:2 \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc #+STARTUP: oddeven hideblocks -Through Org-Babel Org-Mode can communicate with programming languages. -Code contained in source-code blocks can be evaluated and data can -pass seamlessly between different programming languages, Org-Mode -constructs (tables, file links, example text) and interactive comint -buffers. +#+begin_html +
+

executable source code blocks in org-mode

+
+ +#+end_html + +Org-Babel makes source-code blocks in Org-Mode executable and allows +data to pass seamlessly between different programming languages, +Org-Mode constructs (tables, file links, example text) and interactive +comint buffers. In this document: - The [[* Introduction][Introduction]] :: provides a brief overview of the design and use diff --git a/publish-babel.org b/publish-babel.org index 4bc92c821..e9fc0a159 100644 --- a/publish-babel.org +++ b/publish-babel.org @@ -1,5 +1,7 @@ #+TITLE: Tools for publishing Org-babel documentation -#+OPTIONS: toc:nil num:nil ^:nil +#+OPTIONS: toc:t h:3 num:nil ^:nil + +This file contains the code required to export the documentation of Org-babel. * org-babel-documentation Project @@ -25,6 +27,9 @@ publishing. Publish a project with =C-c C-e X=. * org-babel-documentation stylesheet +Calling =org-babel-tangle= in this file will export the css file for +the Org-babel documentation. + #+begin_src css :tangle doc/stylesheet #logo { float:right;