ASCII export w/ citations

ASCII export w/ citations

[Ken Mankoff]

Hi,

I have the following setup for citing in Org documents:

(org-add-link-type
 "textcite"  (lambda (key) (org-open-file cby-references-file t nil key))
 (lambda (path desc format)
   (cond
    ((eq format 'latex) (format "\\textcite{%s}" path))
    ((eq format 'ascii) (format "@%s" path))
    )))
(org-add-link-type
 "cite"  (lambda (key) (org-open-file cby-references-file t nil key))
 (lambda (path desc format)
   (cond
    ((eq format 'latex) (format "\\autocite{%s}" path))
    ((eq format 'ascii) (format "[@%s]" path))
    )))

When I export to ASCII, things look mostly great. Except, at the bottom
of every section, I have the "raw" Org citations repeated. That is, if I
[[cite:Foo2001]] somewhere in the text, at the bottom I'll see:

[(Foo, 2001)] cite:Foo2001

Can anyone explain why ASCII export is repeating the "raw" cite commands
at the bottom of each section and/or how to turn this off?

Thanks,

  -k.
  

Re: ASCII export w/ citations

[Nicolas Goaziou]

Hello,

Ken Mankoff <mankoff@gmail.com> writes:

> I have the following setup for citing in Org documents:
>
> (org-add-link-type
>  "textcite"  (lambda (key) (org-open-file cby-references-file t nil key))
>  (lambda (path desc format)
>    (cond
>     ((eq format 'latex) (format "\\textcite{%s}" path))
>     ((eq format 'ascii) (format "@%s" path))
>     )))
> (org-add-link-type
>  "cite"  (lambda (key) (org-open-file cby-references-file t nil key))
>  (lambda (path desc format)
>    (cond
>     ((eq format 'latex) (format "\\autocite{%s}" path))
>     ((eq format 'ascii) (format "[@%s]" path))
>     )))
>
> When I export to ASCII, things look mostly great. Except, at the bottom
> of every section, I have the "raw" Org citations repeated. That is, if I
> [[cite:Foo2001]] somewhere in the text, at the bottom I'll see:
>
> [(Foo, 2001)] cite:Foo2001
>
> Can anyone explain why ASCII export is repeating the "raw" cite commands
> at the bottom of each section and/or how to turn this off?

See `org-ascii-links-to-notes'.


Regards,

-- 
Nicolas Goaziou

Re: ASCII export w/ citations

[Ken Mankoff]

* On 2015-01-01 at 13:36, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
>> When I export to ASCII, things look mostly great. Except, at the
>> bottom of every section, I have the "raw" Org citations repeated.
>> That is, if I [[cite:Foo2001]] somewhere in the text, at the bottom
>> I'll see:
>>
>> [(Foo, 2001)] cite:Foo2001
>>
>> Can anyone explain why ASCII export is repeating the "raw" cite
>> commands at the bottom of each section and/or how to turn this off?
>
> See `org-ascii-links-to-notes'.

OK. If I set that to nil then the links are not at the bottom of the
section, they are inline. But ASCII (in my opinion) shouldn't have
links. If I wanted links, I'd use Org or Markdown. Can you advise how I
get no links (or is it no notes?) at all?

  -k.

Re: ASCII export w/ citations

[Ken Mankoff]

* On 2015-01-01 at 13:59, Ken Mankoff <mankoff@gmail.com> wrote:
> OK. If I set that to nil then the links are not at the bottom of the
> section, they are inline. But ASCII (in my opinion) shouldn't have
> links. If I wanted links, I'd use Org or Markdown. Can you advise how
> I get no links (or is it no notes?) at all?

I can get the behavior I want (I think) if I
redefine 'org-ascii--describe-links' to return nil:

> (defun org-ascii--describe-links (links width info)
>   nil)

Seems to work for me (for now). Is this a bad idea?

  -k.

Re: ASCII export w/ citations

[Nicolas Goaziou]

Ken Mankoff <mankoff@gmail.com> writes:

> OK. If I set that to nil then the links are not at the bottom of the
> section, they are inline. But ASCII (in my opinion) shouldn't have
> links.

I disagree. It is a bug to silently ignore every link in ASCII export.

> Can you advise how I get no links (or is it no notes?) at all?

You want links. Otherwise it is contradictory with your custom export
function.

Anyway, custom export functions during ASCII export are not supported in
8.2.10. I fixed it in 8.3. You may want to update Org to test the new
behaviour.

Regards,

Re: ASCII export w/ citations

[Ken Mankoff]

* On 2015-01-01 at 15:45, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
> Anyway, custom export functions during ASCII export are not supported
> in 8.2.10. I fixed it in 8.3. You may want to update Org to test the
> new behaviour.

I don't see mention of custom export functions in the manual. Is there a
page describing how I would use these, or can you provide an example
that would stop printing of links in ASCII export?

Re: ASCII export w/ citations

[Nicolas Goaziou]

Ken Mankoff <mankoff@gmail.com> writes:

> I don't see mention of custom export functions in the manual. Is there a
> page describing how I would use these, or can you provide an example
> that would stop printing of links in ASCII export?

In your initial mail, you wrote

  (org-add-link-type
   "cite"  (lambda (key) (org-open-file cby-references-file t nil key))
   (lambda (path desc format)
     (cond
      ((eq format 'latex) (format "\\autocite{%s}" path))
      ((eq format 'ascii) (format "[@%s]" path))
      )))

The second lambda is a custom export function for "cite" links.

Anyway, I think you should update Org as the behaviour is different than
in your initial mail.

BTW, if you want to remove all links from ASCII export, use an export
filter.

Regards,

Re: ASCII export w/ citations

[Ken Mankoff]

* On 2015-01-02 at 15:42, Nicolas Goaziou <mail@nicolasgoaziou.fr> wrote:
> Ken Mankoff <mankoff@gmail.com> writes:
>
> In your initial mail, you wrote
>
>   (org-add-link-type
>    "cite"  (lambda (key) (org-open-file cby-references-file t nil key))
>    (lambda (path desc format)
>      (cond
>       ((eq format 'latex) (format "\\autocite{%s}" path))
>       ((eq format 'ascii) (format "[@%s]" path))
>       )))
>
> The second lambda is a custom export function for "cite" links.
>
> Anyway, I think you should update Org as the behaviour is different
> than in your initial mail.

Yes everything works well now with the updated (Git) Org.

Thanks,

  -k.