Writing Manual
Introduction
This manual is a draft: it is considered incomplete and there are plans to add or change information contained in it.
This document is a technical explanation of the mechanical procedures I use to accomplish the task of writing: arranging words to communicate a specific meaning. It is, in some ways, a prequel to my Publishing Manual, and a companion to my Style Manual.
This manual was written by me, emsenn, and is released for the benefit of the public under the terms included in the "License" supplement. It was made possible with financial contributions from humans like you. Please direct comments to my public inbox or, if necessary, my personal email.
Writing Manual
Requirements
List of Software
Emacs
Org-mode
Flyspell
Whatever that thing is I was using to check for vague words and stuff.
Anatomy of a Document
Operations
Document Creation
Create a Basic Document
Create a Larder Inventory
This procedure explains how to create a larder inventory: a record of the foods and other supplies in my kitchen.
Document Maintenance
Maintain a Larder Inventory
Introduction
This procedure explains how to maintain an larder inventory: a record of the foods and other supplies in my kitchen.. It assumes you have created a larder inventory: see "Create a Larder Inventory".
Resources
Boilerplate
Boilerplate are pieces of text inserted into other documents.
I save my boilerplate in a file named plates.inc
that lives at the project's root. To use a piece of boilerplate
, I add the line #+INCLUDE: "./plates.inc::boilerplate"
, where boilerplate
the name of the plate, which follows #+BEGIN:
Abandonware
#+BEGIN: abandonware 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. #+END
Acknowledgements
#+BEGIN: acknowledgements This {{{document-type}}} was directly inspired or supported by the work of others. Please see the "Acknowledgements" section. #+END:
Assumes Knowledge
#+BEGIN: assumes-knowledge This {{{document-type}}} assumes the reader is knows {{{assumed-knowledge}}}. #+END
Contemporary
#+BEGIN: contemporary This {{{document-type}}} was written when the events it discusses were contemporary. Information in it may now be incorrect, and opinions presented may be out of date. #+END
Correspondence
#+BEGIN: correspondence This document was written as a piece of correspondence to a certain person or community, and should be read in that light. #+END
Credits
#+BEGIN: credits This {{{document-type}}} was the work of more than one person; please see the "Credits" supplement. #+END
Editorial and License Information
#+BEGIN: default-eli This {{{document-type}}} was written by me, emsenn, and is released for the benefit of the public under the terms included in the "License" supplement. It was made possible with financial contributions from humans like you. Please direct comments to my public inbox or, if necessary, my personal email. #+END
Difficult Subject
#+BEGIN: difficult-subject This {{{document-type}}} tackles a subject which is */difficult/*: the language used to approach may have flaws, and may not accurately convey my intentions. It is suggested you assume I wrote the piece honestly and with sincere intentions. #+END
Draft
#+BEGIN: draft This {{{document-type}}} is a /draft/: it is considered incomplete and there are plans to add or change information contained in it. #+END
Literate Programming
#+BEGIN: literate-programming This {{{document-type}}} 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/. #+END
Living Document
#+BEGIN: living-document This {{{document-type}}} is a */living/* /document/: it is subject to continued change and amendment. #+END
MIT License
#+BEGIN: mit-license Copyright {{{time(%Y)}}} {{{author}}} Permission is hereby granted, free of charge, to any person obtaining a copy of this document and associated media files (the "Document"), to deal in the Doftware without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Doftware, and to permit persons to whom the Doftware 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. #+HTML: <strong> The Document 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, or 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 Document or the use or other dealings in the Document. #+HTML: </strong> #+END
Personal Contribute
#+BEGIN: personal-contribute This document was made possible with contributions from humans like you. Thank you! I currently accept contributions through the following platforms: - One-time through... - Paypal - Ko-fi - Recurring through... - Liberapay If there is another service through which you'd like to contribute, please send an email. */Please note/* that in accordance with my personal directives #003 and #018, I release all useful information I create for free, so financial contributions do not entitle you to access to any "exclusive content." #+END
Personal Marketing
#+BEGIN: personal-marketing This {{{document-type}}} was written to persuade people to purchase something from {{{author}}}. It certainly contains a bias as a result of that, which readers should maintain an awareness of. #+END
Personal Reference
#+BEGIN: personal-reference 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 {{{public-inbox}}}. #+END
Use Org
#+BEGIN: use-org #+END
Voluntary
#+BEGIN: voluntary This document was written voluntary for the benefit of the public. It was made possible with contributions from humans like you. Thank you. #+END
Setup Files
Supplements
Contribute
This document was made possible with contributions from humans like you. Thank you! I currently accept contributions through the following platforms:
If there is another service through which you'd like to contribute, please send an email. Please note that in accordance with my personal directives #003 and #018, I release all useful information I create for free, so financial contributions do not entitle you to access to any "exclusive content."
License
Copyright 2019 emsenn
Permission is hereby granted, free of charge, to any person obtaining a copy of this document and associated media files (the "Document"), to deal in the Doftware without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Doftware, and to permit persons to whom the Doftware 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 Document 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, or 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 Document or the use or other dealings in the Document.