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 the default header for new Org files in Worg.  Feel free
  14 # to tailor it to your needs.
  15
  16 This page collects suggestions and practices to keep your org files
  17 tidy.  Consider this, when need arises or simply when you feel like
  18 cleaning up.
  19
  20 * Archiving: Moving away nodes, that are no longer used
  21
  22 Filing away content that is no longer needed, is probably the most
  23 effective way to cleanup and tidy your org files: Have a look at
  24 [[file:org-hacks.org::#archiving][archiving]].
  25
  26 * Cleaning up Org-Metadata
  27
  28 Tags and properties are examples for Org data, that is not only read
  29 by users is also processed by org itself. Because of that it is also
  30 possible for Org to find and remove unused pieces of metadata:
  31
  32 - [[file:org-hacks.org::#remove-redundant-tags][Remove redundant tags]]
  33 - [[file:org-hacks.org::#remove-empty-property-drawers][Remove empty property drawers]]
  34 - [[file:org-hacks.org::#check-for-misplaced-timestamps][Make sure, that timestamps for scheduled and deadline are placed correctly]]
  35 - [[file:org-tidy.org::#clean-up-ids][Clean up IDs from org-id]]
  36
  37 ** org-id-cleanup: Cleaning up IDs from org-id
  38   :PROPERTIES:
  39   :CUSTOM_ID: clean-up-ids
  40   :END:
  41 #+index: id!clean
  42 You already know org-id which comes as a part of org: It allows to
  43 add unique IDs to your Org-nodes, which e.g. are used in
  44 links and allow easy navigation within org.
  45
  46 Now, if a user tends to delete those links without deleting the IDs
  47 the links refer to, unused IDs (with no link pointing at them) will be
  48 left over.
  49
  50 In general this is not a problem for org-id and no intervention is
  51 required. However, if the user produces hundreds or thousands of such
  52 unreferenced IDs, this might eventually start to slow down org-id,
  53 especially its function org-id-update-id-locations.
  54
  55 In such a situation [[https://github.com/marcIhm/org-id-cleanup][org-id-cleanup]] may come in handy. It provides an
  56 interactive assistant, that will guide you through the process of
  57 finding and eventually deleting such unused IDs. You may think of this
  58 process as "cleaning up IDs from org-id"; whence the name.
  59
  60 Org-id-cleanup can be tried whithout hesitation: Before each step it
  61 gives detailed information, so that you may bail out at will. And as a
  62 safety-net a log of removed IDs is written to disk.
  63
  64 org-id-cleanup is available at [[https://melpa.org/#/org-id-cleanup][melpa]].
  65 * Tidy or repair other elements of org
  66
  67 - [[file:org-hacks.org::#align-tables-in-file][Make sure, that all tables in a file are formatted correctly]]
  68 - [[https://github.com/alphapapa/unpackaged.el#ensure-blank-lines-between-headings-and-before-contents][Ensure blank lines between headings and before contents]]
  69 - [[file:org-tools/index.org::#fix-links][This might help to repair broken links]]
  70