emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Max Nikulin <manikulin@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: [RFC][PATCH] Allow to export to ascii custom link types as notes
Date: Mon, 23 Oct 2023 00:05:35 +0700	[thread overview]
Message-ID: <uh3kp2$908$1@ciao.gmane.io> (raw)
In-Reply-To: <874jijaukf.fsf@localhost>

On 22/10/2023 16:13, Ihor Radchenko wrote:
> Max Nikulin writes:
> 
>> For ascii backend :export function from `org-link-parameters' may return
>> (PATH . DESCRIPTION) `cons' instead of string.
> 
> This is non-standard. We should document it somewhere in the manual.

Currently the question is whether it is acceptable or it should be 
changed to e.g. plist or even to use a callback.

>> I believe that parenthesis should be skipped in the case of angle
>> brackets "(<URI>)", but I do not change this behavior. There is some
>> inconsistency in respect to brackets for description of inline links,
>> but it is preserved as well.
> 
> May you elaborate?

I believe, parenthesis are not necessary when angle brackets are added 
around URI. Anyway currently behavior is not consistent and angle 
brackets are not added in some cases. I would prefer to stick to angle 
brackets and to drop parenthesis when <> are present.

>> I do not like that :export functions are called twice: for text and for
>> note. In my opinion it is better to collect links in a property of INFO
>> to later format notes at the end of the heading. I would consider more
>> dense style of notes with list markers instead of empty line as separator.
> 
> Again, may you elaborate?

List of links is added by `org-ascii--describe-links' that iterates over 
links earlier handled by `org-ascii-link', so :export function is called 
twice for each link having this property. I would consider collecting 
links in some property of the INFO argument instead. As a result 
`org-ascii--describe-link' would reuse results of formatters called by 
`org-ascii-link'.

Currently list of links is formatted as

[Description 1] <URL 1>

[Description 2] <URL 2>

 From my point of view it would not harm to have more dense formatting

- [Description 1] <URL 1>
- [Description 2] <URL 2>

>> +           (if (string-match-p "\\`\u200b*\\[.*\\]\u200b*\\'" anchor)
>> +               anchor
>> +	     (format "[%s]" anchor))
> 
> This is out of scope of the patch, isn't it?

Not really.

> I can see the motivation, but we should probably move this change to a
> separate patch and discussion thread.

In the case of inline links brackets are sometimes added around 
description, sometimes not. To keep current behavior I have decided that 
it is better to suppress duplicated brackets implicitly than to add an 
extra argument that controls adding [] explicitly. I do not insist on 
"\u200b*" that allows to handle duplication due to brackets in Org 
documents [[https://orgmode.org][\u200b[Org]\u200b]]. However I would 
prefer to keep the regexp for the case of brackets added by link formatters.



  reply	other threads:[~2023-10-22 17:06 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-20 17:21 [RFC][PATCH] Allow to export to ascii custom link types as notes Max Nikulin
2023-10-22  9:13 ` Ihor Radchenko
2023-10-22 17:05   ` Max Nikulin [this message]
2023-10-23  9:17     ` Ihor Radchenko
2023-10-23 11:00       ` Max Nikulin
2023-10-23 12:09         ` Ihor Radchenko
2023-10-24  8:11           ` Max Nikulin
2023-10-24 10:40             ` Ihor Radchenko
2023-10-24 15:06               ` [PATCH] ox-ascii.el: Consistently add brackets around links (was: Re: [RFC][PATCH] Allow to export to ascii custom link types as notes) Max Nikulin
2023-10-25 10:34                 ` Ihor Radchenko
2023-10-26 16:46                   ` man pages references (Re: [PATCH] ox-ascii.el: Consistently add brackets around links) Max Nikulin
2023-11-05 12:08                     ` Ihor Radchenko
2023-10-27 14:36               ` [RFC][PATCH] Allow to export to ascii custom link types as notes Max Nikulin
2023-10-25 15:16           ` [RFC][PATCH v2] " Max Nikulin
2023-11-07  9:30             ` Ihor Radchenko
2023-11-07 11:48               ` Max Nikulin
2023-11-07 11:58                 ` Ihor Radchenko
2023-11-08 10:23                   ` Max Nikulin
2023-11-08 10:45                     ` Ihor Radchenko
2023-11-08 10:57                       ` Max Nikulin
2023-11-08 11:16                         ` Ihor Radchenko
2023-11-09 11:12                           ` Max Nikulin
2023-11-11 11:17                             ` Ihor Radchenko

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='uh3kp2$908$1@ciao.gmane.io' \
    --to=manikulin@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).