Skip to content

Commit 40b290c

Browse files
author
github-actions
committed
[docgen] Update docs
1 parent fb50c10 commit 40b290c

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

doc/orgmode_api.txt

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ OrgApi.refile({opts}) *OrgApi.refile*
3737

3838
OrgApi.insert_link() *OrgApi.insert_link*
3939
Insert a link to a given location at the current cursor position
40+
41+
The expected format is
42+
<protocol>:<location>::<in_file_location>
43+
44+
If <in_file_location> is *<headline>, <headline> is used as prefilled description for the link.
45+
If <protocol> is id, this format can also be used to pass a prefilled description.
4046
@param link_location string
4147
@return boolean
4248

@@ -64,6 +70,19 @@ OrgFile:get_closest_headline() *OrgFile:get_closest_headline*
6470
@return OrgApiHeadline | nil
6571

6672

73+
OrgFile:get_link() *OrgFile:get_link*
74+
Get a link destination as string
75+
76+
Depending if org_id_link_to_org_use_id is set the format is
77+
78+
id:<uuid>::*title and the id is created if not existing
79+
or
80+
file:<filepath>::*title
81+
82+
The result is meant to be used as link_location for OrgApi.insert_link.
83+
@return string
84+
85+
6786
OrgApiHeadline *OrgApiHeadline*
6887

6988
Fields: ~
@@ -172,6 +191,19 @@ OrgHeadline:id_get_or_create() *OrgHeadline:id_get_or_create*
172191
@return string
173192

174193

194+
OrgHeadline:get_link() *OrgHeadline:get_link*
195+
Get a link destination as string
196+
197+
Depending if org_id_link_to_org_use_id is set the format is
198+
199+
id:<uuid>::*title and the id is created if not existing
200+
or
201+
file:<filepath>::*title
202+
203+
The result is meant to be used as link_location for OrgApi.insert_link.
204+
@return string
205+
206+
175207
OrgApiAgenda *OrgApiAgenda*
176208

177209

0 commit comments

Comments
 (0)