![]() A human-readable version of the code, nicely typeset with all the explanations and code, through a process called weaving.Ultimately, you can produce one of two outputs from the same file: The code gets interweaved with the code as you explain it. The general idea is that you write code as you would write a story or an article, describing what you want to do and how to solve it. Literate programming was first proposed by Donald Knuth in 1984 ( Literate Programming, The Computer Journal, 27 (2): 97–111) as a technique of producing computer code from prose. Whether you already use Emacs and Org or not, I hope you will find value in this book by seeing how uniquely Literate Programming can help you better write, maintain, understand and share your config files. Org mode has emerged in the last few years as a powerful and simple markup language for general writing, but with unique features that make it easy to include code within the text, and even further, to easily extract that code into stand-alone source files which can be interpreted by their corresponding programs.Applying Literate Programming to config files makes them much easier to share, since their explanation is naturally woven into the code Configuration files are often shared and read by others, as we all like to learn by reading the config files of other people.Most configuration files are self-contained but their structure and syntax may not be immediately evident, so they benefit from a human-readable explanation of their contents.This makes it easier to draw a narrative for them Configuration files are inherently focused, since they correspond to a single application, program or set of programs, all related.However, I have found that it can be especially applicable to configuration files, for several reasons: Literate Programming is a beautiful concept, but it is ambitious and hard to apply in general software development. If you are already familiar with Literate Programming you might find most of the basic concepts familiar. Welcome! In this booklet I will introduce you to Literate Configuration, which is the application of Literate Programming to configuration files. Directory and command navigation and history. ![]() URL dispatching to site-specific browsers.BetterTouchTool integration (experimental).Using noweb references to structure your code.Configuring Emacs and Org for literate programming.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |