org-tidy.org

   1 #+TITLE:      Suggestions to keep your org-files tidy
   2 #+AUTHOR:     Worg people
   3 #+OPTIONS:    H:3 num:nil toc:t \n:nil ::t |:t ^:t -:t f:t *:t tex:t d:(HIDE) tags:not-in-toc
   4 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
   5 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
   6 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
   7 #+LANGUAGE:   en
   8 #+PRIORITIES: A C B
   9 #+CATEGORY:   worg
  10 #+HTML_LINK_UP:    index.html
  11 #+HTML_LINK_HOME:  https://orgmode.org/worg/
  12
  13 # This file is released by its authors and contributors under the GNU
  14 # Free Documentation license v1.3 or later, code examples are released
  15 # under the GNU General Public License v3 or later.
  16
  17 # This file is the default header for new Org files in Worg.  Feel free
  18 # to tailor it to your needs.
  19
  20 This page collects suggestions and practices to keep your org files
  21 tidy.  Consider this, when need arises or simply when you feel like
  22 cleaning up.
  23
  24 * Archiving: Moving away nodes, that are no longer used
  25
  26 Filing away content that is no longer needed, is probably the most
  27 effective way to cleanup and tidy your org files: Have a look at
  28 [[file:org-hacks.org::#archiving][archiving]].
  29
  30 * Cleaning up Org-Metadata
  31
  32 Tags and properties are examples for Org data, that is not only read
  33 by users is also processed by org itself. Because of that it is also
  34 possible for Org to find and remove unused pieces of metadata:
  35
  36 - [[file:org-hacks.org::#remove-redundant-tags][Remove redundant tags]]
  37 - [[file:org-hacks.org::#remove-empty-property-drawers][Remove empty property drawers]]
  38 - [[file:org-hacks.org::#check-for-misplaced-timestamps][Make sure, that timestamps for scheduled and deadline are placed correctly]]
  39 - [[file:org-tidy.org::#clean-up-ids][Clean up IDs from org-id]]
  40
  41 ** org-id-cleanup: Cleaning up IDs from org-id
  42   :PROPERTIES:
  43   :CUSTOM_ID: clean-up-ids
  44   :END:
  45 #+index: id!clean
  46 You already know org-id which comes as a part of org: It allows to
  47 add unique IDs to your Org-nodes, which e.g. are used in
  48 links and allow easy navigation within org.
  49
  50 Now, if a user tends to delete those links without deleting the IDs
  51 the links refer to, unused IDs (with no link pointing at them) will be
  52 left over.
  53
  54 In general this is not a problem for org-id and no intervention is
  55 required. However, if the user produces hundreds or thousands of such
  56 unreferenced IDs, this might eventually start to slow down org-id,
  57 especially its function org-id-update-id-locations.
  58
  59 In such a situation [[https://github.com/marcIhm/org-id-cleanup][org-id-cleanup]] may come in handy. It provides an
  60 interactive assistant, that will guide you through the process of
  61 finding and eventually deleting such unused IDs. You may think of this
  62 process as "cleaning up IDs from org-id"; whence the name.
  63
  64 Org-id-cleanup can be tried whithout hesitation: Before each step it
  65 gives detailed information, so that you may bail out at will. And as a
  66 safety-net a log of removed IDs is written to disk.
  67
  68 org-id-cleanup is available at [[https://melpa.org/#/org-id-cleanup][melpa]].
  69 * Tidy or repair other elements of org
  70
  71 - [[file:org-hacks.org::#align-tables-in-file][Make sure, that all tables in a file are formatted correctly]]
  72 - [[https://github.com/alphapapa/unpackaged.el#ensure-blank-lines-between-headings-and-before-contents][Ensure blank lines between headings and before contents]]
  73 - [[file:org-tools/index.org::#fix-links][This might help to repair broken links]]
  74