mirrors
/
org-mode
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git
0
0
Fork 1
Code Releases Activity

moving/removing files, and updating paths

This commit is contained in:
Eric Schulte 2009-09-11 13:56:14 -06:00
parent c0554c7753
commit eec9c235d0
18 changed files with 32 additions and 1893 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

674
contrib/babel/COPYING
View File

@ -1,674 +0,0 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program 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
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

4
contrib/babel/README
View File

@ -1,4 +0,0 @@
org-babel.el --- executable source code blocks in org-mode
- for information on org see the http://org-mode.org
- for information on org-babel see the http://eschulte.github.com/org-babel/

0
contrib/babel/org-babel.org → contrib/babel/babel.org
View File

BIN
contrib/babel/doc/images/dirs.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 27 KiB

BIN
contrib/babel/doc/images/library-of-babel.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 101 KiB

BIN
contrib/babel/doc/images/tower-of-babel.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 258 KiB

BIN
contrib/babel/images/blue.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 2.0 KiB

39
contrib/babel/intro.org
View File

@ -1,39 +0,0 @@
* Introduction
[[http:orgmode.org][Emacs org-mode]] is an exceptionally rich emacs mode based around
hierachically-structured text documents. The environment that has
been designed around this central concept provides support for many
different usage modes. At a high level, important areas include note
taking, project planning and document publishing. Working with the
text files is made efficient by document navigation and editing
facilities which include creation, folding, restructuring and
repositioning of subtrees and list items, and a plain-text
spreadsheet for tabular data. Nevertheless, org is unobtrusive: an
org-mode buffer may make use of only the most basic features, or
even none at all. It is notoriously difficult to describe org
briefly: good starting points include [...].
Org therefore provides an ideal environment for literate
programming: chunks of source code in any language can be embedded
within the org-mode text file. The hierarchical structure of the
document may reflect, for example, the logic of the problem being
addressed or the structure of the project within which the problem
arises. Embedding source code within Org documents means that, for
example, the project-planning features of org-mode are immediately
available, and that the document may be published to HTML and LaTeX
with appropriate formatting of the code.
In addition to the standard org functionality, org provides
convenient switching between the org buffer with embedded code, and
a separate buffer in the native language mode. Thus literate
programming with org-mode does not impact upon language-specific
modes for working with source code in emacs. For example, when
working with [[http://www.r-project.org/][R]] code, you do not leave [[http://ess.r-project.org/][ess-mode]] until you flick back
from the code buffer to view it embedded within an org buffer, which
may also contain chunks of code in other languages.
* Org-Babel
Org-Babel provides several extensions to the above-described method of
working with source code in org mode:
1. Code block execution for interpreted languages (python, ruby, shell, R, perl)
2. [...]

17
contrib/babel/library-of-babel.org
View File

@ -3,23 +3,6 @@
#+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
<div id="subtitle">
<p>
off-the-shelf functions for data analysis and plotting using <a href="org-babel-worg.html">org-babel</a><br/>
<a href="http://downlode.org/Etext/library_of_babel.html">Full text of the Borges short story</a>
</p>
</div>
<div id="logo">
<p>
<img src="images/library-of-babel.png" alt="images/tower-of-babel.png" />
<div id="attr">
from <a href="http://www.poetryfoundation.org/harriet/2008/01/random-poetry-02/">poetryfoundation.org</a>
</div>
</p>
</div>
#+end_html
* Introduction
The Library of Babel is an extensible collection of ready-made and
easily-shortcut-callable source-code blocks for handling common

863
contrib/babel/org-babel-worg.org
View File

@ -1,863 +0,0 @@
#+OPTIONS: H:3 num:nil toc:2 \n:nil @:t ::t |:t ^:{} -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
#+STARTUP: align fold nodlcheck hidestars oddeven lognotestate hideblocks
#+SEQ_TODO: TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
#+TAGS: Write(w) Update(u) Fix(f) Check(c)
#+TITLE: Org-babel
#+AUTHOR: Eric Schulte, Dan Davison
#+EMAIL: schulte.eric at gmail dot com, davison at stats dot ox dot ac dot uk
#+LANGUAGE: en
#+CATEGORY: worg
# #+INFOJS_OPT: view:content
#+begin_html
<div id="subtitle">
<p>executable source code blocks in org-mode</p>
</div>
<div id="logo">
<p>
<img src="images/tower-of-babel.png" alt="images/tower-of-babel.png"/>
<div id="attr">
The Tower of Babel by
<a href="http://commons.wikimedia.org/wiki/Pieter_Brueghel_the_Elder" title="">
<b>Pieter Brueghel the Elder</b>
</a>
</div>
<p>
And the Lord said, Behold, the people is one, and they have all
one language; and this they begin to do; and now nothing will be
restrained from them, which they have imagined to do. Genesis
11:1-9
</p>
</p>
</div>
#+end_html
#+begin_html
<p>
</p>
#+end_html
* Introduction
:PROPERTIES:
:CUSTOM_ID: introduction
:END:
Org-babel is an extension to the very excellent [[http://orgmode.org/][Org-mode]], providing
the ability to execute source code in many different languages
within org-mode documents. The results of code execution --- text,
tables and graphics --- can be integrated into the powerful
publishing facilities of org-mode. Org-mode is an [[http://www.gnu.org/software/emacs/][Emacs]] major mode
for doing almost anything with plain text. If you are not familiar
with Org-mode please take a moment to read [[http://orgmode.org/][the Org-mode homepage]]
before continuing.
Org-babel provides the following modifications to [[http://orgmode.org/manual/Literal-examples.html][the existing
support]] for blocks of source code examples in the org-mode core.
1. Interactive source code execution
2. Arguments to source code blocks
3. Exportation of source code blocks to files (literate programming)
* Getting started
:PROPERTIES:
:CUSTOM_ID: getting-started
:END:
1) Grab the latest code from the git repo at [[http://github.com/eschulte/org-babel/tree/master][github/org-babel]]
#+begin_src sh
git clone git://github.com/eschulte/org-babel.git
#+end_src
2) 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
3) Finally, activate the subset of supported Org-babel languages
which you want to be able to execute on your system. As an
example, the following activates python, ruby and R. For a full
list of languages, with notes on their dependencies see the
[[#reference-and-documentation][Reference / Documentation]] section below.
#+begin_src emacs-lisp
(require 'org-babel-python)
(require 'org-babel-ruby)
(require 'org-babel-R)
;;
;; Once you've activated languages, load the library of babel to
;; make pre-built helper functions available in the languages you will be using.
(org-babel-load-library-of-babel)
#+end_src
* Basic org-babel functionality
:PROPERTIES:
:CUSTOM_ID: basic-functionality
:END:
*** Source code blocks
:PROPERTIES:
:CUSTOM_ID: source-code-blocks
:END:
Org-babel is all about *source code blocks* in org mode. These are
blocks of code (in whatever language), that can occur anywhere in
an org-mode file. For example, the following is a source block
containing [[http://www.ruby-lang.org/][ruby]] code:
: #+begin_src ruby
: "This file was last evaluated on #{Date.today}"
: #+end_src
If you are unfamiliar with the notion of a source code block in
org-mode, please have a look at the [[http://orgmode.org/manual/Literal-examples.html][relevant manual section]] before
proceding.
Note that above is what the source block looks like in the org-mode
file. We had to take [[http://orgmode.org/manual/Literal-examples.html#Literal-examples][special steps]] to make it look that way in the
HTML output. Normally, when exported to HTML, source blocks are
fontified according to their language, and the begin_src...end_src
mark-up is omitted, like this:
#+begin_src ruby
"This file was last evaluated on #{Date.today}"
#+end_src
From now on, if you are viewing the HTML version, you will see the
HTML output only. However, much of this document consists of
interactive examples, and therefore in order to get a feeling for the
mechanics of Org-babel it might make most sense to grab the plain text
version of this file
#+HTML: <a href="org-babel-worg.org">org-babel-worg.org</a>
and work through it in Emacs. Alternatively the htmlized
version of the plain text of this file at
#+HTML: <a href="org-babel-worg.org.html">org-babel-worg.html</a>
allows the plain text version to be viewed (non-interactively) in a web browser.
*** Source code execution
:PROPERTIES:
:CUSTOM_ID: source-code-execution
:END:
For interpreted languages such as shell, python, R, etc, org-babel
allows source blocks to be executed: the code is passed to the
interpreter and you have control over what is done with the results of
execution. Here are three examples of code blocks in three different
languages, followed by their output. If you are viewing the plain text
version of this document in emacs, place point anywhere inside the
blocks and use =C-c C-c= to run the code[fn:1] (and feel free to alter
it!).
**** Ruby
#+begin_src ruby
"This file was last evaluated on #{Date.today}"
#+end_src
#+resname:
: This file was last evaluated on 2009-08-09
**** [[http://www.r-project.org/][R]]
#+begin_src R :results value
matrix(rnorm(6), nrow=2)
#+end_src
#+resname:
| -0.138279734486552 | -2.2476234005706 | -0.0839549402407832 |
| 0.0730510956002737 | 0.0634015508602321 | 0.174013159381603 |
**** [[http://ditaa.sourceforge.net/][ditaa]]
#+begin_src ditaa :file images/blue.png :cmdline -r
+---------+
| cBLU |
| |
| +----+
| |cPNK|
| | |
+----+----+
#+end_src
#+resname:
[[file:images/blue.png]]
*** Source code block syntax
The basic syntax of source-code blocks in Org-babel is as follows:
: #+srcname: name(arguments)
: #+begin_src language header-arguments
: body
: #+end_src
- name :: This name is associated with the source-code block. This is
similar to the =#+tblname= lines which can be used to name tables
in org-mode files. By referencing the srcname of a source-code
block it is possible to evaluate the block from other places,
files, or from inside tables.
- arguments :: Code blocks can have arguments (see [[#arguments-to-source-code-blocks][below]]) which are
provided using a familiar function-call syntax similar
to (e.g.) python or R.
- language :: The language of the code in the source-code block. Valid
values must be members of `org-babel-interpreters'.
- header-arguments :: Header arguments control many facets of the
evaluation and output of source-code blocks. See the [[* Header Arguments][Header
Arguments]] section for a complete review of available header
arguments.
- body :: The actual source code which will be evaluated. An
important key-binding to become familiar with is =C-c
'=. This calls `org-edit-special' which brings up an edit
buffer containing the code using the emacs major mode
appropriate to the language.
*** What happens to the results?
:PROPERTIES:
:CUSTOM_ID: results
:END:
Org-babel provides two fundamentally different modes for capturing
the results of code evaluation, specified by the =:results= header
argument.
**** =:results value= (functional mode)
This means that the 'result' of code evaluation is defined to be
the *value* of the last statement in the block. Thus with this
setting, one can view the code block as a function with a return
value. And not only can you view it that way, but you can
actually use the return value of one source block as input for
another (see [[meta-programming-language]]). This setting is the
default.
As an example, consider the following block of python code and its
output.
#+begin_src python :results value
import time
print("Hello, today's date is %s" % time.ctime())
print('Two plus two is')
2 + 2
#+end_src
#+resname:
: 4
Notice that in functional mode, the output consists of the value of
the last statement, and nothing else.
**** =:results output= (scripting mode)
With this setting, org-babel captures all the text output of the
code block and places it in the org buffer. One can think of this
as a 'scripting' mode: the code block contains a series of
commands, and you get the output of all the commands. Unlike in
the 'functional' mode, the code block has no return value. (This
mode will be more familiar to Sweave users).
Now consider the result of evaluating the same source block as
before, but under scripting mode.
#+srcname: name
#+begin_src python :results output
import time
print("Hello, today's date is %s" % time.ctime())
print('Two plus two is')
2 + 2
#+end_src
#+resname: name
: Hello, today's date is Fri Sep 4 19:49:06 2009
: Two plus two is
Again, we got what we asked for: all the text output (stdout) from
python. Since we didn't print the last value (2 + 2), we didn't get it
in our output.
*** Arguments to source code blocks
:PROPERTIES:
:CUSTOM_ID: arguments-to-source-code-blocks
:END:
In addition to evaluation of code blocks, org-babel allows them to
be parameterised (i.e. have arguments). Thus source code blocks
now have the status of *functions*. Arguments to code blocks can
be used in both functional and scripting mode.
**** Simple example of using a source block as a function
First let's look at a very simple example. The following source
block defines an org-babel function that will square its input.
#+srcname: square(x)
#+begin_src python
x*x
#+end_src
In the org-mode file that looks like this:
: #+srcname: square(x)
: #+begin_src python
: x*x
: #+end_src
Now we use the source block:
: #+lob: square(x=6)
(/for information on the/ =lob= /syntax see [[library-of-babel]]/)
#+lob: square(x=6)
#+resname: square(x=6)
: 36
**** A more complex example: using an org-table as input
In this example we're going to define a function to compute a
Fibonacci sequence, and we're going to make it take its input
from a table in the org-mode buffer.
Here are the inputs for fibonacci-seq:
#+tblname: fibonacci-inputs
| 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 |
| 2 | 4 | 6 | 8 | 10 | 12 | 14 | 16 | 18 | 20 |
in the Org-mode buffer this looks like
: #+tblname: fibonacci-inputs
: | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 |
: | 2 | 4 | 6 | 8 | 10 | 12 | 14 | 16 | 18 | 20 |
[[http://www.gnu.org/software/emacs/manual/elisp.html][Emacs Lisp]] source code
#+srcname: fibonacci-seq(fib-inputs=fibonacci-inputs)
#+begin_src emacs-lisp
(defun fibonacci (n)
(if (or (= n 0) (= n 1))
n
(+ (fibonacci (- n 1)) (fibonacci (- n 2)))))
(mapcar (lambda (row)
(mapcar #'fibonacci row)) fib-inputs)
#+end_src
in the Org-mode buffer this looks like
: #+srcname: fibonacci-seq(fib-inputs=fibonacci-inputs)
: #+begin_src emacs-lisp
: (defun fibonacci (n)
: (if (or (= n 0) (= n 1))
: n
: (+ (fibonacci (- n 1)) (fibonacci (- n 2)))))
:
: (mapcar (lambda (row)
: (mapcar #'fibonacci row)) fib-inputs)
: #+end_src
Results of Emacs Lisp code evaluation
#+resname:
| 1 | 1 | 2 | 3 | 5 | 8 | 13 | 21 | 34 | 55 |
| 1 | 3 | 8 | 21 | 55 | 144 | 377 | 987 | 2584 | 6765 |
* A meta-programming language for org-mode
:PROPERTIES:
:CUSTOM_ID: meta-programming-language
:END:
Since information can pass freely between source-code blocks and
org-mode tables you can mix and match languages using each language
for those tasks to which it is suited. This makes Org-mode files with
Org-babel into a kind of meta-functional programming language in which
functions from many languages can work together.
As an example, lets take some system diagnostics in the shell, and
then graph them with R.
1. First we create a code block containing shell code creating a list
of the directories in our home directory, together with their
sizes. Org-babel automatically converts the output into an org
table.
#+srcname: directories
#+begin_src bash :results replace
cd ~ && du -sc * |grep -v total
#+end_src
#+resname: directories
| 72 | "Desktop" |
| 12156104 | "Documents" |
| 3482440 | "Downloads" |
| 2901720 | "Library" |
| 57344 | "Movies" |
| 16548024 | "Music" |
| 120 | "News" |
| 7649472 | "Pictures" |
| 0 | "Public" |
| 152224 | "Sites" |
| 8 | "System" |
| 56 | "bin" |
| 3821872 | "mail" |
| 10605392 | "src" |
| 1264 | "tools" |
2. Now we use a single line of R code to plot the data as a
pie-chart. Note the way that this source block uses the =srcname=
of the previous source block to obtain the data.
#+srcname: directory-pie-chart(dirs = directories)
#+begin_src R :session R-pie-example
pie(dirs[,1], labels = dirs[,2])
#+end_src
[[file:images/dirs.png]]
* Multilingual spreadsheet plugins for org-mode
:PROPERTIES:
:CUSTOM_ID: spreadsheet
:END:
Not only can Org-babel pass entire tables of data to source code
blocks (see [[arguments-to-source-code-blocks]]), Org-babel can also be
used to call source code blocks from *within* tables using the
Org-mode's [[http://orgmode.org/manual/The-spreadsheet.html#The-spreadsheet][existing spreadsheet functionality]].
*** Example 1: data summaries using R
As a simple example, we'll fill in a cell in an org-table with the
average value of a few numbers. First, let's make some data. The
following source block creates an org table filled with five random
numbers between 0 and 1.
#+srcname: tbl-example-data()
#+begin_src R
runif(n=5, min=0, max=1)
#+end_src
#+resname: tbl-example-data
| 0.850250755203888 |
| 0.745323235634714 |
| 0.845673063071445 |
| 0.761818468105048 |
| 0.525476417969912 |
Now we define a source block to do the calculation we want.
#+srcname: R-mean(x)
#+begin_src R
mean(x)
#+end_src
Finally we create the table which is going to make use of the R
code. This is done using the =sbe= ('source block evaluate') macro in
the table formula line.
#+tblname: summaries
| mean |
|-------------------|
| 0.533130449522286 |
#+TBLFM: @2$1='(sbe "R-mean" (x "generate-data()"))
To recalculate the table formula, use =C-u C-c C-c= in the
table. Notice that as things stand the calculated value doesn't
change, because the data (held in the table above named
"tbl-example-data") are static. However, if you delete that data table
then the reference will be interpreted as a reference to the source
block responsible for generating the data; each time the table formula
is recalculated the source block will be evaluated again, and
therefore the calculated average value will change.
*** Example 2: Org-babel test suite
While developing Org-babel, we have used a suite of tests implemented
as a large Org-mode table. To run the entire test suite you simply
evaluate the table with =C-u C-c C-c=, and all of the tests are run,
the results are compared with expectations, and the table is updated
with results and pass/fail statistics.
Here's a sample of our test suite.
#+TBLNAME: org-babel-tests
| functionality | block | arg | expected | results | pass |
|------------------+--------------+-----+-------------+-------------+------|
| basic evaluation | | | | | pass |
|------------------+--------------+-----+-------------+-------------+------|
| emacs lisp | basic-elisp | 2 | 4 | 4 | pass |
| shell | basic-shell | | 6 | 6 | pass |
| ruby | basic-ruby | | org-babel | org-babel | pass |
| python | basic-python | | hello world | hello world | pass |
| R | basic-R | | 13 | 13 | pass |
#+TBLFM: $5='(if (= (length $3) 1) (sbe $2 (n $3)) (sbe $2)) :: $6='(if (string= $4 $5) "pass" (format "expected %S but was %S" $4 $5))
**** code blocks for tests
#+srcname: basic-elisp(n)
#+begin_src emacs-lisp
(* 2 n)
#+end_src
#+srcname: basic-shell
#+begin_src sh :results silent
expr 1 + 5
#+end_src
#+srcname: date-simple
#+begin_src sh :results silent
date
#+end_src
#+srcname: basic-ruby
#+begin_src ruby :results silent
"org-babel"
#+end_src
#+srcname: basic-python
#+begin_src python :results silent
'hello world'
#+end_src
#+srcname: basic-R
#+begin_src R :results silent
b <- 9
b + 4
#+end_src
* The Library of Babel
:PROPERTIES:
:CUSTOM_ID: library-of-babel
:END:
#+begin_html
<div id="logo">
<p>
<img src="images/library-of-babel-clayette.png" />
<div id="attr">
The Library of Babel, by Pierre Clayette
<p>
<a href="http://downlode.org/Etext/library_of_babel.html">Full text of the Borges short story</a>
</p>
</div>
</p>
</div>
#+end_html
As we saw above with the [[*Simple%20example%20of%20using%20a%20source%20block%20as%20a%20function][=square=]] example, once a source block
function has been defined it can be called using the following short
=lob= notation:
: #+lob: square(x=6)
But what about those source code blocks which are so useful you want
to have them available in every org-mode buffer?
In addition to the current buffer, Org-babel searches for
pre-defined source block functions in the Library of Babel. This is
a user-extensible collection of ready-made source-code blocks for
handling common tasks. One use for the LoB (not yet done!) will be
to provide a choice of data graphing procedures for data held in
org-mode tables, using languages such as R, gnuplot, asymptote,
etc. If you implement something that might be of use to other org
users, please consider adding it to the LoB; similarly, feel free to
request help solving a problem using external code via org-babel --
there's always a chance that other org users will be able to
contribute some helpful code. Org-mode demonstrates that an enormous
amount can be achieved using plain text and emacs lisp; the LoB is
intended to fill in the gaps.
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
(org-babel-lob-ingest "path/to/file.org")
#+end_src
Note that it is also possible to pass table values or the output of
a source-code block to lob functions, and it is possible to
reference lob functions in source block arguments.
* Reproducible Research
:PROPERTIES:
:CUSTOM_ID: reproducable-research
:END:
#+begin_quote
An article about computational science in a scientific publication is
not the scholarship itself, it is merely advertising of the
scholarship. The actual scholarship is the complete software
development environment and the complete set of instructions which
generated the figures.
-- D. Donoho
#+end_quote
[[http://reproducibleresearch.net/index.php/Main_Page][Reproducible Research]] (RR) is the practice of distributing along with
an article of research all data, code, and tools required to reproduce
the results discussed in the paper. As such the paper becomes not
only a document describing the research but a complete laboratory in
which the research can be reproduced and extended.
Org-mode already has exceptional support for [[http://orgmode.org/manual/Exporting.html#Exporting][exporting to html and
LaTeX]]. Org-babel makes Org-mode a tool for RR by *activating* the
data and source code embedded into Org-mode documents making the
entire document executable. This makes it not only possible, but
natural to distribute research in a format that encourages readers to
recreate your results, and perform their own analysis.
One notable existing RR tool is [[http://en.wikipedia.org/wiki/Sweave][Sweave]] which provides for the
embedding of [[http://www.r-project.org/][R]] code into LaTeX documents. While Sweave is a mature
and very useful tool, we believe that Org-babel has several
advantages:
- It supports multiple languages (we're not aware of other RR tools that do this)
- The [[http://orgmode.org/manual/Exporting.html#Exporting][export process]] is flexible and powerful, including HTML as a target in addition to LaTeX
- The document can make native use of all the features of Org-mode,
such as those for [[http://orgmode.org/manual/Agenda-Views.html#Agenda-Views][project planning]] and [[http://orgmode.org/manual/TODO-Items.html#TODO-Items][task management]]
* Literate programming
:PROPERTIES:
:CUSTOM_ID: literate-programming
:END:
#+begin_quote
Let us change our traditional attitude to the construction of
programs: Instead of imagining that our main task is to instruct a
/computer/ what to do, let us concentrate rather on explaining to
/human beings/ what we want a computer to do.
The practitioner of literate programming can be regarded as an
essayist, whose main concern is with exposition and excellence of
style. Such an author, with thesaurus in hand, chooses the names of
variables carefully and explains what each variable means. He or she
strives for a program that is comprehensible because its concepts have
been introduced in an order that is best for human understanding,
using a mixture of formal and informal methods that reinforce each
other.
-- Donald Knuth
#+end_quote
Org-babel supports [[http://en.wikipedia.org/wiki/Literate_programming][Literate Programming]] (LP) by allowing the act of
programming to take place inside of Org-mode documents. The Org-mode
file can then be exported (*woven* in LP speak) to html or LaTeX for
consumption by a human, and the embedded source code can be extracted
(*tangled* in LP speak) into structured source code files for
consumption by a computer.
To support these operations Org-babel relies on Org-mode's [[http://orgmode.org/manual/Exporting.html#Exporting][existing
exporting functionality]] for *weaving* of documentation, and on the
=org-babel-tangle= function which makes use of [[http://www.cs.tufts.edu/~nr/noweb/][Noweb]] [[reference-expansion][reference syntax]]
for *tangling* of code files.
The [[literate-programming-example][following example]] demonstrates the process of *tangling* in
Org-babel.
*** Simple Literate Programming Example (Noweb syntax)
:PROPERTIES:
:CUSTOM_ID: literate-programming-example
:END:
Tangling functionality is controlled by the =tangle= family of
[[header-arguments]]. These arguments can be used to turn tangling on or
off (the default) on the source code block, or the outline heading
level.
The following demonstrates the combination of three source code blocks
into a single source code file using =org-babel-tangle=.
The following two blocks will not be tangled by default since they
have no =tangle= header arguments.
#+srcname: hello-world-prefix
#+begin_src sh :exports none
echo "/-----------------------------------------------------------\\"
#+end_src
: #+srcname: hello-world-prefix
: #+begin_src sh :exports none
: echo "/-----------------------------------------------------------\\"
: #+end_src
#+srcname: hello-world-postfix
#+begin_src sh :exports none
echo "\-----------------------------------------------------------/"
#+end_src
: #+srcname: hello-world-postfix
: #+begin_src sh :exports none
: echo "\-----------------------------------------------------------/"
: #+end_src
The third block does have a =tangle= header argument indicating the
name of the file to which it should be written. It also has [[http://www.cs.tufts.edu/~nr/noweb/][Noweb]]
style references to the two previous source code blocks which will be
expanded during tangling to include them in the output file as well.
#+srcname: hello-world
#+begin_src sh :tangle hello :exports none
# <<hello-world-prefix>>
echo "| hello world |"
# <<hello-world-postfix>>
#+end_src
: #+srcname: hello-world
: #+begin_src sh :tangle hello :exports none
: # <<hello-world-prefix>>
: echo "| hello world |"
: # <<hello-world-postfix>>
: #+end_src
Calling =org-babel-tangle= will result in the following being written
to the =hello.sh= file.
#+srcname: hello-world-output
#+begin_src sh
#!/usr/bin/env sh
# generated by org-babel-tangle
# [[file:~/src/org-babel/org-babel-worg.org::#literate-programming-example][block-16]]
# <<hello-world-prefix>>
echo "/-----------------------------------------------------------\\"
echo "| hello world |"
# <<hello-world-postfix>>
echo "\-----------------------------------------------------------/"
# block-16 ends here
#+end_src
*** Emacs Initialization with Org-babel
Org-babel has special support for embedding your emacs initialization
into Org-mode files. The =org-babel-load-file= function can be used
to load the emacs lisp embedded in a literate Org-mode file in the
same way that you might load a regular elisp file.
This allows you to have all the niceness of Org-mode (folding, tags,
notes, html export, etc...) available in your emacs initialization.
To try this out either see the simple [[literate-emacs-init][Literate Emacs Initialization]]
example directly below, or check out the Org-babel Literate
Programming version of Phil Hagelberg's excellent [[http://github.com/technomancy/emacs-starter-kit/tree/master][emacs-starter-kit]]
available at [[http://github.com/eschulte/emacs-starter-kit/tree/master][Org-babel-emacs-starter-kit]].
***** Literate Emacs Initialization
:PROPERTIES:
:CUSTOM_ID: literate-emacs-init
:END:
For a simple example of usage follow these 4 steps.
1) create a directory named =.emacs.d= in the base of your home
directory.
#+begin_src sh
mkdir ~/.emacs.d
#+end_src
2) checkout the latest versions of Org-mode and Org-babel into the src
subdirectory of this new directory
#+begin_src sh
cd ~/.emacs.d
mkdir src
cd src
git clone git://repo.or.cz/org-mode.git
git clone git://github.com/eschulte/org-babel.git
#+end_src
3) place the following in a file called =init.el= in your emacs
initialization directory (=~/.emacs.d=).
#+srcname: emacs-init
#+begin_src emacs-lisp
;;; init.el --- Where all the magic begins
;;
;; This file loads both
;; - Org-mode : http://orgmode.org/ and
;; - Org-babel: http://eschulte.github.com/org-babel/
;;
;; It then loads the rest of our Emacs initialization from Emacs lisp
;; embedded in literate Org-mode files.
;; Load up Org Mode and Org Babel for elisp embedded in Org Mode files
(setq dotfiles-dir (file-name-directory (or (buffer-file-name) load-file-name)))
(add-to-list 'load-path (expand-file-name
"lisp" (expand-file-name
"org" (expand-file-name
"src" dotfiles-dir))))
(add-to-list 'load-path (expand-file-name
"lisp" (expand-file-name
"org-babel" (expand-file-name
"src" dotfiles-dir))))
(require 'org-babel-init)
;; load up all literate org-mode files in this directory
(mapc #'org-babel-load-file (directory-files dotfiles-dir t "\\.org$"))
;;; init.el ends here
#+end_src
4) Implement all of your emacs customizations inside of elisp
source-code blocks located in Org-mode files in this directory.
They will be loaded by emacs on startup.
* Reference / Documentation
:PROPERTIES:
:CUSTOM_ID: reference-and-documentation
:END:
*** Languages
The following can be added to your .emacs and used to activate
languages. It includes a brief list of the requirements for each
language. *Note*: this also serves as the list of languages
currently supported by Org-babel.
#+begin_src emacs-lisp
;; Uncomment each of the following require lines if you want org-babel
;; to support that language. Each language has a comment explaining
;; it's dependencies. See the related files in lisp/langs for more
;; detailed explanations of requirements.
;; (require 'org-babel-R) ;; R and ess-mode
;; (require 'org-babel-asymptote) ;; asymptote
;; (require 'org-babel-css) ;; none
;; (require 'org-babel-ditaa) ;; ditaa
;; (require 'org-babel-dot) ;; dot
;; (require 'org-babel-gnuplot) ;; gnuplot, and gnuplot-mode
;; (require 'org-babel-haskell) ;; haskell, haskell-mode, inf-haskell
;; (require 'org-babel-ocaml) ;; ocaml, and tuareg-mode
;; (require 'org-babel-python) ;; python, and python-mode
;; (require 'org-babel-ruby) ;; ruby, irb, ruby-mode, and inf-ruby
;; (require 'org-babel-sass) ;; sass, sass-mode
;; (require 'org-babel-sql) ;; none
#+end_src
*** Header Arguments
:PROPERTIES:
:CUSTOM_ID: header-arguments
:END:
- results :: results arguments specify what should be done with the
output of source-code blocks
- The following options are mutually exclusive, and specify how the
results should be collected from the source-code block
- value ::
- output ::
- The following options are mutually exclusive and specify what type
of results the code block will return
- vector :: specifies that the results should be interpreted as a
multidimensional vector (even if the vector is
trivial), and will be inserted into the org-mode file
as a table
- scalar :: specifies that the results should be interpreted as a
scalar value, and will be inserted into the org-mode
file as quoted text
- file :: specifies that the results should be interpreted as the
path to a file, and will be inserted into the org-mode
file as a link
- The following options specify how the results should be inserted
into the org-mode file
- replace :: the current results replace any previously inserted
results from the code block
- silent :: rather than being inserted into the org-mode file the
results are echoed into the message bar
- exports :: exports arguments specify what should be included in html
or latex exports of the org-mode file
- code :: the body of code is included into the exported file
- results :: the results of evaluating the code is included in the
exported file
- both :: both the code and results are included in the exported
file
- none :: nothing is included in the exported file
- tangle :: tangle arguments specify whether or not the source-code
block should be included in tangled extraction of
source-code files
- yes :: the source-code block is exported to a source-code file
named after the basename (name w/o extension) of the
org-mode file
- no :: (default) the source-code block is not exported to a
source-code file
- other :: any other string passed to the =tangle= header argument
is interpreted as a file basename to which the block will
be exported
*** Noweb reference syntax
The [[http://www.cs.tufts.edu/~nr/noweb/][Noweb]] Literate Programming system allows named blocks of code to
be referenced by using a =<<code-block-name>>= syntax. When a
document is tangled these references are replaced with the named code.
An example is provided in the [[literate-programming-example]] in this
document.
* Footnotes
[fn:1] Calling =C-c C-o= on a source-code block will open the
block's results in a separate buffer.

77
contrib/babel/publish-babel.org
View File

@ -1,77 +0,0 @@
#+TITLE: Tools for publishing Org-babel documentation
#+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
This defines the =org-babel-documentation= project, for ease of
publishing. Publish a project with =C-c C-e X=.
#+begin_src emacs-lisp :results silent
(setq org-babel-dir (file-name-directory (or load-file-name buffer-file-name)))
(unless (boundp 'org-publish-project-alist)
(setq org-publish-project-alist nil))
(setq org-publish-project-alist
(cons
`("org-babel-documentation"
:base-directory ,org-babel-dir
:base-extension "org"
:exclude ,(regexp-opt-group '("org-babel.org" "test-export.org" "test-tangle.org" "test-tangle-load.org"))
:publishing-directory ,(expand-file-name "doc" org-babel-dir)
:index-filename "org-babel-worg.org"
:auto-postamble nil
:style "<link rel=\"stylesheet\"href=\"stylesheet.css\"type=\"text/css\">"
:publishing-function (org-publish-org-to-html org-publish-org-to-org)
:plain-source t
:htmlized-source t)
org-publish-project-alist))
#+end_src
* org-babel-documentation stylesheet
Calling =org-babel-tangle= in this file will export the css file for
the Org-babel documentation.
#+begin_src sass :file doc/stylesheet.css :results silent
#logo
float: right
text-align: center
max-width: 240px
font-size: 8pt
margin-left: 1em
#attr
margin: -0.5em
#subtitle
float: center
text-align: center
#content
color: #2e2e2e
.outline-text-2
margin-left: 2em
.outline-text-3
margin-left: 2em
.outline-text-4
margin-left: 2em
.outline-text-5
margin-left: 2em
.outline-text-6
margin-left: 2em
h3
margin-left: 1em
color: #000
a
text-decoration: none
color: #4a708b
a:hover
text-decoration: underline
#+end_src

0
contrib/babel/org-babel-requirements.org → contrib/babel/requirements.org
View File

5
contrib/babel/snippets/org-mode/block
View File

@ -1,5 +0,0 @@
#name : #+begin_...#+end_
# --
#+begin_$1 $2
$0
#+end_$1

6
contrib/babel/snippets/org-mode/sb
View File

@ -1,6 +0,0 @@
#name : #+begin_src...#+end_src
# --
#+srcname: ${1:name}
#+begin_src ${2:language} $3
$0
#+end_src

60
contrib/babel/test-export.org
View File

@ -1,60 +0,0 @@
#+TITLE: Testing Org-Babel Export
#+OPTIONS: toc:2 ^:nil
* all
** full source blocks
*** ruby
source block is here, but is shouldn't be exported...
#+begin_src ruby :results silent :exports none
class Schulte
def initialize
puts :eric
end
end
#+end_src
The source block is here, and lets see the code
#+begin_src ruby :results silent :exports code
class Schulte
def initialize
puts :eric
end
end
#+end_src
This is a source block, and lets see the results
#+begin_src ruby :exports results :results replace
:the_results
#+end_src
lets see the source, and results for a ruby array
#+begin_src ruby :results replace
[1, 2, 3, 4].map{ |n| n * 2 }
#+end_src
*** emacs-lisp
a table
#+begin_src emacs-lisp
'(1 2 3 4 5)
#+end_src
hidden
#+begin_src emacs-lisp :exports none :results silent
9
#+end_src
** in-line source blocks
This is an inline source code block src_ruby{1 + 6}. And another
source block with text output src_emacs-lisp{"eric"}.

18
contrib/babel/test-tangle-load.org
View File

@ -1,18 +0,0 @@
#+TITLE: testing org-babel-load
#+OPTIONS: toc:nil num:nil ^:nil
* elisp blocks
** lets look at the order
#+begin_src emacs-lisp
(message "I'm the first")
#+end_src
#+begin_src emacs-lisp
(message "I'm the second")
#+end_src
#+begin_src emacs-lisp
(message "I'm the third")
#+end_src

108
contrib/babel/test-tangle.org
View File

@ -1,108 +0,0 @@
#+OPTIONS: toc:2 ^:nil
#+TITLE: Testing Org-Babel Tangling
* Some file
Some text here
#+BEGIN_SRC sh
echo "line 1"
echo "line 2"
#+END_SRC
more text
#+srcname: ruby-no-session
#+begin_src ruby
def hello
puts "hello world"
end
#+end_src
#+srcname: first-ruby-block
#+begin_src ruby :session special :tangle trivial-symbol
:block_the_first
#+end_src
#+srcname: ruby-with-noweb-references
#+begin_src ruby :tangle yes
# <<ruby-no-session>>
hello()
#+end_src
** Some subsection
#+BEGIN_SRC sh
echo "line 3"
echo "line 4"
#+END_SRC
blah blah blah
#+BEGIN_EXAMPLE
text line 1
text line 2
text line 3
#+END_EXAMPLE
more stuff
#+srcname: i-have-a-name
#+begin_src sh
echo "I have a name"
#+end_src
foo foo bar baz
#+BEGIN_SRC sh
echo "line 5"
echo "line 6"
#+END_SRC
** Ruby blocks
#+srcname: another-ruby-block
#+begin_src ruby :session special
holder = 98
#+end_src
#+srcname: ruby-plus-2
#+begin_src ruby :session special
def plus_two(n)
n + 2
end
#+end_src
#+srcname: final-ruby
#+begin_src ruby :session special
plus_two(holder)
#+end_src
** Emacs Lisp initialization stuff
#+srcname: lets-set-some-variables()
#+begin_src emacs-lisp
(setq test-tangle-loading "org-babel tangles")
(setq test-tangle-advert "use org-babel-tangle for all your emacs initialization files!!")
#+end_src
#+srcname: i-shouldnt-be-tangled
#+begin_src emacs-lisp :tangle no
(setq test-tangle-i-should-not-exist "hopefully I'm not included")
#+end_src
*** Emacs Lisp (not to be tangled)
:PROPERTIES:
:tangle: no
:END:
#+srcname: i-also-shouldnt-be-tangled
#+begin_src emacs-lisp
(setq test-tangle-me-either "i also shouldn't be tangled")
#+end_src

54
contrib/babel/lisp/org-babel-init.el → contrib/lisp/org-babel-init.el
View File

@ -29,30 +29,40 @@
;; for more information see the comments in org-babel.el
;;; Code:
(require 'cl)
(require 'org)
(require 'org-exp-blocks)
(require 'org-babel)
(require 'org-babel-ref)
(require 'org-babel-exp)
(require 'org-babel-table)
(require 'org-babel-comint)
(require 'org-babel-lob)
(require 'org-babel-tangle)
(let* ((babel-dir (expand-file-name
"lisp"
(expand-file-name
"babel"
(expand-file-name
".." (file-name-directory (or load-file-name buffer-file-name))))))
(langs-dir (expand-file-name "langs" babel-dir))
(load-path (append
(list babel-dir langs-dir)
(or load-path nil))))
;; language specific files
(add-to-list 'load-path (expand-file-name "langs" (file-name-directory (or load-file-name buffer-file-name))))
(require 'org-babel-lisp)
(require 'org-babel-sh)
;; org-babel core
(require 'cl)
(require 'org)
(require 'org-exp-blocks)
(require 'org-babel)
(require 'org-babel-ref)
(require 'org-babel-exp)
(require 'org-babel-table)
(require 'org-babel-comint)
(require 'org-babel-lob)
(require 'org-babel-tangle)
;; Library of babel
(defvar org-babel-lob-dir
(expand-file-name ".."
(file-name-directory
(or load-file-name buffer-file-name)))
"The directory holding the library-of-babel")
(defun org-babel-load-library-of-babel ()
(org-babel-lob-ingest (expand-file-name "library-of-babel.org" org-babel-lob-dir)))
;; org-babel languages
(require 'org-babel-lisp)
(require 'org-babel-sh)
;; Library of babel
(defvar org-babel-lob-dir
(expand-file-name ".." babel-dir)
"The directory holding the library-of-babel")
(defun org-babel-load-library-of-babel ()
(org-babel-lob-ingest (expand-file-name "library-of-babel.org" org-babel-lob-dir))))
(provide 'org-babel-init)
;;; org-babel-init.el ends here