emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[ELPA] New package: org-real


From: Tyler Grinn
Subject: [ELPA] New package: org-real
Date: Tue, 05 Oct 2021 15:46:58 -0400
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.60 (gnu/linux)

I would like to propose that org-real be added to ELPA.

Org real allows you to keep track of real things as org-mode links.  A
real link looks like this: real://mouth/nose?rel=below .  Following a
real link pops up a boxy.el diagram which shows where the thing is.  The
command org-real-world will combine all real links in the current buffer
and display it as a boxy.el diagram.

You can use it to map a physical filing system to your org-mode workflow
or sprinkle real links throughout an existing org file to create a
alternate hierarchy to navigate with org-real-world.

https://gitlab.com/tygrdev/org-real


I have some implementation questions for anyone willing to take a look.

https://gitlab.com/tygrdev/org-real/-/blob/19711cb1362f8fb21ee6ab1d4f71dfc2adc4c798/org-real.el#L464-496

In order to support editing existing real links with the org-real custom
completion mechanism, I temporarily advise read-string, during the
org-insert-link process, to look out for real links.

In that same section, I shadow org-link-make-description-function in
order to suggest a description if both the existing description and
org-link-make-description-function are unset.

I call org-real-apply after inserting a link to check that the new link
does not conflict with any other real link in the buffer, if it is real.


https://gitlab.com/tygrdev/org-real/-/blob/19711cb1362f8fb21ee6ab1d4f71dfc2adc4c798/org-real.el#L561-580

The function org-link-make-string is not available in Emacs 26, so I've
copied the implementation from Emacs 27 for backwards compatibility.


https://gitlab.com/tygrdev/org-real/-/blob/19711cb1362f8fb21ee6ab1d4f71dfc2adc4c798/org-real.el#L641-656

I've copied the args construction from ispell-start-process.


I assume copying existing Emacs code is OK, I just wanted to be sure and
see if I needed any attribution.


diff --git a/elpa-packages b/elpa-packages
index 480f7dd2a8..280f48650b 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -288,6 +288,9 @@
   :shell-command "make autoloads info; mv doc/org.info org.info; mv 
doc/orgguide.info orgguide.info"
   :doc ("org.info" "orgguide.info")
   :auto-sync t)
+ ("org-real"
+  :url "https://gitlab.com/tygrdev/org-real";
+  :auto-sync t)
  ("org-translate"      :url nil)
  ("orgalist"            :url nil)
  ("org-edna"           :url "bzr::https://bzr.savannah.gnu.org/r/org-edna-el";) 
;URL?
Best,


Tyler

reply via email to

[Prev in Thread] Current Thread [Next in Thread]