From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: "Thomas S. Dye" <tsd@tsdye.com>
Cc: Org Mode List <emacs-orgmode@gnu.org>
Subject: Re: [RFC] Dog food, anyone?
Date: Mon, 18 Dec 2017 23:04:24 +0100 [thread overview]
Message-ID: <87efnrlml3.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <m2mv2foilb.fsf@tsdye.com> (Thomas S. Dye's message of "Mon, 18 Dec 2017 11:02:24 -1000")
Hello,
"Thomas S. Dye" <tsd@tsdye.com> writes:
> I've spent a few hours with manual.org now and I like it very much. The
> info file it produces looks clean to me and it compiled without a hitch
> using Org mode from the master branch.
Great!
> One change that might be made globally is the use of em-dash (---) to
> set off text, versus en-dash (--) between numerals, e.g. "the range of
> run times is 1--5 seconds". I've spotted several places where the
> en-dash is used to set off text. See this web site for the convention
> on dashes:
>
> https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Conventions.html
I think it is a matter of "American English" vs "British English"
convention. See, e.g., <https://www.gsbe.co.uk/grammar-the-dash.html>.
I consistently used the latter because I find it more aesthetically
pleasing. As a GNU manual, we can switch to the American English
convention everywhere. In this case, however, em-dash are not
spaced-out.
In the same vein, we also need to use title case. This needs some
special care as fuzzy links need to be updated accordingly.
WDYT?
> Attached, please find a patch with some copy editing to the introductory
> section of the "Working with source code" chapter. The patch also
> includes a correction for a typo elsewhere in the manual.
Thank you. I applied it with the changes mentioned below.
> +Users can control how live they want each
> +source code block by tweaking the [[*Using header arguments][header arguments]] for compiling,
> +execution, extraction, and exporting.
I changed it to
... by tweaking the header arguments (see [[* Using header
arguments]]) for compiling...
For more information, see (info "(texinfo) @ref"), last paragraphs.
N.B.: I suggest to read it in regular info viewer, i.e., "info texinfo"
from the command line, instead of Emacs to make sense out of this.
> +Source code blocks are one of many Org block types, which also include
> +=quote=, =export=, =verse=, =latex=, =example=, and =verbatim=. This
> +section pertains to blocks between =#+BEGIN_SRC= and =#+END_SRC=.
> +
> +For editing and formatting a source code block, Org uses an
> +appropriate Emacs major-mode that includes features specifically
> +designed for source code in that language.
> +
> +Org can extract one or more source code blocks and write them to one
> +or more source files --- a process known as /tangling/ in literate
> +programming terminology.
I changed it to
... or more sources files---a process known as...
per above.
Regards,
--
Nicolas Goaziou 0x80A93738
next prev parent reply other threads:[~2017-12-18 22:04 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-17 10:34 [RFC] Dog food, anyone? Nicolas Goaziou
2017-12-17 11:59 ` Vikas Rawal
2017-12-17 18:41 ` Thomas S. Dye
2017-12-17 19:01 ` Nicolas Goaziou
2017-12-17 21:58 ` Thomas S. Dye
2017-12-17 23:03 ` Adrian Bradd
2017-12-18 1:13 ` Thomas S. Dye
2017-12-17 23:44 ` Nicolas Goaziou
2017-12-18 1:15 ` Vikas Rawal
2017-12-18 1:23 ` Thomas S. Dye
2017-12-17 18:51 ` Kaushal Modi
2017-12-17 19:27 ` Nicolas Goaziou
2017-12-17 18:58 ` [RFC] Official Org manual in Org! (Was: Dog food, anyone?) Kaushal Modi
2017-12-21 8:00 ` Marcin Borkowski
2017-12-21 13:47 ` [RFC] Official Org manual in Org! Nicolas Goaziou
2017-12-17 23:10 ` [RFC] Dog food, anyone? Eric Abrahamsen
2017-12-18 21:02 ` Thomas S. Dye
2017-12-18 22:04 ` Nicolas Goaziou [this message]
2017-12-19 0:12 ` Thomas S. Dye
2017-12-19 19:25 ` Nicolas Goaziou
2017-12-19 20:11 ` Thomas S. Dye
2017-12-19 20:16 ` Jonathan Leech-Pepin
2017-12-19 23:11 ` Nicolas Goaziou
2017-12-20 0:05 ` Jonathan Leech-Pepin
2017-12-20 0:59 ` Thomas S. Dye
[not found] ` <WM!57dfd1c25b2c2af3021c1294841c916968d326cf362c32864a6fbc9615cf19dba6ceadc1960e4c3ef5578687af476fba!@mailhub-mx1.ncl.ac.uk>
2017-12-21 12:58 ` Phillip Lord
2017-12-21 13:37 ` Nicolas Goaziou
2017-12-21 17:26 ` Phillip Lord
2017-12-21 19:53 ` Nicolas Goaziou
[not found] ` <WM!3e1c2e8dc2d528e2348759d2a34555337e2f3a5782534bcece582121239ecf030ff1b6d5efd2b2c4955a04c496f00ac6!@mailhub-mx2.ncl.ac.uk>
2017-12-21 22:13 ` Phillip Lord
2017-12-22 18:30 ` Nicolas Goaziou
2017-12-23 6:56 ` Yasushi SHOJI
2017-12-23 14:12 ` Kaushal Modi
2017-12-25 1:44 ` Yasushi SHOJI
2018-04-26 23:34 ` Bastien
2018-04-28 10:56 ` Nicolas Goaziou
2018-04-28 12:43 ` Bastien
2018-05-09 0:30 ` Nicolas Goaziou
2018-05-09 18:16 ` Gregor Zattler
2018-05-09 19:12 ` Nicolas Goaziou
-- strict thread matches above, loose matches on Subject: below --
2018-05-09 18:11 Jon Snader
2018-05-10 8:02 ` Neil Jerram
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=87efnrlml3.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=emacs-orgmode@gnu.org \
--cc=tsd@tsdye.com \
/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).