emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Small grammar tweaks in export sections of org.texi
@ 2012-04-24 16:10 Brian van den Broek
  2012-04-24 21:35 ` Bastien
  0 siblings, 1 reply; 6+ messages in thread
From: Brian van den Broek @ 2012-04-24 16:10 UTC (permalink / raw)
  To: emacs-orgmode

[-- Attachment #1: Type: text/plain, Size: 850 bytes --]

Hi all,

The attached patch provides a number of minor (and pedantic, I suppose) grammar tweaks to doc/org.texi. 

I've labelled it a TINYCHANGE. I am not sure of the exact bounds of what can count as a tiny change, but all this does is insert `a', `an' and `in' in a number of places in the docs. 

I've quite a few other typo corrections / phrasing improvements I could make to the docs, but I cannot presently sign the FSF papers. (I am on leave, living abroad for the year, and won't be able to get my employer's sign-off until I return home.) I'd appreciate being told if further documentation patches can be accepted in these circumstances. If they cannot, I will have to wait until I can address the FSF papers issue with my employer.

Thanks and best,

Brian vdB

PS Here's hoping I *have* sorted out how to get this through to patchwork :-)

[-- Attachment #2: 0001-Small-grammar-tweaks-in-export-sections-of-org.texi.patch --]
[-- Type: text/x-diff, Size: 8863 bytes --]

From 737e49207c5a6976bf582265f2b43c14944274c5 Mon Sep 17 00:00:00 2001
From: Brian van den Broek <vanden@gmail.com>
Date: Tue, 24 Apr 2012 17:37:57 +0200
Subject: [PATCH] Small grammar tweaks in export sections of org.texi

* org.texi The sections in the Exporting section of the manual left
out articles in the description of the org-export-as-* commands, among
other places. This patch adds them, adds a few missing prepositions,
and switches instances of "an HTML" to "a html" for internal
consistency.

TINYCHANGE
---
 doc/org.texi |   42 +++++++++++++++++++++---------------------
 1 files changed, 21 insertions(+), 21 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index e22d446..e5b58af 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -3587,7 +3587,7 @@ Jump to line 255.
 Search for a link target @samp{<<My Target>>}, or do a text search for
 @samp{my target}, similar to the search in internal links, see
 @ref{Internal links}.  In HTML export (@pxref{HTML export}), such a file
-link will become an HTML reference to the corresponding named anchor in
+link will become a HTML reference to the corresponding named anchor in
 the linked file.
 @item *My Target
 In an Org file, restrict search to headlines.
@@ -9820,7 +9820,7 @@ with special characters and symbols available in these encodings.
 @table @kbd
 @orgcmd{C-c C-e a,org-export-as-ascii}
 @cindex property, EXPORT_FILE_NAME
-Export as ASCII file.  For an Org file, @file{myfile.org}, the ASCII file
+Export as an ASCII file.  For an Org file, @file{myfile.org}, the ASCII file
 will be @file{myfile.txt}.  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
@@ -9869,7 +9869,7 @@ the text and the link in a note before the next heading.  See the variable
 @section HTML export
 @cindex HTML export
 
-Org mode contains an HTML (XHTML 1.0 strict) exporter with extensive
+Org mode contains a HTML (XHTML 1.0 strict) exporter with extensive
 HTML formatting, in ways similar to John Gruber's @emph{markdown}
 language, but with additional support for tables.
 
@@ -9895,7 +9895,7 @@ 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.  For an Org file @file{myfile.org},
+Export as a 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
@@ -9904,7 +9904,7 @@ current subtree, use @kbd{C-c @@}.}, the tree head will become the document
 title.  If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
 property, that name will be used for the export.
 @orgcmd{C-c C-e b,org-export-as-html-and-open}
-Export as HTML file and immediately open it with a browser.
+Export as a HTML file and immediately open it with a browser.
 @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
 Export to a temporary buffer.  Do not create a file.
 @orgcmd{C-c C-e R,org-export-region-as-html}
@@ -9914,7 +9914,7 @@ the region.  This is good for cut-and-paste operations.
 @item C-c C-e v h/b/H/R
 Export only the visible part of the document.
 @item M-x org-export-region-as-html
-Convert the region to HTML under the assumption that it was Org mode
+Convert the region to HTML under the assumption that it was in Org mode
 syntax before.  This is a global command that can be invoked in any
 buffer.
 @item M-x org-replace-region-by-HTML
@@ -10008,7 +10008,7 @@ includes automatic links created by radio targets (@pxref{Radio
 targets}).  Links to external files will still work if the target file is on
 the same @i{relative} path as the published Org file.  Links to other
 @file{.org} files will be translated into HTML links under the assumption
-that an HTML version also exists of the linked file, at the same relative
+that a HTML version also exists of the linked file, at the same relative
 path.  @samp{id:} links can then be used to jump to specific entries across
 files.  For information related to linking files while publishing them to a
 publishing directory see @ref{Publishing links}.
@@ -10315,7 +10315,7 @@ sections.
 @table @kbd
 @orgcmd{C-c C-e l,org-export-as-latex}
 @cindex property EXPORT_FILE_NAME
-Export as @LaTeX{} file.  For an Org file
+Export as a @LaTeX{} file.  For an Org file
 @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
@@ -10328,7 +10328,7 @@ Export to a temporary buffer.  Do not create a file.
 @item C-c C-e v l/L
 Export only the visible part of the document.
 @item M-x org-export-region-as-latex
-Convert the region to @LaTeX{} under the assumption that it was Org mode
+Convert the region to @LaTeX{} under the assumption that it was in Org mode
 syntax before.  This is a global command that can be invoked in any
 buffer.
 @item M-x org-replace-region-by-latex
@@ -10672,7 +10672,7 @@ Currently DocBook exporter only supports DocBook V5.0.
 @table @kbd
 @orgcmd{C-c C-e D,org-export-as-docbook}
 @cindex property EXPORT_FILE_NAME
-Export as DocBook file.  For an Org file, @file{myfile.org}, the DocBook XML
+Export as a DocBook file.  For an Org file, @file{myfile.org}, the DocBook XML
 file will be @file{myfile.xml}.  The file will be overwritten without
 warning.  If there is an active region@footnote{This requires
 @code{transient-mark-mode} to be turned on}, only the region will be
@@ -10681,12 +10681,12 @@ current subtree, use @kbd{C-c @@}.}, the tree head will become the document
 title.  If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
 property, that name will be used for the export.
 @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
-Export as DocBook file, process to PDF, then open the resulting PDF file.
+Export as a DocBook file, process to PDF, then open the resulting PDF file.
 
 @vindex org-export-docbook-xslt-proc-command
 @vindex org-export-docbook-xsl-fo-proc-command
-Note that, in order to produce PDF output based on exported DocBook file, you
-need to have XSLT processor and XSL-FO processor software installed on your
+Note that, in order to produce PDF output based on an exported DocBook file,
+you need to have XSLT processor and XSL-FO processor software installed on your
 system.  Check variables @code{org-export-docbook-xslt-proc-command} and
 @code{org-export-docbook-xsl-fo-proc-command}.
 
@@ -10907,7 +10907,7 @@ inherits, an @code{EXPORT_FILE_NAME} property, that name will be used for the
 export.
 
 @orgcmd{C-c C-e O,org-export-as-odt-and-open}
-Export as OpenDocument Text file and open the resulting file.
+Export as an OpenDocument Text file and open the resulting file.
 
 @vindex org-export-odt-preferred-output-format
 If @code{org-export-odt-preferred-output-format} is specified, open the
@@ -11239,11 +11239,11 @@ the @LaTeX{}-to-MathML converter.
 @table @kbd
 
 @item M-x org-export-as-odf
-Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file.
+Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file.
 
 @item M-x org-export-as-odf-and-open
-Convert a @LaTeX{} math snippet to OpenDocument formula (@file{.odf}) file and
-open the formula file with the system-registered application.
+Convert a @LaTeX{} math snippet to an OpenDocument formula (@file{.odf}) file
+and open the formula file with the system-registered application.
 @end table
 
 @cindex dvipng
@@ -11779,10 +11779,10 @@ all the nodes.
 
 @table @kbd
 @orgcmd{C-c C-e j,org-export-as-taskjuggler}
-Export as TaskJuggler file.
+Export as a TaskJuggler file.
 
 @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
-Export as TaskJuggler file and then open the file with TaskJugglerUI.
+Export as a TaskJuggler file and then open the file with TaskJugglerUI.
 @end table
 
 @subsection Tasks
@@ -11892,7 +11892,7 @@ The Freemind exporter was written by Lennart Borgman.
 
 @table @kbd
 @orgcmd{C-c C-e m,org-export-as-freemind}
-Export as Freemind mind map.  For an Org file @file{myfile.org}, the Freemind
+Export as a Freemind mind map.  For an Org file @file{myfile.org}, the Freemind
 file will be @file{myfile.mm}.
 @end table
 
@@ -11906,7 +11906,7 @@ does not interpret any additional Org mode features.
 
 @table @kbd
 @orgcmd{C-c C-e x,org-export-as-xoxo}
-Export as XOXO file.  For an Org file @file{myfile.org}, the XOXO file will be
+Export as an XOXO file.  For an Org file @file{myfile.org}, the XOXO file will be
 @file{myfile.html}.
 @orgkey{C-c C-e v x}
 Export only the visible part of the document.
-- 
1.7.9


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* Re: Small grammar tweaks in export sections of org.texi
  2012-04-24 16:10 Small grammar tweaks in export sections of org.texi Brian van den Broek
@ 2012-04-24 21:35 ` Bastien
  2012-04-24 23:01   ` Brian van den Broek
  0 siblings, 1 reply; 6+ messages in thread
From: Bastien @ 2012-04-24 21:35 UTC (permalink / raw)
  To: Brian van den Broek; +Cc: emacs-orgmode

Hi Brian,

Brian van den Broek <brian.van.den.broek@gmail.com> writes:

> The attached patch provides a number of minor (and pedantic, I
> suppose) grammar tweaks to doc/org.texi. 

Applied, thanks.

> I've labelled it a TINYCHANGE. I am not sure of the exact bounds of what
> can count as a tiny change, but all this does is insert `a', `an' and `in'
> in a number of places in the docs.

A "tiny change" is a change that modifies <= than 20 lines.

> I've quite a few other typo corrections / phrasing improvements I could
> make to the docs, but I cannot presently sign the FSF papers. (I am on
> leave, living abroad for the year, and won't be able to get my employer's
> sign-off until I return home.) I'd appreciate being told if further
> documentation patches can be accepted in these circumstances. If they
> cannot, I will have to wait until I can address the FSF papers issue with
> my employer.

I suggest this:

1. try to figure out what really prevents you from assigning your
   copyright to FSF (unless your job contract says "everything you write
   in your free time belongs to us", I don't see a real problem here, but
   of course I don't have all the cards in hands to judge appropriately.)

2. try to convince your boss/company that it can be useful.

3. try to give advice on the list in a way that makes it easy for others
   to create a patch.

But in your situation, submitting patches would just prevent us from 
getting your corrections into Emacs.

Sorry for these bureaucratic contraints, and thanks for your
understanding!

-- 
 Bastien

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Small grammar tweaks in export sections of org.texi
  2012-04-24 21:35 ` Bastien
@ 2012-04-24 23:01   ` Brian van den Broek
  2012-04-26 13:54     ` Bastien
  0 siblings, 1 reply; 6+ messages in thread
From: Brian van den Broek @ 2012-04-24 23:01 UTC (permalink / raw)
  To: Bastien; +Cc: emacs-orgmode

On 24 April 2012 23:35, Bastien <bzg@gnu.org> wrote:
> Hi Brian,

<snip>

> Applied, thanks.
>
>> I've labelled it a TINYCHANGE. I am not sure of the exact bounds of what
>> can count as a tiny change, but all this does is insert `a', `an' and `in'
>> in a number of places in the docs.
>
> A "tiny change" is a change that modifies <= than 20 lines.

Hi Bastien,

Thanks for the reply.

I ought to have been more clear; I'd seen the >20 lines standard
before, but wasn't sure if 1) it was per patch or cumulative over all
patches and 2) if things like fixing a spelling mistake in a variable
name over many lines counted. I've read around some more and learned
(from <http://www.gnu.org/prep/maintain/maintain.html#Legally-Significant>)
that by the gnu projects standards, a) the limit is cumulative over
all patches, b) trivial changes like replacing many instances of a
name do not count, but multiple such sorts of changes "can" and c) the
standard they presently endorse is >15 lines. (Sadly, the document I
linked to is a model of neither clarity nor precision.)

>> I've quite a few other typo corrections / phrasing improvements I could
>> make to the docs, but I cannot presently sign the FSF papers. (I am on
>> leave, living abroad for the year, and won't be able to get my employer's
>> sign-off until I return home.) I'd appreciate being told if further
>> documentation patches can be accepted in these circumstances. If they
>> cannot, I will have to wait until I can address the FSF papers issue with
>> my employer.
>
> I suggest this:
>
> 1. try to figure out what really prevents you from assigning your
>   copyright to FSF (unless your job contract says "everything you write
>   in your free time belongs to us", I don't see a real problem here, but
>   of course I don't have all the cards in hands to judge appropriately.)

I don't think my employer (I teach Philosophy at the College-level)
has a basis to claim ownership of copyright on my work product, but I
also seem to have misplaced my law degree :-) I thus cannot
confidently say that it is false that I "have an employer who *might*
have a basis" to claim ownership of my changes.

I've written the relevant gnu.org address seeking clarification as to
whether my good faith belief suffices in my circumstances.

Thanks for the guidance. Best,

Brian

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Small grammar tweaks in export sections of org.texi
  2012-04-24 23:01   ` Brian van den Broek
@ 2012-04-26 13:54     ` Bastien
  2012-04-30 16:45       ` Brian van den Broek
  0 siblings, 1 reply; 6+ messages in thread
From: Bastien @ 2012-04-26 13:54 UTC (permalink / raw)
  To: Brian van den Broek; +Cc: emacs-orgmode

Hi Brian,

Brian van den Broek <brian.van.den.broek@gmail.com> writes:

> a) the limit is cumulative over all patches,

It makes sense.

> b) trivial changes like replacing many instances of a
> name do not count, but multiple such sorts of changes "can" and c) the
> standard they presently endorse is >15 lines. (Sadly, the document I
> linked to is a model of neither clarity nor precision.)

Yes -- that's actually what's on http://orgmode.org/worg/org-contribute.html

>> 1. try to figure out what really prevents you from assigning your
>>   copyright to FSF (unless your job contract says "everything you write
>>   in your free time belongs to us", I don't see a real problem here, but
>>   of course I don't have all the cards in hands to judge appropriately.)
>
> I don't think my employer (I teach Philosophy at the College-level)
> has a basis to claim ownership of copyright on my work product, but I
> also seem to have misplaced my law degree :-) I thus cannot
> confidently say that it is false that I "have an employer who *might*
> have a basis" to claim ownership of my changes.
>
> I've written the relevant gnu.org address seeking clarification as to
> whether my good faith belief suffices in my circumstances.

Okay let us know.  You might get a faster reply by Cc'ing me as the
maintainer.  Also, perhaps your College administration will be faster
that GNU ones -- but chances are that both will be slow anyway.

In the meantime, don't hesitate to report problems informally on the
list!

Thanks,

-- 
 Bastien

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Small grammar tweaks in export sections of org.texi
  2012-04-26 13:54     ` Bastien
@ 2012-04-30 16:45       ` Brian van den Broek
  2012-04-30 23:46         ` Bastien
  0 siblings, 1 reply; 6+ messages in thread
From: Brian van den Broek @ 2012-04-30 16:45 UTC (permalink / raw)
  To: Bastien; +Cc: emacs-orgmode

On 26 April 2012 15:54, Bastien <bzg@gnu.org> wrote:
> Hi Brian,
>
> Brian van den Broek <brian.van.den.broek@gmail.com> writes:

<snip>

>> I don't think my employer (I teach Philosophy at the College-level)
>> has a basis to claim ownership of copyright on my work product, but I
>> also seem to have misplaced my law degree :-) I thus cannot
>> confidently say that it is false that I "have an employer who *might*
>> have a basis" to claim ownership of my changes.
>>
>> I've written the relevant gnu.org address seeking clarification as to
>> whether my good faith belief suffices in my circumstances.
>
> Okay let us know.  You might get a faster reply by Cc'ing me as the
> maintainer.  Also, perhaps your College administration will be faster
> that GNU ones -- but chances are that both will be slow anyway.
>
> In the meantime, don't hesitate to report problems informally on the
> list!


Hi Bastien,

Thanks for the response and sorry for my delay; I was traveling.

To my considerable surprise and pleasure, my email to the relevant
gnu.org address got a reply in under 48h. The synopsis is that gnu and
the FSF are only concerned about employer claims for those employed to
program or those studying comp sci at uni. Hence, I shall send my
papers in shortly. It may, however, take some considerable time
nonetheless; I am given to understand that mail from Egypt to the US
is both unreliable and extremely slow. Once all is settled, expect
patches :-)

Thanks and best,

Brian vdB

^ permalink raw reply	[flat|nested] 6+ messages in thread

* Re: Small grammar tweaks in export sections of org.texi
  2012-04-30 16:45       ` Brian van den Broek
@ 2012-04-30 23:46         ` Bastien
  0 siblings, 0 replies; 6+ messages in thread
From: Bastien @ 2012-04-30 23:46 UTC (permalink / raw)
  To: Brian van den Broek; +Cc: emacs-orgmode

Brian van den Broek <brian.van.den.broek@gmail.com> writes:

> Hence, I shall send my
> papers in shortly. It may, however, take some considerable time
> nonetheless; I am given to understand that mail from Egypt to the US
> is both unreliable and extremely slow. Once all is settled, expect
> patches :-)

Great news!  Thanks for the future patches :)

-- 
 Bastien

^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2012-04-30 23:45 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-04-24 16:10 Small grammar tweaks in export sections of org.texi Brian van den Broek
2012-04-24 21:35 ` Bastien
2012-04-24 23:01   ` Brian van den Broek
2012-04-26 13:54     ` Bastien
2012-04-30 16:45       ` Brian van den Broek
2012-04-30 23:46         ` Bastien

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).