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

From: Ihor Radchenko <yantar92@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [Feature proposal] Add :description function to org-link-parameters
Date: Sat, 03 Aug 2019 00:01:45 +0800	[thread overview]
Message-ID: <871ry3eety.fsf@yantar92-laptop.i-did-not-set--mail-host-address--so-tickle-me> (raw)

Hi,

Wondering if anyone is interested in adding a new org-link property to
customise generating the link description.

For now, there is global org-link-make-description-function, which is
shared among all the link types. If would be more convenient if the
description function can be set independently for different link types.

I propose to use :description property in org-link-parameters. A sample
implementation working with current org version is below:

#+begin_src emacs-lisp
(defun yant/org-make-link-description-function (link desk)
  "Return description of the link LINK according to :description link property.
Return DESK if :desk is not set."
  (let ((fun (org-link-get-parameter (car (split-string link ":")) :description)))
    (if (functionp fun)
	(funcall fun link desk)
      desk)))

(setq org-make-link-description-function #'yant/org-make-link-description-function)
#+end_src

Example usage:

#+begin_src emacs-lisp
(defun org-id-link-desk (link desk)
  "Description function for id: link."
  (let ((id (cadr (split-string link ":"))))
    (org-with-point-at (org-id-find id 'marker)
      (s-replace "||" "/" (yant/task-fulltitle)))))

(org-link-set-parameters "id" 
                         :desk #'org-id-link-desk)
#+end_src

Best,
Ihor


-- 
Ihor Radchenko,
PhD,
Center for Advancing Materials Performance from the Nanoscale (CAMP-nano)
State Key Laboratory for Mechanical Behavior of Materials, Xi'an Jiaotong University, Xi'an, China
Email: yantar92@gmail.com, ihor_radchenko@alumni.sutd.edu.sg

next             reply	other threads:[~2019-08-02 16:02 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-08-02 16:01 Ihor Radchenko [this message]
2019-08-02 22:23 ` [Feature proposal] Add :description function to org-link-parameters John Kitchin
2019-08-03  2:35   ` Ihor Radchenko
2019-10-07  2:52 ` stardiviner
2020-02-04  8:13 ` Bastien
2022-10-09  6:41 ` 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=871ry3eety.fsf@yantar92-laptop.i-did-not-set--mail-host-address--so-tickle-me \
    --to=yantar92@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

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