Org-mode element API: How to extract link description

Org-mode element API: How to extract link description

[Sébastien Gendre]

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

Hello,

With the Org-mode element API, when I get an element of type "link", how
do I extract the link description ?

It's not a property of a link, from what I can see in when explore the
content of a link element. And I found nothing on the documentation.

Did I miss something ?


Best regards

-------
Gendre Sébastien

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 849 bytes --]

Re: Org-mode element API: How to extract link description

[Ihor Radchenko]

Sébastien Gendre <seb@k-7.ch> writes:

> With the Org-mode element API, when I get an element of type "link", how
> do I extract the link description ?

> It's not a property of a link, from what I can see in when explore the
> content of a link element. And I found nothing on the documentation.

Link description is considered to be link contents.
But do note that simple `org-element-at-point' does not compute
contents. It is only available in the full parse tree. From
`org-element-at-point', a practical way to retrieve description text is
using substring between :contents-begin/end.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: Org-mode element API: How to extract link description

[Sébastien Gendre]

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


Thank you very much.

Ihor Radchenko <yantar92@posteo.net> writes:

> Sébastien Gendre <seb@k-7.ch> writes:
>
>> With the Org-mode element API, when I get an element of type "link", how
>> do I extract the link description ?
>
>> It's not a property of a link, from what I can see in when explore the
>> content of a link element. And I found nothing on the documentation.
>
> Link description is considered to be link contents.
> But do note that simple `org-element-at-point' does not compute
> contents. It is only available in the full parse tree. From
> `org-element-at-point', a practical way to retrieve description text is
> using substring between :contents-begin/end.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 849 bytes --]

Re: Org-mode element API: How to extract link description

[Alexander Adolf via General discussions about Org-mode.]

Ihor Radchenko <yantar92@posteo.net> writes:

> Sébastien Gendre <seb@k-7.ch> writes:
>
>> With the Org-mode element API, when I get an element of type "link", how
>> do I extract the link description ?
> [...]
> Link description is considered to be link contents.
> But do note that simple `org-element-at-point' does not compute
> contents. It is only available in the full parse tree. From
> `org-element-at-point', a practical way to retrieve description text is
> using substring between :contents-begin/end.
> [...]

I use org-link-display-format to get the description part when I have
the link as a string. Perhaps something along the lines of

    (org-link-display-format (buffer-substring-no-properties
                              (org-element-contents-begin link)
                              (org-element-contents-end link)))

for your use-case?


Hoping to have helped,

  --alexander