Re: [PATCH] correct doc typos

[Carsten Dominik <carsten.dominik@gmail.com>]

On Nov 25, 2010, at 6:46 PM, Brian Gough wrote:

> Hi
>
> Here is a patch for some proofreading corrections for the Org manual.
> This is just an sample to check if it is in suitable format.  We have
> a lot more corrections to come.
>
> Because there are more than 20 lines affected I'm assuming we will
> need to do copyright assignments.  If not I can send all the patches
> now.  Alternatively would you prefer us to wait until the assignment
> is done?
>
> I haven't included a changelog entry since these are just for typos
> etc and don't make any major changes to the meaning of the text.
>
> Credit to my colleague Barry Gidden for the proofreading, he did the
> real work on this.


Hi Brain,

thanks for the corrections - after applying them, the acknowledgement
section now carries credits to Barry for proofreading and to you
for turning this into a book (a bit premature - but hopefully not for  
long!)

- Carsten

>
> -- 
> Brian Gough
>
> Network Theory Ltd,
> Publishing Free Software Manuals --- http://www.network-theory.co.uk/
>
>
> From 03619e889bf061607785f092481dbfe36bcee9be Mon Sep 17 00:00:00 2001
> From: Brian Gough <bjg@network-theory.co.uk>
> Date: Thu, 25 Nov 2010 17:02:38 +0000
> Subject: [PATCH] correct doc typos
>
> ---
> doc/org.texi |   90 +++++++++++++++++++++++++++ 
> +-----------------------------
> 1 files changed, 44 insertions(+), 46 deletions(-)
>
> diff --git a/doc/org.texi b/doc/org.texi
> index f391e84..a0b1b0b 100644
> --- a/doc/org.texi
> +++ b/doc/org.texi
> @@ -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 a different value (e.g.  
> 20), start
> +@samp{1)}.  If you want a list to start with a different value  
> (e.g. 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
> @@ -1537,7 +1537,7 @@ XEmacs, you should use Kyle E. Jones'  
> @file{filladapt.el}.  To turn this on,
> put into @file{.emacs}: @code{(require 'filladapt)}}, and by  
> exporting them
> properly (@pxref{Exporting}).  Since indentation is what governs the
> structure of these lists, many structural constructs like @code{# 
> +BEGIN_...}
> -blocks can be indented to signal that they should be considered of  
> a list
> +blocks can be indented to signal that they should be considered as  
> a list
> item.
>
> @vindex org-list-demote-modify-bullet
> @@ -1548,7 +1548,7 @@ the current list-level) improves readability,  
> customize the variable
> @vindex org-list-automatic-rules
> The following commands act on items when the cursor is in the first  
> line of
> an item (the line with the bullet or number).  Some of them imply the
> -application of automatic rules to keep list structure in tact.  If  
> some of
> +application of automatic rules to keep list structure intact.  If  
> some of
> these actions get in your way, configure @code{org-list-automatic- 
> rules}
> to disable them individually.
>
> @@ -1569,7 +1569,7 @@ heading (@pxref{Structure editing}).  If this  
> command is used in the middle
> of a line, the line is @emph{split} and the rest of the line becomes  
> the new
> item@footnote{If you do not want the line to be split, customize the  
> variable
> @code{org-M-RET-may-split-line}.}.  If this command is executed  
> @emph{before
> -item's body}, the new item is created @emph{before} the current  
> item.  If the
> +an item's body}, the new item is created @emph{before} the current  
> item.  If the
> command is executed in the white space before the text that is part  
> of an
> item but does not contain the bullet, a bullet is added to the  
> current line.
>
> @@ -1581,7 +1581,7 @@ the structure, or return an error.
> Insert a new item with a checkbox (@pxref{Checkboxes}).
> @orgcmd{@key{TAB},org-cycle}
> In a new item with no text yet, the first @key{TAB} demotes the item  
> to
> -become a child of the previous one.  Subsequents @key{TAB} move the  
> item to
> +become a child of the previous one.  Subsequent @key{TAB}s move the  
> item to
> meaningful levels in the list and eventually get it back to its  
> initial
> position.
> @kindex S-@key{down}
> @@ -1687,8 +1687,7 @@ press @key{TAB} there.  Org-mode uses the  
> @code{PROPERTIES} drawer for
> storing properties (@pxref{Properties and Columns}), and you can  
> also arrange
> for state change notes (@pxref{Tracking TODO state changes}) and  
> clock times
> (@pxref{Clocking work time}) to be stored in a drawer  
> @code{LOGBOOK}.  If you
> -want to store a quick note in the LOGBOOK drawer, in a similar way  
> as this is
> -done by state changes, use
> +want to store a quick note in the LOGBOOK drawer, in a similar way  
> to state changes, use
>
> @table @kbd
> @kindex C-c C-z
> @@ -1843,7 +1842,7 @@ When this mode is active and the cursor is on  
> a line that looks to Org like a
> headline or the first line of a list item, most structure editing  
> commands
> will work, even if the same keys normally have different  
> functionality in the
> major mode you are using.  If the cursor is not in one of those  
> special
> -lines, Orgstruct mode lurks silently in the shadow.  When you use
> +lines, Orgstruct mode lurks silently in the shadows.  When you use
> @code{orgstruct++-mode}, Org will also export indentation and autofill
> settings into that mode, and detect item context after the first  
> line of an
> item.
> @@ -2137,7 +2136,7 @@ on a per-file basis with:
> @end example
>
> If you would like to overrule the automatic alignment of number-rich  
> columns
> -to the right and of string-rich column to the left, you and use  
> @samp{<r>},
> +to the right and of string-rich column to the left, you can use  
> @samp{<r>},
> @samp{c}@footnote{Centering does not work inside Emacs, but it does  
> have an
> effect when exporting to HTML.} or @samp{<l>} in a similar fashion.   
> You may
> also combine alignment and field width like this: @samp{<l10>}.
> @@ -2470,7 +2469,7 @@ tan($1);Dp3s1        @r{Compute in degrees,  
> precision 3, display SCI 1}
> sin($1);Dp3%.1e      @r{Same, but use printf specifier for display}
> vmean($2..$7)        @r{Compute column range mean, using vector  
> function}
> vmean($2..$7);EN     @r{Same, but treat empty fields as 0}
> -taylor($3,x=7,2)     @r{taylor series of $3, at x=7, second degree}
> +taylor($3,x=7,2)     @r{Taylor series of $3, at x=7, second degree}
> @end example
>
> Calc also contains a complete set of logical operations.  For example
> @@ -3859,7 +3858,7 @@ work time}.
>
> The most basic logging is to keep track of @emph{when} a certain TODO
> item was finished.  This is achieved with@footnote{The corresponding
> -in-buffer setting is: @code{#+STARTUP: logdone}}.
> +in-buffer setting is: @code{#+STARTUP: logdone}}
>
> @lisp
> (setq org-log-done 'time)
> @@ -4759,7 +4758,7 @@ single property:
> Create a sparse tree based on the value of a property.  This first
> prompts for the name of a property, and then for a value.  A sparse  
> tree
> is created with all entries that define this property with the given
> -value.  If you enclose the value into curly braces, it is  
> interpreted as
> +value.  If you enclose the value in curly braces, it is interpreted  
> as
> a regular expression and matched against the property values.
> @end table
>
> @@ -4779,7 +4778,7 @@ useful, you can turn it on by setting the  
> variable
> all properties inherited from the parent, to a list of properties
> that should be inherited, or to a regular expression that matches
> inherited properties.  If a property has the value @samp{nil}, this is
> -interpreted as an explicit undefine of he property, so that  
> inheritance
> +interpreted as an explicit undefine of the property, so that  
> inheritance
> search will stop at this value and return @code{nil}.
>
> Org-mode has a few properties for which inheritance is hard-coded, at
> @@ -4921,7 +4920,7 @@ same summary information.
> The @code{est+} summary type requires further explanation.  It is  
> used for
> combining estimates, expressed as low-high ranges.  For example,  
> instead
> of estimating a particular task will take 5 days, you might estimate  
> it as
> -5-6 days if you're fairly confident you know how much woark is  
> required, or
> +5-6 days if you're fairly confident you know how much work is  
> required, or
> 1-10 days if you don't really know what needs to be done.  Both ranges
> average at 5.5 days, but the first represents a more predictable  
> delivery.
>
> @@ -5345,7 +5344,7 @@ you want to use unabbreviated names and/or  
> other languages, configure
> 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
> +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
> @@ -5430,7 +5429,7 @@ just like @kbd{S-@key{left}/@key{right}}.  At  
> the end of the stamp, the
> time will be changed by one minute.
> @item
> If the timestamp contains a range of clock times or a repeater, these
> -will not be overlayed, but remain in the buffer as they were.
> +will not be overlaid, but remain in the buffer as they were.
> @item
> When you delete a timestamp character-by-character, it will only
> disappear from the buffer after @emph{all} (invisible) characters
> @@ -5624,7 +5623,7 @@ With the @samp{+1m} cookie, the date shift  
> will always be exactly one
> month.  So if you have not paid the rent for three months, marking  
> this
> entry DONE will still keep it as an overdue deadline.  Depending on  
> the
> task, this may not be the best way to handle it.  For example, if you
> -forgot to call you father for 3 weeks, it does not make sense to call
> +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
> @@ -5854,7 +5853,7 @@ but you can specify your own function using  
> the @code{:formatter} parameter.
>              @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.}
> :formula     @r{Content of a @code{#+TBLFM} line to be added and  
> evaluated.}
>              @r{As a special case, @samp{:formula %} adds a column  
> with % time.}
> -             @r{If you do not specify a formula here, any existing  
> formula.}
> +             @r{If you do not specify a formula here, any existing  
> formula}
>              @r{below the clock table will survive updates and be  
> evaluated.}
> :formatter   @r{A function to format clock data and insert it into  
> the buffer.}
> @end example
> @@ -6608,7 +6607,7 @@ Refile as the child of the item currently  
> being clocked.
> @orgcmdtkc{C-0 C-c C-w @ @r{or} @ C-u C-u C-u C-c C-w,C-0 C-c C- 
> w,org-refile-cache-clear}
>
> Clear the target cache.  Caching of refile targets can be turned on by
> -setting @code{org-refile-use-cache}.  To make the command seen new  
> possible
> +setting @code{org-refile-use-cache}.  To make the command see new  
> possible
> targets, you have to clear the cache with this command.
> @end table
>
> @@ -7722,7 +7721,7 @@ file or subtree (@pxref{Agenda files}).
> Filter the current agenda view with respect to a tag and/or effort  
> estimates.
> The difference between this and a custom agenda command is that  
> filtering is
> very fast, so that you can switch quickly between different filters  
> without
> -having to recreate the agenda@footnote{Custom commands can preset a  
> filter by
> +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
> @@ -7741,7 +7740,7 @@ Instead of pressing @kbd{+} or @kbd{-} after  
> @kbd{/}, you can also
> immediately use the @kbd{\} command.
>
> @vindex org-sort-agenda-noeffort-is-high
> -In order to filter for effort estimates, you should set-up allowed
> +In order to filter for effort estimates, you should set up allowed
> efforts globally, for example
> @lisp
> (setq org-global-properties
> @@ -7883,9 +7882,9 @@ Decrease the priority of the current item.
> @c
> @orgcmdkkc{z,C-c C-z,org-agenda-add-note}
> @vindex org-log-into-drawer
> -Add a note to the entry.  This note will be recorded, and then  
> files to the
> +Add a note to the entry.  This note will be recorded, and then  
> filed to the
> same location where state change notes are put.  Depending on
> -@code{org-log-into-drawer}, this maybe inside a drawer.
> +@code{org-log-into-drawer}, this may be inside a drawer.
> @c
> @orgcmd{C-c C-a,org-attach}
> Dispatcher for all command related to attachments.
> @@ -8728,7 +8727,7 @@ 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
> @@ -8973,7 +8972,7 @@ not necessary (but OK) to surround multi- 
> character sub- and superscripts
> with curly braces.  For example
>
> @example
> -The mass if the sun is M_sun = 1.989 x 10^30 kg.  The radius of
> +The mass of the sun is M_sun = 1.989 x 10^30 kg.  The radius of
> the sun is R_@{sun@} = 6.96 x 10^8 m.
> @end example
>
> @@ -9258,7 +9257,7 @@ Insert template with export options, see  
> example below.
> @example
> #+TITLE:       the title to be shown (default is the buffer name)
> #+AUTHOR:      the author (default taken from @code{user-full-name})
> -#+DATE:        a date, fixed, of a format string for @code{format- 
> time-string}
> +#+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
> @@ -9360,7 +9359,7 @@ Like @kbd{C-c C-e}, but only export the text  
> that is currently visible
> (i.e. not hidden by outline visibility).
> @orgcmd{C-u C-u C-c C-e,org-export}
> @vindex org-export-run-in-background
> -Call an the exporter, but reverse the setting of
> +Call the exporter, but reverse the setting of
> @code{org-export-run-in-background}, i.e. request background  
> processing if
> not set, or force processing in the current Emacs process if set.
> @end table
> @@ -9783,7 +9782,7 @@ sdepth:  @r{Maximum headline level that will  
> still become an independent}
>          @r{@code{org-export-headline-levels} (= the @code{H} switch  
> in @code{#+OPTIONS}).}
>          @r{If this is smaller than in @code{org-export-headline- 
> levels}, each}
>          @r{info/folding section can still contain child headlines.}
> -toc:     @r{Should the table of content @emph{initially} be visible?}
> +toc:     @r{Should the table of contents @emph{initially} be  
> visible?}
>          @r{Even when @code{nil}, you can always get to the "toc"  
> with @kbd{i}.}
> tdepth:  @r{The depth of the table of contents.  The defaults are  
> taken from}
>          @r{the variables @code{org-export-headline-levels} and  
> @code{org-export-with-toc}.}
> @@ -10219,7 +10218,7 @@ exported DocBook XML files invalid by not  
> quoting DocBook code correctly.
> #+BEGIN_DOCBOOK
> <warning>
>   <para>You should know what you are doing when quoting DocBook XML  
> code
> -  in your Org file.  Invalid DocBook XML file may be generated by
> +  in your Org file.  Invalid DocBook XML may be generated by
>   DocBook exporter if you are not careful!</para>
> </warning>
> #+END_DOCBOOK
> @@ -11224,7 +11223,7 @@ Neither the code block nor its results will  
> be exported.
> @end table
>
> It is possible to inhibit the evaluation of code blocks during export.
> -Setting the the @code{org-export-babel-evaluate} variable to  
> @code{nil} will
> +Setting the @code{org-export-babel-evaluate} variable to @code{nil}  
> will
> ensure that no code blocks are evaluated as part of the export  
> process.  This
> can be useful in situations where potentially untrusted Org-mode  
> files are
> exported in an automated fashion, for example when Org-mode is used  
> as the
> @@ -11921,7 +11920,7 @@ and a link of the following form will be  
> inserted in the org buffer:
> Most of this functionality follows immediately from the fact that  
> @code{:dir}
> sets the value of the Emacs variable @code{default-directory},  
> thanks to
> tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need  
> to
> -install tramp separately in order for the these features to work  
> correctly.
> +install tramp separately in order for these features to work  
> correctly.
>
> @subsubheading Further points
>
> @@ -12685,7 +12684,7 @@ applies.
> @vindex org-table-formula-constants
> @vindex org-table-formula
> Set file-local values for constants to be used in table formulas.   
> This
> -line set the local variable @code{org-table-formula-constants-local}.
> +line sets the local variable @code{org-table-formula-constants- 
> local}.
> The global version of this variable is
> @code{org-table-formula-constants}.
> @item #+FILETAGS: :tag1:tag2:tag3:
> @@ -12706,7 +12705,7 @@ These lines (several are allowed) specify  
> link abbreviations.
> @vindex org-default-priority
> This line sets the limits and the default for the priorities.  All  
> three
> must be either letters A-Z or numbers 0-9.  The highest priority must
> -have a lower ASCII number that the lowest priority.
> +have a lower ASCII number than the lowest priority.
> @item #+PROPERTY: Property_Name Value
> This line sets a default inheritance value for entries in the current
> buffer, most useful for specifying the allowed values of a property.
> @@ -12887,7 +12886,7 @@ hideblocks   @r{Hide all begin/end blocks on  
> startup}
> nohideblocks @r{Do not hide blocks on startup}
> @end example
> @cindex org-pretty-entities
> -The the display of entities as UTF8 characters is governed by the  
> variable
> +The display of entities as UTF8 characters is governed by the  
> variable
> @code{org-pretty-entities} and the keywords
> @cindex @code{entitiespretty}, STARTUP keyword
> @cindex @code{entitiesplain}, STARTUP keyword
> @@ -13016,7 +13015,7 @@ individual files using
> #+STARTUP: indent
> @end example
>
> -If you want a similar effect in earlier version of Emacs and/or  
> Org, or if
> +If you want a similar effect in an earlier version of Emacs and/or  
> Org, or if
> you want the indentation to be hard space characters so that the  
> plain text
> file looks as similar as possible to the Emacs display, Org supports  
> you in
> the following way:
> @@ -13279,7 +13278,7 @@ to have other replacement keys, look at the  
> variable
> @item @file{yasnippet.el}
> @cindex @file{yasnippet.el}
> The way Org-mode binds the TAB key (binding to @code{[tab]} instead of
> -@code{"\t"}) overrules yasnippets' access to this key.  The  
> following code
> +@code{"\t"}) overrules yasnippet's access to this key.  The  
> following code
> fixed this problem:
>
> @lisp
> @@ -13461,7 +13460,7 @@ can also set the @code{:description}  
> property to provide a default for
> the link description when the link is later inserted into an Org
> buffer with @kbd{C-c C-l}.
>
> -When is makes sense for your new link type, you may also define a  
> function
> +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)
> 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.
> @@ -13793,9 +13792,9 @@ others can benefit from your work.
> @cindex radio lists
> @cindex org-list-insert-radio-list
>
> -Sending and receiving radio lists works exactly the same way than  
> sending and
> +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 lists templates in HTML, La@TeX{} and Texinfo modes by  
> calling
> +insert radio list templates in HTML, La@TeX{} and Texinfo modes by  
> calling
> @code{org-list-insert-radio-list}.
>
> Here are the differences with radio tables:
> @@ -13841,7 +13840,7 @@ specially marked regions that are updated by  
> some user-written function.
> A good example for such a block is the clock table inserted by the
> command @kbd{C-c C-x C-r} (@pxref{Clocking work time}).
>
> -Dynamic block are enclosed by a BEGIN-END structure that assigns a  
> name
> +Dynamic blocks are enclosed by a BEGIN-END structure that assigns a  
> name
> to the block and can also specify parameters for the function  
> producing
> the content of the block.
>
> @@ -14162,7 +14161,7 @@ values and check if VALUE is in this list.
> @end defun
>
> @defopt org-property-allowed-value-functions
> -Hook for functions supplying allowed values for specific.
> +Hook for functions supplying allowed values for a specific property.
> The functions must take a single argument, the name of the property,  
> and
> return a flat list of allowed values.  If @samp{:ETC} is one of
> the values, use the values as completion help, but allow also other  
> values
> @@ -14314,7 +14313,7 @@ in-buffer settings, but it will understand  
> the logistics of TODO state
> @node Setting up the staging area, Pushing to MobileOrg, MobileOrg,  
> MobileOrg
> @section Setting up the staging area
>
> -MobileOrg needs to interact with Emacs through directory on a  
> server.  If you
> +MobileOrg needs to interact with Emacs through a directory on a  
> server.  If you
> are using a public server, you should consider to encrypt the files  
> that are
> uploaded to the server.  This can be done with Org-mode 7.02 and with
> @i{MobileOrg 1.5} (iPhone version), and you need an @file{openssl}
> @@ -14329,8 +14328,7 @@ variable.  Note that encryption will apply  
> only to the contents of the
> The easiest way to create that directory is to use a free
> @uref{http://dropbox.com,Dropbox.com} account@footnote{If you cannot  
> use
> Dropbox, or if your version of MobileOrg does not support it, you  
> can use a
> -webdav server.  For more information, check out the the  
> documentation of
> -MobileOrg and also this
> +webdav server.  For more information, check out the documentation  
> of MobileOrg and also this
> @uref{http://orgmode.org/worg/org-faq.php#mobileorg_webdav, FAQ  
> entry}.}.
> When MobileOrg first connects to your Dropbox, it will create a  
> directory
> @i{MobileOrg} inside the Dropbox.  After the directory has been  
> created, tell
> @@ -14350,7 +14348,7 @@ This operation copies all files currently  
> listed in @code{org-mobile-files}
> to the directory @code{org-mobile-directory}.  By default this list  
> contains
> all agenda files (as listed in @code{org-agenda-files}), but  
> additional files
> can be included by customizing @code{org-mobiles-files}.  File names  
> will be
> -staged with path relative to @code{org-directory}, so all files  
> should be
> +staged with paths relative to @code{org-directory}, so all files  
> should be
> inside this directory.  The push operation also creates a special  
> Org file
> @file{agendas.org} with all custom agenda view defined by the
> user@footnote{While creating the agendas, Org-mode will force ID  
> properties
> @@ -14404,7 +14402,7 @@ another window and also push it onto the  
> kill ring.  So you could use @kbd{?
> z C-y C-c C-c} to store that flagging note as a normal note in the  
> entry.
> Pressing @kbd{?} twice in succession will offer to remove the
> @code{:FLAGGED:} tag along with the recorded flagging note (which is  
> stored
> -in a property).  In this way you indicate, that the intended  
> processing for
> +in a property).  In this way you indicate that the intended  
> processing for
> this flagged entry is finished.
> @end table
> @end enumerate
> -- 
> 1.6.0.6
>
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

- Carsten