Re: [O] Corrections for org mode manual
Julian Gehring writes: > This patch should take care of (I hope all) the double spaces at the > ending of the sentences (and a few other formatting issues). Applied, thanks a lot! Best, -- Bastien
Re: [O] Corrections for org mode manual
Hi Bastien,
thank you for including the patches.
> Also note that the convention is to use a double-space at the ending
> of each sentence. There are a lot of fixes needed to this regard...
This patch should take care of (I hope all) the double spaces at the
ending of the sentences (and a few other formatting issues).
Best
Julian
>From ac31b86b5a3be0cfa2e994fef42e777ed1a3f115 Mon Sep 17 00:00:00 2001
From: Julian Gehring
Date: Sat, 25 Jun 2011 10:50:40 +0200
Subject: [PATCH] fix double spacing at the end of sentences in whole org mode manual
---
doc/org.texi | 260 +-
1 files changed, 130 insertions(+), 130 deletions(-)
diff --git a/doc/org.texi b/doc/org.texi
index 7614b1a..721fe78 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -1426,7 +1426,7 @@ commands can be accessed through a dispatcher:
This prompts for an extra key to select a sparse-tree creating command.
@orgcmd{C-c / r,org-occur}
@vindex org-remove-highlights-with-change
-Occur. Prompts for a regexp and shows a sparse tree with all matches. If
+Prompts for a regexp and shows a sparse tree with all matches. If
the match is in a headline, the headline is made visible. If the match is in
the body of an entry, headline and body are made visible. In order to
provide minimal context, also the full hierarchy of headlines above the match
@@ -1658,7 +1658,7 @@ converted into a list item.
@kindex C-c *
@item C-c *
Turn a plain list item into a headline (so that it becomes a subheading at
-its location). @xref{Structure editing}, for a detailed explanation.
+its location). @xref{Structure editing}, for a detailed explanation.
@kindex C-c C-*
@item C-c C-*
Turn the whole plain list into a subtree of the current heading. Checkboxes
@@ -1940,7 +1940,7 @@ unpredictable for you, configure the variables
@table @kbd
@tsubheading{Creation and conversion}
@orgcmd{C-c |,org-table-create-or-convert-from-region}
-Convert the active region to table. If every line contains at least one
+Convert the active region to table. If every line contains at least one
TAB character, the function assumes that the material is tab separated.
If every line contains a comma, comma-separated values (CSV) are assumed.
If not, lines are split at whitespace into fields. You can use a prefix
@@ -2520,7 +2520,7 @@ a Lisp string (in double-quotes) containing the field. If you provide the
@samp{N} mode switch, all referenced elements will be numbers (non-number
fields will be zero) and interpolated as Lisp numbers, without quotes. If
you provide the @samp{L} flag, all fields will be interpolated literally,
-without quotes. i.e., if you want a reference to be interpreted as a string
+without quotes. 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. Here are a few examples---note how the
@@ -3027,7 +3027,7 @@ or with a mouse click (@pxref{Handling links}). Links to custom IDs will
point to the corresponding headline. The preferred match for a text link is
a @i{dedicated target}: the same string in double angular brackets. Targets
may be located anywhere; sometimes it is convenient to put them into a
-comment line. For example
+comment line. For example
@example
# <>
@@ -3323,7 +3323,7 @@ displayed at startup by configuring the variable
@orgcmd{C-c %,org-mark-ring-push}
@cindex mark ring
Push the current position onto the mark ring, to be able to return
-easily. Commands following an internal link do this automatically.
+easily. Commands following an internal link do this automatically.
@c
@orgcmd{C-c &,org-mark-ring-goto}
@cindex links, returning to
@@ -3428,7 +3428,7 @@ not accept any arguments, and return the full link with prefix.
File links can contain additional information to make Emacs jump to a
particular location in the file when following a link. This can be a
line number or a search option after a double@footnote{For backward
-compatibility, line numbers can also follow a single colon.} colon. For
+compatibility, line numbers can also follow a single colon.} colon. For
example, when the command @kbd{C-c l} creates a link (@pxref{Handling
links}) to a file, it encodes the words in the current line as a search
string that can be used to find this line back later when following the
@@ -4239,7 +4239,7 @@ large number of subtasks (@pxref{Checkboxes}).
@vindex org-list-automatic-rules
Every item in a plain list@footnote{With the exception of description
-lists. But you can allow it by modifying @code{org-list-automatic-rules}
+lists. But you can allow it by modifying @code{org-list-automatic-rules}
accordingly.} (@pxref{Plain lists}) can be made into a checkbox by starting
it with the string @samp{[ ]}. This feature is similar to TODO items
(@pxref{TODO Item
Re: [O] Corrections for org mode manual
Hi Julian,
Julian Gehring writes:
> while reading through the org mode manual I found some lines that could
> require minor corrections.
>
> I attached a patch file with corrections
> ('0001-add-corrections-to-org-manual.patch'), as well as one with
> suggestions ('0001-add-suggestions-to-org-manual.patch') that are more
> of a matter of style.
I applied both patches, thanks very much.
> If there are any questions or comments, please let me know. I will have
> a look at the remaining chapters as soon as possible.
Please do -- documentation always needs more proofreading.
Also note that the convention is to use a double-space at the ending
of each sentence. There are a lot of fixes needed to this regard...
Thanks!
--
Bastien
Re: [O] Corrections for org mode manual
Julian Gehring writes: > here is a patch with four small corrections for the org mode manual. I > hope it helps. Applied, thanks! -- Bastien
Re: [O] Corrections for org mode manual
Hey,
here is a patch with four small corrections for the org mode manual. I
hope it helps.
Best
Julian>From ace6614d8a95bbaca5dfd2f6596f1a1554fb53c5 Mon Sep 17 00:00:00 2001
From: Julian Gehring
Date: Fri, 24 Jun 2011 10:56:43 +0200
Subject: [PATCH] correct manual
---
doc/org.texi | 12 ++--
1 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/doc/org.texi b/doc/org.texi
index 936416d..a9159d5 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -265,7 +265,7 @@
@copying
This manual is for Org version @value{VERSION}.
-Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010
+Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
Free Software Foundation, Inc.
@quotation
@@ -6243,7 +6243,7 @@ prefix commands:
@table @kbd
@orgkey{C-u C-c c}
-Visit the target location of a cpature template. You get to select the
+Visit the target location of a capture template. You get to select the
template in the usual way.
@orgkey{C-u C-u C-c c}
Visit the last stored capture item in its buffer.
@@ -9818,7 +9818,7 @@ support text viewers and accessibility, and align it to the right.
@end example
@noindent
-and you could use @code{http} addresses just as well.
+You could use @code{http} addresses just as well.
@node Math formatting in HTML export, Text areas in HTML export, Images in HTML export, HTML export
@subsection Math formatting in HTML export
@@ -10058,7 +10058,7 @@ sections.
@orgcmd{C-c C-e l,org-export-as-latex}
@cindex property EXPORT_FILE_NAME
Export as @LaTeX{} file. For an Org file
-@file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
+@file{myfile.org}, the @LaTeX{} 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
exported. If the selected region is a single tree@footnote{To select the
@@ -11426,8 +11426,8 @@ Optional switches controlling exportation of the code block (see switches discus
@ref{Literal examples})
@item
Optional header arguments control many aspects of evaluation, export and
-tangling of code blocks. See the @ref{Header arguments}
-section. Header arguments can also be set on a per-buffer or per-subtree
+tangling of code blocks. See the @ref{Header arguments}.
+Header arguments can also be set on a per-buffer or per-subtree
basis using properties.
@item
The source code.
--
1.7.4.1
[O] Corrections for org mode manual
Hey,
while reading through the org mode manual I found some lines that could
require minor corrections.
I attached a patch file with corrections
('0001-add-corrections-to-org-manual.patch'), as well as one with
suggestions ('0001-add-suggestions-to-org-manual.patch') that are more
of a matter of style.
If there are any questions or comments, please let me know. I will have
a look at the remaining chapters as soon as possible.
Best
Julian
>From 18eb49c49439c7664e4179e28f4213954c5e7c8c Mon Sep 17 00:00:00 2001
From: Julian Gehring
Date: Sat, 4 Jun 2011 23:07:41 +0200
Subject: [PATCH] add corrections to org manual
---
doc/org.texi | 32 +---
1 files changed, 17 insertions(+), 15 deletions(-)
diff --git a/doc/org.texi b/doc/org.texi
index eb97759..182219e 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -4025,7 +4025,7 @@ called ``habits''. A habit has the following properties:
You have enabled the @code{habits} module by customizing the variable
@code{org-modules}.
@item
-The habit is a TODO, with a TODO keyword representing an open state.
+The habit is a TODO item, with a TODO keyword representing an open state.
@item
The property @code{STYLE} is set to the value @code{habit}.
@item
@@ -4941,7 +4941,7 @@ optional. The individual parts have the following meaning:
@var{property}@r{The property that should be edited in this column.}
@r{Special properties representing meta data are allowed here}
@r{as well (@pxref{Special properties})}
-@var{title} @r{The header text for the column. If omitted, the property}
+@var{title} @r{The header text for the column. If omitted, the property}
@r{name is used.}
@{@var{summary-type}@} @r{The summary type. If specified, the column values for}
@r{parent nodes are computed from the children.}
@@ -6131,7 +6131,7 @@ not started at exactly the right moment.
@kindex ;
Calling @code{org-timer-set-timer} from an Org-mode buffer runs a countdown
-timer. Use @key{;} from agenda buffers, @key{C-c C-x ;} everwhere else.
+timer. Use @kbd{;} from agenda buffers, @kbd{C-c C-x ;} everwhere else.
@code{org-timer-set-timer} prompts the user for a duration and displays a
countdown timer in the modeline. @code{org-timer-default-timer} sets the
@@ -6999,7 +6999,7 @@ Lift the restriction.
@cindex agenda dispatcher
@cindex dispatching agenda commands
The views are created through a dispatcher, which should be bound to a
-global key---for example @kbd{C-c a} (@pxref{Installation}). In the
+global key---for example @kbd{C-c a} (@pxref{Activation}). In the
following we will assume that @kbd{C-c a} is indeed how the dispatcher
is accessed and list keyboard access to commands accordingly. After
pressing @kbd{C-c a}, an additional letter is required to execute a
@@ -8396,7 +8396,7 @@ version of some agenda views to carry around. Org-mode can export custom
agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's
@file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the
ghostscript @file{ps2pdf} utility must be installed on the system. Selecting
-a PDF file with also create the postscript file.}, and iCalendar files. If
+a PDF file will also create the postscript file.}, and iCalendar files. If
you want to do this only occasionally, use the command
@table @kbd
@@ -8940,8 +8940,8 @@ If the syntax for the label format conflicts with the language syntax, use a
@code{-l} switch to change the format, for example @samp{#+BEGIN_SRC pascal
-n -r -l "((%s))"}. See also the variable @code{org-coderef-label-format}.
-HTML export also allows examples to be published as text areas, @xref{Text
-areas in HTML export}.
+HTML export also allows examples to be published as text areas (@xref{Text
+areas in HTML export}).
Because the @code{#+BEGIN_...} and @code{#+END_...} patterns need to be added
so often, shortcuts are provided using the Easy Templates facility
@@ -9641,8 +9641,8 @@ language, but with additional support for tables.
@table @kbd
@orgcmd{C-c C-e h,org-export-as-html}
@cindex property, EXPORT_FILE_NAME
-Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
-the ASCII file will be @file{myfile.html}. The file will be overwritten
+Export as HTML file. For an Org file @file{myfile.org},
+the HTML file will be @file{myfile.html}. 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
exported. If the selected region is a single tree@footnote{To select the
@@ -10057,8 +10057,8 @@ sections.
@table @kbd
@orgcmd{C-c C-e l,org-export-as-latex}
@cindex property EXPORT_FILE_NAME
-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
+Export as @LaTeX{} file. For an Org file
+@file{myfile
