[PATCH] ox-ascii.el: Fix justify when `indent-tabs-mode' is non-nil

[PATCH] ox-ascii.el: Fix justify when `indent-tabs-mode' is non-nil

[Morgan Willcock]

* lisp/ox-ascii.el (org-ascii--justify-lines): Ensure that
`indent-tabs-mode' is nil when applying indentation to justify lines.
This prevents tab characters from appearing in the export when
`indent-tabs-mode' still has its default value of t.  TINYCHANGE
---
Hi,

I've attached a patch to fix an issue where tab characters are generated by
the ASCII exporter when `indent-tabs-mode' has its default value of t.

Here is a simple test case which generates tabs with 'emacs -Q':

(with-temp-buffer
  (insert "#+TITLE: My Title\n"
	  "#+OPTIONS: author:nil\n"
	  "#+OPTIONS: toc:nil\n")
  (org-mode)
  (org-ascii-export-as-ascii)
  (with-current-buffer "*Org ASCII Export*"
    (buffer-string)))

I haven't gone through the FSF copyright assignment process but I'm assuming
this is OK based on the line count.

Thanks,
Morgan

 lisp/ox-ascii.el | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lisp/ox-ascii.el b/lisp/ox-ascii.el
index d1762d41c..176542661 100644
--- a/lisp/ox-ascii.el
+++ b/lisp/ox-ascii.el
@@ -480,6 +480,9 @@ HOW determines the type of justification: it can be `left',
     (insert s)
     (goto-char (point-min))
     (let ((fill-column text-width)
+          ;; Ensure that `indent-tabs-mode' is nil so that indentation
+          ;; will always be achieved using spaces rather than tabs.
+          (indent-tabs-mode nil)
 	  ;; Disable `adaptive-fill-mode' so it doesn't prevent
 	  ;; filling lines matching `adaptive-fill-regexp'.
 	  (adaptive-fill-mode nil))
-- 
2.30.2

Re: [PATCH] ox-ascii.el: Fix justify when `indent-tabs-mode' is non-nil

[Timothy]

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

Hi Morgan,

> I’ve attached a patch to fix an issue where tab characters are generated by
> the ASCII exporter when `indent-tabs-mode’ has its default value of t.

Thanks for finding this bug, fixing it, and sending us it 🙂. I was able to
reproduce your test case with “emacs -Q” (thanks for that, by the way).
As you suspected, with the small number of changed lines, this would be fine to
accept without FSF assignment.
However, your “patch” seems to consist of a diff at the bottom of your email and
a commit message at the top?? It would be preferable if you could provide a
“proper” patch, that way you can get attribution for your help instead of just
someone committing it on your behalf.

All the best,
Timothy

Re: [PATCH] ox-ascii.el: Fix justify when `indent-tabs-mode' is non-nil

[Morgan Willcock]

Timothy <tecosaur@gmail.com> writes:

> Hi Morgan,
>
>> I’ve attached a patch to fix an issue where tab characters are generated by
>> the ASCII exporter when `indent-tabs-mode’ has its default value of t.
>
> Thanks for finding this bug, fixing it, and sending us it 🙂. I was able to
> reproduce your test case with “emacs -Q” (thanks for that, by the way).
> As you suspected, with the small number of changed lines, this would be fine to
> accept without FSF assignment.

Great! Thank you for taking a look.

> However, your “patch” seems to consist of a diff at the bottom of your email and
> a commit message at the top?? It would be preferable if you could provide a
> “proper” patch, that way you can get attribution for your help instead of just
> someone committing it on your behalf.

I used `git send-email` which is listed as being OK on the website:

  "If you have configured git to use send-email, then you can use that."
                                 -- https://orgmode.org/contribute.html

The mail can be applied with `git am` and the commit message will be
correct. I'm also happy to resend as a separate patch if that is the
requirement.

Thanks,
Morgan

Re: [PATCH] ox-ascii.el: Fix justify when `indent-tabs-mode' is non-nil

[Timothy]

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

Hi Morgan,

> Great! Thank you for taking a look.

No problem, thanks for making the patch :)

> I used `git send-email` which is listed as being OK on the website:

Huh, I guess it should be fine then. I’ve just never seen the commit message at
the top like that so I assumed you’d done it by hand. :shrug:

All the best,
Timothy

Re: [PATCH] ox-ascii.el: Fix justify when `indent-tabs-mode' is non-nil

[Timothy]

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

Hi  Morgan,

I’ve just taken a look at your patch (it `git am's just fine), since nobody else
seems to have had the time to look at your patch as of late. There’s one thing
which I now realise completely slipped by me last time — why are tabs bad?
Maybe I’m missing something obvious, but exporting with tabs and viewing/`cat'ing
the file everything looks fine to me in terms of alignment.

Morgan Willcock <mwillcock@precedence.co.uk> writes:

> I’ve attached a patch to fix an issue where tab characters are generated by
> the ASCII exporter when `indent-tabs-mode’ has its default value of t.

All the best,
Timothy

Re: [PATCH] ox-ascii.el: Fix justify when `indent-tabs-mode' is non-nil

[Morgan Willcock]

Timothy <tecosaur@gmail.com> writes:

> Hi  Morgan,
>
> I’ve just taken a look at your patch (it `git am's just fine), since nobody else
> seems to have had the time to look at your patch as of late. There’s one thing
> which I now realise completely slipped by me last time — why are tabs bad?
> Maybe I’m missing something obvious, but exporting with tabs and viewing/`cat'ing
> the file everything looks fine to me in terms of alignment.

Hi Timothy,

It seems to default to spaces everywhere else. If you export an actual
document through the ascii exporter instead of just a document header
you will get a mix of tabs and spaces. This is how it was brought to my
attention, I was distributing a file that was batch exported and someone
pointed out that the indentation was inconsistent.

If it is handled as an export preference or defaults to the global
indentation preference then that would be fine but I don't believe
either of those are the case.

Thanks for continuing to look,
Morgan

Re: [PATCH] ox-ascii.el: Fix justify when `indent-tabs-mode' is non-nil

[Timothy]

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

Hi  Morgan,

Thanks for clarifying this. That makes sense to me, and so I’ve just pushed your
patch as 3a77e59 🙂, with a slightly tweaked commit message. Thanks for going to
the effort of pinpointing and fixing this issue, and your patience in seeing
this accepted.

Morgan Willcock <mwillcock@precedence.co.uk> writes:

> It seems to default to spaces everywhere else. If you export an actual
> document through the ascii exporter instead of just a document header
> you will get a mix of tabs and spaces. This is how it was brought to my
> attention, I was distributing a file that was batch exported and someone
> pointed out that the indentation was inconsistent.
>
> If it is handled as an export preference or defaults to the global
> indentation preference then that would be fine but I don’t believe
> either of those are the case.
>
> Thanks for continuing to look,
> Morgan

All the best,
Timothy

[PATCH] ox-ascii.el: Fix justify when `indent-tabs-mode' is non-nil

[Morgan Willcock]

* lisp/ox-ascii.el (org-ascii--justify-lines): Ensure that
`indent-tabs-mode' is nil when applying indentation to justify lines.
This prevents tab characters from appearing in the export when
`indent-tabs-mode' still has its default value of t.  TINYCHANGE
---
Hi,

I've attached a patch to fix an issue where tab characters are generated by
the ASCII exporter when `indent-tabs-mode' has its default value of t.

Here is a simple test case which generates tabs with 'emacs -Q':

(with-temp-buffer
  (insert "#+TITLE: My Title\n"
	  "#+OPTIONS: author:nil\n"
	  "#+OPTIONS: toc:nil\n")
  (org-mode)
  (org-ascii-export-as-ascii)
  (with-current-buffer "*Org ASCII Export*"
    (buffer-string)))

I haven't gone through the FSF copyright assignment process but I'm assuming
this is OK based on the line count.

Thanks,
Morgan

 lisp/ox-ascii.el | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lisp/ox-ascii.el b/lisp/ox-ascii.el
index d1762d41c..176542661 100644
--- a/lisp/ox-ascii.el
+++ b/lisp/ox-ascii.el
@@ -480,6 +480,9 @@ HOW determines the type of justification: it can be `left',
     (insert s)
     (goto-char (point-min))
     (let ((fill-column text-width)
+          ;; Ensure that `indent-tabs-mode' is nil so that indentation
+          ;; will always be achieved using spaces rather than tabs.
+          (indent-tabs-mode nil)
 	  ;; Disable `adaptive-fill-mode' so it doesn't prevent
 	  ;; filling lines matching `adaptive-fill-regexp'.
 	  (adaptive-fill-mode nil))
-- 
2.30.2