||1 month ago|
|README.org||2 months ago|
|auto-id.el||1 month ago|
|tests.el||2 months ago|
- How-to guides
auto-id is a package to generate
CUSTOM_ID properties for Org buffers.
auto-id provides a great degree of control over
CUSTOM_ID generation -
auto-id-ignore-existingis used to prevent existing CUSTOM_IDs from being modified.
auto-id-transformersis used to control the generation of custom IDs. The default value aims to work for most situations. For everything else, the seven included transformer functions can be reused as desired.
auto-id-words-to-removecan be used to remove specific words from a custom ID.
- In case of duplication,
auto-id-uniquify-functionsare used to determine how to make each custom ID unique.
If necessary, any of these may be made file- or directory-local.
- CUSTOM_IDs based on headline lineage
- control over number of words
- omit or de-parenthesize text in parenthesis
Contributions and contact
I'd like for all software to be liberated - transparent, trustable, and accessible for anyone to use, study, or improve.
I'd like anyone using my software to credit me for the work.
I'd like to receive financial support for my efforts, so I can spend all my time doing what I find meaningful.
But I don't want to make demands or threats (e.g. via legal conditions) to accomplish all that, nor restrict my services to only those who can pay.
How to generate CUSTOM_IDs
To generate CUSTOM_IDs for a single Org mode buffer -
- Switch to the buffer
M-x auto-id-this-buffer RET
For all Org files
If you want automatic CUSTOM_ID generation in all Org files, add
(add-hook 'org-mode-hook #'auto-id-mode)
The CUSTOM_IDs will be generated when you next save the buffers.
In specific Org files
However, you are more likely to want automatic CUSTOM_ID generation in specific files. In that case -
Visit the file, then add a file local variable to enable
auto-id-modein it -
M-x add-file-local-variable RET eval RET (auto-id-mode) RET
- Save and revert the buffer
In Org files in a specific directory
Or, if you want automatic CUSTOM_ID generation for all Org files in a directory -
Add a directory-local variable -
M-x add-dir-local-variable RET org-mode RET eval RET (auto-id-mode) RET
- Save the
- Revert the desired Org buffers