* [PATCH] use @result{} instead of --> (looks nicer) @ 2010-12-08 21:05 Brian Gough 2010-12-08 21:05 ` [PATCH] use macro for @LaTeX name Brian Gough 2011-01-26 17:33 ` [Accepted] use @result{} instead of --> (looks nicer) Bastien Guerry 0 siblings, 2 replies; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 54 +++++++++++++++++++++++++++--------------------------- 1 files changed, 27 insertions(+), 27 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 7df03fe..94a4290 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -5304,20 +5304,20 @@ various inputs will be interpreted, the items filled in by Org-mode are in @b{bold}. @example -3-2-5 --> 2003-02-05 -2/5/3 --> 2003-02-05 -14 --> @b{2006}-@b{06}-14 -12 --> @b{2006}-@b{07}-12 -2/5 --> @b{2007}-02-05 -Fri --> nearest Friday (default date or later) -sep 15 --> @b{2006}-09-15 -feb 15 --> @b{2007}-02-15 -sep 12 9 --> 2009-09-12 -12:45 --> @b{2006}-@b{06}-@b{13} 12:45 -22 sept 0:34 --> @b{2006}-09-22 0:34 -w4 --> ISO week for of the current year @b{2006} -2012 w4 fri --> Friday of ISO week 4 in 2012 -2012-w04-5 --> Same as above +3-2-5 @result{} 2003-02-05 +2/5/3 @result{} 2003-02-05 +14 @result{} @b{2006}-@b{06}-14 +12 @result{} @b{2006}-@b{07}-12 +2/5 @result{} @b{2007}-02-05 +Fri @result{} nearest Friday (default date or later) +sep 15 @result{} @b{2006}-09-15 +feb 15 @result{} @b{2007}-02-15 +sep 12 9 @result{} 2009-09-12 +12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45 +22 sept 0:34 @result{} @b{2006}-09-22 0:34 +w4 @result{} ISO week for of the current year @b{2006} +2012 w4 fri @result{} Friday of ISO week 4 in 2012 +2012-w04-5 @result{} Same as above @end example Furthermore you can specify a relative date by giving, as the @@ -5329,13 +5329,13 @@ a single letter, you use the abbreviation of day name, the date will be the Nth such day. E.g. @example -+0 --> today -. --> today -+4d --> four days from today -+4 --> same as above -+2w --> two weeks from today -++5 --> five days from default date -+2tue --> second Tuesday from now. ++0 @result{} today +. @result{} today ++4d @result{} four days from today ++4 @result{} same as above ++2w @result{} two weeks from today +++5 @result{} five days from default date ++2tue @result{} second Tuesday from now. @end example @vindex parse-time-months @@ -5349,9 +5349,9 @@ start time and a duration (in HH:MM format). Use `-' or `-{}-' as the separator in the former case and use '+' as the separator in the latter case. E.g. @example -11am-1:15pm --> 11:00-13:15 -11am--1:15pm --> same as above -11am+2:15 --> same as above +11am-1:15pm @result{} 11:00-13:15 +11am--1:15pm @result{} same as above +11am+2:15 @result{} same as above @end example @cindex calendar, for selecting date @@ -13295,9 +13295,9 @@ Org will move the following key bindings in Org files, and in the agenda buffer (but not during date selection). @example -S-UP -> M-p S-DOWN -> M-n -S-LEFT -> M-- S-RIGHT -> M-+ -C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+ +S-UP @result{} M-p S-DOWN @result{} M-n +S-LEFT @result{} M-- S-RIGHT @result{} M-+ +C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+ @end example @vindex org-disputed-keys -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] use macro for @LaTeX name 2010-12-08 21:05 [PATCH] use @result{} instead of --> (looks nicer) Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] make use of the provided @ie and @eg macros to fix the spacing Brian Gough 2011-01-26 17:33 ` [Accepted] use @result{} instead of --> (looks nicer) Bastien Guerry 1 sibling, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 254 +++++++++++++++++++++++++++++----------------------------- 1 files changed, 127 insertions(+), 127 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 94a4290..4b4163e 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -556,7 +556,7 @@ Structural markup elements * Horizontal rules:: Make a line * Comment lines:: What will *not* be exported -Embedded La@TeX{} +Embedded @LaTeX{} * Special symbols:: Greek letters and other symbols * Subscripts and superscripts:: Simple syntax for raising/lowering text @@ -571,7 +571,7 @@ Exporting * The export dispatcher:: How to access exporter commands * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding * HTML export:: Exporting to HTML -* LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF +* LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF * DocBook export:: Exporting to DocBook * TaskJuggler export:: Exporting to TaskJuggler * Freemind export:: Exporting to Freemind mind maps @@ -590,13 +590,13 @@ HTML export * CSS support:: Changing the appearance of the output * JavaScript support:: Info and Folding in a web browser -La@TeX{} and PDF export +@LaTeX{} and PDF export * LaTeX/PDF export commands:: Which key invokes which commands * Header and sectioning:: Setting up the export file structure -* Quoting LaTeX code:: Incorporating literal La@TeX{} code -* Tables in LaTeX export:: Options for exporting tables to La@TeX{} -* Images in LaTeX export:: How to insert figures into La@TeX{} output +* Quoting LaTeX code:: Incorporating literal @LaTeX{} code +* Tables in LaTeX export:: Options for exporting tables to @LaTeX{} +* Images in LaTeX export:: How to insert figures into @LaTeX{} output * Beamer class export:: Turning the file into a presentation DocBook export @@ -707,7 +707,7 @@ Hacking * Add-on packages:: Available extensions * Adding hyperlink types:: New custom link types * Context-sensitive commands:: How to add functionality to such commands -* Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs +* Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs * Dynamic blocks:: Automatically filled blocks * Special agenda views:: Customized views * Extracting agenda information:: Postprocessing of agenda information @@ -775,7 +775,7 @@ documentation, and tangling. Org's automatic, context-sensitive table editor with spreadsheet capabilities can be integrated into any major mode by activating the minor Orgtbl mode. Using a translation step, it can be used to maintain -tables in arbitrary file types, for example in La@TeX{}. The structure +tables in arbitrary file types, for example in @LaTeX{}. The structure editing and list creation capabilities can be used outside Org with the minor Orgstruct mode. @@ -792,7 +792,7 @@ ends, for example: @r{@bullet{} a full agenda and planner with deadlines and work scheduling} @pindex GTD, Getting Things Done @r{@bullet{} an environment in which to implement David Allen's GTD system} -@r{@bullet{} a simple hypertext system, with HTML and La@TeX{} export} +@r{@bullet{} a simple hypertext system, with HTML and @LaTeX{} export} @r{@bullet{} a publishing tool to create a set of interlinked webpages} @r{@bullet{} an environment for literate programming} @end example @@ -1725,7 +1725,7 @@ larger document, not only for one-off documents like emails. The basic syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is defined in a paragraph that is started by a footnote marker in square brackets in column 0, no indentation allowed. If you need a paragraph break -inside a footnote, use the La@TeX{} idiom @samp{\par}. The footnote reference +inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference is simply the marker in square brackets, inside text. For example: @example @@ -1737,7 +1737,7 @@ The Org homepage[fn:1] now looks a lot better than it used to. Org-mode extends the number-based syntax to @emph{named} footnotes and optional inline definition. Using plain numbers as markers (as @file{footnote.el} does) is supported for backward compatibility, but not -encouraged because of possible conflicts with La@TeX{} snippets (@pxref{Embedded +encouraged because of possible conflicts with @LaTeX{} snippets (@pxref{Embedded LaTeX}). Here are the valid references: @table @code @@ -1749,7 +1749,7 @@ snippet. A named footnote reference, where @code{name} is a unique label word, or, for simplicity of automatic creation, a number. @item [fn:: This is the inline definition of this footnote] -A La@TeX{}-like anonymous footnote where the definition is given directly at the +A @LaTeX{}-like anonymous footnote where the definition is given directly at the reference point. @item [fn:name: a definition] An inline definition of a footnote, which also specifies a name for the note. @@ -2197,7 +2197,7 @@ example in mail mode, use Furthermore, with some special setup, it is possible to maintain tables in arbitrary syntax with Orgtbl mode. For example, it is possible to -construct La@TeX{} tables with the underlying ease and power of +construct @LaTeX{} tables with the underlying ease and power of Orgtbl mode, including spreadsheet capabilities. For details, see @ref{Tables in arbitrary syntax}. @@ -8468,7 +8468,7 @@ the agenda). When exporting Org-mode documents, the exporter tries to reflect the structure of the document as accurately as possible in the backend. Since -export targets like HTML, La@TeX{}, or DocBook allow much richer formatting, +export targets like HTML, @LaTeX{}, or DocBook allow much richer formatting, Org-mode has rules on how to prepare text for rich export. This section summarizes the markup rules used in an Org-mode buffer. @@ -8564,7 +8564,7 @@ the table of contents entirely, by configuring the variable Org-mode normally exports the text before the first headline, and even uses the first line as the document title. The text will be fully marked up. If -you need to include literal HTML, La@TeX{}, or DocBook code, use the special +you need to include literal HTML, @LaTeX{}, or DocBook code, use the special constructs described below in the sections for the individual exporters. @vindex org-export-skip-text-before-1st-heading @@ -8705,7 +8705,7 @@ the object with @code{\ref@{tab:basic-data@}}: @end example @cindex inlined images, markup rules -Some backends (HTML, La@TeX{}, and DocBook) allow you to directly include +Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include images into the exported document. Org does this, if a link to an image files does not have a description part, for example @code{[[./img/a.jpg]]}. If you wish to define a caption for the image and maybe a label for internal @@ -8756,16 +8756,16 @@ If the example is source code from a programming language, or any other text that can be marked up by font-lock in Emacs, you can ask for the example to look like the fontified Emacs buffer@footnote{This works automatically for the HTML backend (it requires version 1.34 of the @file{htmlize.el} package, -which is distributed with Org). Fontified code chunks in LaTeX can be +which is distributed with Org). Fontified code chunks in @LaTeX{} can be achieved using either the listings or the @url{http://code.google.com/p/minted, minted,} package. To use listings, turn on the variable @code{org-export-latex-listings} and ensure that the listings -package is included by the LaTeX header (e.g. by configuring +package is included by the @LaTeX{} header (e.g. by configuring @code{org-export-latex-packages-alist}). See the listings documentation for configuration options, including obtaining colored output. For minted it is necessary to install the program @url{http://pygments.org, pygments}, in addition to setting @code{org-export-latex-minted}, ensuring that the minted -package is included by the LaTeX header, and ensuring that the +package is included by the @LaTeX{} header, and ensuring that the @code{-shell-escape} option is passed to @file{pdflatex} (see @code{org-latex-to-pdf-process}). See the documentation of the variables @code{org-export-latex-listings} and @code{org-export-latex-minted} for @@ -8919,18 +8919,18 @@ construct complex HTML code. @node Embedded LaTeX, , Macro replacement, Markup -@section Embedded La@TeX{} +@section Embedded @LaTeX{} @cindex @TeX{} interpretation -@cindex La@TeX{} interpretation +@cindex @LaTeX{} interpretation Plain ASCII is normally sufficient for almost all note taking. One exception, however, are scientific notes which need to be able to contain -mathematical symbols and the occasional formula. La@TeX{}@footnote{La@TeX{} +mathematical symbols and the occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on Donald E. Knuth's @TeX{} system. Many of the -features described here as ``La@TeX{}'' are really from @TeX{}, but for +features described here as ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this distinction.} is widely used to typeset -scientific documents. Org-mode supports embedding La@TeX{} code into its -files, because many academics are used to writing and reading La@TeX{} source +scientific documents. Org-mode supports embedding @LaTeX{} code into its +files, because many academics are used to writing and reading @LaTeX{} source code, and because it can be readily processed to produce pretty output for a number of export backends. @@ -8947,14 +8947,14 @@ number of export backends. @cindex math symbols @cindex special symbols @cindex @TeX{} macros -@cindex La@TeX{} fragments, markup rules +@cindex @LaTeX{} fragments, markup rules @cindex HTML entities -@cindex La@TeX{} entities +@cindex @LaTeX{} entities -You can use La@TeX{} macros to insert special symbols like @samp{\alpha} to +You can use @LaTeX{} macros to insert special symbols like @samp{\alpha} to indicate the Greek letter, or @samp{\to} to indicate an arrow. Completion for these macros is available, just type @samp{\} and maybe a few letters, -and press @kbd{M-@key{TAB}} to see possible completions. Unlike La@TeX{} +and press @kbd{M-@key{TAB}} to see possible completions. Unlike @LaTeX{} code, Org-mode allows these macros to be present without surrounding math delimiters, for example: @@ -8965,13 +8965,13 @@ Angles are written as Greek letters \alpha, \beta and \gamma. @vindex org-entities During export, these symbols will be transformed into the native format of the exporter backend. Strings like @code{\alpha} will be exported as -@code{α} in the HTML output, and as @code{$\alpha$} in the La@TeX{} +@code{α} in the HTML output, and as @code{$\alpha$} in the @LaTeX{} output. Similarly, @code{\nbsp} will become @code{ } in HTML and -@code{~} in La@TeX{}. If you need such a symbol inside a word, terminate it +@code{~} in @LaTeX{}. If you need such a symbol inside a word, terminate it like this: @samp{\Aacute@{@}stor}. A large number of entities is provided, with names taken from both HTML and -La@TeX{}, see the variable @code{org-entities} for the complete list. +@LaTeX{}, see the variable @code{org-entities} for the complete list. @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and @samp{...} are all converted into special commands creating hyphens of different lengths or a compact set of dots. @@ -8994,7 +8994,7 @@ for display purposes only. @cindex subscript @cindex superscript -Just like in La@TeX{}, @samp{^} and @samp{_} are used to indicate super- +Just like in @LaTeX{}, @samp{^} and @samp{_} are used to indicate super- and subscripts. Again, these can be used without embedding them in math-mode delimiters. To increase the readability of ASCII text, it is not necessary (but OK) to surround multi-character sub- and superscripts @@ -9028,13 +9028,13 @@ format sub- and superscripts in a WYSIWYM way. @end table @node LaTeX fragments, Previewing LaTeX fragments, Subscripts and superscripts, Embedded LaTeX -@subsection La@TeX{} fragments -@cindex La@TeX{} fragments +@subsection @LaTeX{} fragments +@cindex @LaTeX{} fragments @vindex org-format-latex-header Going beyond symbols and sub- and superscripts, a full formula language is -needed. Org-mode can contain La@TeX{} math fragments, and it supports ways -to process these for several export backends. When exporting to La@TeX{}, +needed. Org-mode can contain @LaTeX{} math fragments, and it supports ways +to process these for several export backends. When exporting to @LaTeX{}, the code is obviously left as it is. When exporting to HTML, Org invokes the @uref{http://www.mathjax.org, MathJax library} (@pxref{Math formatting in HTML export}) to process and display the math@footnote{If you plan to use @@ -9042,24 +9042,24 @@ this regularly or on pages with significant page views, you should install @file{MathJax} on your own server in order to limit the load of our server.}. Finally, it can also process the mathematical expressions into images@footnote{For this to work -you need to be on a system with a working La@TeX{} installation. You also +you need to be on a system with a working @LaTeX{} installation. You also need the @file{dvipng} program, available at -@url{http://sourceforge.net/projects/dvipng/}. The La@TeX{} header that will +@url{http://sourceforge.net/projects/dvipng/}. The @LaTeX{} header that will be used when processing a fragment can be configured with the variable @code{org-format-latex-header}.} that can be displayed in a browser or in DocBook documents. -La@TeX{} fragments don't need any special marking at all. The following -snippets will be identified as La@TeX{} source code: +@LaTeX{} fragments don't need any special marking at all. The following +snippets will be identified as @LaTeX{} source code: @itemize @bullet @item Environments of any kind@footnote{When @file{MathJax} is used, only the environment recognized by @file{MathJax} will be processed. When dvipng is -used to create images, any La@TeX{} environments will be handled.}. The only +used to create images, any @LaTeX{} environments will be handled.}. The only requirement is that the @code{\begin} statement appears on a new line, preceded by only whitespace. @item -Text within the usual La@TeX{} math delimiters. To avoid conflicts with +Text within the usual @LaTeX{} math delimiters. To avoid conflicts with currency specifications, single @samp{$} characters are only recognized as math delimiters if the enclosed text contains at most two line breaks, is directly attached to the @samp{$} characters with no whitespace in between, @@ -9083,7 +9083,7 @@ either $$ a=+\sqrt@{2@} $$ or \[ a=-\sqrt@{2@} \]. @vindex org-format-latex-options If you need any of the delimiter ASCII sequences for other purposes, you can configure the option @code{org-format-latex-options} to deselect the -ones you do not wish to have interpreted by the La@TeX{} converter. +ones you do not wish to have interpreted by the @LaTeX{} converter. @vindex org-export-with-LaTeX-fragments LaTeX processing can be configured with the variable @@ -9095,21 +9095,21 @@ of these lines: @example #+OPTIONS: LaTeX:t @r{Do the right thing automatically (MathJax)} #+OPTIONS: LaTeX:dvipng @r{Force using dvipng images} -#+OPTIONS: LaTeX:nil @r{Do not process La@TeX{} fragments at all} +#+OPTIONS: LaTeX:nil @r{Do not process @LaTeX{} fragments at all} #+OPTIONS: LaTeX:verbatim @r{Verbatim export, for jsMath or so} @end example @node Previewing LaTeX fragments, CDLaTeX mode, LaTeX fragments, Embedded LaTeX -@subsection Previewing LaTeX fragments +@subsection Previewing @LaTeX{} fragments @cindex LaTeX fragments, preview -If you have @file{dvipng} installed, La@TeX{} fragments can be processed to +If you have @file{dvipng} installed, @LaTeX{} fragments can be processed to produce preview images of the typeset expressions: @table @kbd @kindex C-c C-x C-l @item C-c C-x C-l -Produce a preview image of the La@TeX{} fragment at point and overlay it +Produce a preview image of the @LaTeX{} fragment at point and overlay it over the source code. If there is no fragment at point, process all fragments in the current entry (between two headlines). When called with a prefix argument, process the entire subtree. When called with @@ -9131,7 +9131,7 @@ preview images. @cindex CDLa@TeX{} CDLa@TeX{} mode is a minor mode that is normally used in combination with a -major La@TeX{} mode like AUC@TeX{} in order to speed-up insertion of +major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of environments and math templates. Inside Org-mode, you can make use of some of the features of CDLa@TeX{} mode. You need to install @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with @@ -9154,7 +9154,7 @@ Environment templates can be inserted with @kbd{C-c @{}. @item @kindex @key{TAB} The @key{TAB} key will do template expansion if the cursor is inside a -La@TeX{} fragment@footnote{Org-mode has a method to test if the cursor is +@LaTeX{} fragment@footnote{Org-mode has a method to test if the cursor is inside such a fragment, see the documentation of the function @code{org-inside-LaTeX-fragment-p}.}. For example, @key{TAB} will expand @code{fr} to @code{\frac@{@}@{@}} and position the cursor @@ -9168,7 +9168,7 @@ To get a list of all abbreviations, type @kbd{M-x cdlatex-command-help}. @kindex _ @kindex ^ @vindex cdlatex-simplify-sub-super-scripts -Pressing @kbd{_} and @kbd{^} inside a La@TeX{} fragment will insert these +Pressing @kbd{_} and @kbd{^} inside a @LaTeX{} fragment will insert these characters together with a pair of braces. If you use @key{TAB} to move out of the braces, and if the braces surround only a single character or macro, they are removed again (depending on the variable @@ -9176,14 +9176,14 @@ macro, they are removed again (depending on the variable @item @kindex ` Pressing the backquote @kbd{`} followed by a character inserts math -macros, also outside La@TeX{} fragments. If you wait more than 1.5 seconds +macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds after the backquote, a help window will pop up. @item @kindex ' Pressing the single-quote @kbd{'} followed by another character modifies the symbol before point with an accent or a font. If you wait more than 1.5 seconds after the single-quote, a help window will pop up. Character -modification will work only inside La@TeX{} fragments, outside the quote +modification will work only inside @LaTeX{} fragments, outside the quote is normal. @end itemize @@ -9195,8 +9195,8 @@ Org-mode documents can be exported into a variety of other formats. For printing and sharing of notes, ASCII export produces a readable and simple version of an Org file. HTML export allows you to publish a notes file on the web, while the XOXO format provides a solid base for exchange with a -broad range of other applications. La@TeX{} export lets you use Org-mode and -its structured editing functions to easily create La@TeX{} files. DocBook +broad range of other applications. @LaTeX{} export lets you use Org-mode and +its structured editing functions to easily create @LaTeX{} files. DocBook export makes it possible to convert Org files to many other formats using DocBook tools. For project management you can create gantt and resource charts by using TaskJuggler export. To incorporate entries with associated @@ -9213,7 +9213,7 @@ enabled (default in Emacs 23). * The export dispatcher:: How to access exporter commands * ASCII/Latin-1/UTF-8 export:: Exporting to flat files with encoding * HTML export:: Exporting to HTML -* LaTeX and PDF export:: Exporting to La@TeX{}, and processing to PDF +* LaTeX and PDF export:: Exporting to @LaTeX{}, and processing to PDF * DocBook export:: Exporting to DocBook * TaskJuggler export:: Exporting to TaskJuggler * Freemind export:: Exporting to Freemind mind maps @@ -9320,7 +9320,7 @@ settings. Here you can: @cindex special strings @cindex emphasized text @cindex @TeX{} macros -@cindex La@TeX{} fragments +@cindex @LaTeX{} fragments @cindex author info, in export @cindex time info, in export @example @@ -9342,7 +9342,7 @@ tags: @r{turn on/off inclusion of tags, may also be @code{not-in-toc}} <: @r{turn on/off inclusion of any time/date stamps like DEADLINES} *: @r{turn on/off emphasized text (bold, italic, underlined)} TeX: @r{turn on/off simple @TeX{} macros in plain text} -LaTeX: @r{configure export of La@TeX{} fragments. Default @code{auto}} +LaTeX: @r{configure export of @LaTeX{} fragments. Default @code{auto}} skip: @r{turn on/off skipping the text before the first heading} author: @r{turn on/off inclusion of author name/email into exported file} email: @r{turn on/off inclusion of author email into exported file} @@ -9351,9 +9351,9 @@ timestamp: @r{turn on/off inclusion creation time into exported file} d: @r{turn on/off inclusion of drawers} @end example @noindent -These options take effect in both the HTML and La@TeX{} export, except for +These options take effect in both the HTML and @LaTeX{} export, except for @code{TeX} and @code{LaTeX}, which are respectively @code{t} and @code{nil} -for the La@TeX{} export. The default values for these and many other options +for the @LaTeX{} export. The default values for these and many other options are given by a set of variables. For a list of such variables, the corresponding OPTIONS keys and also the publishing keys (@pxref{Project alist}), see the constant @code{org-export-plist-vars}. @@ -9635,7 +9635,7 @@ and you could use @code{http} addresses just as well. @cindex MathJax @cindex dvipng -La@TeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two +@LaTeX{} math snippets (@pxref{LaTeX fragments}) can be displayed in two different ways on HTML pages. The default is to use the @uref{http://www.mathjax.org, MathJax system} which should work out of the box with Org mode installation because @code{http://orgmode.org} serves @@ -9656,7 +9656,7 @@ insert something like the following into the buffer: @code{org-export-html-mathjax-options} for the meaning of the parameters in this line. -If you prefer, you can also request that La@TeX{} are processed into small +If you prefer, you can also request that @LaTeX{} are processed into small images that will be inserted into the browser page. Before the availability of MathJax, this was the default method for Org files. This method requires that the @file{dvipng} program is available on your system. You can still @@ -9832,32 +9832,32 @@ You can choose default values for these options by customizing the variable pages, configure the variable @code{org-export-html-use-infojs}. @node LaTeX and PDF export, DocBook export, HTML export, Exporting -@section La@TeX{} and PDF export -@cindex La@TeX{} export +@section @LaTeX{} and PDF export +@cindex @LaTeX{} export @cindex PDF export @cindex Guerry, Bastien -Org-mode contains a La@TeX{} exporter written by Bastien Guerry. With -further processing@footnote{The default LaTeX output is designed for +Org-mode contains a @LaTeX{} exporter written by Bastien Guerry. With +further processing@footnote{The default @LaTeX{} output is designed for processing with pdftex or latex. It includes packages that are not compatible with xetex and possibly luatex. See the variables @code{org-export-latex-default-packages-alist} and @code{org-export-latex-packages-alist}.}, this backend is also used to -produce PDF output. Since the La@TeX{} output uses @file{hyperref} to +produce PDF output. Since the @LaTeX{} output uses @file{hyperref} to implement links and cross references, the PDF output file will be fully linked. @menu * LaTeX/PDF export commands:: Which key invokes which commands * Header and sectioning:: Setting up the export file structure -* Quoting LaTeX code:: Incorporating literal La@TeX{} code -* Tables in LaTeX export:: Options for exporting tables to La@TeX{} -* Images in LaTeX export:: How to insert figures into La@TeX{} output +* Quoting LaTeX code:: Incorporating literal @LaTeX{} code +* Tables in LaTeX export:: Options for exporting tables to @LaTeX{} +* Images in LaTeX export:: How to insert figures into @LaTeX{} output * Beamer class export:: Turning the file into a presentation @end menu @node LaTeX/PDF export commands, Header and sectioning, LaTeX and PDF export, LaTeX and PDF export -@subsection La@TeX{} export commands +@subsection @LaTeX{} export commands @cindex region, active @cindex active region @@ -9865,7 +9865,7 @@ linked. @table @kbd @orgcmd{C-c C-e l,org-export-as-latex} @cindex property EXPORT_FILE_NAME -Export as La@TeX{} file @file{myfile.tex}. For an Org file +Export as @LaTeX{} file @file{myfile.tex}. For an Org file @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will be overwritten without warning. If there is an active region@footnote{This requires @code{transient-mark-mode} be turned on.}, only the region will be @@ -9878,16 +9878,16 @@ Export to a temporary buffer, do not create a file. @item C-c C-e v l/L Export only the visible part of the document. @item M-x org-export-region-as-latex -Convert the region to La@TeX{} under the assumption that it was Org-mode +Convert the region to @LaTeX{} under the assumption that it was Org-mode syntax before. This is a global command that can be invoked in any buffer. @item M-x org-replace-region-by-latex -Replace the active region (assumed to be in Org-mode syntax) by La@TeX{} +Replace the active region (assumed to be in Org-mode syntax) by @LaTeX{} code. @orgcmd{C-c C-e p,org-export-as-pdf} -Export as La@TeX{} and then process to PDF. +Export as @LaTeX{} and then process to PDF. @orgcmd{C-c C-e d,org-export-as-pdf-and-open} -Export as La@TeX{} and then process to PDF, then open the resulting PDF file. +Export as @LaTeX{} and then process to PDF, then open the resulting PDF file. @end table @cindex headline levels, for exporting @@ -9910,13 +9910,13 @@ creates two levels of headings and does the rest as items. @node Header and sectioning, Quoting LaTeX code, LaTeX/PDF export commands, LaTeX and PDF export @subsection Header and sectioning structure -@cindex La@TeX{} class -@cindex La@TeX{} sectioning structure -@cindex La@TeX{} header +@cindex @LaTeX{} class +@cindex @LaTeX{} sectioning structure +@cindex @LaTeX{} header @cindex header, for LaTeX files @cindex sectioning structure, for LaTeX export -By default, the La@TeX{} output uses the class @code{article}. +By default, the @LaTeX{} output uses the class @code{article}. @vindex org-export-latex-default-class @vindex org-export-latex-classes @@ -9943,12 +9943,12 @@ header. See the docstring of @code{org-export-latex-classes} for more information. @node Quoting LaTeX code, Tables in LaTeX export, Header and sectioning, LaTeX and PDF export -@subsection Quoting La@TeX{} code +@subsection Quoting @LaTeX{} code -Embedded La@TeX{} as described in @ref{Embedded LaTeX}, will be correctly -inserted into the La@TeX{} file. This includes simple macros like +Embedded @LaTeX{} as described in @ref{Embedded LaTeX}, will be correctly +inserted into the @LaTeX{} file. This includes simple macros like @samp{\ref@{LABEL@}} to create a cross reference to a figure. Furthermore, -you can add special code that should only be present in La@TeX{} export with +you can add special code that should only be present in @LaTeX{} export with the following constructs: @cindex #+LaTeX @@ -9968,10 +9968,10 @@ All lines between these markers are exported literally @node Tables in LaTeX export, Images in LaTeX export, Quoting LaTeX code, LaTeX and PDF export -@subsection Tables in La@TeX{} export -@cindex tables, in La@TeX{} export +@subsection Tables in @LaTeX{} export +@cindex tables, in @LaTeX{} export -For La@TeX{} export of a table, you can specify a label and a caption +For @LaTeX{} export of a table, you can specify a label and a caption (@pxref{Images and tables}). You can also use the @code{ATTR_LaTeX} line to request a @code{longtable} environment for the table, so that it may span several pages, or provide the @code{multicolumn} keyword that will make the @@ -9991,13 +9991,13 @@ Finally, you can set the alignment string: @node Images in LaTeX export, Beamer class export, Tables in LaTeX export, LaTeX and PDF export -@subsection Images in La@TeX{} export -@cindex images, inline in La@TeX{} -@cindex inlining images in La@TeX{} +@subsection Images in @LaTeX{} export +@cindex images, inline in @LaTeX{} +@cindex inlining images in @LaTeX{} Images that are linked to without a description part in the link, like @samp{[[file:img.jpg]]} or @samp{[[./img.jpg]]} will be inserted into the PDF -output file resulting from La@TeX{} processing. Org will use an +output file resulting from @LaTeX{} processing. Org will use an @code{\includegraphics} macro to insert the image. If you have specified a caption and/or a label as described in @ref{Images and tables}, the figure will be wrapped into a @code{figure} environment and thus become a floating @@ -10028,16 +10028,16 @@ for @code{\includegraphics} and @code{wrapfigure}. @end example If you need references to a label created in this way, write -@samp{\ref@{fig:SED-HR4049@}} just like in La@TeX{}. +@samp{\ref@{fig:SED-HR4049@}} just like in @LaTeX{}. @node Beamer class export, , Images in LaTeX export, LaTeX and PDF export @subsection Beamer class export -The LaTeX class @file{beamer} allows production of high quality presentations -using LaTeX and pdf processing. Org-mode has special support for turning an +The @LaTeX{} class @file{beamer} allows production of high quality presentations +using @LaTeX{} and pdf processing. Org-mode has special support for turning an Org-mode file or tree into a @file{beamer} presentation. -When the LaTeX class for the current buffer (as set with @code{#+LaTeX_CLASS: +When the @LaTeX{} class for the current buffer (as set with @code{#+LaTeX_CLASS: beamer}) or subtree (set with a @code{LaTeX_CLASS} property) is @code{beamer}, a special export mode will turn the file or tree into a beamer presentation. Any tree with not-too-deep level nesting should in principle be @@ -10365,7 +10365,7 @@ resource assignments based on the project outline and the constraints that you have provided. The TaskJuggler exporter is a bit different from other exporters, such as the -HTML and LaTeX exporters for example, in that it does not export all the +HTML and @LaTeX{} exporters for example, in that it does not export all the nodes of a document or strictly follow the order of the nodes in the document. @@ -10740,11 +10740,11 @@ should take the specified file, make the necessary transformation (if any) and place the result into the destination folder. @node Publishing options, Publishing links, Publishing action, Configuration -@subsection Options for the HTML/La@TeX{} exporters +@subsection Options for the HTML/@LaTeX{} exporters @cindex options, for publishing The property list can be used to set many export options for the HTML -and La@TeX{} exporters. In most cases, these properties correspond to user +and @LaTeX{} exporters. In most cases, these properties correspond to user variables in Org. The table below lists these properties along with the variable they belong to. See the documentation string for the respective variable for details. @@ -10849,9 +10849,9 @@ respective variable for details. @end multitable Most of the @code{org-export-with-*} variables have the same effect in -both HTML and La@TeX{} exporters, except for @code{:TeX-macros} and +both HTML and @LaTeX{} exporters, except for @code{:TeX-macros} and @code{:LaTeX-fragments}, respectively @code{nil} and @code{t} in the -La@TeX{} export. +@LaTeX{} export. @vindex org-publish-project-alist When a property is given a value in @code{org-publish-project-alist}, @@ -11557,7 +11557,7 @@ properties. In the following example, the @code{:results} header argument is set to @code{silent}, meaning the results of execution will not be inserted in the buffer, and the @code{:exports} header argument is set to @code{code}, meaning only the body of the code block will be -preserved on export to HTML or LaTeX. +preserved on export to HTML or @LaTeX{}. @example #+source: factorial @@ -11852,7 +11852,7 @@ such by Org-mode. E.g., @code{:results value raw}. Results are assumed to be HTML and will be enclosed in a @code{begin_html} block. E.g., @code{:results value html}. @item @code{latex} -Results assumed to be LaTeX and are enclosed in a @code{begin_latex} block. +Results assumed to be @LaTeX{} and are enclosed in a @code{begin_latex} block. E.g., @code{:results value latex}. @item @code{code} Result are assumed to be parseable code and are enclosed in a code block. @@ -11891,9 +11891,9 @@ inserted as with @code{replace}. The header argument @code{:file} is used to specify a path for file output. An Org-mode style @code{file:} link is inserted into the buffer as the result (see @ref{Link format}). Common examples are graphical output from R, -gnuplot, ditaa and LaTeX code blocks. +gnuplot, ditaa and @LaTeX{} code blocks. -Note that for some languages, including R, gnuplot, LaTeX and ditaa, +Note that for some languages, including R, gnuplot, @LaTeX{} and ditaa, graphical output is sent to the specified file without the file being referenced explicitly in the code block. See the documentation for the individual languages for details. In contrast, general purpose languages such @@ -11973,7 +11973,7 @@ which the link does not point. @subsubsection @code{:exports} The @code{:exports} header argument specifies what should be included in HTML -or LaTeX exports of the Org-mode file. +or @LaTeX{} exports of the Org-mode file. @itemize @bullet @item @code{code} @@ -13203,7 +13203,7 @@ setup. See the installation instructions in the file @cindex @file{cdlatex.el} @cindex Dominik, Carsten Org-mode can make use of the CDLa@TeX{} package to efficiently enter -La@TeX{} fragments into Org files. See @ref{CDLaTeX mode}. +@LaTeX{} fragments into Org files. See @ref{CDLaTeX mode}. @item @file{imenu.el} by Ake Stenhoff and Lars Lindberg @cindex @file{imenu.el} Imenu allows menu access to an index of items in a file. Org-mode @@ -13361,7 +13361,7 @@ Org. * Add-on packages:: Available extensions * Adding hyperlink types:: New custom link types * Context-sensitive commands:: How to add functionality to such commands -* Tables in arbitrary syntax:: Orgtbl for La@TeX{} and other programs +* Tables in arbitrary syntax:: Orgtbl for @LaTeX{} and other programs * Dynamic blocks:: Automatically filled blocks * Special agenda views:: Customized views * Extracting agenda information:: Postprocessing of agenda information @@ -13541,7 +13541,7 @@ contexts. If the function finds it should do nothing locally, it returns @code{ Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a frequent feature request has been to make it work with native tables in -specific languages, for example La@TeX{}. However, this is extremely +specific languages, for example @LaTeX{}. However, this is extremely hard to do in a general way, would lead to a customization nightmare, and would take away much of the simplicity of the Orgtbl-mode table editor. @@ -13556,7 +13556,7 @@ for a very flexible system. Bastien added the ability to do the same with lists, in Orgstruct mode. You can use Org's facilities to edit and structure lists by turning @code{orgstruct-mode} on, then locally exporting such lists in another format -(HTML, La@TeX{} or Texinfo.) +(HTML, @LaTeX{} or Texinfo.) @menu @@ -13614,7 +13614,7 @@ additional columns. @noindent The one problem remaining is how to keep the source table in the buffer without disturbing the normal workings of the file, for example during -compilation of a C file or processing of a La@TeX{} file. There are a +compilation of a C file or processing of a @LaTeX{} file. There are a number of different solutions: @itemize @bullet @@ -13625,7 +13625,7 @@ language. For example, in C mode you could wrap the table between @item Sometimes it is possible to put the table after some kind of @i{END} statement, for example @samp{\bye} in @TeX{} and @samp{\end@{document@}} -in La@TeX{}. +in @LaTeX{}. @item You can just comment the table line-by-line whenever you want to process the file, and uncomment it whenever you need to edit the table. This @@ -13635,14 +13635,14 @@ key. @end itemize @node A LaTeX example, Translator functions, Radio tables, Tables in arbitrary syntax -@subsection A La@TeX{} example of radio tables -@cindex La@TeX{}, and Orgtbl mode +@subsection A @LaTeX{} example of radio tables +@cindex @LaTeX{}, and Orgtbl mode -The best way to wrap the source table in La@TeX{} is to use the +The best way to wrap the source table in @LaTeX{} is to use the @code{comment} environment provided by @file{comment.sty}. It has to be activated by placing @code{\usepackage@{comment@}} into the document header. Orgtbl mode can insert a radio table skeleton@footnote{By -default this works only for La@TeX{}, HTML, and Texinfo. Configure the +default this works only for @LaTeX{}, HTML, and Texinfo. Configure the variable @code{orgtbl-radio-tables} to install templates for other modes.} with the command @kbd{M-x orgtbl-insert-radio-table}. You will be prompted for a table name, let's say we use @samp{salesfigures}. You @@ -13659,13 +13659,13 @@ will then get the following template: @end example @noindent -@vindex La@TeX{}-verbatim-environments +@vindex @LaTeX{}-verbatim-environments The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function -@code{orgtbl-to-latex} to convert the table into La@TeX{} and to put it +@code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it into the receiver location with name @code{salesfigures}. You may now fill in the table, feel free to use the spreadsheet features@footnote{If the @samp{#+TBLFM} line contains an odd number of dollar characters, -this may cause problems with font-lock in La@TeX{} mode. As shown in the +this may cause problems with font-lock in @LaTeX{} mode. As shown in the example you can fix this by adding an extra line inside the @code{comment} environment that is used to balance the dollar expressions. If you are using AUC@TeX{} with the font-latex library, a @@ -13715,7 +13715,7 @@ Month & \multicolumn@{1@}@{c@}@{Days@} & Nr.\ sold & per day\\ \end@{comment@} @end example -The La@TeX{} translator function @code{orgtbl-to-latex} is already part of +The @LaTeX{} translator function @code{orgtbl-to-latex} is already part of Orgtbl mode. It uses a @code{tabular} environment to typeset the table and marks horizontal lines with @code{\hline}. Furthermore, it interprets the following parameters (see also @pxref{Translator functions}): @@ -13779,7 +13779,7 @@ As you can see, the properties passed into the function (variable @var{PARAMS}) are combined with the ones newly defined in the function (variable @var{PARAMS2}). The ones passed into the function (i.e. the ones set by the @samp{ORGTBL SEND} line) take precedence. So if you -would like to use the La@TeX{} translator, but wanted the line endings to +would like to use the @LaTeX{} translator, but wanted the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you could just overrule the default with @@ -13788,7 +13788,7 @@ overrule the default with @end example For a new language, you can either write your own converter function in -analogy with the La@TeX{} translator, or you can use the generic function +analogy with the @LaTeX{} translator, or you can use the generic function directly. For example, if you have a language where a table is started with @samp{!BTBL!}, ended with @samp{!ETBL!}, and where table lines are started with @samp{!BL!}, ended with @samp{!EL!}, and where the field @@ -13824,7 +13824,7 @@ others can benefit from your work. Sending and receiving radio lists works exactly the same way as sending and receiving radio tables (@pxref{Radio tables}). As for radio tables, you can -insert radio list templates in HTML, La@TeX{} and Texinfo modes by calling +insert radio list templates in HTML, @LaTeX{} and Texinfo modes by calling @code{org-list-insert-radio-list}. Here are the differences with radio tables: @@ -13841,8 +13841,8 @@ parameters. @kbd{C-c C-c} will work when pressed on the first item of the list. @end itemize -Here is a La@TeX{} example. Let's say that you have this in your -La@TeX{} file: +Here is a @LaTeX{} example. Let's say that you have this in your +@LaTeX{} file: @cindex #+ORGLST @example @@ -13859,7 +13859,7 @@ La@TeX{} file: @end example Pressing `C-c C-c' on @code{a new house} and will insert the converted -La@TeX{} list between the two marker lines. +@LaTeX{} list between the two marker lines. @node Dynamic blocks, Special agenda views, Tables in arbitrary syntax, Hacking @section Dynamic blocks @@ -14482,7 +14482,7 @@ Before I get to this list, a few special mentions are in order: @table @i @item Bastien Guerry Bastien has written a large number of extensions to Org (most of them -integrated into the core by now), including the LaTeX exporter and the plain +integrated into the core by now), including the @LaTeX{} exporter and the plain list parser. His support during the early days, when he basically acted as co-maintainer, was central to the success of this project. Bastien also invented Worg, helped establishing the Web presence of Org, and sponsors @@ -14605,7 +14605,7 @@ folded entries, and column view for properties. @item @i{Tokuya Kameshima} wrote @file{org-wl.el} and @file{org-mew.el}. @item -@i{Shidai Liu} ("Leo") asked for embedded La@TeX{} and tested it. He also +@i{Shidai Liu} ("Leo") asked for embedded @LaTeX{} and tested it. He also provided frequent feedback and some patches. @item @i{Matt Lundin} has proposed last-row references for table formulas and named -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] make use of the provided @ie and @eg macros to fix the spacing 2010-12-08 21:05 ` [PATCH] use macro for @LaTeX name Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] fix commas that should be full stops, semicolons or emdashes Brian Gough 0 siblings, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 86 +++++++++++++++++++++++++++++----------------------------- 1 files changed, 43 insertions(+), 43 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 4b4163e..c1be294 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -481,7 +481,7 @@ Capture - Refile - Archive * Capture:: Capturing new stuff * Attachments:: Add files to tasks * RSS Feeds:: Getting input from RSS feeds -* Protocols:: External (e.g. Browser) access to Emacs and Org +* Protocols:: External (@eg{} Browser) access to Emacs and Org * Refiling notes:: Moving a tree from one place to another * Archiving:: What to do with finished projects @@ -1193,7 +1193,7 @@ the previously used indirect buffer. @cindex @code{showeverything}, STARTUP keyword When Emacs first visits an Org file, the global state is set to -OVERVIEW, i.e. only the top level headlines are visible. This can be +OVERVIEW, @ie{} only the top level headlines are visible. This can be configured through the variable @code{org-startup-folded}, or on a per-file basis by adding one of the following lines anywhere in the buffer: @@ -1213,7 +1213,7 @@ for this property are @code{folded}, @code{children}, @code{content}, and @code{all}. @table @asis @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility} -Switch back to the startup visibility of the buffer, i.e. whatever is +Switch back to the startup visibility of the buffer, @ie{} whatever is requested by startup options and @samp{VISIBILITY} properties in individual entries. @end table @@ -1284,7 +1284,7 @@ customize the variable @code{org-M-RET-may-split-line}.}. If the command is used at the beginning of a headline, the new headline is created before the current line. If at the beginning of any other line, the content of that line is made the new heading. If the command is -used at the end of a folded subtree (i.e. behind the ellipses at the end +used at the end of a folded subtree (@ie{} behind the ellipses at the end of a headline), then a headline like the current one will be inserted after the end of the subtree. @orgcmd{C-@key{RET},org-insert-heading-respect-content} @@ -1318,7 +1318,7 @@ level). @orgcmd{M-S-@key{down},org-move-subtree-down} Move subtree down (swap with next subtree of same level). @orgcmd{C-c C-x C-w,org-cut-subtree} -Kill subtree, i.e. remove it from buffer but save in kill ring. +Kill subtree, @ie{} remove it from buffer but save in kill ring. With a numeric prefix argument N, kill N sequential subtrees. @orgcmd{C-c C-x M-w,org-copy-subtree} Copy subtree to kill ring. With a numeric prefix argument N, copy the N @@ -1482,7 +1482,7 @@ as bullets. @emph{Ordered} list items start with a numeral followed by either a period or a right parenthesis@footnote{You can filter out any of them by configuring @code{org-plain-list-ordered-item-terminator}.}, such as @samp{1.} or -@samp{1)}. If you want a list to start with a different value (e.g. 20), start +@samp{1)}. If you want a list to start with a different value (@eg{} 20), start the text of the item with @code{[@@20]}@footnote{If there's a checkbox in the item, the cookie must be put @emph{before} the checkbox.}. Those constructs can be used in any item of the list in order to enforce a particular @@ -1722,7 +1722,7 @@ or on a per-file basis by using Org-mode supports the creation of footnotes. In contrast to the @file{footnote.el} package, Org-mode's footnotes are designed for work on a larger document, not only for one-off documents like emails. The basic -syntax is similar to the one used by @file{footnote.el}, i.e. a footnote is +syntax is similar to the one used by @file{footnote.el}, @ie{} a footnote is defined in a paragraph that is started by a footnote marker in square brackets in column 0, no indentation allowed. If you need a paragraph break inside a footnote, use the @LaTeX{} idiom @samp{\par}. The footnote reference @@ -1799,7 +1799,7 @@ S @r{Short for first @code{r}, then @code{s} action.} n @r{Normalize the footnotes by collecting all definitions (including} @r{inline definitions) into a special section, and then numbering them} @r{in sequence. The references will then also be numbers. This is} - @r{meant to be the final step before finishing a document (e.g. sending} + @r{meant to be the final step before finishing a document (e.g., sending} @r{off an email). The exporters do this automatically, and so could} @r{something like @code{message-send-hook}.} d @r{Delete the footnote at point, and all definitions of and references} @@ -2575,7 +2575,7 @@ following command: Install a new formula for the current column and replace current field with the result of the formula. The command prompts for a formula, with default taken from the @samp{#+TBLFM} line, applies it to the current field and -stores it. With a numeric prefix argument(e.g. @kbd{C-5 C-c =}) the command +stores it. With a numeric prefix argument(@eg{} @kbd{C-5 C-c =}) the command will apply it to that many consecutive fields in the current column. @end table @@ -2877,7 +2877,7 @@ Specify whether the plot will be @code{2d}, @code{3d}, or @code{grid}. @item with Specify a @code{with} option to be inserted for every col being plotted -(e.g. @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). +(@eg{} @code{lines}, @code{points}, @code{boxes}, @code{impulses}, etc...). Defaults to @code{lines}. @item file @@ -3264,7 +3264,7 @@ variable @code{org-display-internal-link-with-indirect-buffer}}. @cindex @code{inlineimages}, STARTUP keyword @cindex @code{noinlineimages}, STARTUP keyword Toggle the inline display of linked images. Normally this will only inline -images that have no description part in the link, i.e. images that will also +images that have no description part in the link, @ie{} images that will also be inlined during export. When called with a prefix argument, also display images that do have a link description. You can ask for inline images to be displayed at startup by configuring the variable @@ -3366,7 +3366,7 @@ can define them in the file with @noindent In-buffer completion (@pxref{Completion}) can be used after @samp{[} to complete link abbreviations. You may also define a function -@code{org-PREFIX-complete-link} that implements special (e.g. completion) +@code{org-PREFIX-complete-link} that implements special (@eg{} completion) support for inserting such a link with @kbd{C-c C-l}. Such a function should not accept any arguments, and return the full link with prefix. @@ -4947,7 +4947,7 @@ values. @noindent The first column, @samp{%25ITEM}, means the first 25 characters of the -item itself, i.e. of the headline. You probably always should start the +item itself, @ie{} of the headline. You probably always should start the column definition with the @samp{ITEM} specifier. The other specifiers create columns @samp{Owner} with a list of names as allowed values, for @samp{Status} with four different possible values, and for a checkbox @@ -5326,7 +5326,7 @@ letter ([dwmy]) to indicate change in days, weeks, months, or years. With a single plus or minus, the date is always relative to today. With a double plus or minus, it is relative to the default date. If instead of a single letter, you use the abbreviation of day name, the date will be -the Nth such day. E.g. +the Nth such day. @Eg{} @example +0 @result{} today @@ -5346,7 +5346,7 @@ the variables @code{parse-time-months} and @code{parse-time-weekdays}. You can specify a time range by giving start and end times or by giving a start time and a duration (in HH:MM format). Use `-' or `-{}-' as the separator -in the former case and use '+' as the separator in the latter case. E.g. +in the former case and use '+' as the separator in the latter case. @Eg{} @example 11am-1:15pm @result{} 11:00-13:15 @@ -5483,7 +5483,7 @@ be listed on that date after it has been marked DONE. If you don't like this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In addition, a reminder that the scheduled date has passed will be present in the compilation for @emph{today}, until the entry is marked DONE. -I.e. the task will automatically be forwarded until completed. +@Ie{} the task will automatically be forwarded until completed. @example *** TODO Call Trillian for a date on New Years Eve. @@ -6086,7 +6086,7 @@ trees to an archive file keeps the system compact and fast. * Capture:: Capturing new stuff * Attachments:: Add files to tasks * RSS Feeds:: Getting input from RSS feeds -* Protocols:: External (e.g. Browser) access to Emacs and Org +* Protocols:: External (@eg{} Browser) access to Emacs and Org * Refiling notes:: Moving a tree from one place to another * Archiving:: What to do with finished projects @end menu @@ -7268,7 +7268,7 @@ brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are assumed to be date/time specifications in the standard Org way, and the comparison will be done accordingly. Special values that will be recognized are @code{"<now>"} for now (including time), and @code{"<today>"}, and -@code{"<tomorrow>"} for these days at 0:00 hours, i.e. without a time +@code{"<tomorrow>"} for these days at 0:00 hours, @ie{} without a time specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year, respectively, can be used. @@ -7691,7 +7691,7 @@ always show a table with the clocked times for the timespan and file scope covered by the current agenda view. The initial setting for this mode in new agenda buffers can be set with the variable @code{org-agenda-start-with-clockreport-mode}. By using a prefix argument -when toggling this mode (i.e. @kbd{C-u R}), the clock table will not show +when toggling this mode (@ie{} @kbd{C-u R}), the clock table will not show contributions from entries that are hidden by agenda filtering@footnote{Only tags filtering will be respected here, effort filtering is ignored.}. @c @@ -8760,7 +8760,7 @@ which is distributed with Org). Fontified code chunks in @LaTeX{} can be achieved using either the listings or the @url{http://code.google.com/p/minted, minted,} package. To use listings, turn on the variable @code{org-export-latex-listings} and ensure that the listings -package is included by the @LaTeX{} header (e.g. by configuring +package is included by the @LaTeX{} header (@eg{} by configuring @code{org-export-latex-packages-alist}). See the listings documentation for configuration options, including obtaining colored output. For minted it is necessary to install the program @url{http://pygments.org, pygments}, in @@ -8787,7 +8787,7 @@ switch to the end of the @code{BEGIN} line, to get the lines of the example numbered. If you use a @code{+n} switch, the numbering from the previous numbered snippet will be continued in the current one. In literal examples, Org will interpret strings like @samp{(ref:name)} as labels, and use them as -targets for special hyperlinks like @code{[[(name)]]} (i.e. the reference name +targets for special hyperlinks like @code{[[(name)]]} (@ie{} the reference name enclosed in single parenthesis). In HTML, hovering the mouse over such a link will remote-highlight the corresponding code line, which is kind of cool. @@ -8854,7 +8854,7 @@ include your @file{.emacs} file, you could use: #+INCLUDE: "~/.emacs" src emacs-lisp @end example @noindent -The optional second and third parameter are the markup (e.g. @samp{quote}, +The optional second and third parameter are the markup (@eg{} @samp{quote}, @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the language for formatting the contents. The markup is optional, if it is not given, the text will be assumed to be in Org-mode format and will be @@ -9288,9 +9288,9 @@ Insert template with export options, see example below. #+AUTHOR: the author (default taken from @code{user-full-name}) #+DATE: a date, fixed, or a format string for @code{format-time-string} #+EMAIL: his/her email address (default from @code{user-mail-address}) -#+DESCRIPTION: the page description, e.g. for the XHTML meta tag -#+KEYWORDS: the page keywords, e.g. for the XHTML meta tag -#+LANGUAGE: language for HTML, e.g. @samp{en} (@code{org-export-default-language}) +#+DESCRIPTION: the page description, e.g., for the XHTML meta tag +#+KEYWORDS: the page keywords, e.g., for the XHTML meta tag +#+LANGUAGE: language for HTML, e.g., @samp{en} (@code{org-export-default-language}) #+TEXT: Some descriptive text to be inserted at the beginning. #+TEXT: Several lines may be given. #+OPTIONS: H:2 num:t toc:t \n:nil @@:t ::t |:t ^:t f:t TeX:t ... @@ -9385,11 +9385,11 @@ separate Emacs process@footnote{To make this behavior the default, customize the variable @code{org-export-run-in-background}.}. @orgcmd{C-c C-e v,org-export-visible} Like @kbd{C-c C-e}, but only export the text that is currently visible -(i.e. not hidden by outline visibility). +(@ie{} not hidden by outline visibility). @orgcmd{C-u C-u C-c C-e,org-export} @vindex org-export-run-in-background Call the exporter, but reverse the setting of -@code{org-export-run-in-background}, i.e. request background processing if +@code{org-export-run-in-background}, @ie{} request background processing if not set, or force processing in the current Emacs process if set. @end table @@ -10259,7 +10259,7 @@ exported DocBook XML files invalid by not quoting DocBook code correctly. @cindex DocBook recursive sections DocBook exporter exports Org files as articles using the @code{article} -element in DocBook. Recursive sections, i.e. @code{section} elements, are +element in DocBook. Recursive sections, @ie{} @code{section} elements, are used in exported articles. Top level headlines in Org files are exported as top level sections, and lower level headlines are exported as nested sections. The entire structure of Org files will be exported completely, no @@ -10419,7 +10419,7 @@ time. @subsection Export of properties -The exporter also takes TODO state information into consideration, i.e. if a +The exporter also takes TODO state information into consideration, @ie{} if a task is marked as done it will have the corresponding attribute in TaskJuggler (@samp{complete 100}). Also it will export any property on a task resource or resource node which is known to TaskJuggler, such as @@ -10471,7 +10471,7 @@ examples should illustrate this: @subsection Reports @vindex org-export-taskjuggler-default-reports -TaskJuggler can produce many kinds of reports (e.g. gantt chart, resource +TaskJuggler can produce many kinds of reports (@eg{} gantt chart, resource allocation, etc). The user defines what kind of reports should be generated for a project in the TaskJuggler file. The exporter will automatically insert some default reports in the file. These defaults are defined in @@ -10629,7 +10629,7 @@ configures one project, and may be in one of the two following forms: @lisp ("project-name" :property value :property value ...) - @r{i.e. a well-formed property list with alternating keys and values} + @r{@ie{} a well-formed property list with alternating keys and values} @r{or} ("project-name" :components ("project-name" "project-name" ...)) @@ -11099,7 +11099,7 @@ This may be necessary in particular if files include other files via @cindex source code, working with Source code can be included in Org-mode documents using a @samp{src} block, -e.g. +@eg{} @example #+BEGIN_SRC emacs-lisp @@ -11228,7 +11228,7 @@ this variable to nil to switch without asking. It is possible to export the @emph{contents} of code blocks, the @emph{results} of code block evaluation, @emph{neither}, or @emph{both}. For most languages, the default exports the contents of code blocks. However, for -some languages (e.g. @code{ditaa}) the default exports the results of code +some languages (@eg{} @code{ditaa}) the default exports the results of code block evaluation. For information on exporting code block bodies, see @ref{Literal examples}. @@ -11913,7 +11913,7 @@ then not supplying @code{:dir}. Under the surface, @code{:dir} simply sets the value of the Emacs variable @code{default-directory}. When using @code{:dir}, you should supply a relative path for file output -(e.g. @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which +(@eg{} @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which case that path will be interpreted relative to the default directory. In other words, if you want your plot to go into a folder called Work in your @@ -12215,7 +12215,7 @@ No column name pre-processing takes place @item @code{yes} Column names are removed and reapplied as with @code{nil} even if the table -does not ``look like'' it has column names (i.e. the second row is not an +does not ``look like'' it has column names (@ie{} the second row is not an hline) @end itemize @@ -12253,7 +12253,7 @@ and is then reapplied to the results. @subsubsection @code{:shebang} Setting the @code{:shebang} header argument to a string value -(e.g. @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the +(@eg{} @code{:shebang "#!/bin/bash"}) causes the string to be inserted as the first line of any tangled file holding the code block, and the file permissions of the tangled file are set to make it executable. @@ -12553,7 +12553,7 @@ option keyword is already complete, pressing @kbd{M-@key{TAB}} again will insert example settings for this keyword. @item In the line after @samp{#+STARTUP: }, complete startup keywords, -i.e. valid keys for this line. +@ie{} valid keys for this line. @item Elsewhere, complete dictionary words using Ispell. @end itemize @@ -12605,7 +12605,7 @@ additional details. @vindex org-speed-commands-user Single keys can be made to execute commands when the cursor is at the -beginning of a headline, i.e. before the first star. Configure the variable +beginning of a headline, @ie{} before the first star. Configure the variable @code{org-use-speed-commands} to activate this feature. There is a pre-defined list of commands, and you can add more such commands using the variable @code{org-speed-commands-user}. Speed keys do not only speed up @@ -12743,7 +12743,7 @@ buffer, most useful for specifying the allowed values of a property. @item #+SETUPFILE: file This line defines a file that holds more in-buffer setup. Normally this is entirely ignored. Only when the buffer is parsed for option-setting lines -(i.e. when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a +(@ie{} when starting Org-mode for a file, when pressing @kbd{C-c C-c} in a settings line, or when exporting), then the contents of this file are parsed as if they had been included in the buffer. In particular, the file can be any other Org-mode file with internal setup. You can visit the file the @@ -13491,7 +13491,7 @@ the link description when the link is later inserted into an Org buffer with @kbd{C-c C-l}. When it makes sense for your new link type, you may also define a function -@code{org-PREFIX-complete-link} that implements special (e.g. completion) +@code{org-PREFIX-complete-link} that implements special (@eg{} completion) support for inserting such a link with @kbd{C-c C-l}. Such a function should not accept any arguments, and return the full link with prefix. @@ -13694,7 +13694,7 @@ table inserted between the two marker lines. Now let's assume you want to make the table header by hand, because you want to control how columns are aligned, etc@. In this case we make sure that the table translator skips the first 2 lines of the source -table, and tell the command to work as a @i{splice}, i.e. to not produce +table, and tell the command to work as a @i{splice}, @ie{} to not produce header and footer commands of the target table: @example @@ -13777,7 +13777,7 @@ hands processing over to the generic translator. Here is the entire code: As you can see, the properties passed into the function (variable @var{PARAMS}) are combined with the ones newly defined in the function -(variable @var{PARAMS2}). The ones passed into the function (i.e. the +(variable @var{PARAMS2}). The ones passed into the function (@ie{} the ones set by the @samp{ORGTBL SEND} line) take precedence. So if you would like to use the @LaTeX{} translator, but wanted the line endings to be @samp{\\[2mm]} instead of the default @samp{\\}, you could just @@ -14223,7 +14223,7 @@ does not need to preserve point. After evaluation, the cursor will be moved to the end of the line (presumably of the headline of the processed entry) and search continues from there. Under some circumstances, this may not produce the wanted results. For example, -if you have removed (e.g. archived) the current (sub)tree it could +if you have removed (@eg{} archived) the current (sub)tree it could mean that the next entry will be skipped entirely. In such cases, you can specify the position from where search should continue by making FUNC set the variable `org-map-continue-from' to the desired buffer -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] fix commas that should be full stops, semicolons or emdashes 2010-12-08 21:05 ` [PATCH] make use of the provided @ie and @eg macros to fix the spacing Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] fix plain text that looks better with markup Brian Gough 0 siblings, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 50 +++++++++++++++++++++++++------------------------- 1 files changed, 25 insertions(+), 25 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index c1be294..937a83c 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -1760,7 +1760,7 @@ Since Org allows multiple references to the same note, you can then use @vindex org-footnote-auto-label Footnote labels can be created automatically, or you can create names yourself. This is handled by the variable @code{org-footnote-auto-label} and its -corresponding @code{#+STARTUP} keywords, see the docstring of that variable +corresponding @code{#+STARTUP} keywords. See the docstring of that variable for details. @noindent The following command handles footnotes: @@ -2997,7 +2997,7 @@ a link targeting a headline, in-buffer completion can be used. Just type a star followed by a few optional letters into the buffer and press @kbd{M-@key{TAB}}. All headlines in the current buffer will be offered as completions.}. In non-Org files, the search will look for the words in the -link text, in the above example the search would be for @samp{my target}. +link text. In the above example the search would be for @samp{my target}. Following a link pushes a mark onto Org's own mark ring. You can return to the previous position with @kbd{C-c &}. Using this command @@ -3286,7 +3286,7 @@ previously recorded positions. @cindex links, finding next/previous Move forward/backward to the next link in the buffer. At the limit of the buffer, the search fails once, and then wraps around. The key -bindings for this are really too long, you might want to bind this also +bindings for this are really too long; you might want to bind this also to @kbd{C-n} and @kbd{C-p} @lisp (add-hook 'org-load-hook @@ -5948,7 +5948,7 @@ If you restart Emacs and clock into any task, Org will notice that you have a dangling clock which was never clocked out from your last session. Using that clock's starting time as the beginning of the unaccounted-for period, Org will ask how you want to resolve that time. The logic and behavior is -identical to dealing with away time due to idleness, it's just happening due +identical to dealing with away time due to idleness; it's just happening due to a recovery event rather than a set amount of idle time. You can also check all the files visited by your Org agenda for dangling @@ -6278,7 +6278,7 @@ Text to be inserted as it is. @vindex org-default-notes-file Specification of where the captured item should be placed. In Org-mode files, targets usually define a node. Entries will become children of this -node, other types will be added to the table or list in the body of this +node. Other types will be added to the table or list in the body of this node. Most target specifications contain a file name. If that file name is the empty string, it defaults to @code{org-default-notes-file}. @@ -7754,7 +7754,7 @@ refreshes and more secondary filtering. The filter is a global property of the entire agenda view - in a block agenda, you should only set this in the global options section, not in the section of an individual block.} -You will be prompted for a tag selection letter, SPC will mean any tag at +You will be prompted for a tag selection letter; SPC will mean any tag at all. Pressing @key{TAB} at that prompt will offer use completion to select a tag (including any tags that do not have a selection character). The command then hides all entries that do not contain or inherit this tag. When called @@ -7916,10 +7916,10 @@ same location where state change notes are put. Depending on Dispatcher for all command related to attachments. @c @orgcmd{C-c C-s,org-agenda-schedule} -Schedule this item, with prefix arg remove the scheduling timestamp +Schedule this item. With prefix arg remove the scheduling timestamp @c @orgcmd{C-c C-d,org-agenda-deadline} -Set a deadline for this item, with prefix arg remove the deadline. +Set a deadline for this item. With prefix arg remove the deadline. @c @orgcmd{k,org-agenda-action} Agenda actions, to set dates for selected items to the cursor date. @@ -7987,7 +7987,7 @@ will be passed through to the @kbd{s} and @kbd{d} commands, to bulk-remove these special timestamps. @example r @r{Prompt for a single refile target and move all entries. The entries} - @r{will no longer be in the agenda, refresh (@kbd{g}) to bring them back.} + @r{will no longer be in the agenda; refresh (@kbd{g}) to bring them back.} $ @r{Archive all selected entries.} A @r{Archive entries by moving them to their respective archive siblings.} t @r{Change TODO state. This prompts for a single TODO keyword and} @@ -8237,7 +8237,7 @@ For command sets creating a block agenda, @code{org-agenda-custom-commands} has two separate spots for setting options. You can add options that should be valid for just a single command in the set, and options that should be valid for all commands in -the set. The former are just added to the command entry, the latter +the set. The former are just added to the command entry; the latter must come after the list of command entries. Going back to the block agenda example (@pxref{Block agenda}), let's change the sorting strategy for the @kbd{C-c a h} commands to @code{priority-down}, but let's sort @@ -8445,7 +8445,7 @@ turning on column view in the agenda will visit all relevant agenda files and make sure that the computations of this property are up to date. This is also true for the special @code{CLOCKSUM} property. Org will then sum the values displayed in the agenda. In the daily/weekly agenda, the sums will -cover a single day, in all other views they cover the entire block. It is +cover a single day; in all other views they cover the entire block. It is vital to realize that the agenda may show the same entry @emph{twice} (for example as scheduled and as a deadline), and it may show two entries from the same hierarchy (for example a @emph{parent} and its @emph{child}). In these @@ -8657,7 +8657,7 @@ different backends support this to varying degrees. You can make words @b{*bold*}, @i{/italic/}, _underlined_, @code{=code=} and @code{~verbatim~}, and, if you must, @samp{+strike-through+}. Text in the code and verbatim string is not processed for Org-mode specific -syntax, it is exported verbatim. +syntax; it is exported verbatim. @node Horizontal rules, Comment lines, Emphasis and monospace, Structural markup elements @subheading Horizontal rules @@ -8825,7 +8825,7 @@ switching to a temporary buffer with the source code. You need to exit by pressing @kbd{C-c '} again@footnote{Upon exit, lines starting with @samp{*} or @samp{#} will get a comma prepended, to keep them from being interpreted by Org as outline nodes or special comments. These commas will be stripped -for editing with @kbd{C-c '}, and also for export.}, the edited version will +for editing with @kbd{C-c '}, and also for export.}. The edited version will then replace the old version in the Org buffer. Fixed-width regions (where each line starts with a colon followed by a space) will be edited using @code{artist-mode}@footnote{You may select a different-mode with the @@ -8835,7 +8835,7 @@ fixed-width region. @kindex C-c l @item C-c l Calling @code{org-store-link} while editing a source code example in a -temporary buffer created with @kbd{C-c '} will prompt for a label, make sure +temporary buffer created with @kbd{C-c '} will prompt for a label. Make sure that it is unique in the current buffer, and insert it with the proper formatting like @samp{(ref:label)} at the end of the current line. Then the label is stored as a link @samp{(label)}, for retrieval with @kbd{C-c C-l}. @@ -8856,7 +8856,7 @@ include your @file{.emacs} file, you could use: @noindent The optional second and third parameter are the markup (@eg{} @samp{quote}, @samp{example}, or @samp{src}), and, if the markup is @samp{src}, the -language for formatting the contents. The markup is optional, if it is not +language for formatting the contents. The markup is optional; if it is not given, the text will be assumed to be in Org-mode format and will be processed normally. The include line will also allow additional keyword parameters @code{:prefix1} and @code{:prefix} to specify prefixes for the @@ -8971,7 +8971,7 @@ output. Similarly, @code{\nbsp} will become @code{ } in HTML and like this: @samp{\Aacute@{@}stor}. A large number of entities is provided, with names taken from both HTML and -@LaTeX{}, see the variable @code{org-entities} for the complete list. +@LaTeX{}; see the variable @code{org-entities} for the complete list. @samp{\-} is treated as a shy hyphen, and @samp{--}, @samp{---}, and @samp{...} are all converted into special commands creating hyphens of different lengths or a compact set of dots. @@ -9183,7 +9183,7 @@ after the backquote, a help window will pop up. Pressing the single-quote @kbd{'} followed by another character modifies the symbol before point with an accent or a font. If you wait more than 1.5 seconds after the single-quote, a help window will pop up. Character -modification will work only inside @LaTeX{} fragments, outside the quote +modification will work only inside @LaTeX{} fragments; outside, the quote is normal. @end itemize @@ -9494,7 +9494,7 @@ property, that name will be used for the export. @orgcmd{C-c C-e b,org-export-as-html-and-open} Export as HTML file and immediately open it with a browser. @orgcmd{C-c C-e H,org-export-as-html-to-buffer} -Export to a temporary buffer, do not create a file. +Export to a temporary buffer. Do not create a file. @orgcmd{C-c C-e R,org-export-region-as-html} Export the active region to a temporary buffer. With a prefix argument, do not produce the file header and footer, but just the plain HTML section for @@ -9874,7 +9874,7 @@ current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} property, that name will be used for the export. @orgcmd{C-c C-e L,org-export-as-latex-to-buffer} -Export to a temporary buffer, do not create a file. +Export to a temporary buffer. Do not create a file. @item C-c C-e v l/L Export only the visible part of the document. @item M-x org-export-region-as-latex @@ -10407,7 +10407,7 @@ with @code{:taskjuggler_resource:} (or whatever you customized identifier (named @samp{resource_id}) to the resources (using the standard Org properties commands, @pxref{Property syntax}) or you can let the exporter generate identifiers automatically (the exporter picks the first word of the -headline as the identifier as long as it is unique, see the documentation of +headline as the identifier as long as it is unique---see the documentation of @code{org-taskjuggler-get-unique-id}). Using that identifier you can then allocate resources to tasks. This is again done with the @samp{allocate} property on the tasks. Do this in column view or when on the task type @@ -10720,7 +10720,7 @@ setup, you need to add @code{:exclude "-source\\.org"} to the project definition in @code{org-publish-project-alist} to avoid that the published source files will be considered as new org files the next time the project is published.}. Other files like images only need to be copied to the -publishing destination, for this you may use @code{org-publish-attachment}. +publishing destination; for this you may use @code{org-publish-attachment}. For non-Org files, you always need to specify the publishing function: @multitable @columnfractions 0.3 0.7 @@ -13663,7 +13663,7 @@ will then get the following template: The @code{#+ORGTBL: SEND} line tells Orgtbl mode to use the function @code{orgtbl-to-latex} to convert the table into @LaTeX{} and to put it into the receiver location with name @code{salesfigures}. You may now -fill in the table, feel free to use the spreadsheet features@footnote{If +fill in the table---feel free to use the spreadsheet features@footnote{If the @samp{#+TBLFM} line contains an odd number of dollar characters, this may cause problems with font-lock in @LaTeX{} mode. As shown in the example you can fix this by adding an extra line inside the @@ -14133,7 +14133,7 @@ properties. Get all properties of the entry at point-or-marker POM.@* This includes the TODO keyword, the tags, time strings for deadline, scheduled, and clocking, and any additional properties defined in the -entry. The return value is an alist, keys may occur multiple times +entry. The return value is an alist. Keys may occur multiple times if the property key was used several times.@* POM may also be nil, in which case the current entry is used. If WHICH is nil or `all', get all properties. If WHICH is @@ -14270,12 +14270,12 @@ information about the entry, or in order to change metadata in the entry. Here are a couple of functions that might be handy: @defun org-todo &optional arg -Change the TODO state of the entry, see the docstring of the functions for +Change the TODO state of the entry. See the docstring of the functions for the many possible values for the argument ARG. @end defun @defun org-priority &optional action -Change the priority of the entry, see the docstring of this function for the +Change the priority of the entry. See the docstring of this function for the possible values for ACTION. @end defun -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] fix plain text that looks better with markup 2010-12-08 21:05 ` [PATCH] fix commas that should be full stops, semicolons or emdashes Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] use kbd font Brian Gough 0 siblings, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 8 ++++---- 1 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 937a83c..be62056 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -2884,7 +2884,7 @@ Defaults to @code{lines}. If you want to plot to a file, specify @code{"@var{path/to/desired/output-file}"}. @item labels -List of labels to be used for the deps (defaults to the column headers if +List of labels to be used for the @code{deps} (defaults to the column headers if they exist). @item line @@ -9054,7 +9054,7 @@ snippets will be identified as @LaTeX{} source code: @itemize @bullet @item Environments of any kind@footnote{When @file{MathJax} is used, only the -environment recognized by @file{MathJax} will be processed. When dvipng is +environment recognized by @file{MathJax} will be processed. When @file{dvipng} is used to create images, any @LaTeX{} environments will be handled.}. The only requirement is that the @code{\begin} statement appears on a new line, preceded by only whitespace. @@ -10433,7 +10433,7 @@ resource or resource node which is known to TaskJuggler, such as The exporter will handle dependencies that are defined in the tasks either with the @samp{ORDERED} attribute (@pxref{TODO dependencies}), with the -@samp{BLOCKER} attribute (see org-depend.el) or alternatively with a +@samp{BLOCKER} attribute (see @file{org-depend.el}) or alternatively with a @samp{depends} attribute. Both the @samp{BLOCKER} and the @samp{depends} attribute can be either @samp{previous-sibling} or a reference to an identifier (named @samp{task_id}) which is defined for another task in the @@ -11916,7 +11916,7 @@ When using @code{:dir}, you should supply a relative path for file output (@eg{} @code{:file myfile.jpg} or @code{:file results/myfile.jpg}) in which case that path will be interpreted relative to the default directory. -In other words, if you want your plot to go into a folder called Work in your +In other words, if you want your plot to go into a folder called @file{Work} in your home directory, you could use @example -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] use kbd font 2010-12-08 21:05 ` [PATCH] fix plain text that looks better with markup Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] improvements to wording style Brian Gough 0 siblings, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index be62056..d1a00c2 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -7754,7 +7754,7 @@ refreshes and more secondary filtering. The filter is a global property of the entire agenda view - in a block agenda, you should only set this in the global options section, not in the section of an individual block.} -You will be prompted for a tag selection letter; SPC will mean any tag at +You will be prompted for a tag selection letter; @key{SPC} will mean any tag at all. Pressing @key{TAB} at that prompt will offer use completion to select a tag (including any tags that do not have a selection character). The command then hides all entries that do not contain or inherit this tag. When called -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] improvements to wording style 2010-12-08 21:05 ` [PATCH] use kbd font Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] include explanations of how to look up a docstring Brian Gough 0 siblings, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 26 ++++++++++---------------- 1 files changed, 10 insertions(+), 16 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index d1a00c2..b9ff083 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -1854,8 +1854,7 @@ item. @cindex editing tables Org comes with a fast and intuitive table editor. Spreadsheet-like -calculations are supported in connection with the Emacs @file{calc} -package +calculations are supported using the Emacs @file{calc} package @ifinfo (@pxref{Top,Calc,,Calc,Gnu Emacs Calculator Manual}). @end ifinfo @@ -2116,7 +2115,7 @@ will then set the width of this column to this value. @noindent Fields that are wider become clipped and end in the string @samp{=>}. -Note that the full text is still in the buffer, it is only invisible. +Note that the full text is still in the buffer but is hidden. To see the full text, hold the mouse over the field---a tool-tip window will show the full content. To edit such a field, use the command @kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will @@ -2499,8 +2498,7 @@ interpolated as Lisp numbers, without quotes. If you provide the I.e., if you want a reference to be interpreted as a string by the Lisp form, enclose the reference operator itself in double-quotes, like @code{"$3"}. Ranges are inserted as space-separated fields, so you can -embed them in list or vector syntax. A few examples, note how the -@samp{N} mode is used when we do computations in Lisp. +embed them in list or vector syntax. Here are a few examples---note how the @samp{N} mode is used when we do computations in Lisp: @example @r{Swap the first two characters of the content of column 1} @@ -2524,7 +2522,7 @@ evaluated, and the current field replaced with the result. @cindex #+TBLFM Formulas are stored in a special line starting with @samp{#+TBLFM:} -directly below the table. If you typed the equation in the 4th field of +directly below the table. If you type the equation in the 4th field of the 3rd data line in the table, the formula will look like @samp{@@3$4=$1+$2}. When inserting/deleting/swapping column and rows with the appropriate commands, @i{absolute references} (but not relative @@ -5482,8 +5480,7 @@ The headline will be listed under the given date@footnote{It will still be listed on that date after it has been marked DONE. If you don't like this, set the variable @code{org-agenda-skip-scheduled-if-done}.}. In addition, a reminder that the scheduled date has passed will be present -in the compilation for @emph{today}, until the entry is marked DONE. -@Ie{} the task will automatically be forwarded until completed. +in the compilation for @emph{today}, until the entry is marked DONE, @ie{} the task will automatically be forwarded until completed. @example *** TODO Call Trillian for a date on New Years Eve. @@ -5628,7 +5625,7 @@ forgot to call your father for 3 weeks, it does not make sense to call him 3 times in a single day to make up for it. Finally, there are tasks like changing batteries which should always repeat a certain time @i{after} the last time you did it. For these tasks, Org-mode has -special repeaters markers with @samp{++} and @samp{.+}. For example: +special repeaters @samp{++} and @samp{.+}. For example: @example ** TODO Call Father @@ -8923,9 +8920,7 @@ construct complex HTML code. @cindex @TeX{} interpretation @cindex @LaTeX{} interpretation -Plain ASCII is normally sufficient for almost all note taking. One -exception, however, are scientific notes which need to be able to contain -mathematical symbols and the occasional formula. @LaTeX{}@footnote{@LaTeX{} +Plain ASCII is normally sufficient for almost all note taking. Exceptions include scientific notes, which often require mathematical symbols and the occasional formula. @LaTeX{}@footnote{@LaTeX{} is a macro system based on Donald E. Knuth's @TeX{} system. Many of the features described here as ``@LaTeX{}'' are really from @TeX{}, but for simplicity I am blurring this distinction.} is widely used to typeset @@ -9743,7 +9738,7 @@ inclusion of these defaults off, customize @code{org-export-html-style-include-default}}. You may overwrite these settings, or add to them by using the variables @code{org-export-html-style} (for Org-wide settings) and @code{org-export-html-style-extra} (for more -granular settings, like file-local settings). To set the latter variable +fine-grained settings, like file-local settings). To set the latter variable individually for each file, you can use @cindex #+STYLE @@ -10717,8 +10712,7 @@ produce @file{file.org} and @file{file.org.html} in the publishing directory@footnote{@file{file-source.org} and @file{file-source.org.html} if source and publishing directories are equal. Note that with this kind of setup, you need to add @code{:exclude "-source\\.org"} to the project -definition in @code{org-publish-project-alist} to avoid that the published -source files will be considered as new org files the next time the project is +definition in @code{org-publish-project-alist} to prevent the published source files from being considered as new org files the next time the project is published.}. Other files like images only need to be copied to the publishing destination; for this you may use @code{org-publish-attachment}. For non-Org files, you always need to specify the publishing function: @@ -12595,7 +12589,7 @@ For example, on an empty line, typing "<e" and then pressing TAB, will expand into a complete EXAMPLE template. You can install additional templates by customizing the variable -@code{org-structure-template-alist}. Refer docstring of the variable for +@code{org-structure-template-alist}. See the docstring of the variable for additional details. @node Speed keys, Code evaluation security, Easy Templates, Miscellaneous -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] include explanations of how to look up a docstring 2010-12-08 21:05 ` [PATCH] improvements to wording style Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] use a full sentence Brian Gough 2010-12-09 17:38 ` [PATCH] include explanations of how to look up a docstring Giovanni Ridolfi 0 siblings, 2 replies; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 6 ++---- 1 files changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index b9ff083..faa552e 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -1346,8 +1346,7 @@ Clone a subtree by making a number of sibling copies of it. You will be prompted for the number of copies to make, and you can also specify if any timestamps in the entry should be shifted. This can be useful, for example, to create a number of tasks related to a series of lectures to prepare. For -more details, see the docstring of the command -@code{org-clone-subtree-with-time-shift}. +more details, see the docstring@footnote{Docstrings for commands can be displayed with @kbd{M-x describe-function} or @kbd{C-h f}.} of the command @code{org-clone-subtree-with-time-shift}. @orgcmd{C-c C-w,org-refile} Refile entry or region to a different location. @xref{Refiling notes}. @orgcmd{C-c ^,org-sort-entries-or-items} @@ -1760,8 +1759,7 @@ Since Org allows multiple references to the same note, you can then use @vindex org-footnote-auto-label Footnote labels can be created automatically, or you can create names yourself. This is handled by the variable @code{org-footnote-auto-label} and its -corresponding @code{#+STARTUP} keywords. See the docstring of that variable -for details. +corresponding @code{#+STARTUP} keywords. See the docstring@footnote{Docstrings for variables can be displayed with @kbd{M-x describe-variable} or @kbd{C-h v}.} of that variable for details. @noindent The following command handles footnotes: -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] use a full sentence 2010-12-08 21:05 ` [PATCH] include explanations of how to look up a docstring Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] tangling is not a widely-known term, describe it as literate programming Brian Gough 2010-12-09 17:38 ` [PATCH] include explanations of how to look up a docstring Giovanni Ridolfi 1 sibling, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index faa552e..1a2b3dd 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -2338,7 +2338,7 @@ $3 = remote(FOO, @@@@#$2) @r{copy column 2 from table FOO into} @end example @noindent For the second example, table FOO must have at least as many rows -as the current table. Inefficient@footnote{The computation time scales as +as the current table. Note that this is inefficient@footnote{The computation time scales as O(N^2) because table FOO is parsed for each field to be copied.} for large number of rows. -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] tangling is not a widely-known term, describe it as literate programming 2010-12-08 21:05 ` [PATCH] use a full sentence Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] make "time stamps" consistent with timestamps Brian Gough 0 siblings, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 5 +++-- 1 files changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 1a2b3dd..930f948 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -770,7 +770,7 @@ create dynamic @i{agenda views}. Org mode contains the Org Babel environment which allows you to work with embedded source code blocks in a file, to facilitate code evaluation, -documentation, and tangling. +documentation, and literate programming techniques. Org's automatic, context-sensitive table editor with spreadsheet capabilities can be integrated into any major mode by activating the @@ -11103,7 +11103,8 @@ Source code can be included in Org-mode documents using a @samp{src} block, Org-mode provides a number of features for working with live source code, including editing of code blocks in their native major-mode, evaluation of -code blocks, tangling of code blocks, and exporting code blocks and their +code blocks, converting code blocks into source files (known as @dfn{tangling} +in literate programming), and exporting code blocks and their results in several formats. This functionality was contributed by Eric Schulte and Dan Davison, and was originally named Org-babel. -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] make "time stamps" consistent with timestamps 2010-12-08 21:05 ` [PATCH] tangling is not a widely-known term, describe it as literate programming Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] make explanation of keyword lines clearer Brian Gough 2011-02-01 11:29 ` [Accepted] make "time stamps" consistent with timestamps Bastien Guerry 0 siblings, 2 replies; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 930f948..553d670 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -6608,7 +6608,7 @@ create new nodes as new parents for refiling on the fly, check the variable @code{org-refile-allow-creating-parent-nodes}. When the variable @code{org-log-refile}@footnote{with corresponding @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile}, -and @code{nologrefile}} is set, a time stamp or a note will be +and @code{nologrefile}} is set, a timestamp or a note will be recorded when an entry has been refiled. @orgkey{C-u C-c C-w} Use the refile interface to jump to a heading. @@ -7987,7 +7987,7 @@ $ @r{Archive all selected entries.} A @r{Archive entries by moving them to their respective archive siblings.} t @r{Change TODO state. This prompts for a single TODO keyword and} @r{changes the state of all selected entries, bypassing blocking and} - @r{suppressing logging notes (but not time stamps).} + @r{suppressing logging notes (but not timestamps).} + @r{Add a tag to all selected entries.} - @r{Remove a tag from all selected entries.} s @r{Schedule all items to a new date. To shift existing schedule dates} -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] make explanation of keyword lines clearer 2010-12-08 21:05 ` [PATCH] make "time stamps" consistent with timestamps Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] use emdashes when needed Brian Gough 2011-02-01 11:29 ` [Accepted] make "time stamps" consistent with timestamps Bastien Guerry 1 sibling, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 3 +-- 1 files changed, 1 insertions(+), 2 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 553d670..fc4b17d 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -12680,8 +12680,7 @@ lines into the buffer (@pxref{In-buffer settings}). Org-mode uses special lines in the buffer to define settings on a per-file basis. These lines start with a @samp{#+} followed by a keyword, a colon, and then individual words defining a setting. Several -setting words can be in the same line, but you can also have multiple -lines for the keyword. While these settings are described throughout +setting words can be in the same line, but you can also have multiple repeated lines for the same keyword. While these settings are described throughout the manual, here is a summary. After changing any of those lines in the buffer, press @kbd{C-c C-c} with the cursor still in the line to activate the changes immediately. Otherwise they become effective only -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] use emdashes when needed 2010-12-08 21:05 ` [PATCH] make explanation of keyword lines clearer Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] put emacs functions in code font Brian Gough 0 siblings, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 14 +++++++------- 1 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index fc4b17d..c30378c 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -943,7 +943,7 @@ to the mailing list, in order to minimize the work the mailing list moderators have to do.}. For bug reports, please first try to reproduce the bug with the latest -version of Org available - if you are running an outdated version, it is +version of Org available---if you are running an outdated version, it is quite possible that the bug has been fixed already. If the bug persists, prepare a report and provide as much information as possible, including the version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org @@ -6150,7 +6150,7 @@ with a prefix arg, finalize and then jump to the captured item. @orgcmd{C-c C-w,org-capture-refile} Finalize the capture process by refiling (@pxref{Refiling notes}) the note to a different place. Please realize that this is a normal refiling command -that will be executed - so the cursor position at the moment you run this +that will be executed---so the cursor position at the moment you run this command is important. If you have inserted a tree with a parent and children, first move the cursor back to the parent. Any prefix argument given to this command will be passed on to the @code{org-refile} command. @@ -7746,7 +7746,7 @@ having to recreate the agenda.@footnote{Custom commands can preset a filter by binding the variable @code{org-agenda-filter-preset} as an option. This filter will then be applied to the view and persist as a basic filter through refreshes and more secondary filtering. The filter is a global property of -the entire agenda view - in a block agenda, you should only set this in the +the entire agenda view---in a block agenda, you should only set this in the global options section, not in the section of an individual block.} You will be prompted for a tag selection letter; @key{SPC} will mean any tag at @@ -8024,7 +8024,7 @@ Org will create entries (in org-mode syntax) in that file instead. Most entries will be stored in a date-based outline tree that will later make it easy to archive appointments from previous months/years. The tree will be built under an entry with a @code{DATE_TREE} property, or else with years as -top-level entries. Emacs will prompt you for the entry text - if you specify +top-level entries. Emacs will prompt you for the entry text---if you specify it, the entry will be created in @code{org-agenda-diary-file} without further interaction. If you directly press @key{RET} at the prompt without typing text, the target file will be shown in another window for you to finish the @@ -10038,7 +10038,7 @@ exportable as a beamer presentation. By default, the top-level entries (or the first level below the selected subtree heading) will be turned into frames, and the outline structure below this level will become itemize lists. You can also configure the variable @code{org-beamer-frame-level} to a -different level - then the hierarchy above frames will produce the sectioning +different level---then the hierarchy above frames will produce the sectioning structure of the presentation. A template for useful in-buffer settings or properties can be inserted into @@ -12632,7 +12632,7 @@ Source code blocks can be evaluated during export, or when pressing @kbd{C-c C-c} in the block. The most important thing to realize here is that Org mode files which contain code snippets are, in a certain sense, like executable files. So you should accept them and load them into Emacs only from trusted -sources - just like you would do with a program you install on your computer. +sources---just like you would do with a program you install on your computer. Make sure you know what you are doing before customizing the variables which take off the default security brakes. @@ -13028,7 +13028,7 @@ indentation shifts by two@footnote{See the variable stars but the last one are made invisible using the @code{org-hide} face@footnote{Turning on @code{org-indent-mode} sets @code{org-hide-leading-stars} to @code{t} and @code{org-adapt-indentation} to -@code{nil}.} - see below under @samp{2.} for more information on how this +@code{nil}.}---see below under @samp{2.} for more information on how this works. You can turn on @code{org-indent-mode} for all files by customizing the variable @code{org-startup-indented}, or you can turn it on for individual files using -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] put emacs functions in code font 2010-12-08 21:05 ` [PATCH] use emdashes when needed Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] use code font for example footnote labels Brian Gough 2011-02-01 11:32 ` [Accepted] put emacs functions in code font Bastien Guerry 0 siblings, 2 replies; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 44 ++++++++++++++++++++++---------------------- 1 files changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index c30378c..aecb224 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -12381,13 +12381,13 @@ are active: @multitable @columnfractions 0.25 0.75 @kindex C-c C-c -@item @kbd{C-c C-c} @tab org-babel-execute-src-block +@item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block} @kindex C-c C-o -@item @kbd{C-c C-o} @tab org-babel-open-src-block-result +@item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result} @kindex C-up -@item @kbd{C-@key{up}} @tab org-babel-load-in-session +@item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session} @kindex M-down -@item @kbd{M-@key{down}} @tab org-babel-pop-to-session +@item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session} @end multitable In an Org-mode buffer, the following key bindings are active: @@ -12395,46 +12395,46 @@ In an Org-mode buffer, the following key bindings are active: @multitable @columnfractions 0.45 0.55 @kindex C-c C-v a @kindex C-c C-v C-a -@item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab org-babel-sha1-hash +@item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash} @kindex C-c C-v b @kindex C-c C-v C-b -@item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab org-babel-execute-buffer +@item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer} @kindex C-c C-v f @kindex C-c C-v C-f -@item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab org-babel-tangle-file +@item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file} @kindex C-c C-v g -@item @kbd{C-c C-v g} @tab org-babel-goto-named-source-block +@item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block} @kindex C-c C-v h -@item @kbd{C-c C-v h} @tab org-babel-describe-bindings +@item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings} @kindex C-c C-v l @kindex C-c C-v C-l -@item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab org-babel-lob-ingest +@item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest} @kindex C-c C-v p @kindex C-c C-v C-p -@item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab org-babel-expand-src-block +@item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block} @kindex C-c C-v s @kindex C-c C-v C-s -@item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab org-babel-execute-subtree +@item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree} @kindex C-c C-v t @kindex C-c C-v C-t -@item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab org-babel-tangle +@item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle} @kindex C-c C-v z @kindex C-c C-v C-z -@item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab org-babel-switch-to-session +@item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session} @end multitable @c When possible these keybindings were extended to work when the control key is @c kept pressed, resulting in the following additional keybindings. @c @multitable @columnfractions 0.25 0.75 -@c @item @kbd{C-c C-v C-a} @tab org-babel-sha1-hash -@c @item @kbd{C-c C-v C-b} @tab org-babel-execute-buffer -@c @item @kbd{C-c C-v C-f} @tab org-babel-tangle-file -@c @item @kbd{C-c C-v C-l} @tab org-babel-lob-ingest -@c @item @kbd{C-c C-v C-p} @tab org-babel-expand-src-block -@c @item @kbd{C-c C-v C-s} @tab org-babel-execute-subtree -@c @item @kbd{C-c C-v C-t} @tab org-babel-tangle -@c @item @kbd{C-c C-v C-z} @tab org-babel-switch-to-session +@c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash} +@c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer} +@c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file} +@c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest} +@c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block} +@c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree} +@c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle} +@c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session} @c @end multitable @node Batch execution, , Key bindings and useful functions, Working With Source Code -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] use code font for example footnote labels 2010-12-08 21:05 ` [PATCH] put emacs functions in code font Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] fix missing word in math formatting section Brian Gough 2011-02-01 11:33 ` [Accepted] use code font for example footnote labels Bastien Guerry 2011-02-01 11:32 ` [Accepted] put emacs functions in code font Bastien Guerry 1 sibling, 2 replies; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index aecb224..a29f544 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -12892,9 +12892,9 @@ fninline @r{define footnotes inline} fnnoinline @r{define footnotes in separate section} fnlocal @r{define footnotes near first reference, but not inline} fnprompt @r{prompt for footnote labels} -fnauto @r{create [fn:1]-like labels automatically (default)} +fnauto @r{create @code{[fn:1]}-like labels automatically (default)} fnconfirm @r{offer automatic label for editing or confirmation} -fnplain @r{create [1]-like labels automatically} +fnplain @r{create @code{[1]}-like labels automatically} fnadjust @r{automatically renumber and sort footnotes} nofnadjust @r{do not renumber and sort automatically} @end example -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] fix missing word in math formatting section 2010-12-08 21:05 ` [PATCH] use code font for example footnote labels Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] typo/grammar fix for .done CSS explanation Brian Gough 2011-02-01 11:33 ` [Accepted] use code font for example footnote labels Bastien Guerry 1 sibling, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index a29f544..1c44a79 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -9649,7 +9649,7 @@ insert something like the following into the buffer: @code{org-export-html-mathjax-options} for the meaning of the parameters in this line. -If you prefer, you can also request that @LaTeX{} are processed into small +If you prefer, you can also request that @LaTeX{} fragments are processed into small images that will be inserted into the browser page. Before the availability of MathJax, this was the default method for Org files. This method requires that the @file{dvipng} program is available on your system. You can still -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] typo/grammar fix for .done CSS explanation 2010-12-08 21:05 ` [PATCH] fix missing word in math formatting section Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] explain how to check the default version of Org Brian Gough 2011-02-01 11:34 ` [Accepted] typo/grammar fix for .done CSS explanation Bastien Guerry 0 siblings, 2 replies; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 1c44a79..6b6d643 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -9701,7 +9701,7 @@ p.date @r{publishing date} p.creator @r{creator info, about org-mode version} .title @r{document title} .todo @r{TODO keywords, all not-done states} -.done @r{the DONE keywords, all stated the count as done} +.done @r{the DONE keywords, all states that count as done} .WAITING @r{each TODO keyword also uses a class named after itself} .timestamp @r{timestamp} .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED} -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] explain how to check the default version of Org 2010-12-08 21:05 ` [PATCH] typo/grammar fix for .done CSS explanation Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2010-12-08 21:05 ` [PATCH] add index entries Brian Gough 2011-02-01 11:36 ` [Accepted] explain how to check the default version of Org Bastien Guerry 2011-02-01 11:34 ` [Accepted] typo/grammar fix for .done CSS explanation Bastien Guerry 1 sibling, 2 replies; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 3 +-- 1 files changed, 1 insertions(+), 2 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 6b6d643..3a7356b 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -813,8 +813,7 @@ questions (FAQ), links to tutorials, etc@. This page is located at @cindex XEmacs @b{Important:} @i{If you are using a version of Org that is part of the Emacs -distribution or an XEmacs package, please skip this section and go directly -to @ref{Activation}.} +distribution or an XEmacs package, please skip this section and go directly to @ref{Activation}. To see what version of Org (if any) is part of your Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x org-version}.} If you have downloaded Org from the Web, either as a distribution @file{.zip} or @file{.tar} file, or as a Git archive, you must take the following steps -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [PATCH] add index entries 2010-12-08 21:05 ` [PATCH] explain how to check the default version of Org Brian Gough @ 2010-12-08 21:05 ` Brian Gough 2011-02-01 11:37 ` [Accepted] " Bastien Guerry 2011-02-01 11:36 ` [Accepted] explain how to check the default version of Org Bastien Guerry 1 sibling, 1 reply; 27+ messages in thread From: Brian Gough @ 2010-12-08 21:05 UTC (permalink / raw) To: emacs-orgmode; +Cc: Barry Gidden, Brian Gough --- doc/org.texi | 3 +++ 1 files changed, 3 insertions(+), 0 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 3a7356b..2cb8ce2 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -6135,6 +6135,7 @@ suggestion.} for capturing new material. @orgcmd{C-c c,org-capture} Call the command @code{org-capture}. Note that this keybinding is global and not active by default - you need to install it. If you have templates +@cindex date tree defined @pxref{Capture templates}, it will offer these templates for selection or use a new Org outline node as the default template. It will insert the template into the target file and switch to an indirect buffer @@ -7365,6 +7366,7 @@ the files listed in @code{org-agenda-text-search-extra-files}. @node Stuck projects, , Search view, Built-in agenda views @subsection Stuck projects +@pindex GTD, Getting Things Done If you are following a system like David Allen's GTD to organize your work, one of the ``duties'' you have is a regular review to make sure @@ -11255,6 +11257,7 @@ markup language for a wiki. @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code @section Extracting source code +@cindex tangling @cindex source code, extracting @cindex code block, extracting source code -- 1.6.0.6 ^ permalink raw reply related [flat|nested] 27+ messages in thread
* [Accepted] add index entries 2010-12-08 21:05 ` [PATCH] add index entries Brian Gough @ 2011-02-01 11:37 ` Bastien Guerry 0 siblings, 0 replies; 27+ messages in thread From: Bastien Guerry @ 2011-02-01 11:37 UTC (permalink / raw) To: emacs-orgmode Patch 462 (http://patchwork.newartisans.com/patch/462/) is now "Accepted". Maintainer comment: none This relates to the following submission: http://mid.gmane.org/%3C1291842341-15199-19-git-send-email-bjg%40network-theory.co.uk%3E Here is the original message containing the patch: > Content-Type: text/plain; charset="utf-8" > MIME-Version: 1.0 > Content-Transfer-Encoding: 7bit > Subject: [Orgmode] add index entries > Date: Thu, 09 Dec 2010 02:05:41 -0000 > From: Brian Gough <bjg@network-theory.co.uk> > X-Patchwork-Id: 462 > Message-Id: <1291842341-15199-19-git-send-email-bjg@network-theory.co.uk> > To: emacs-orgmode@gnu.org > Cc: Barry Gidden <barryg@network-theory.co.uk>, > Brian Gough <bjg@network-theory.co.uk> > > --- > doc/org.texi | 3 +++ > 1 files changed, 3 insertions(+), 0 deletions(-) > > > diff --git a/doc/org.texi b/doc/org.texi > index 3a7356b..2cb8ce2 100644 > --- a/doc/org.texi > +++ b/doc/org.texi > @@ -6135,6 +6135,7 @@ suggestion.} for capturing new material. > @orgcmd{C-c c,org-capture} > Call the command @code{org-capture}. Note that this keybinding is global and > not active by default - you need to install it. If you have templates > +@cindex date tree > defined @pxref{Capture templates}, it will offer these templates for > selection or use a new Org outline node as the default template. It will > insert the template into the target file and switch to an indirect buffer > @@ -7365,6 +7366,7 @@ the files listed in @code{org-agenda-text-search-extra-files}. > > @node Stuck projects, , Search view, Built-in agenda views > @subsection Stuck projects > +@pindex GTD, Getting Things Done > > If you are following a system like David Allen's GTD to organize your > work, one of the ``duties'' you have is a regular review to make sure > @@ -11255,6 +11257,7 @@ markup language for a wiki. > @comment Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code > @node Extracting source code, Evaluating code blocks, Exporting code blocks, Working With Source Code > @section Extracting source code > +@cindex tangling > @cindex source code, extracting > @cindex code block, extracting source code > > ^ permalink raw reply [flat|nested] 27+ messages in thread
* [Accepted] explain how to check the default version of Org 2010-12-08 21:05 ` [PATCH] explain how to check the default version of Org Brian Gough 2010-12-08 21:05 ` [PATCH] add index entries Brian Gough @ 2011-02-01 11:36 ` Bastien Guerry 1 sibling, 0 replies; 27+ messages in thread From: Bastien Guerry @ 2011-02-01 11:36 UTC (permalink / raw) To: emacs-orgmode Patch 452 (http://patchwork.newartisans.com/patch/452/) is now "Accepted". Maintainer comment: none This relates to the following submission: http://mid.gmane.org/%3C1291842341-15199-18-git-send-email-bjg%40network-theory.co.uk%3E Here is the original message containing the patch: > Content-Type: text/plain; charset="utf-8" > MIME-Version: 1.0 > Content-Transfer-Encoding: 7bit > Subject: [Orgmode] explain how to check the default version of Org > Date: Thu, 09 Dec 2010 02:05:40 -0000 > From: Brian Gough <bjg@network-theory.co.uk> > X-Patchwork-Id: 452 > Message-Id: <1291842341-15199-18-git-send-email-bjg@network-theory.co.uk> > To: emacs-orgmode@gnu.org > Cc: Barry Gidden <barryg@network-theory.co.uk>, > Brian Gough <bjg@network-theory.co.uk> > > --- > doc/org.texi | 3 +-- > 1 files changed, 1 insertions(+), 2 deletions(-) > > > diff --git a/doc/org.texi b/doc/org.texi > index 6b6d643..3a7356b 100644 > --- a/doc/org.texi > +++ b/doc/org.texi > @@ -813,8 +813,7 @@ questions (FAQ), links to tutorials, etc@. This page is located at > @cindex XEmacs > > @b{Important:} @i{If you are using a version of Org that is part of the Emacs > -distribution or an XEmacs package, please skip this section and go directly > -to @ref{Activation}.} > +distribution or an XEmacs package, please skip this section and go directly to @ref{Activation}. To see what version of Org (if any) is part of your Emacs distribution, type @kbd{M-x load-library RET org} and then @kbd{M-x org-version}.} > > If you have downloaded Org from the Web, either as a distribution @file{.zip} > or @file{.tar} file, or as a Git archive, you must take the following steps > ^ permalink raw reply [flat|nested] 27+ messages in thread
* [Accepted] typo/grammar fix for .done CSS explanation 2010-12-08 21:05 ` [PATCH] typo/grammar fix for .done CSS explanation Brian Gough 2010-12-08 21:05 ` [PATCH] explain how to check the default version of Org Brian Gough @ 2011-02-01 11:34 ` Bastien Guerry 1 sibling, 0 replies; 27+ messages in thread From: Bastien Guerry @ 2011-02-01 11:34 UTC (permalink / raw) To: emacs-orgmode Patch 456 (http://patchwork.newartisans.com/patch/456/) is now "Accepted". Maintainer comment: none This relates to the following submission: http://mid.gmane.org/%3C1291842341-15199-17-git-send-email-bjg%40network-theory.co.uk%3E Here is the original message containing the patch: > Content-Type: text/plain; charset="utf-8" > MIME-Version: 1.0 > Content-Transfer-Encoding: 7bit > Subject: [Orgmode] typo/grammar fix for .done CSS explanation > Date: Thu, 09 Dec 2010 02:05:39 -0000 > From: Brian Gough <bjg@network-theory.co.uk> > X-Patchwork-Id: 456 > Message-Id: <1291842341-15199-17-git-send-email-bjg@network-theory.co.uk> > To: emacs-orgmode@gnu.org > Cc: Barry Gidden <barryg@network-theory.co.uk>, > Brian Gough <bjg@network-theory.co.uk> > > --- > doc/org.texi | 2 +- > 1 files changed, 1 insertions(+), 1 deletions(-) > > > diff --git a/doc/org.texi b/doc/org.texi > index 1c44a79..6b6d643 100644 > --- a/doc/org.texi > +++ b/doc/org.texi > @@ -9701,7 +9701,7 @@ p.date @r{publishing date} > p.creator @r{creator info, about org-mode version} > .title @r{document title} > .todo @r{TODO keywords, all not-done states} > -.done @r{the DONE keywords, all stated the count as done} > +.done @r{the DONE keywords, all states that count as done} > .WAITING @r{each TODO keyword also uses a class named after itself} > .timestamp @r{timestamp} > .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED} > ^ permalink raw reply [flat|nested] 27+ messages in thread
* [Accepted] use code font for example footnote labels 2010-12-08 21:05 ` [PATCH] use code font for example footnote labels Brian Gough 2010-12-08 21:05 ` [PATCH] fix missing word in math formatting section Brian Gough @ 2011-02-01 11:33 ` Bastien Guerry 1 sibling, 0 replies; 27+ messages in thread From: Bastien Guerry @ 2011-02-01 11:33 UTC (permalink / raw) To: emacs-orgmode Patch 450 (http://patchwork.newartisans.com/patch/450/) is now "Accepted". Maintainer comment: none This relates to the following submission: http://mid.gmane.org/%3C1291842341-15199-15-git-send-email-bjg%40network-theory.co.uk%3E Here is the original message containing the patch: > Content-Type: text/plain; charset="utf-8" > MIME-Version: 1.0 > Content-Transfer-Encoding: 7bit > Subject: [Orgmode] use code font for example footnote labels > Date: Thu, 09 Dec 2010 02:05:37 -0000 > From: Brian Gough <bjg@network-theory.co.uk> > X-Patchwork-Id: 450 > Message-Id: <1291842341-15199-15-git-send-email-bjg@network-theory.co.uk> > To: emacs-orgmode@gnu.org > Cc: Barry Gidden <barryg@network-theory.co.uk>, > Brian Gough <bjg@network-theory.co.uk> > > --- > doc/org.texi | 4 ++-- > 1 files changed, 2 insertions(+), 2 deletions(-) > > > diff --git a/doc/org.texi b/doc/org.texi > index aecb224..a29f544 100644 > --- a/doc/org.texi > +++ b/doc/org.texi > @@ -12892,9 +12892,9 @@ fninline @r{define footnotes inline} > fnnoinline @r{define footnotes in separate section} > fnlocal @r{define footnotes near first reference, but not inline} > fnprompt @r{prompt for footnote labels} > -fnauto @r{create [fn:1]-like labels automatically (default)} > +fnauto @r{create @code{[fn:1]}-like labels automatically (default)} > fnconfirm @r{offer automatic label for editing or confirmation} > -fnplain @r{create [1]-like labels automatically} > +fnplain @r{create @code{[1]}-like labels automatically} > fnadjust @r{automatically renumber and sort footnotes} > nofnadjust @r{do not renumber and sort automatically} > @end example > ^ permalink raw reply [flat|nested] 27+ messages in thread
* [Accepted] put emacs functions in code font 2010-12-08 21:05 ` [PATCH] put emacs functions in code font Brian Gough 2010-12-08 21:05 ` [PATCH] use code font for example footnote labels Brian Gough @ 2011-02-01 11:32 ` Bastien Guerry 1 sibling, 0 replies; 27+ messages in thread From: Bastien Guerry @ 2011-02-01 11:32 UTC (permalink / raw) To: emacs-orgmode Patch 470 (http://patchwork.newartisans.com/patch/470/) is now "Accepted". Maintainer comment: none This relates to the following submission: http://mid.gmane.org/%3C1291842341-15199-14-git-send-email-bjg%40network-theory.co.uk%3E Here is the original message containing the patch: > Content-Type: text/plain; charset="utf-8" > MIME-Version: 1.0 > Content-Transfer-Encoding: 7bit > Subject: [Orgmode] put emacs functions in code font > Date: Thu, 09 Dec 2010 02:05:36 -0000 > From: Brian Gough <bjg@network-theory.co.uk> > X-Patchwork-Id: 470 > Message-Id: <1291842341-15199-14-git-send-email-bjg@network-theory.co.uk> > To: emacs-orgmode@gnu.org > Cc: Barry Gidden <barryg@network-theory.co.uk>, > Brian Gough <bjg@network-theory.co.uk> > > --- > doc/org.texi | 44 ++++++++++++++++++++++---------------------- > 1 files changed, 22 insertions(+), 22 deletions(-) > > > diff --git a/doc/org.texi b/doc/org.texi > index c30378c..aecb224 100644 > --- a/doc/org.texi > +++ b/doc/org.texi > @@ -12381,13 +12381,13 @@ are active: > > @multitable @columnfractions 0.25 0.75 > @kindex C-c C-c > -@item @kbd{C-c C-c} @tab org-babel-execute-src-block > +@item @kbd{C-c C-c} @tab @code{org-babel-execute-src-block} > @kindex C-c C-o > -@item @kbd{C-c C-o} @tab org-babel-open-src-block-result > +@item @kbd{C-c C-o} @tab @code{org-babel-open-src-block-result} > @kindex C-up > -@item @kbd{C-@key{up}} @tab org-babel-load-in-session > +@item @kbd{C-@key{up}} @tab @code{org-babel-load-in-session} > @kindex M-down > -@item @kbd{M-@key{down}} @tab org-babel-pop-to-session > +@item @kbd{M-@key{down}} @tab @code{org-babel-pop-to-session} > @end multitable > > In an Org-mode buffer, the following key bindings are active: > @@ -12395,46 +12395,46 @@ In an Org-mode buffer, the following key bindings are active: > @multitable @columnfractions 0.45 0.55 > @kindex C-c C-v a > @kindex C-c C-v C-a > -@item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab org-babel-sha1-hash > +@item @kbd{C-c C-v a} @ @ @r{or} @ @ @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash} > @kindex C-c C-v b > @kindex C-c C-v C-b > -@item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab org-babel-execute-buffer > +@item @kbd{C-c C-v b} @ @ @r{or} @ @ @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer} > @kindex C-c C-v f > @kindex C-c C-v C-f > -@item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab org-babel-tangle-file > +@item @kbd{C-c C-v f} @ @ @r{or} @ @ @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file} > @kindex C-c C-v g > -@item @kbd{C-c C-v g} @tab org-babel-goto-named-source-block > +@item @kbd{C-c C-v g} @tab @code{org-babel-goto-named-source-block} > @kindex C-c C-v h > -@item @kbd{C-c C-v h} @tab org-babel-describe-bindings > +@item @kbd{C-c C-v h} @tab @code{org-babel-describe-bindings} > @kindex C-c C-v l > @kindex C-c C-v C-l > -@item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab org-babel-lob-ingest > +@item @kbd{C-c C-v l} @ @ @r{or} @ @ @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest} > @kindex C-c C-v p > @kindex C-c C-v C-p > -@item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab org-babel-expand-src-block > +@item @kbd{C-c C-v p} @ @ @r{or} @ @ @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block} > @kindex C-c C-v s > @kindex C-c C-v C-s > -@item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab org-babel-execute-subtree > +@item @kbd{C-c C-v s} @ @ @r{or} @ @ @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree} > @kindex C-c C-v t > @kindex C-c C-v C-t > -@item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab org-babel-tangle > +@item @kbd{C-c C-v t} @ @ @r{or} @ @ @kbd{C-c C-v C-t} @tab @code{org-babel-tangle} > @kindex C-c C-v z > @kindex C-c C-v C-z > -@item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab org-babel-switch-to-session > +@item @kbd{C-c C-v z} @ @ @r{or} @ @ @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session} > @end multitable > > @c When possible these keybindings were extended to work when the control key is > @c kept pressed, resulting in the following additional keybindings. > > @c @multitable @columnfractions 0.25 0.75 > -@c @item @kbd{C-c C-v C-a} @tab org-babel-sha1-hash > -@c @item @kbd{C-c C-v C-b} @tab org-babel-execute-buffer > -@c @item @kbd{C-c C-v C-f} @tab org-babel-tangle-file > -@c @item @kbd{C-c C-v C-l} @tab org-babel-lob-ingest > -@c @item @kbd{C-c C-v C-p} @tab org-babel-expand-src-block > -@c @item @kbd{C-c C-v C-s} @tab org-babel-execute-subtree > -@c @item @kbd{C-c C-v C-t} @tab org-babel-tangle > -@c @item @kbd{C-c C-v C-z} @tab org-babel-switch-to-session > +@c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash} > +@c @item @kbd{C-c C-v C-b} @tab @code{org-babel-execute-buffer} > +@c @item @kbd{C-c C-v C-f} @tab @code{org-babel-tangle-file} > +@c @item @kbd{C-c C-v C-l} @tab @code{org-babel-lob-ingest} > +@c @item @kbd{C-c C-v C-p} @tab @code{org-babel-expand-src-block} > +@c @item @kbd{C-c C-v C-s} @tab @code{org-babel-execute-subtree} > +@c @item @kbd{C-c C-v C-t} @tab @code{org-babel-tangle} > +@c @item @kbd{C-c C-v C-z} @tab @code{org-babel-switch-to-session} > @c @end multitable > > @node Batch execution, , Key bindings and useful functions, Working With Source Code > ^ permalink raw reply [flat|nested] 27+ messages in thread
* [Accepted] make "time stamps" consistent with timestamps 2010-12-08 21:05 ` [PATCH] make "time stamps" consistent with timestamps Brian Gough 2010-12-08 21:05 ` [PATCH] make explanation of keyword lines clearer Brian Gough @ 2011-02-01 11:29 ` Bastien Guerry 1 sibling, 0 replies; 27+ messages in thread From: Bastien Guerry @ 2011-02-01 11:29 UTC (permalink / raw) To: emacs-orgmode Patch 454 (http://patchwork.newartisans.com/patch/454/) is now "Accepted". Maintainer comment: none This relates to the following submission: http://mid.gmane.org/%3C1291842341-15199-11-git-send-email-bjg%40network-theory.co.uk%3E Here is the original message containing the patch: > Content-Type: text/plain; charset="utf-8" > MIME-Version: 1.0 > Content-Transfer-Encoding: 7bit > Subject: [Orgmode] make "time stamps" consistent with timestamps > Date: Thu, 09 Dec 2010 02:05:33 -0000 > From: Brian Gough <bjg@network-theory.co.uk> > X-Patchwork-Id: 454 > Message-Id: <1291842341-15199-11-git-send-email-bjg@network-theory.co.uk> > To: emacs-orgmode@gnu.org > Cc: Barry Gidden <barryg@network-theory.co.uk>, > Brian Gough <bjg@network-theory.co.uk> > > --- > doc/org.texi | 4 ++-- > 1 files changed, 2 insertions(+), 2 deletions(-) > > > diff --git a/doc/org.texi b/doc/org.texi > index 930f948..553d670 100644 > --- a/doc/org.texi > +++ b/doc/org.texi > @@ -6608,7 +6608,7 @@ create new nodes as new parents for refiling on the fly, check the > variable @code{org-refile-allow-creating-parent-nodes}. > When the variable @code{org-log-refile}@footnote{with corresponding > @code{#+STARTUP} keywords @code{logrefile}, @code{lognoterefile}, > -and @code{nologrefile}} is set, a time stamp or a note will be > +and @code{nologrefile}} is set, a timestamp or a note will be > recorded when an entry has been refiled. > @orgkey{C-u C-c C-w} > Use the refile interface to jump to a heading. > @@ -7987,7 +7987,7 @@ $ @r{Archive all selected entries.} > A @r{Archive entries by moving them to their respective archive siblings.} > t @r{Change TODO state. This prompts for a single TODO keyword and} > @r{changes the state of all selected entries, bypassing blocking and} > - @r{suppressing logging notes (but not time stamps).} > + @r{suppressing logging notes (but not timestamps).} > + @r{Add a tag to all selected entries.} > - @r{Remove a tag from all selected entries.} > s @r{Schedule all items to a new date. To shift existing schedule dates} > ^ permalink raw reply [flat|nested] 27+ messages in thread
* Re: [PATCH] include explanations of how to look up a docstring 2010-12-08 21:05 ` [PATCH] include explanations of how to look up a docstring Brian Gough 2010-12-08 21:05 ` [PATCH] use a full sentence Brian Gough @ 2010-12-09 17:38 ` Giovanni Ridolfi 1 sibling, 0 replies; 27+ messages in thread From: Giovanni Ridolfi @ 2010-12-09 17:38 UTC (permalink / raw) To: Brian Gough; +Cc: emacs-orgmode, carsten.dominik Brian Gough <bjg@network-theory.co.uk> writes: > include explanations of how to look up a docstring > --- a/doc/org.texi > +++ b/doc/org.texi > @@ -1346,8 +1346,7 @@ Clone a subtree by making a number of sibling copies of it. You will be [...] > This can be useful, for example, > to create a number of tasks related to a series of lectures to prepare. For > -more details, see the docstring of the command > -@code{org-clone-subtree-with-time-shift}. > +more details, see the docstring@footnote{Docstrings for commands can > be displayed with @kbd{M-x describe-function} or @kbd{C-h f}.} [...] > This is handled by the variable @code{org-footnote-auto-label} and its > -corresponding @code{#+STARTUP} keywords. See the docstring of that variable > -for details. > +corresponding @code{#+STARTUP} keywords. See the > docstring@footnote{Docstrings for variables can be displayed with > @kbd{M-x describe-variable} or @kbd{C-h v}.} of that variable for > details. IMO these explanations are redundant. It is an Org-mode manual not a GNU/Emacs manual. see eg: http://lists.gnu.org/archive/html/emacs-orgmode/2006-11/msg00012.html ;-) cheers, Giovanni ^ permalink raw reply [flat|nested] 27+ messages in thread
* [Accepted] use @result{} instead of --> (looks nicer) 2010-12-08 21:05 [PATCH] use @result{} instead of --> (looks nicer) Brian Gough 2010-12-08 21:05 ` [PATCH] use macro for @LaTeX name Brian Gough @ 2011-01-26 17:33 ` Bastien Guerry 1 sibling, 0 replies; 27+ messages in thread From: Bastien Guerry @ 2011-01-26 17:33 UTC (permalink / raw) To: emacs-orgmode Patch 458 (http://patchwork.newartisans.com/patch/458/) is now "Accepted". Maintainer comment: none This relates to the following submission: http://mid.gmane.org/%3C1291842341-15199-1-git-send-email-bjg%40network-theory.co.uk%3E Here is the original message containing the patch: > Content-Type: text/plain; charset="utf-8" > MIME-Version: 1.0 > Content-Transfer-Encoding: 7bit > Subject: [Orgmode] use @result{} instead of --> (looks nicer) > Date: Thu, 09 Dec 2010 02:05:23 -0000 > From: Brian Gough <bjg@network-theory.co.uk> > X-Patchwork-Id: 458 > Message-Id: <1291842341-15199-1-git-send-email-bjg@network-theory.co.uk> > To: emacs-orgmode@gnu.org > Cc: Barry Gidden <barryg@network-theory.co.uk>, > Brian Gough <bjg@network-theory.co.uk> > > --- > doc/org.texi | 54 +++++++++++++++++++++++++++--------------------------- > 1 files changed, 27 insertions(+), 27 deletions(-) > > > diff --git a/doc/org.texi b/doc/org.texi > index 7df03fe..94a4290 100644 > --- a/doc/org.texi > +++ b/doc/org.texi > @@ -5304,20 +5304,20 @@ various inputs will be interpreted, the items filled in by Org-mode are > in @b{bold}. > > @example > -3-2-5 --> 2003-02-05 > -2/5/3 --> 2003-02-05 > -14 --> @b{2006}-@b{06}-14 > -12 --> @b{2006}-@b{07}-12 > -2/5 --> @b{2007}-02-05 > -Fri --> nearest Friday (default date or later) > -sep 15 --> @b{2006}-09-15 > -feb 15 --> @b{2007}-02-15 > -sep 12 9 --> 2009-09-12 > -12:45 --> @b{2006}-@b{06}-@b{13} 12:45 > -22 sept 0:34 --> @b{2006}-09-22 0:34 > -w4 --> ISO week for of the current year @b{2006} > -2012 w4 fri --> Friday of ISO week 4 in 2012 > -2012-w04-5 --> Same as above > +3-2-5 @result{} 2003-02-05 > +2/5/3 @result{} 2003-02-05 > +14 @result{} @b{2006}-@b{06}-14 > +12 @result{} @b{2006}-@b{07}-12 > +2/5 @result{} @b{2007}-02-05 > +Fri @result{} nearest Friday (default date or later) > +sep 15 @result{} @b{2006}-09-15 > +feb 15 @result{} @b{2007}-02-15 > +sep 12 9 @result{} 2009-09-12 > +12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45 > +22 sept 0:34 @result{} @b{2006}-09-22 0:34 > +w4 @result{} ISO week for of the current year @b{2006} > +2012 w4 fri @result{} Friday of ISO week 4 in 2012 > +2012-w04-5 @result{} Same as above > @end example > > Furthermore you can specify a relative date by giving, as the > @@ -5329,13 +5329,13 @@ a single letter, you use the abbreviation of day name, the date will be > the Nth such day. E.g. > > @example > -+0 --> today > -. --> today > -+4d --> four days from today > -+4 --> same as above > -+2w --> two weeks from today > -++5 --> five days from default date > -+2tue --> second Tuesday from now. > ++0 @result{} today > +. @result{} today > ++4d @result{} four days from today > ++4 @result{} same as above > ++2w @result{} two weeks from today > +++5 @result{} five days from default date > ++2tue @result{} second Tuesday from now. > @end example > > @vindex parse-time-months > @@ -5349,9 +5349,9 @@ start time and a duration (in HH:MM format). Use `-' or `-{}-' as the separator > in the former case and use '+' as the separator in the latter case. E.g. > > @example > -11am-1:15pm --> 11:00-13:15 > -11am--1:15pm --> same as above > -11am+2:15 --> same as above > +11am-1:15pm @result{} 11:00-13:15 > +11am--1:15pm @result{} same as above > +11am+2:15 @result{} same as above > @end example > > @cindex calendar, for selecting date > @@ -13295,9 +13295,9 @@ Org will move the following key bindings in Org files, and in the agenda > buffer (but not during date selection). > > @example > -S-UP -> M-p S-DOWN -> M-n > -S-LEFT -> M-- S-RIGHT -> M-+ > -C-S-LEFT -> M-S-- C-S-RIGHT -> M-S-+ > +S-UP @result{} M-p S-DOWN @result{} M-n > +S-LEFT @result{} M-- S-RIGHT @result{} M-+ > +C-S-LEFT @result{} M-S-- C-S-RIGHT @result{} M-S-+ > @end example > > @vindex org-disputed-keys > ^ permalink raw reply [flat|nested] 27+ messages in thread
end of thread, other threads:[~2011-02-01 11:37 UTC | newest] Thread overview: 27+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2010-12-08 21:05 [PATCH] use @result{} instead of --> (looks nicer) Brian Gough 2010-12-08 21:05 ` [PATCH] use macro for @LaTeX name Brian Gough 2010-12-08 21:05 ` [PATCH] make use of the provided @ie and @eg macros to fix the spacing Brian Gough 2010-12-08 21:05 ` [PATCH] fix commas that should be full stops, semicolons or emdashes Brian Gough 2010-12-08 21:05 ` [PATCH] fix plain text that looks better with markup Brian Gough 2010-12-08 21:05 ` [PATCH] use kbd font Brian Gough 2010-12-08 21:05 ` [PATCH] improvements to wording style Brian Gough 2010-12-08 21:05 ` [PATCH] include explanations of how to look up a docstring Brian Gough 2010-12-08 21:05 ` [PATCH] use a full sentence Brian Gough 2010-12-08 21:05 ` [PATCH] tangling is not a widely-known term, describe it as literate programming Brian Gough 2010-12-08 21:05 ` [PATCH] make "time stamps" consistent with timestamps Brian Gough 2010-12-08 21:05 ` [PATCH] make explanation of keyword lines clearer Brian Gough 2010-12-08 21:05 ` [PATCH] use emdashes when needed Brian Gough 2010-12-08 21:05 ` [PATCH] put emacs functions in code font Brian Gough 2010-12-08 21:05 ` [PATCH] use code font for example footnote labels Brian Gough 2010-12-08 21:05 ` [PATCH] fix missing word in math formatting section Brian Gough 2010-12-08 21:05 ` [PATCH] typo/grammar fix for .done CSS explanation Brian Gough 2010-12-08 21:05 ` [PATCH] explain how to check the default version of Org Brian Gough 2010-12-08 21:05 ` [PATCH] add index entries Brian Gough 2011-02-01 11:37 ` [Accepted] " Bastien Guerry 2011-02-01 11:36 ` [Accepted] explain how to check the default version of Org Bastien Guerry 2011-02-01 11:34 ` [Accepted] typo/grammar fix for .done CSS explanation Bastien Guerry 2011-02-01 11:33 ` [Accepted] use code font for example footnote labels Bastien Guerry 2011-02-01 11:32 ` [Accepted] put emacs functions in code font Bastien Guerry 2011-02-01 11:29 ` [Accepted] make "time stamps" consistent with timestamps Bastien Guerry 2010-12-09 17:38 ` [PATCH] include explanations of how to look up a docstring Giovanni Ridolfi 2011-01-26 17:33 ` [Accepted] use @result{} instead of --> (looks nicer) Bastien Guerry
Code repositories for project(s) associated with this public inbox https://git.savannah.gnu.org/cgit/emacs/org-mode.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).