I stood in line for a few hours the day the iPhone came out in 2007. I had been using various cell phones before then, but the iPhone was revolutionary. I didn’t have to wade through sales pitches and confusing marketing to figure out which features I needed to pay for. Everything was included for a single price, and the price only depended on how many minutes I needed each month.
Cell phone companies have recovered some ground. Monthly fees depend on how many minutes AND how much data you want, as well as whether or not you want to tether a laptop or other device to the phone (that was always off the table with the first iPhone). If you want to upgrade more often than every two years, that’s another new monthly fee. Not quite as bad as before the iPhone, but getting more complicated so you don’t realize just how much you’re paying for spotty service. Until we have real competition in the cell market, this will be our future.
Today, let’s build a set of tools that will help us create a concordance of a text. We’ll have to make a lot of assumptions so that we can see the core pieces, so keep in mind that any real implementation will probably have different details.
We’ll assume for now that we have a stream of characters representing the text. We haven’t discussed where we get data or where we store it yet. That’s for another time. For now, we’re focused on what we do with the data between getting and storing it. If we can wrap our minds around what to do with the data, then we can plug-in any data retrieval or storage we want onto our processing later.
While I am trying to round out the content management aspects of OokOok this year, I’m starting to think ahead to next year’s work on databases and processing. Part of the goal is to offer a platform that lets you take advantage of parallel processing without requiring that you be aware that you’re doing so. Of course, any such platform will be less powerful than hand-coding parallel code in C or using your favorite Hadoop library. Less powerful is better than not available. I want OokOok to make available capabilities that would otherwise be hidden away.
Map/reduce seem like the simplest way to think about parallel processing. We have two kinds of operations: those that look at one item at a time (mappings), or those that have to see everything before they can finish their calculation (reductions). Reductions can get by seeing one item at a time if they can keep notes on a scratch pad. We could put operations then into two slightly different camps: those that need a scratch pad (reductions) and those that don’t (mappings).
I’m making rapid progress in getting OokOok to a stable programming scheme. I haven’t made a lot of changes in its capabilities, though I did add the ability to archive themes and projects as Bagit files yesterday, I’ve been working on making the important stuff declarative. By hiding all the details behind a veneer of relationships, I can fiddle with how I manage those relationships without having to touch every relationship every time I make a change in the underlying schemas (and schemes).
For those used to an older style of Perl programming, this might come as a surprise. For those who have dealt with things like MooseX::Declare and CatalystX::Declare, you’ll be shaking your head at my foolhardiness in jumping into making an OokOok:Declare that hides the details of how to construct certain types of classes.
Behind the scenes, OokOok consists of controllers, models, views, REST collections/resources, SQL result objects, a template engine, and tag libraries for the templates. Almost two hundred classes in all.
If I built all of these the usual Perl way, there’d be a lot of boilerplate code around. By moving to a declarative approach, I can isolate all the boilerplate in a few core meta-classes. When the boilerplate has to change, I only have to touch one place. Everything else comes along for the ride.
For the rest of this post, I want to walk through how I use some of these declarative constructions. I won’t get into the scary details of how to make declarative constructions in Perl (at least, not in this post).
OokOok is coming along nicely. It’s been a couple of months since the last update, so I’ll outline a bit of what I’ve done since the last post. I’m nowhere near being able to throw up a demonstration server for anyone to play with, but I’m getting closer. With a little more testing, a reasonably decent administrative interface, some simple themes, and full authorization management, we’ll be good to go on a first demo. I’m aiming for the end of the year. I’m trying to think about what a good, simple demonstration project might be that is just text on-line. Perhaps a curated collection of creative-commons licensed works on a subject?
OokOok isn’t meant to do everything for everyone. I’m designing it with opinions. I think they are well researched and thought out opinions, but they are opinions. I hope the pros can outweigh the cons, but that’s something you’ll need to decide when considering which platform to use for your project.
I’m designing the system to enable citation, reproduction, sustainability, and description. You should be able to point someone at exactly the version of the page that you saw (citation), be able to see the same content each time you view that version of the page (reproduction), see that content “forever” (sustainability), and leverage computation through description (composing the rules) instead of prescription (composing the ways). I’ve based all the opinionated choices in the system on trying to meet the needs of those four “axioms.”
Today, I want to explore what it means for something to be citable.
I come from the sciences, where citation is a shorthand for bringing in a body of work that you don’t want to reproduce in your text. It’s like linking in a library in a program. You’re asserting that something is important to your argument and anyone can find out why they should believe it by following the citation. You don’t have to explain the reasoning behind what you’re referencing.
If you use citations to give shout outs to people in your field, then you don’t need what I’m thinking about. Readers understand that these citations are to remind them about the other people and their body of work, not the particular passage pointed to in the citation. The details aren’t important enough to look up.
I’m interested in the citations that people need to follow.
I’ve made some good progress on the OokOok project over the last week. The system has a minimal page management interface now, so you can create, edit, and delete new pages and place them in the project’s sitemap. You can create project editions that freeze the content in time, and you can see the different versions of a page using time-based URLs.
You know you have a real software project when you have a list of things that won’t be in the current version. So it is with OokOok. Eventually, I want to support any dynamic web-based digital humanities project and allow it to run forever without any project-specific maintenance. For now, I’ll be happy creating a simple text content management system that has all the time-oriented features. We can add support for algorithms later.
Today, I want to talk a bit about the model I’m using to keep track of the different versions and the impact this has on the user interface.
I’m using part of my research time to dive back into a development thread I’ve been working on for the last decade. It started with the various Gestinanna packages through 2004 that are now on BackPAN, the archive of CPAN modules no longer considered actively distributed. I followed it a few years later with a set of Ruby fabulator gems that are in my github repository. I designed these to run in Radiant, a nice CMS for small teams. I used the Ruby/Radiant system to teach a course at DHSI in 2011 covering data acquisition, management, and presentation.
Now, I’m combining my experience and starting a new coding effort. I’ll be posting code to github.com/jgsmith/perl-ookook/. There are a lot of design decisions that I hope to discuss in a series of blog posts. For example, why did I choose Perl over something new and shiny like Ruby or Node.js? Why didn’t I use a venerable environment like Java and the JVM? Why have a backend SQL database instead of a noSQL database. For now, I’ll try to discuss a few questions that have shorter answers.
I’m almost half way to my goal of 150,000 words for my next novel. Given how it’s paced so far, I might need to aim for 200,000. However long the first draft ends up being, I intend to cut 20%. Hopefully, I’ll cut the worst 20%, leaving a fairly decent 80%.
I’m a process kind of guy. If I know that I’ll get to something later because of the process I’m going through, then I won’t worry about it now. I’m this way when I program, and I’m this way when I write. Processes can make it easier to get around the tendency to overlook things that we’re already familiar with.
I’m planning on a twelve step process for editing based on the chapters in Self-Editing for Fiction Writers. The book is an excellent resource for anyone who wants to try their hand at editing their manuscript. You still might want to pass your work by someone else, but going through Self-Editing will make subsequent edits less painful.
You might think that working in a digital humanities group would mean a lot less paper, but that’s not the case. I have a folder for each project I’m working on, each filled with papers showing things like milestones, budgets, and work plans. Every time I have a meeting about a project, I pull out the folder(s) related to it and go through the papers to catch up with where we are.
The problem with having everything on paper is that I have to be where the paper is. If I’m at home, I don’t have access to it. Same goes for the bus, or if I’m out-of-town. If I had everything digitized, or at least in some digital form, and available in the cloud, perhaps in Evernote, then I could use it anywhere, as long as I had wi-fi or cellular access.
What got me started thinking about this was the fact that in a few months, I’m going to have a 600 page (more or less) manuscript to edit. I don’t want to have to print it out and lug it around, or take sixty pages at a time with me on the bus. It wastes a lot of paper and is difficult to manage. Continue Reading Going Digital
Seeing what happens when you collide the humanities with the digital