phundrak/org-unique-id
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
5 Commits 1 Branch 4 Tags 78 KiB
Emacs Lisp 82.9%
Makefile 17.1%
975311184a
Go to file
Lucien Cartier-Tilet 975311184a
Add org-unique-id-maybe as a wrapper to org-unique-id 
This new function allows for a cleaner hook addition. It also moves
the check for the presence of the auto-id option to this function.
This allows the user to call org-unique-id on any org buffer,
regardless of the presence of auto-id and its value.
2022-08-24 02:48:58 +02:00
CONTRIBUTING.org Change some function names, add README, LICENSE and CONTRIBUTING 2021-06-15 18:32:21 +02:00
LICENSE.md Change some function names, add README, LICENSE and CONTRIBUTING 2021-06-15 18:32:21 +02:00
org-unique-id.el Add org-unique-id-maybe as a wrapper to org-unique-id 2022-08-24 02:48:58 +02:00
README.org Change some function names, add README, LICENSE and CONTRIBUTING 2021-06-15 18:32:21 +02:00

README.org

org-unique-id

Introduction

org-unique-id is a utility package for org users that are tired dealing with random org IDs for their headers that change on each org to HTML export (and other kinds of exports). This package creates meaningful custom IDs for org headers that won’t change unless the user modifies them manually.

Table of Contents   TOC_2_gh

Installation

This package can be installed like any other simple package. Your first option is to download org-unique-id or clone this package in your load-path and add the following to your configuration:

  (require 'org-unique-id)
  (add-hook 'org-mode-hook
            (lambda ()
              (add-hook 'before-save-hook
                        (lambda ()
                          (when (and (eq major-mode       'org-mode)
                                     (eq buffer-read-only nil))
                            (org-unique-id))))))

You can also use a package manager such as Quelpa or Straight in order to load automatically your package. In my case, I prefer the latter with its use-package integration:

  (use-package org-unique-id
    :require t
    :after org
    :straight (org-unique-id :type git
                             :host github
                             :repo "Phundrak/org-unique-id")
    :init
    (add-hook 'org-mode-hook
       (lambda ()
         (add-hook 'before-save-hook
                   (lambda ()
                     (when (and (eq major-mode       'org-mode)
                                (eq buffer-read-only nil))
                       (org-unique-id)))))))

I also add :build t to my straight recipe to ensure my package is compiled.

If you know how to handle this with a pure Straight recipe, or with a Quelpa recipe, don’t hesitate to submit a PR to add it to this README!

Also, DAMN that’s one hell of a hook, if you know anything simpler than this, please submit it!

Contributing

See /phundrak/org-unique-id/src/commit/975311184af24c7276c3b30e7381f182baad8c39/CONTRIBUTING.org.

License

org-unique-id is available under the GNU GPL-3.0 license. You can find the full text in LICENSE.md.