emsenn's INCL File

Introduction

In this document I provide a collection of texts I use to avoid repeating myself when writing. To avoid recursion, it lacks much of the normal styling and information my other documents have, because that styling and information come from this document.

emsenn's INCL File

What's an INCL File

My INCL file (said "inkle," like twinkle,) is a collection of texts to be included in my Org-mode source files, so they'll be rendered during export or publishing. This helps keep me from repeating myself.

Example: I'm writing a new CSS theme as a literately-programmed essay explaining the design philosophy. In its introduction, I want to let people know it's a draft, that I'll assume they know how to read CSS, and briefly explain literate programming. The slowest solution would be to re-write that information each time I needed it. I could speed that up by copying the text into the document from a template.

Both methods have a problem beside speed: if I change how I want to explain literate programming, I would have to change the explanation in every document. Maybe that'd be as simple as doing a find-and-replace across multiple files, but that'd still take time.

WARNING: This document, beyond this "Introduction" section, is meant as a resource, not a coherent piece of writing. Links will be broken, paragraphs won't make sense against each other, and so on.

Resources

This section contains the action resources to be included in other files. Each section contains brief explanation of the resource's use, followed by a horizontal rule, under which is the resouce.

(Why do I have each resource inside a #+BEGIN tag to give it a name? because then i don't need to add :contents-only t to every include.)

Frontmatter

Editorial and License Information

Default Editorial and License Information

This document was written by emsenn and is released as software under the terms included in the [BROKEN LINK: license] supplement. Please direct comments to their public inbox or, if necessary, email.

Status Disclosures

Draft Disclosure

This document is a draft: it is incomplete in one or more ways.

Abandonware Disclosure

This document represents something that is abandoned: no longer being maintained. If you would like to take ownership of the project, please send emsenn an email.

Living Document Disclosure

This document is a living document: it is subject to continued change and amendment.

Context Disclosures

Correspondence Context Disclosure

This document was written as a piece of correspondence to a certain person or community, and should be read in that light.

Personal Reference Context Disclosure

This document was written primarily as a personal reference for the author. It may assume an uncommon familiarity with the topics and context being discussed. If you are trying to use this document and find a part unhelpful, please submit an email to the author's [BROKEN LINK: {{{public-inbox}}}] or [BROKEN LINK: {{{email}}}] if necessary.

Financial Disclosures

Personal, Marketing Financial Disclosure

This document was written to persuade people to purchase something from emsenn. It certainly contains a bias as a result of that, which readers should maintain an awareness of.

Personal, Voluntary Financial Disclosure

Implementation Disclosures

Literate Programming Disclosure

This document is implemented using the literate programming paradigm. The "software" being presented is included as sections of code, within a longer piece of prose which explains the code's purpose and usage. For a more complete explanation of my implementation of the paradigm, see "Literate Programming" in my Style Manual.

Supplements

Licenses

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.