* [PATCH] Org mode manual proofreading
@ 2015-03-13 19:28 Simen Heggestøyl
0 siblings, 0 replies; only message in thread
From: Simen Heggestøyl @ 2015-03-13 19:28 UTC (permalink / raw)
To: emacs-orgmode
[-- Attachment #1.1: Type: text/plain, Size: 275 bytes --]
Hi!
I just read the Org mode manual (it was a good read, thanks!), and
noted formatting- and spelling errors I found along the way. The
attached patch corrects those.
This is my first time contributing to Org mode. I have signed the FSF
papers for Emacs earlier.
-- Simen
[-- Attachment #1.2: Type: text/html, Size: 398 bytes --]
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org.texi-Fix-numerous-typos.patch --]
[-- Type: text/x-patch, Size: 12569 bytes --]
From 497f8a29cfa21328094d4ff5418ac9722ee4d8d1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Simen=20Heggest=C3=B8yl?= <simenheg@gmail.com>
Date: Fri, 13 Mar 2015 20:18:41 +0100
Subject: [PATCH] org.texi: Fix numerous typos
* org.texi: Fix numerous formatting- and typing errors.
---
doc/org.texi | 56 +++++++++++++++++++++++++++++---------------------------
1 file changed, 29 insertions(+), 27 deletions(-)
diff --git a/doc/org.texi b/doc/org.texi
index b701fd7..4020636 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -2437,7 +2437,7 @@ of a @emph{column formula} that will be applied to all non-header fields in a
column without having to copy the formula to each relevant field. There is
also a formula debugger, and a formula editor with features for highlighting
fields in the table corresponding to the references at the point in the
-formula, moving these references by arrow keys
+formula, moving these references by arrow keys.
@menu
* References:: How to refer to another field or range
@@ -2575,9 +2575,9 @@ Insert the doubled value of each column of row 1 of the table named
@noindent For the second/third example, the table named @code{FOO} must have
at least as many rows/columns as the current table. Note that this is
-inefficient@footnote{The computation time scales as O(N^2) because the table
-named @code{FOO} is parsed for each field to be read.} for large number of
-rows/columns.
+inefficient@footnote{The computation time scales as O(N@math{^2}) because the
+table named @code{FOO} is parsed for each field to be read.} for large number
+of rows/columns.
@subsubheading Named references
@cindex named references
@@ -2723,7 +2723,7 @@ $0;%.1f @r{Reformat current cell to 1 decimal}
($3-32)*5/9 @r{Degrees F -> C conversion}
$c/$1/$cm @r{Hz -> cm conversion, using @file{constants.el}}
tan($1);Dp3s1 @r{Compute in degrees, precision 3, display SCI 1}
-sin($1);Dp3%.1e @r{Same, but use printf specifier for display}
+sin($1);Dp3%.1e @r{Same, but use @samp{printf} specifier for display}
taylor($3,x=7,2) @r{Taylor series of $3, at x=7, second degree}
@end example
@@ -2770,7 +2770,7 @@ not enough.
If a formula starts with a single-quote followed by an opening parenthesis,
then it is evaluated as a Lisp form. The evaluation should return either a
string or a number. Just as with @file{calc} formulas, you can specify modes
-and a printf format after a semicolon.
+and a @samp{printf} format after a semicolon.
With Emacs Lisp forms, you need to be conscious about the way field
references are interpolated into the form. By default, a reference will be
@@ -3566,7 +3566,7 @@ exact headline will be matched, ignoring spaces and cookies. If the value is
@code{query-to-create}, then an exact headline will be searched; if it is not
found, then the user will be queried to create it.}
file:projects.org::*task title @r{heading search in Org
-file}@footnote{ Headline searches always match the exact headline, ignoring
+file}@footnote{Headline searches always match the exact headline, ignoring
spaces and cookies. If the headline is not found and the value of the option
@code{org-link-search-must-match-exact-headline} is @code{query-to-create},
then the user will be queried to create it.}
@@ -3728,7 +3728,7 @@ valid link prefixes like @samp{http:} or @samp{ftp:}, including the prefixes
defined through link abbreviations (@pxref{Link abbreviations}). If you
press @key{RET} after inserting only the @var{prefix}, Org will offer
specific completion support for some link types@footnote{This works by
-calling a special function @code{org-PREFIX-complete-link}.} For
+calling a special function @code{org-PREFIX-complete-link}.}. For
example, if you type @kbd{file @key{RET}}, file name completion (alternative
access: @kbd{C-u C-c C-l}, see below) will be offered, and after @kbd{bbdb
@key{RET}} you can complete contact names.
@@ -3887,7 +3887,7 @@ called with the tag as the only argument to create the link.
With the above setting, you could link to a specific bug with
@code{[[bugzilla:129]]}, search the web for @samp{OrgMode} with
@code{[[google:OrgMode]]}, show the map location of the Free Software
-Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten office
+Foundation @code{[[gmap:51 Franklin Street, Boston]]} or of Carsten's office
@code{[[omap:Science Park 904, Amsterdam, The Netherlands]]} and find out
what the Org author is doing besides Emacs hacking with
@code{[[ads:Dominik,C]]}.
@@ -5231,7 +5231,7 @@ or with a tree they need to be inserted into a special drawer
right below a headline, and its planning line (@pxref{Deadlines and
scheduling}) when applicable. Each property is specified on a single line,
with the key (surrounded by colons) first, and the value after it. Keys are
-case-insensitives. Here is an example:
+case-insensitive. Here is an example:
@example
* CD collection
@@ -6578,7 +6578,7 @@ be selected:
:tend @r{A time string specifying when to stop considering times.}
@r{Relative times like @code{"<now>"} can also be used. See}
@r{@ref{Matching tags and properties} for relative time syntax.}
-:wstart @r{The starting day of the week. The default is 1 for monday.}
+:wstart @r{The starting day of the week. The default is 1 for Monday.}
:mstart @r{The starting day of the month. The default 1 is for the first}
@r{day of the month.}
:step @r{@code{week} or @code{day}, to split the table into chunks.}
@@ -7862,7 +7862,7 @@ The default number of days displayed in the agenda is set by the variable
variable can be set to any number of days you want to see by default in the
agenda, or to a span name, such as @code{day}, @code{week}, @code{month} or
@code{year}. For weekly agendas, the default is to start on the previous
-monday (see @code{org-agenda-start-on-weekday}). You can also set the start
+Monday (see @code{org-agenda-start-on-weekday}). You can also set the start
date using a date shift: @code{(setq org-agenda-start-day "+10d")} will
start the agenda ten days from today in the future.
@@ -7990,7 +7990,7 @@ collected into a single place.
@orgcmd{C-c a t,org-todo-list}
Show the global TODO list. This collects the TODO items from all agenda
files (@pxref{Agenda views}) into a single buffer. By default, this lists
-items with a state the is not a DONE state. The buffer is in
+items with a state that is not a DONE state. The buffer is in
@code{agenda-mode}, so there are commands to examine and manipulate the TODO
entries directly from that buffer (@pxref{Agenda commands}).
@orgcmd{C-c a T,org-todo-list}
@@ -8941,7 +8941,7 @@ 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.
@@ -9678,7 +9678,7 @@ of contents entirely, by configuring the variable @code{org-export-with-toc},
or on a per-file basis with a line like
@example
-#+OPTIONS: toc:2 @r{only inlcude two levels in TOC}
+#+OPTIONS: toc:2 @r{only include two levels in TOC}
#+OPTIONS: toc:nil @r{no default TOC at all}
@end example
@@ -9991,7 +9991,7 @@ commas will be stripped 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 variable @code{org-edit-fixed-width-region-mode}.}
+a different mode with the variable @code{org-edit-fixed-width-region-mode}.}
to allow creating ASCII drawings easily. Using this command in an empty line
will create a new fixed-width region.
@kindex C-c l
@@ -10024,10 +10024,11 @@ if the markup is @samp{src}, the language for formatting the contents.
If markup is requested, the included content will be placed within an
appropriate block@footnote{While you can request paragraphs (@samp{verse},
@samp{quote}, @samp{center}), but this places severe restrictions on the type
-of content that is permissible}. No changes to the included content are made
-and it is the responsibility of the user to ensure that the result is valid
-Org syntax. For markup @samp{example} and @samp{src}, which is requesting a
-literal example, the content will be code-escaped before inclusion.
+of content that is permissible.}. No changes to the included content are
+made and it is the responsibility of the user to ensure that the result is
+valid Org syntax. For markup @samp{example} and @samp{src}, which is
+requesting a literal example, the content will be code-escaped before
+inclusion.
If no markup is requested, the text will be assumed to be in Org mode format
and will be processed normally. However, footnote labels (@pxref{Footnotes})
@@ -10631,7 +10632,7 @@ such keywords if the list is long.
@vindex org-export-default-language
The language used for translating some strings
(@code{org-export-default-language}). E.g., @samp{#+LANGUAGE: fr} will tell
-Org to translate @emph{File} (english) into @emph{Fichier} (french) in the
+Org to translate @emph{File} (English) into @emph{Fichier} (French) in the
clocktable.
@item SELECT_TAGS
@@ -11233,7 +11234,7 @@ HTML5 introduces several new element types. By default, Org will not make
use of these element types, but you can set @code{org-html-html5-fancy} to
@code{t} (or set @code{html5-fancy} item in an @code{OPTIONS} line), to
enable a few new block-level elements. These are created using arbitrary
-#+BEGIN and #+END blocks. For instance:
+@code{#+BEGIN} and @code{#+END} blocks. For instance:
@example
#+BEGIN_ASIDE
@@ -11466,7 +11467,7 @@ buffer. For example, with the following settings,
@smallexample
#+HTML_MATHJAX: align: left indent: 5em tagside: left font: Neo-Euler
@end smallexample
-equation labels will be displayed on the left marign and equations will be
+equation labels will be displayed on the left margin and equations will be
five ems from the left margin.
@noindent See the docstring of
@@ -11662,7 +11663,7 @@ pages, configure the variable @code{org-html-use-infojs}.
@cindex @LaTeX{} export
@cindex PDF export
-@LaTeX{} export can produce an arbitrarily complex LaTeX document of any
+@LaTeX{} export can produce an arbitrarily complex @LaTeX{} document of any
standard or custom document class. With further processing@footnote{The
default @LaTeX{} output is designed for processing with @code{pdftex} or
@LaTeX{}. It includes packages that are not compatible with @code{xetex} and
@@ -14334,7 +14335,8 @@ The following sections describe Org mode's code block handling facilities.
Live code blocks can be specified with a @samp{src} block or
inline.@footnote{Note that @samp{src} blocks may be inserted using Org mode's
-@ref{Easy templates} system} The structure of a @samp{src} block is
+Easy templates system (see @ref{Easy templates}).} The structure of a
+@samp{src} block is
@example
#+NAME: <name>
@@ -14732,7 +14734,7 @@ describes each header argument in detail.
@node Using header arguments
@subsection Using header arguments
-The values of header arguments can be set in several way. When the header
+The values of header arguments can be set in several ways. When the header
arguments in each layer have been determined, they are combined in order from
the first, least specific (having the lowest priority) up to the last, most
specific (having the highest priority). A header argument with a higher
@@ -15586,7 +15588,7 @@ execution.
The @code{:session} header argument starts a (possibly named) session for an
interpreted language where the interpreter’s state is preserved. All code
-blocks sharing the same name are exectuted by the same interpreter process.
+blocks sharing the same name are executed by the same interpreter process.
By default, a session is not started.
@itemize @bullet
--
2.1.4
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2015-03-13 19:28 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-03-13 19:28 [PATCH] Org mode manual proofreading Simen Heggestøyl
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).