[PATCH] ox.el: Customize org-export-dispatch options

emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Jim Wisniewski <wisnij@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [PATCH] ox.el: Customize org-export-dispatch options
Date: Sat, 15 Apr 2023 00:48:15 -0400	[thread overview]
Message-ID: <CAAukYu0m7A=tNunf=2HaTXW3GWvNWsku-8yA0HAbDzm8J8ETTw@mail.gmail.com> (raw)

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

Here's a small enhancement I wrote to add customizable variables for the
`org-export-dispatch' UI options that don't already have one.  I almost always
export with "Body only" switched on, and I got tired of manually toggling it
each time; while I was at it I also added variables for "Visible only" and
"Force publishing", because why not.  Hopefully others will find this helpful as
well.

I tried this out locally by eval-ing the new code and customizing the new
variables, and it appears to have the desired effect.  `make test' and `make
compile' also succeed.

I sent in the copyright assignment form but haven't gotten the contract back to
sign yet.

Changelog:

* lisp/ox.el: Add customizable variables `org-export-body-only',
`org-export-visible-only', and `org-export-force-publishing', and use
them in `org-export-dispatch'.

* doc/org-manual.org: Document the new export variables.

Currently when calling `org-export-dispatch', two of the export
options can have their defaults specified with customizable variables:
"Export scope" (via `org-export-initial-scope') and "Async export"
(via `org-export-in-background').  This change adds customizable
variables for the "Body only", "Visible only", and "Force publishing"
options as well.

-- 
JJW

[-- Attachment #2: 0001-ox.el-Customize-org-export-dispatch-options.patch --]
[-- Type: text/x-patch, Size: 4069 bytes --]

From 563a31988df9fb1b1b2093918e03cd92b7a671a0 Mon Sep 17 00:00:00 2001
From: Jim Wisniewski <wisnij@gmail.com>
Date: Fri, 14 Apr 2023 02:46:25 -0400
Subject: [PATCH] ox.el: Customize org-export-dispatch options

* lisp/ox.el: Add customizable variables `org-export-body-only',
`org-export-visible-only', and `org-export-force-publishing', and use
them in `org-export-dispatch'.

* doc/org-manual.org: Document the new export variables.

Currently when calling `org-export-dispatch', two of the export
options can have their defaults specified with customizable variables:
"Export scope" (via `org-export-initial-scope') and "Async export"
(via `org-export-in-background').  This change adds customizable
variables for the "Body only", "Visible only", and "Force publishing"
options as well.
---
 doc/org-manual.org | 22 ++++++++++++++++++++++
 lisp/ox.el         | 28 ++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index a54bd6f35..2e98793bf 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -11773,6 +11773,24 @@ further alter what is exported, and how.
   in the export.  Affects only those back-end formats that have
   sections like =<head>...</head>= in HTML.
 
+  #+vindex: org-export-body-only
+  To make body-only export the default, customize the variable
+  ~org-export-body-only~.
+
+- {{{kbd(C-f)}}} ::
+  #+kindex: C-c C-e C-f
+
+  Toggle force-publishing export.  Publish functions normally only
+  publish changed files (see [[**Triggering Publication]]).  Forced
+  publishing causes files to be published even if their timestamps do
+  not indicate the file has been changed.
+
+  #+vindex: org-export-force-publishing
+  To make forced publishing the default, customize the variable
+  ~org-export-force-publishing~.  (This is similar to
+  ~org-publish-use-timestamps-flag~, but only affects the export
+  dispatcher.)
+
 - {{{kbd(C-s)}}} ::
   #+kindex: C-c C-e C-s
 
@@ -11794,6 +11812,10 @@ further alter what is exported, and how.
   certain parts of an Org document by adjusting the visibility of
   particular headings.  See also [[*Sparse Trees]].
 
+  #+vindex: org-export-visible-only
+  To make visible-only export the default, customize the variable
+  ~org-export-visible-only~.
+
 ** Export Settings
 :PROPERTIES:
 :DESCRIPTION: Common export settings.
diff --git a/lisp/ox.el b/lisp/ox.el
index 8be60985f..736d9d1c8 100644
--- a/lisp/ox.el
+++ b/lisp/ox.el
@@ -955,6 +955,31 @@ these cases."
   :group 'org-export-general
   :type 'boolean)
 
+(defcustom org-export-body-only nil
+  "The initial \"Body only\" setting when exporting with `org-export-dispatch'.
+Non-nil means only export body code, without the surrounding
+template."
+  :group 'org-export-general
+  :version "30.0"
+  :package-version '(Org . "9.7")
+  :type 'boolean)
+
+(defcustom org-export-visible-only nil
+  "The initial \"Visible only\" setting when exporting with `org-export-dispatch'.
+Non-nil means don't export the contents of hidden elements."
+  :group 'org-export-general
+  :version "30.0"
+  :package-version '(Org . "9.7")
+  :type 'boolean)
+
+(defcustom org-export-force-publishing nil
+  "The initial \"Force publishing\" setting when exporting with `org-export-dispatch'.
+Non-nil means force all files in the project to be published."
+  :group 'org-export-general
+  :version "30.0"
+  :package-version '(Org . "9.7")
+  :type 'boolean)
+
 (defcustom org-export-in-background nil
   "Non-nil means export and publishing commands will run in background.
 Results from an asynchronous export are never displayed
@@ -7094,6 +7119,9 @@ asynchronous export stack."
 		         (setq org-export-dispatch-last-action
 			       (org-export--dispatch-ui
 			        (list org-export-initial-scope
+				      (and org-export-body-only 'body)
+				      (and org-export-visible-only 'visible)
+				      (and org-export-force-publishing 'force)
 				      (and org-export-in-background 'async))
 			        nil
 			        org-export-dispatch-use-expert-ui)))
-- 
2.39.2

next             reply	other threads:[~2023-04-15  4:49 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-15  4:48 Jim Wisniewski [this message]
2023-04-15  9:49 ` [PATCH] ox.el: Customize org-export-dispatch options Ihor Radchenko
2023-04-15 20:36   ` Jim Wisniewski
2023-04-16 13:00     ` Ihor Radchenko
2023-04-19 21:44       ` Jim Wisniewski
2023-04-20  8:48         ` Ihor Radchenko
2023-04-21 18:04           ` Jim Wisniewski
2023-04-22 12:40             ` Ihor Radchenko
2023-05-02 21:05               ` Jim Wisniewski
2023-05-03 11:46                 ` Ihor Radchenko
2023-05-14 13:21               ` Bastien Guerry
2023-05-14 14:19                 ` Ihor Radchenko
2023-05-14 18:35                   ` Jim Wisniewski
2023-04-15 11:08 ` Max Nikulin

find likely ancestor, descendant, or conflicting patches for this message:
( dfblob:a54bd6f3 dfblob:2e98793b dfblob:8be60985 dfblob:736d9d1c )
 OR (
bs:"ox.el: Customize org-export-dispatch options" )
	(help)

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='CAAukYu0m7A=tNunf=2HaTXW3GWvNWsku-8yA0HAbDzm8J8ETTw@mail.gmail.com' \
    --to=wisnij@gmail.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).