Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.49 KB

Example.md

File metadata and controls

55 lines (35 loc) · 2.49 KB
Raw

An example workflow

You may have your own workflow, but let me suggest one potential way to make a Bookworm portable so that you can easily redeploy it across servers or upgrade it to new versions; saving all the creation scripts in a git repository that you also initialize as a bookworm directory.

I'll use as an example the Federalist papers bookworm, which adopts this format.

1. Create a git repository for the project

I like to name repositories after the collection with a hypen to Bookworm at the end: so this one is called federalist-bookworm. (Bookworm plugins, on the other hand, have bookworm first and then the functionality, if you're browsing my git repos.

The goal of this repository is that you can clone it to any computer and quickly rebuild the bookworm.

2. Make a makefile for the project.

That Makefile should have a few base targets.

Those are:

  • .bookworm -- the hidden directory containing bookworm-specific files. Always created with bookworm init.
  • The three files required for the bookworm:
    • input.txt
    • jsoncatalog.txt
    • field_descriptions.json
  • A target like bookwormcompleted that causes the bookworm to actually be run.

The main script that actually makes the inputs from the data we have on hand (here stored in the file "federalist.papers.XML" which has both data and metadata) is parseXML.py. The real work will go into making that script work right.

input.txt:
	python parseXML.py

#this one is redundant, but just for clarity:
jsoncatalog.txt: webpages
	python parseXML.py

The hardest of the three to script automatically is field_descriptions.json; probably you should just write that manually, but you can get a template to work from by running bookworm prep guessAtFieldDescriptions.

The last step in the Makefile relies on all the other files, and actually descends into the Bookworm folder to do a make. Note that although here it doesn't reuire the field_descriptions.json file explicitly, it creates it using the scripts/guessAtDerivedCatalog.py script. You can use that guessing script for a first stab, but I strongly recommend not just copying the file directly unless you know that and why it works.

bookworm.cnf:
	bookworm init

.bookworm:
	bookworm init

bookwormdatabase: bookworm bookworm.cnf input.txt jsoncatalog.txt
	bookworm build all

One these have run, run bookworm serve to set up a simple interactive webserver at http://localhost:8005.