Writing Manual

Introduction

Please note any “TODO” or “TK” – that means text around it is incomplete or inaccurate, such as missing a citation.

This document is a manual of the procedures I use to write. It is intended to serve as a prequel to my publishing manual.

License & Editorial Information

This document and the source code it contains are released under the MIT License and maintained at https://git.sr.ht/~emsenn/writing-manual, where a list of syndications is available.

Table of Contents

Requirements

Emacs

Org-mode

Setup

Installing Emacs and Org-Mode

Constructing a Document Repository

Every piece of writing I make exists in its own repository. There are a few reasons for this. On the technical front, it lets me change how any given document works, and deviate from the “standard” format as much as I want. On the publicity front, it makes it easier to promote just the pieces I want to with an audience, without necessarily exposing them to other pieces before appropriate. On the legal front, it makes it certain their license is their own, pretty safely against any “infective” licenses syndication platforms might have.

Each repository contains, when I make it, two files: the source file that I'll write in, and the README, where I explain some information about the document, useful to potential future authors or the editors.

Source File

The source file is the Org-mode file which represents the document. It's the file that you'll edit as you draft and later edit the piece, and it's what is used to generate renderings for publishing the document online and other places.

Org-mode Declarations

Frontmatter

A Section

* Demo Section
#+BEGIN Introduction
This section is about...
#+END

#+TOC: headlines 1 local

README

The README of a document is primarily aimed at editors, authors, and publishers, not the reading audience. (That's who the License and Editorial Information section of the source file is for.)

README Frontmatter

# "{{doc.title}}"
_A document: an essay, "{{doc.title}}," by emsenn._

Summary

The document's summary should specify what type of document it is, when it was written, and usually, what it was in response to, more than its topic. (Which is usually clear from the title and catalyst/trigger.)

**"{{doc.title}}"** is a {{doc.type}} I wrote on {{doc.date}}...

List of Renderings

After explaining what the document is about in the summary, I list all the renderings (and syndications) of the document. Since this is a fresh piece, there's only one thing to list: the source file.

- [Original Org-mode Version](./{{doc.slug}}.org)

Repository Disclosure

This repository is maintained at
[git.sr.ht/~emsenn/{{doc.slug}}](https://git.sr.ht/~emsenn/{{doc.slug}})
and mirrored on [Gitlab.com](https://gitlab.com/emsenn/{{doc.slug}}).

Author Credits

## Document Authorship
This document was written by [emsenn].

Language Disclosure

## Language
This document is written in English.

Document History

## Document History
This document was first drafted in November 2018 in response to my
experience with a small business a couple months prior.

Contribution Guidelines

## Contributing
I welcome contributions, please send a message to my [public inbox].

Financial Disclosure

## Financing
This document was written voluntarily and has no associated costs.
Donations to this project's maintainer may be made at:

- https://ko-fi.com/emsenn/
- https://en.liberapay.com/emsenn/

For more ways to contribute financially, see
[emsenn.net/contribute](https://emsenn.net/contribute).

License

## License
This document, as software, is released under the MIT License:

    Copyright 2019 emsenn

    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.

Credits

## Credits
- This document was written by [emsenn].
[emsenn]: https://emsenn.net
[public inbox]: https://lists.sr.ht/~emsenn/public-inbox

Drafting

Editing