about summary refs log tree commit diff stats
path: root/front-matter
diff options
context:
space:
mode:
Diffstat (limited to 'front-matter')
-rw-r--r--front-matter/colophon.txt64
-rw-r--r--front-matter/process.txt70
2 files changed, 37 insertions, 97 deletions
diff --git a/front-matter/colophon.txt b/front-matter/colophon.txt index 2293898..e19192e 100644 --- a/front-matter/colophon.txt +++ b/front-matter/colophon.txt
@@ -8,38 +8,48 @@ project:
8 class: front-matter 8 class: front-matter
9... 9...
10 10
11This website is authored in [Vim][] 11_Autocento of the breakfast table_ is a hypertextual exploration
12using an extended version of John Gruber's [Markdown][] syntax. 12of the clockwork of inspiration, revision, and obsession.
13It's compiled into HTML and other formats 13It represents a compilation of most of my writing,
14with John McFarlane's [pandoc][] document-conversion tool. 14linked together along thematic lines into a sort of whole.
15The site is hosted on [Github][] at <http://github.com/duckwork/autocento>. 15It lives on the web.
16Instead of hand-coding all of the HTML files you're reading now,
17I've relied on a process that leverages open-source technologies
18to publish my work onto a web platform.
16 19
17The content of this site has been compiled 20The [source files][] are authored in [Vim][]
18from a multitude of other projects, including 21using an [extended version][] of [Markdown][].
19_[Elegies for alternate selves][elegies]_, 22It's compiled into the HTML you're reading,
20_[The book of Hezekiah][hez]_, 23as well as a few other formats,
21_[Stark raving][stark]_ (later called _Everything changes_), 24with [Pandoc][], a document-conversion tool.
22and _[Buildings out of air][paul]_, 25The site is hosted on [Github][] and [Namecheap][].
23as well as new poems written 2014--2015. 26You can view the repository at <http://github.com/duckwork/autocento>.
24 27
25The [appendices][], as well as the HTML itself 28I use a [Makefile][] to compile the text source files
26and backlink functionality, 29into HTML, and to generate a series of [appendices][]
27are compiled with [this makefile][makefile]. 30and [other site][] [functionality][]
28The Javascript that randomizes the &xi; link at the bottom of each page 31with the help of a [compilation shell script][].
29is located [here][randomizer].
30 32
31Any questions or accolades can be directed to my [email][]. 33I use this system because it's fairly simple, extensible, and open.
34It's available for anyone to examine, learn from, and use.
35See the [license][] for more details.
32 36
37[Email me][] with questions or accolades,
38or submit a [pull request][] or [issue][] on Github.
39
40[source files]: https://github.com/duckwork/autocento/tree/gh-pages/text
33[Vim]: http://www.vim.org 41[Vim]: http://www.vim.org
42[extended version]: http://johnmcfarlane.net/pandoc/README.html#pandocs-markdown
34[Markdown]: http://daringfireball.net/projects/markdown/ 43[Markdown]: http://daringfireball.net/projects/markdown/
35[pandoc]: http://johnmcfarlane.net/pandoc/ 44[Pandoc]: http://johnmcfarlane.net/pandoc/
36[Github]: https://github.com 45[Github]: https://github.com
37[elegies]: elegyforanalternateself.html 46[Namecheap]: http://namecheap.com
38[hez]: prelude.html 47[Makefile]: https://github.com/duckwork/autocento/blob/gh-pages/makefile
39[stark]: table_contents.html
40[paul]: art.html
41[appendices]: hapax.html 48[appendices]: hapax.html
42[makefile]: https://github.com/duckwork/autocento/blob/gh-pages/makefile 49[other site]: https://github.com/duckwork/autocento/blob/gh-pages/scripts/randomize.js
43[randomizer]: https://github.com/duckwork/autocento/blob/gh-pages/scripts/randomize.js 50[functionality]: backlinks/in-bed.html
44 51[compilation shell script]: https://github.com/duckwork/autocento/blob/gh-pages/scripts/compile.sh
45[email]: mailto:case.duckworth+autocento@gmail.com 52[license]: license.html
53[Email me]: mailto:case.duckworth+autocento@gmail.com
54[pull request]: https://github.com/duckwork/autocento/pulls
55[issue]: https://github.com/duckwork/autocento/issues
diff --git a/front-matter/process.txt b/front-matter/process.txt deleted file mode 100644 index 955f0f3..0000000 --- a/front-matter/process.txt +++ /dev/null
@@ -1,70 +0,0 @@
1---
2title: Autocento of the breakfast table
3subtitle: process narrative
4genre: prose
5
6id: process
7toc: "Process narrative"
8
9project:
10 title: Front matter
11 class: front-matter
12...
13
14## Hi. My name is Case Duckworth. This is my thesis.
15
16_Autocento of the breakfast table_ is an inter/hypertextual exploration of the workings of inspiration, revision, and obsession.
17I've compiled this work over multiple years, and recently linked it all together to form a (hopefully) more cohesive whole.
18To make this easier than collating everything by hand, I've relied on a process that leverages open-source technologies to publish my work onto a web platform.
19
20## Process steps
21
221. Write poems.
232. Convert to Markdown.
24 - Markdown, originally by [John Gruber][], is a lightweight markup language that allows me to focus on the _content_ of my writing, knowing that I can work on the _presentation_ later.
25 - The original `markdown.pl` program is buggy and inconsistent with how it applies styles to markup. It also only works to convert text to HTML.
26 - Because of these limitations, I've used John MacFarlane's [extended Markdown syntax][], which lets me write richer documents and programmatically compile my work into multiple formats.
273. Compile to HTML with Pandoc.
28 - At first, I used this code in the shell to generate my HTML:
29 ```bash
30 for file in *.txt; do
31 pandoc "$file" -f markdown -t html5 \
32 --template=template.html -o "${file%txt}html"
33 done
34 ```
35 but this proved tedious with time.
36 - After a lot of experimenting with different scripting languages, I finally realized that [`GNU make`][] would fit this task perfectly.
37 - You can see my makefile [here][makefile]---it's kind of a mess, but it does the job. See below for a more detailed explanation of the makefile.
384. Style the pages with CSS.
39 - I use a pretty basic style for _Autocento_. You can see my stylesheet [here][stylesheet].
404. Use [Github][] to put them online.
41 - Github uses `git` under the hood---a Version Control System developed for keeping track of large code projects.
42 - My workflow with `git` looks like this:
43 - Change files in the project directory---revise a poem, change the makefile, add a style, etc.
44 - (If necessary, re-compile with `make`.)
45 - `git status` tells me which files have changed, which have been added, and if any have been deleted.
46 - `git add -A` adds all the changes to the _staging area_, or I can add individual files, depending on what I want to commit.
47 - `git commit -m "[message]"` commits the changes to git. This means they're "saved"---if I do something I want to revert, I can `git revert` back to a commit and start again.
48 - `git push` pushes the changes to the _remote repository_---in this case, the Github repo that serves <http://autocento.me>.
49 - Lather, rinse, repeat.
505. Write Makefile to extend build capabilities.
51 - As of now, I've completed a _[Hapax legomenon][]_ compiler, a [back-link][] compiler, and an updater for the [random link functionality][] that's on this site.
52 - I'd like to build a compiler for the [Index of first lines][] and [Index of common titles][] once I have time.
53
54## The beauty of this system
55
56- I can compile these poems into (almost) any format: `pandoc` supports a lot.
57- Once I complete the above process once, I can focus on revising my poems.
58- These poems are online for anyone to see and use for their own work.
59
60[John Gruber]: http://daringfireball.net/projects/markdown/
61[extended Markdown syntax]: http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown
62[`GNU make`]: https://www.gnu.org/software/make/manual/make.html
63[makefile]: https://github.com/duckwork/autocento/blob/gh-pages/makefile
64[stylesheet]: https://github.com/duckwork/autocento/blob/gh-pages/style.css
65[Github]: https://github.com
66[Hapax legomenon]: hapax.html
67[back-link]: makefile
68[random link functionality]: trunk/lozenge.js
69[Index of first lines]: first-lines.html
70[Index of common titles]: common-titles.html