From 10010aa3260ed8a8893361ed44449fcb6ed1e7c5 Mon Sep 17 00:00:00 2001 From: Dan Davison Date: Sun, 11 Apr 2010 22:10:17 -0400 Subject: [PATCH] Create texinfo node structures for new chapter --- doc/org.texi | 5 +++-- doc/source-code-chapter.texi | 25 +++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 1b3e078c2..c5b55957a 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -108,6 +108,7 @@ license to the document, as described in section 6 of the license. * Markup:: Prepare text for rich export * Exporting:: Sharing and publishing of notes * Publishing:: Create a web site of linked Org files +* Working With Source Code:: Using Org for literate programming, reproducible research and code evaluation. * Miscellaneous:: All the rest which did not fit elsewhere * Hacking:: How to hack your way around * MobileOrg:: Viewing and capture on a mobile device @@ -10330,7 +10331,7 @@ and the description from the body (limited to How this calendar is best read and updated, depends on the application you are using. The FAQ covers this issue. -@node Publishing, Miscellaneous, Exporting, Top +@node Publishing, Working With Source Code, Exporting, Top @chapter Publishing @cindex publishing @cindex O'Toole, David @@ -10844,7 +10845,7 @@ This may be necessary in particular if files include other files via @include source-code-chapter.texi -@node Miscellaneous, Hacking, Publishing, Top +@node Miscellaneous, Hacking, Working With Source Code, Top @chapter Miscellaneous @menu diff --git a/doc/source-code-chapter.texi b/doc/source-code-chapter.texi index 9cce3ccc3..dafe4365c 100644 --- a/doc/source-code-chapter.texi +++ b/doc/source-code-chapter.texi @@ -1,3 +1,6 @@ +@node Working With Source Code, Miscellaneous, Publishing, Top +@comment node-name, next, previous, up +@comment Working With Source Code, Miscellaneous, Publishing, Top @chapter ``Working With Source Code'' or ``Embedded Source Code'' Source code can be included in Org-mode documents using a @samp{src} block: @@ -25,8 +28,18 @@ Code execution, with results captured in the Org buffer (@ref{Evaluating Code Bl Using code blocks in table formulas @end itemize +@menu +* Structure of Code Blocks:: +* Editing Source Code:: +* Exporting Code Blocks:: +* Extracting Source Code:: +* Evaluating Code Blocks:: +@end menu +@node Structure of Code Blocks, Editing Source Code, Working With Source Code, Working With Source Code +@comment node-name, next, previous, up +@comment Structure of Code Blocks, Editing Source Code, Working With Source Code, Working With Source Code @section Structure of Code Blocks The basic structure of code blocks is as follows: @@ -52,6 +65,9 @@ FIXME link/relocate switches discussion in ``Literal examples'' section The code @end table +@node Editing Source Code, Exporting Code Blocks, Structure of Code Blocks, Working With Source Code +@comment node-name, next, previous, up +@comment Editing Source Code, Exporting Code Blocks, Structure of Code Blocks, Working With Source Code @section Editing Source Code Use @kbd{C-c '} to edit the code block at point. This brings up a @@ -80,10 +96,19 @@ By default, Org will ask before returning to an open edit buffer. Set to a non-nil value to switch without asking. @end table +@node Exporting Code Blocks, Extracting Source Code, Editing Source Code, Working With Source Code +@comment node-name, next, previous, up +@comment Exporting Code Blocks, Extracting Source Code, Editing Source Code, Working With Source Code @section Exporting Code Blocks +@node Extracting Source Code, Evaluating Code Blocks, Exporting Code Blocks, Working With Source Code +@comment node-name, next, previous, up +@comment Extracting Source Code, Evaluating Code Blocks, Exporting Code Blocks, Working With Source Code @section Extracting Source Code +@node Evaluating Code Blocks, , Extracting Source Code, Working With Source Code +@comment node-name, next, previous, up +@comment Evaluating Code Blocks, , Extracting Source Code, Working With Source Code @section Evaluating Code Blocks This syntax can be expanded by naming the source code block.