phundrak
/
org-unique-id
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update package description

This commit is contained in:
Lucien Cartier-Tilet 2022-09-07 10:18:22 +02:00
parent e14eb92ec0
commit 4468556f4e
Signed by: phundrak
GPG Key ID: BD7789E705CB8DCA
1 changed files with 44 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
org-unique-id.el
View File

@ -26,17 +26,52 @@
;;; Commentary: ;;; Commentary:
;; This package is inspired by a blog post I published about a year ;; org-unique-id is a utility package for org-mode users that are
;; before I decided to write this package [1], which in turn is ;; tired dealing with random org IDs for their headers’ anchor that
;; largely inspired by another blog post [2]. ;; change on each org to HTML exports among others. This package
;; creates meaningful custom IDs for org headers that won’t change
;; unless the user modifies or removes them manually.
;; ;;
;; It will generate a unique ID for each headers in an org file based ;; In order to be enabled, this package’s `org-unique-id-maybe'
;; on the headers’ name plus a random short string in order to be sure ;; function must be hooked to `before-save-hook', and the string
;; to make it unique. This ID will be inserted in each header’s ;; \\='unique-id:t\\=' must be present in an \\='#+OPTIONS:\\=' line
;; properties as a custom ID. ;; in the buffer.
;; ;;
;; [1] https://blog.phundrak.com/better-custom-ids-orgmode/ ;; If the \\='unique-id:t\\=' string is found, then it will create a
;; [2] https://writequit.org/articles/emacs-org-mode-generate-ids.html ;; slug of the current header (and if there are, its parent headers)
;; and it will add a unique string suffix generated with a UUID
;; generator to ensure all IDs are unique.
;;
;; Here is an example of an org-mode file without the
;; \\='unique-id:t\\=' option after save:
;;
;; #+title: Test file
;; * Test level 1
;; ** Test level 2
;; * Test level 1
;;
;; And here is the same org-mode file but with the option atop its
;; content:
;;
;; ,#+title: Test file
;; ,#+options: unique-id:t
;; ,* Test level 1
;; :PROPERTIES:
;; :CUSTOM_ID: Test-level-1-zmb40t305kj0
;; :END:
;; ,** Test level 2
;; :PROPERTIES:
;; :CUSTOM_ID: Test-level-1-Test-level-2-spn40t305kj0
;; :END:
;; ,* Test level 1
;; :PROPERTIES:
;; :CUSTOM_ID: Test-level-1-1nx40t305kj0
;; :END:
;;
;; Of course the last part of the custom ID might differ for you, but
;; once it is generated, org-unique-id will not modify it or
;; regenerate it unless you delete it yourself, hence ensuring a
;; constant ID for your org exports.
;;; Code: ;;; Code: