From e10d1beb653dc875f97a04a9c23f1f65f9c8ecd9 Mon Sep 17 00:00:00 2001 From: Case Duckworth Date: Mon, 20 Apr 2015 23:58:50 -0700 Subject: Merge colophon and process into colophon --- front-matter/colophon.txt | 64 +++++++++++++++++++++++++------------------ front-matter/process.txt | 70 ----------------------------------------------- 2 files changed, 37 insertions(+), 97 deletions(-) delete mode 100644 front-matter/process.txt (limited to 'front-matter') 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: class: front-matter ... -This website is authored in [Vim][] -using an extended version of John Gruber's [Markdown][] syntax. -It's compiled into HTML and other formats -with John McFarlane's [pandoc][] document-conversion tool. -The site is hosted on [Github][] at . +_Autocento of the breakfast table_ is a hypertextual exploration +of the clockwork of inspiration, revision, and obsession. +It represents a compilation of most of my writing, +linked together along thematic lines into a sort of whole. +It lives on the web. +Instead of hand-coding all of the HTML files you're reading now, +I've relied on a process that leverages open-source technologies +to publish my work onto a web platform. -The content of this site has been compiled -from a multitude of other projects, including -_[Elegies for alternate selves][elegies]_, -_[The book of Hezekiah][hez]_, -_[Stark raving][stark]_ (later called _Everything changes_), -and _[Buildings out of air][paul]_, -as well as new poems written 2014--2015. +The [source files][] are authored in [Vim][] +using an [extended version][] of [Markdown][]. +It's compiled into the HTML you're reading, +as well as a few other formats, +with [Pandoc][], a document-conversion tool. +The site is hosted on [Github][] and [Namecheap][]. +You can view the repository at . -The [appendices][], as well as the HTML itself -and backlink functionality, -are compiled with [this makefile][makefile]. -The Javascript that randomizes the ξ link at the bottom of each page -is located [here][randomizer]. +I use a [Makefile][] to compile the text source files +into HTML, and to generate a series of [appendices][] +and [other site][] [functionality][] +with the help of a [compilation shell script][]. -Any questions or accolades can be directed to my [email][]. +I use this system because it's fairly simple, extensible, and open. +It's available for anyone to examine, learn from, and use. +See the [license][] for more details. +[Email me][] with questions or accolades, +or submit a [pull request][] or [issue][] on Github. + +[source files]: https://github.com/duckwork/autocento/tree/gh-pages/text [Vim]: http://www.vim.org +[extended version]: http://johnmcfarlane.net/pandoc/README.html#pandocs-markdown [Markdown]: http://daringfireball.net/projects/markdown/ -[pandoc]: http://johnmcfarlane.net/pandoc/ +[Pandoc]: http://johnmcfarlane.net/pandoc/ [Github]: https://github.com -[elegies]: elegyforanalternateself.html -[hez]: prelude.html -[stark]: table_contents.html -[paul]: art.html +[Namecheap]: http://namecheap.com +[Makefile]: https://github.com/duckwork/autocento/blob/gh-pages/makefile [appendices]: hapax.html -[makefile]: https://github.com/duckwork/autocento/blob/gh-pages/makefile -[randomizer]: https://github.com/duckwork/autocento/blob/gh-pages/scripts/randomize.js - -[email]: mailto:case.duckworth+autocento@gmail.com +[other site]: https://github.com/duckwork/autocento/blob/gh-pages/scripts/randomize.js +[functionality]: backlinks/in-bed.html +[compilation shell script]: https://github.com/duckwork/autocento/blob/gh-pages/scripts/compile.sh +[license]: license.html +[Email me]: mailto:case.duckworth+autocento@gmail.com +[pull request]: https://github.com/duckwork/autocento/pulls +[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 @@ ---- -title: Autocento of the breakfast table -subtitle: process narrative -genre: prose - -id: process -toc: "Process narrative" - -project: - title: Front matter - class: front-matter -... - -## Hi. My name is Case Duckworth. This is my thesis. - -_Autocento of the breakfast table_ is an inter/hypertextual exploration of the workings of inspiration, revision, and obsession. -I've compiled this work over multiple years, and recently linked it all together to form a (hopefully) more cohesive whole. -To 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. - -## Process steps - -1. Write poems. -2. Convert to Markdown. - - 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. - - 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. - - 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. -3. Compile to HTML with Pandoc. - - At first, I used this code in the shell to generate my HTML: - ```bash - for file in *.txt; do - pandoc "$file" -f markdown -t html5 \ - --template=template.html -o "${file%txt}html" - done - ``` - but this proved tedious with time. - - After a lot of experimenting with different scripting languages, I finally realized that [`GNU make`][] would fit this task perfectly. - - 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. -4. Style the pages with CSS. - - I use a pretty basic style for _Autocento_. You can see my stylesheet [here][stylesheet]. -4. Use [Github][] to put them online. - - Github uses `git` under the hood---a Version Control System developed for keeping track of large code projects. - - My workflow with `git` looks like this: - - Change files in the project directory---revise a poem, change the makefile, add a style, etc. - - (If necessary, re-compile with `make`.) - - `git status` tells me which files have changed, which have been added, and if any have been deleted. - - `git add -A` adds all the changes to the _staging area_, or I can add individual files, depending on what I want to commit. - - `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. - - `git push` pushes the changes to the _remote repository_---in this case, the Github repo that serves . - - Lather, rinse, repeat. -5. Write Makefile to extend build capabilities. - - 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. - - I'd like to build a compiler for the [Index of first lines][] and [Index of common titles][] once I have time. - -## The beauty of this system - -- I can compile these poems into (almost) any format: `pandoc` supports a lot. -- Once I complete the above process once, I can focus on revising my poems. -- These poems are online for anyone to see and use for their own work. - -[John Gruber]: http://daringfireball.net/projects/markdown/ -[extended Markdown syntax]: http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown -[`GNU make`]: https://www.gnu.org/software/make/manual/make.html -[makefile]: https://github.com/duckwork/autocento/blob/gh-pages/makefile -[stylesheet]: https://github.com/duckwork/autocento/blob/gh-pages/style.css -[Github]: https://github.com -[Hapax legomenon]: hapax.html -[back-link]: makefile -[random link functionality]: trunk/lozenge.js -[Index of first lines]: first-lines.html -[Index of common titles]: common-titles.html -- cgit 1.4.1-21-gabe81