HELP is the culmination of everything that I’ve learned about literate programming (LP) in Org-Mode—written with the intent to share it with others in total and complete respect and consideration of you and the value of your time. No platitude here: time is precious.
With that in mind here is a breakdown of the sections you might be interested in (and should ignore):
Here are the files that compose HELP in order of load dependency, the next one always load the previous one. The first two configuration files are the most reusable “out of box” parts of HELP:
- Org-Mode Exemple Complet Minimal → .org-mode-ecm.emacs.el
- Proper etiquette before posting questions to the mailing list is to start Org with nothing else loaded to debug your issue—this is that configuration. It helps you create the Org ECM: Exemple Complet Minimal
- Helper function to dump all of the information you need to include in the ECM
- By necessity all of the essential Emacs configuration, though not much, is in there too and definitely worth taking a look at
- Org-Mode Fundamentals → .org-mode-fundamentals.emacs.el
- Org-Mode configuration great for the style of LP described by the table here
- Individual headlines are good for reference and copy and paste too
- Package-Management.org → .org-mode-package-management.emacs.el
- Package management configuration stuff
- Safe to ignore
- Contribute.org → .org-mode-contribute.emacs.el
- Loads packages that for some reason I make changes
- Safe to ignore
- help.org → .emacs.el
- The section to skim and find parts to copy and paste
- All of my very personal preferences.
- Intent driven headlines that are personal favorites and maybe useful to you
- LP Style Guide
- Writing style guard-rails
- History
- Most of the time you see initialization files that are the result of years of continuous refinement and improvement—you never see the complete messes! The fun story about my config include the mistakes, confusion, and completely dropping Emacs! It is really fond memories for me, too.
- Typography
- How to really configure
fill-column
(for those who cannot remember)
- How to really configure
- Refiling
- Strategy for moving headlines between files
- Common Configurations
- Use mode inheritance to simplify configuration
- Literate Programming
- Every custom configuration of every mode
- LP Style Guide
- The section to skim and find parts to copy and paste