Support via  Liberapay logo Liberapay  GitHub logo GitHub  Paypal logo PayPal

Suggestions to keep your org-files tidy

Table of Contents

This page collects suggestions and practices to keep your org files tidy. Consider this, when need arises or simply when you feel like cleaning up.

Archiving: Moving away nodes, that are no longer used

Filing away content that is no longer needed, is probably the most effective way to cleanup and tidy your org files: Have a look at archiving.

Cleaning up Org-Metadata

Tags and properties are examples for Org data, that is not only read by users is also processed by org itself. Because of that it is also possible for Org to find and remove unused pieces of metadata:

org-id-cleanup: Cleaning up IDs from org-id

You already know org-id which comes as a part of org: It allows to add unique IDs to your Org-nodes, which e.g. are used in links and allow easy navigation within org.

Now, if a user tends to delete those links without deleting the IDs the links refer to, unused IDs (with no link pointing at them) will be left over.

In general this is not a problem for org-id and no intervention is required. However, if the user produces hundreds or thousands of such unreferenced IDs, this might eventually start to slow down org-id, especially its function org-id-update-id-locations.

In such a situation org-id-cleanup may come in handy. It provides an interactive assistant, that will guide you through the process of finding and eventually deleting such unused IDs. You may think of this process as "cleaning up IDs from org-id"; whence the name.

Org-id-cleanup can be tried whithout hesitation: Before each step it gives detailed information, so that you may bail out at will. And as a safety-net a log of removed IDs is written to disk.

org-id-cleanup is available at melpa.

Tidy or repair other elements of org

Documentation from the orgmode.org/worg/ website (either in its HTML format or in its Org format) is licensed under the GNU Free Documentation License version 1.3 or later. The code examples and css stylesheets are licensed under the GNU General Public License v3 or later.