emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* [PATCH] make revisions in export section
@ 2018-08-25  2:55 Will Pierce
  2018-08-27  9:03 ` Nicolas Goaziou
  0 siblings, 1 reply; 2+ messages in thread
From: Will Pierce @ 2018-08-25  2:55 UTC (permalink / raw)
  To: emacs-orgmode


[-- Attachment #1.1: Type: text/plain, Size: 54 bytes --]

Made some revisions in the manual section on exports.

[-- Attachment #1.2: Type: text/html, Size: 75 bytes --]

[-- Attachment #2: 0001-org-manual-make-revisions-in-export-section.patch --]
[-- Type: application/octet-stream, Size: 7504 bytes --]

From 9580fc794d0f9c7951d817ea629115e4c76c1802 Mon Sep 17 00:00:00 2001
From: pierwill <19642016+pierwill@users.noreply.github.com>
Date: Fri, 24 Aug 2018 17:32:01 -0500
Subject: [PATCH] org-manual: make revisions in export section

* make various revision for style and clarity.
---
 doc/org-manual.org | 78 +++++++++++++++++++++-------------------------
 1 file changed, 36 insertions(+), 42 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index d4e82002f..ae2c8b8b8 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -11092,16 +11092,14 @@ as a horizontal line.
 :END:
 #+cindex: exporting
 
-Sometimes, you may want to pretty print your notes, publish them on
-the web or even share them with people not using Org.  In these cases,
-the Org export facilities can be used to convert your documents to
-a variety of other formats, while retaining as much structure (see
-[[*Document Structure]]) and markup (see [[*Markup for Rich Contents]]) as
-possible.
+At some point you might want to print your notes, publish them on the web, or
+share them with people not using Org. Org can convert and export documents
+to a variety of other formats while retaining as much structure (see [[*Document
+Structure]]) and markup (see [[*Markup for Rich Contents]]) as possible.
 
 #+cindex: export back-end
-Libraries responsible for such translation are called back-ends.  Org
-ships with the following ones
+The libraries responsible for translating Org files to other formats are called
+/back-ends/. Org ships with support for the following back-ends:
 
 - /ascii/ (ASCII format)
 - /beamer/ (LaTeX Beamer format)
@@ -11115,18 +11113,18 @@ ships with the following ones
 - /man/ (Man page format)
 
 #+texinfo: @noindent
-Org also uses additional libraries located in =contrib/= directory
-(see [[*Installation]]).  Users can install additional export libraries
-for additional formats from the Emacs packaging system.  For easy
-discovery, these packages have a common naming scheme: ~ox-NAME~,
-where {{{var(NAME)}}} is one of the formats.  For example,
-~ox-koma-letter~ /koma-letter/ back-end.
+Users can install libraries for additional formats from the Emacs packaging
+system. For easy discovery, these packages have a common naming scheme:
+~ox-NAME~, where {{{var(NAME)}}} is a format. For example, ~ox-koma-letter~
+for /koma-letter/ back-end. More libraries can be found in the =contrib/=
+directory (see [[*Installation]]).
 
 #+vindex: org-export-backends
-Org loads back-ends for the following formats by default: ASCII, HTML,
-iCalendar, LaTeX and ODT.  Org can load additional back-ends either of
-two ways: through the ~org-export-backends~ variable configuration;
-or, by requiring the library in the Emacs init file like this:
+Org only loads back-ends for the following formats by default: ASCII, HTML,
+iCalendar, LaTeX, and ODT. Additional back-ends can be loaded in either of
+two ways: by configuring the ~org-export-backends~ variable, or by requiring
+libraries in the Emacs init file. For example, to load the markdown back-end,
+add this to your Emacs config:
 
 #+begin_src emacs-lisp
 (require 'ox-md)
@@ -11164,36 +11162,34 @@ active region, then Org exports just that region.
 Within the dispatcher interface, the following key combinations can
 further alter what is exported, and how.
 
+
 - {{{kbd(C-a)}}} ::
      #+kindex: C-c C-e C-a
 
      Toggle asynchronous export.  Asynchronous export uses an external
      Emacs process with a specially configured initialization file to
-     complete the exporting process in the background thereby
-     releasing the current interface.  This is particularly useful
-     when exporting long documents.
+     complete the exporting process in the background, without tying-up
+     Emacs.  This is particularly useful when exporting long documents.
 
-     Output from an asynchronous export is saved on the "the export
-     stack".  To view this stack, call the export dispatcher with
+     Output from an asynchronous export is saved on the /export
+     stack/.  To view this stack, call the export dispatcher with
      a double {{{kbd(C-u)}}} prefix argument.  If already in the
      export dispatcher menu, {{{kbd(&)}}} displays the stack.
 
-     #+vindex: org-export-async-init-file
-     To make the background export process the default, customize the
-     variable, ~org-export-in-background~.  Additionally, you can set
-     the initialization file used by the background process with
-     ~org-export-async-init-file~.
-
      #+vindex: org-export-in-background
      You can make asynchronous export the default by setting
      ~org-export-in-background~.
 
+     #+vindex: org-export-async-init-file
+     You can set the initialization file used by the background process
+     by setting ~org-export-async-init-file~.
+
 - {{{kbd(C-b)}}} ::
      #+kindex: C-c C-e C-b
 
      Toggle body-only export.  Useful for excluding headers and
      footers in the export.  Affects only those back-end formats that
-     have such sections---like =<head>...</head>= in HTML.
+     have sections like =<head>...</head>= in HTML.
 
 - {{{kbd(C-s)}}} ::
      #+kindex: C-c C-e C-s
@@ -11206,15 +11202,15 @@ further alter what is exported, and how.
      document preamble, Org signals an error and aborts export.
 
      #+vindex: org-export-initial-scope
-     To make the sub-tree export the default, customize the variable
+     To make sub-tree export the default, customize the variable
      ~org-export-initial-scope~.
 
 - {{{kbd(C-v)}}} ::
      #+kindex: C-c C-e C-v
 
-     Toggle visible-only export.  Useful for exporting only visible
-     parts of an Org document by adjusting outline visibility
-     settings.
+     Toggle visible-only export.  This is useful for exporting only certain
+     parts of an Org document by adjusting the visibility
+     of particular headings.
 
 ** Export Settings
 :PROPERTIES:
@@ -11226,8 +11222,8 @@ further alter what is exported, and how.
 #+cindex: @samp{OPTIONS}, keyword
 Export options can be set: globally with variables; for an individual
 file by making variables buffer-local with in-buffer settings (see
-[[*Summary of In-Buffer Settings]]), by setting individual keywords, or by
-specifying them in a compact form with the =OPTIONS= keyword; or for
+[[*Summary of In-Buffer Settings]]); by setting individual keywords or
+specifying them in compact form with the =OPTIONS= keyword; or for
 a tree by setting properties (see [[*Properties and Columns]]).  Options
 set at a specific level override options set at a more general level.
 
@@ -11517,12 +11513,10 @@ following arguments.
      #+vindex: org-export-with-tables
      Toggle inclusion of tables (~org-export-with-tables~).
 
-When exporting sub-trees, special node properties in them can override
-the above keywords.  They are special because they have an =EXPORT_=
-prefix.  For example, =DATE= and =EXPORT_FILE_NAME= keywords become,
-respectively, =EXPORT_DATE= and =EXPORT_FILE_NAME=.  Except for
-=SETUPFILE=, all other keywords listed above have an =EXPORT_=
-equivalent.
+When exporting sub-trees, special node properties can override the above
+keywords. These properties have an =EXPORT_= prefix. For example, =DATE=
+becomes, =EXPORT_DATE= when used for a specific sub-tree. Except for =SETUPFILE=,
+all other keywords listed above have an =EXPORT_= equivalent.
 
 #+cindex: @samp{BIND}, keyword
 #+vindex: org-export-allow-bind-keywords
-- 
2.18.0


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

* Re: [PATCH] make revisions in export section
  2018-08-25  2:55 [PATCH] make revisions in export section Will Pierce
@ 2018-08-27  9:03 ` Nicolas Goaziou
  0 siblings, 0 replies; 2+ messages in thread
From: Nicolas Goaziou @ 2018-08-27  9:03 UTC (permalink / raw)
  To: Will Pierce; +Cc: emacs-orgmode

Hello,

Will Pierce <pierwill@gmail.com> writes:

> Made some revisions in the manual section on exports.

Applied. I added two spaces after each sentence.

Have you signed FSF papers? If you haven't so, please consider signing
them so that I can apply further changes.

Thank you.

Regards,

-- 
Nicolas Goaziou

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

end of thread, other threads:[~2018-08-27  9:12 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-08-25  2:55 [PATCH] make revisions in export section Will Pierce
2018-08-27  9:03 ` Nicolas Goaziou

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