From: TonyMc <afmcc@btinternet.com>
To: emacs-orgmode@gnu.org
Subject: Manual errata suggestions
Date: Sat, 14 Oct 2017 12:32:48 +0100 [thread overview]
Message-ID: <20171014123248.51568eec@Tourifreet> (raw)
Hello,
I have read through the org mode manual (something I have meant to redo
for ages) and found some typos, or sentences that might be worded more
felicitously. I updated my org-mode from 9.1.1 to 9.1.2 part way
through this reading, so some of the items may already have been fixed.
My suggestions are after the -> below, with headings for the relevant
section:
2.5 Structure Editing
subtrees of the same level than the marked subtree -> of the same level
as the marked subtree
2.10 Footnotes
If it is a the definition -> at the definition
3.2 Column width and alignment
In the example of fixed width columns, should there be a <6> in the top
row of the left-hand table?
3.3 Column groups
Why does the header line of the first table wrap e.g., sqrt(N) in
tildes, but not the header line in the second table?
3.5.8 Editing and debugging formulas
If you would like see -> like to see
3.5.10 Advanced features
Such names must start by an alphabetic character -> start with an
5.1 Basic TODO functionality
See also see -> See also
5.2.3 Multiple keyword sets in one file
‘S-<left>’ and ‘S-<right>’ and walk through -> omit second and
7.5.1.2 Column attributes
If more than one summary type apply to the property -> applies to
9.1 Capture
John Wiegley excellent -> Wiegley's
9.4 Protocols for external access
Org protocol is a mean to trigger -> a means (or "provides a way to
trigger")
10.1 Agenda files
When with a prefix argument - > When used with (or when called with)
11.4 Images and Tables
if a link to an image files -> an image file
11.6 Special symbols
Entities may also be used as a may to escape markup -> as a way
12.7 ASCII/Latin-1/UTF-8 export
This is the most simplest and direct text output. -> simplest and most
direct
It does not contain any Org markup either. -> omit either
12.8 Beamer export
tree structure into a high-quality interactive slides -> omit "a"
12.8.4 Beamer specific syntax
at the beginning the object -> of the object
12.12.5 Applying custom styles
To apply and ODT style -> an ODT style
12.12.8 Images in ODT export
The dimensions of this size is measured in centimeters. -> are measured
12.12.12 Advanced topics in ODT export - Creating one-off styles
Such direct formatting are useful -> is useful
12.12.12 Advanced topics in ODT export - Customizing tables in ODT
export
Footnote references and numbering of steps in a sequence are confused in
this section.
12.14.6 Headings and sectioning structure
to an equivalent Texinfo structuring commands. -> omit "an"
12.17 Advanced configuration
specific parts of conversion process -> the conversion process
13.1.2 Sources and destinations for files
There is no space between the variable and its description in this list.
13.1.4 Publishing action
But you also can publish -> But you can also publish
(Footnote 1) If the publishing directory is the same than the source
directory, ‘file.org’ will be exported as ‘file.org.org’, so probably
don’t want to do this. -> If the publishing directory is the same as
the source directory... so you probably don't want...
13.1.6 Links between published files
Eventually, links between published documents -> Finally instead of
Eventually?
13.2 Uploading files
preferable not to use the built in -> built-in
14.7 Languages
Additional documentation for some languages are at -> is at
14.8.2 Specific header arguments
In some subsections, examples are introduced with "Usage example". In
others they are introduced with "Example". It might be better to be
consistent here.
14.8.2.1 ‘:var’
query and pass file name -> pas the file name
14.8.2.5 ‘:file-ext’
auto generated -> auto-generated
14.8.2.7 ‘:dir’ and remote execution
supply a remote s directory -> should "s" be omitted here?
14.8.2.22 ‘:rownames’
can take on values ‘yes’ or ‘no’ values. -> remove one of the "values"
14.8.2.27 ‘:post’
When ‘:post’ has any value, Org binds the results to ‘*this*’ variable
for easy passing to *note var:: header argument specifications. -> This
sentence seems to be missing at least one word.
or for even -> or even for
14.8.2.28 ‘:prologue’
See also see -> omit one "see"
14.9.1.2 ‘:results output’
as as text results -> omit one "as"
14.9.2.1 ‘:results value’
Even those that do support, such as ‘Python’ and ‘Haskell’, they impose
-> Suggest: "Even languages such as 'Python' and 'Haskell' that do
support interactive evaluation impose..."
14.9.2.2 ‘:results output’
Org concatenates whatever text output emitted by the interpreter ->
the output from the interpreter
Note that this collection is not the same as collected from -> as that
collected from (or "that would be collected from")
15.3 Speed keys
Emacs keychords -> Suggest: Emacs key chords
This section also refers the reader to the docstring for the variable
org-speed-commands-user, which contains the following typo:
The car if each entry -> The car of each entry
15.4 Code evaluation and security issues
execution of ‘ditaa’ code +blocks -> omit "+"
15.7 The very busy C-c C-c key
Its uses are well-documented through out this manual -> well documented
throughout this manual
15.8 A cleaner outline view
Because Org makes the font color same as the background color to hide to
stars -> the same as the background color to hide the stars
15.10.1 Packages that Org cooperates with
recognizes such tables and export them properly. -> exports them
15.10.2 Packages that conflict with Org mode
If you want make the windmove function active -> want to make
15.11 org-crypt.el
will be automatically be encrypted -> omit one "be"
A.5 Context-sensitive commands
facilities for building context sensitive commands -> context-sensitive
These context sensitive commands -> context-sensitive
A.6 Tables and lists in arbitrary syntax
Because of Org’s success in handling tables with Orgtbl, a frequently
asked feature is to Org’s usability functions to other table formats
native to other modem’s, such as LaTeX. -> Suggest: Due to Org's
success in handling tables with Orgtbl, a frequently requested feature
is the use of Org's table functions in other modes, e.g., LaTeX
He did by turning -> He did this by
A.6.1 Radio tables
the key to finding the target location are -> The key ... is ...
A.6.2 A LaTeX example of radio tables
environment provided by ‘comment.sty’ -> It would be good to have
comment.sty become a hyperlink to
https://ctan.org/tex-archive/macros/latex/contrib/comment?lang=en
After editing, ‘C-c C-c’ inserts translated table -> the translated
table
A.6.4 Radio lists
Built-in translators functions are: -> translator
A.7 Dynamic blocks
These command -> commands
To syntax -> Not sure what is intended here
A.8 Special agenda views
this is a multi step search process -> multi-step
Tony
next reply other threads:[~2017-10-14 12:06 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-14 11:32 TonyMc [this message]
2017-10-14 12:45 ` Manual errata suggestions Nicolas Goaziou
2022-10-16 4:39 ` [O] " Ihor Radchenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20171014123248.51568eec@Tourifreet \
--to=afmcc@btinternet.com \
--cc=emacs-orgmode@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).