How To Make A Bookmarklet

[posted by Gavin Robinson, 10:55 am, 13 February 2010]

Knowing how to program can save you from tedious repetitive tasks, such as inserting templates into a wiki page. Recently I’ve been spending more time editing the UK National Archives wiki Your Archives. I created a category for women’s wills, and while I was adding pages to it, I found that a lot of them didn’t have the correct template. Wills that were proved in the Prerogative Court of Canterbury are held by the National Archives and can be downloaded from their DocumentsOnline service. Transcripts of these wills can be posted on Your Archives, and we have a template for them which automatically creates a link back to DocumentsOnline based on an ID code, and formats some key data (testator’s name, dates, catalogue reference) in a standard form. Most of the data which goes into the template can be found in the DocumentsOnline index. We used to copy and paste each value manually, which was not the best use of a human’s time. Faced with the prospect of doing this an awful lot, I decided to write a program to do it automatically. First I threw together a Python script, which was alright for me but no use for people who don’t have Python and BeautifulSoup (and I also wrote it in such a way that it relied on Linux with xclip installed). So then I decided to rewrite it in JavaScript, so that other people could use it in their browsers. You can find the finished version and documentation on the PCC Will Bookmarklet page. Below is a walk through of how I did it.

(more…)

Converted to Ubuntu

[posted by Gavin Robinson, 2:47 pm, 23 January 2010]

Last year computer programming was out, but now it’s back in. For me anyway. Having finished my data entry job in October I’ve got more spare computer time, which means I can be more active in digital history again. Some things are different now. Zotero has groups and syncing. The Programming Historian has moved since the last time I looked at it. I can finish my digital edition of Sandall’s history of the 5th Lincolns because Major Teall’s epilogue came out of copyright in the UK at the start of this year. But the biggest change is that I’ve switched my operating system from Windows to Linux. When I built my new desktop PC (codenamed Zen) I installed Ubuntu, and I love it. My laptop (codenamed Orac) still has Windows Vista, but I don’t use it much.

Changing to a completely different operating system might sound like a big step but it was actually really easy. This is partly because most of the applications I use are cross platform. I use Firefox more than any other application (and possibly more than all other applications put together). Don’t think that I spend all my time idly browsing the web: Firefox is vital for my historical research and writing. I use Zotero to store, sort, and access all the bibliographic data plus associated notes and PDFs for my research projects. These can all be synced between my PCs via the Zotero server and my own WebDAV server. My works in progress are now drafted on a private wiki which is also necessarily accessed through my web browser. This is much more powerful and flexible than writing in Word like I used to. Every page has an edit history so I can easily compare versions and revert to an earlier one. Wikilinks make it easy to fit sections together in different orders and link to supplementary information. Thanks to Google my e-mail and RSS feed reader are also on the web. When I’m not using Firefox, I still mostly use cross-platform applications. For the last few years I’ve used oXygen for XML editing and jEdit for find and replace operations, both of which are written in Java. Python can run on Linux, Windows and Macs, and although that doesn’t necessarily make individual scripts cross-platform it doesn’t really matter when I’m writing them for myself. The only Windows specific app that I’ve relied on in the last few years is MS Access. Even that was mainly because I was getting paid good money to put data into it for someone else. For my own research I’ve got some old databases from my PhD research, but all I ever need to do with them is export data into other formats.

Given all this, changing to Linux was not likely to be much of a problem, but that would be understating things. In fact it turned out to be a big advantage. Ubuntu is actually much quicker and easier to install and set up than Windows. It just works out of the box and comes with most of the things that most people need to get started. Open Office, Firefox, and even Python are all pre-installed. Once I’d added my favourite Firefox extensions and synced my Zotero library I was ready to do most of what I need to do. The only tricky things were manually installing a proprietary graphics driver and setting up DVD playback, but even this wasn’t too hard. If you don’t have a powerful new graphics card and don’t need 3D performance out of it, the pre-installed open source driver will be adequate for desktop stuff. Even setting up a network printer was completely painless.

Adding new applications is generally much easier than on Windows. Instead of buying a CD or downloading an executable file you can just access software repositories via a menu and tick boxes to select apps you want to be downloaded and installed. Because most of these apps are free in every sense of the word (like Ubuntu itself) you won’t have to pay money or agree to a licence that sells your soul to the devil. Via the repositories I could easily install Geany (a code editor which I now use for Python programming: I actually like it more than Komodo), gFTP (FTP client), the aforementioned jEdit, and the BeautifulSoup library for Python. It only took a few simple commands at the terminal to install and set up an Apache server with PHP and MySQL for local testing. oXygen had to be downloaded and installed manually as it’s a proprietary application, but the academic licence is cheap and cross-platform: I originally bought it for Windows but my licence automatically carries over to Linux. To get it working properly I had to install the proprietary Sun version of Java, but that was easy to do via the repository. There is a thing called WINE which lets you run some Windows programs in Linux, but so far I’ve only used it for listening to music with Spotify.

With everything set up to my liking, Ubuntu has made me fitter, happier and more productive. It’s faster, more secure, more stable, and less annoying than Windows. You can start using it as soon as the desktop appears on the screen instead of waiting for it to finish starting, or dealing with a patronising storm of pop-ups about how your anti-virus might be out of date or how you’ve got unused icons on your desktop. The Blue Screen of Death is now just an unpleasant memory. Linux users generally don’t have virus scanners or software firewalls because we don’t need them. The only major problem I’ve had so far is when an upgrade to a new version didn’t agree with my proprietary graphics driver and made it impossible to boot to the desktop from the hard disk. Even that was surprisingly easy to recover from, as being able to run the operating system from the LiveCD makes it very easy to rescue any files which aren’t already backed up before doing a clean reinstall (and the reinstall process is quicker and easier than for Windows).

So those are my reasons for preferring Ubuntu to Windows. If you haven’t tried Linux before you can download Ubuntu, burn it onto a CD, and then boot from the CD, which gives you an option to try it out without actually installing it on your PC. And it won’t cost you anything. Meanwhile I’ll be getting on with my research, writing and programming. And blogging about those things…

The Programming Historian

[posted by Gavin Robinson, 2:16 pm, 5 May 2008]

Yesterday Bill Turkel announced that The Programming Historian is now available. This is a book, but not as we know it. It’s published in the form of a website and is completely free to access. As the name suggests, it’s an introduction to computer programming aimed specifically at historians. The tutorials will get you doing useful things as soon as possible, even if you have no previous experience of programming. If you do know programming it’s also worth a look. I found lots of useful tips in it.

By enabling more historians to make better use of digital technology the book is helping to change the way that we do history. And it’s also helping to change the way that we present our research, because it’s a concrete example of the advantages of open access publishing on the web. This means a whole lot more than not having to pay to read it. Although the book has been published, it’s still a work in progress. New chapters will be added in future, and existing ones can be improved in response to feedback from readers. Any typos, factual errors or unclear sentences can all be corrected very easily. Comments from reviewers are displayed on accompanying discussion pages so you can see how the text developed and what people thought of it. The book can keep growing to meet the needs of digital historians: there doesn’t ever have to be a point when it’s finally finished like there is with a printed book.

Go and read it. Now.

Identifying places 2

[posted by Gavin Robinson, 9:26 am, 15 April 2008]

Last week I posted about experiments with Python to automatically identify places mentioned in lists of horses donated to parliament’s armies in the English Civil War. The initial results were very encouraging. Using the difflib algorithm to compare a selection of places with a list of Buckinghamshire parishes gave very encouraging results. Since then I’ve scaled it up and also tried some different approaches. The results are less clear cut when comparing bigger lists, but I’ve been able to write a program which should save me a lot of time compared to the manual methods that I used during my PhD.

(more…)

Identifying Places

[posted by Gavin Robinson, 10:17 am, 8 April 2008]

Never mind the scary theory, here’s some empiricism. And computer programming. The piece I’m working on is an analysis of lists of horses donated to the parliamentarian army in the First Civil War. There are some figures derived from these lists in my forthcoming article in War In History and in the seminar paper that I posted in November, but I’m trying to write an article which examines them in much more detail. This article will be related to debates over allegiance and the causes of the war, which is why I’ve been trying to explore the historiography and think about theoretical issues, but the substance of it will be fairly straightforward empirical stuff with lots of numbers. That’s not to say that this kind of analysis is easy. If it was someone else might have done it all years ago. John Tincey was the first person to try it, but he only did the smallest of the three account books, which is a fraction of the size of the other two. Following his lead I decided to do all of them.

In 1999 I spent about 2 weeks in the PRO typing these lists into an Access database. I’m still using that transcript as the basis of my work now, although I’ve converted it to XML to make it more flexible and checked a selection of the entries against digital photos of the manuscript. I’ve been using the Python classes that I developed for representing uncertainty to calculate totals of horses and values. Some pages are damaged, meaning that exact totals can’t be calculated – this is something that was difficult to deal with in Access but the combination of XML and Python has enough flexibility to cope with it. Getting totals for days and months is fairly easy, but I also want to group by the social status of the donors and the counties that they came from. Before I can group by counties I need to identify place names given in the manuscript as although some entries specify a county in the address, many more give a place name without a county.

(more…)

Top Tips for the Python Programmer

[posted by Gavin Robinson, 12:45 pm, 3 March 2008]

Last week I learnt about using exceptions, which turned out to be the solution to a problem that I’ve mentioned before: if you try to do anything with a variable that hasn’t been initialized, Python throws an exception. In many ways this is good, because trying to do things with non-existent variables can otherwise be a source of hard to find bugs. However, I found it quite annoying when I got exceptions just for checking for a variable and only trying to do things with it inside an if block if it exists. Even the seemingly innocuous statement “if x” will bring a program to a halt if x doesn’t exist.

The way around this is to handle the exception when it occurs, so that the program keeps running but you know that the variable doesn’t exist. For example:

try:
    x
except NameError:
    #x doesn't exist
else:
    #x does exist

This code tries to reference x. If x doesn’t exist, an exception occurs and the code after except is executed (but only if the type of exception thrown matches what’s specified between except and the colon). If x does exist the code after else is executed instead. This is a bit long winded compared to “if x” but it’s better than nothing. Also be aware that different kinds of variables throw different kinds of exceptions when they don’t exist.

  • NameError – any single instance of a built in type or custom object, or a sequence where the sequence itself doesn’t exist, eg x
  • IndexError – numerical index of a sequence where the sequence exists but the specified element doesn’t, eg x[5]
  • KeyError – index of a map where the map exists but an element with that index doesn’t, eg x['y']
  • AttributeError – attribute of an object where the object exists but the specified attribute doesn’t eg x.y (often occurs with objects representing XML elements as it can be difficult to predict what child elements they contain)

Representing uncertainty in Python

[posted by Gavin Robinson, 11:50 am, 28 February 2008]

In December I wrote some Python code to do calculations with pre-decimal British currency. As well as dealing with the awkwardness of pounds, shillings, and pence, I needed to allow for situations where a damaged or illegible manuscript made the values uncertain. To start with I wrote a class called MetaOldMoney which could store exact amounts of money or ranges of values.

Now I’ve written some new code which can easily deal with uncertain values of anything. There are three classes: one to represent an exact value, one to represent a range where the minimum and maximum values are known, and one to represent a minimum value with no maximum. Instances of all three objects contain a tuple of two values. For an exact value they’re both the same, for a range they contain the upper and lower amount, and for a minimum the second value is set to None. The addition operator is redefined so that any combination of these objects can be added together, returning an object of the correct type eg Exact + Range = Range etc. The best thing is that the values contained can be of absolutely any type. Taking full advantage of the Python approach to typing, the classes I’ve defined don’t even need to know what they contain. The addition will just work as long as the contained objects can be added together.

These classes are so flexible that there are lots of different ways I could use them. I could put my OldMoney objects inside them, or I could define a new money object which contains individual uncertain values for pound, shillings and pence. I could even nest the objects inside each other to allow for situations where the maximum value in a range is also a range.

Code below: (more…)

Places

[posted by Gavin Robinson, 12:01 pm, 28 January 2008]

Following on from adding an interactive index of people to my digital edition of Sandall’s history of 5th Lincs, I’ve now added a similar feature for place names. It works in exactly the same way as the person index, but it also has a map view. Again this uses the Exhibit API, which makes it very easy to mash up data with Google Maps without even having to know anything about the Google Maps API. The map view is a bit slower than the normal view, especially if the list isn’t filtered, but that’s an inherent limitation of using maps.

One of the many cool things about the map is that it strikingly illustrates the allied advances in the last months of the First World War. If you go into the map view and click “The Beginning of the Great Advance” on the list of chapters, you’ll see the battalion holding the line in Flanders, then moving behind the lines for rest near Amiens, then moving up to the front line at Saint-Quentin. Then click on each of the following chapters in turn and watch the markers surge forward as 46th Division breaks through the Hindenburg Line and pushes towards Belgium.

Adding the place index was mostly similar to adding the person index: I added a unique id to each<placeName> tag using a Python script, pulled out the place names into an SQLite database, identified/disambiguated them and added a regularized name, then used another Python script to pull the regularized names out of the database and put them into the key attributes in the XML file. Identifying the places was easier than identifying people, and took a couple of days, although there are a few that I couldn’t find. As with people I added some code the the XSLT to generate a JSON file of all the places. Then following the map view tutorial I used the Exhibit API to pull latitude and longitude co-ordinates from Google Maps and put them into another JSON file. This turned out to be a bit unreliable as about 10 per cent of the places had their co-ordinates missing. It seems to be random, as running the script again with the same set of data produced a similar error rate but with different places. I had to take the missing places from the output file, put them into another input file and run the script over them again, which produced a similar 10 per cent error rate, but the remaining few co-ordinates could be put in manually. Once I had a JSON file with all the correct geocodes it was easy to copy code from the tutorial to add a map view to the Exhibit page. In a few cases it turned out that Google had given me the wrong co-ordinates. Mostly this was because there are two or more places with the same name and it had picked the wrong one. I thought I’d put in enough information from my manual searches to disambiguate them but it seems that the results of a Google Map search can be a bit unpredictable, and don’t necessarily give you the full address of a place.

I’ve now done most of what I planned to do in this phase. There are still some features that could be added, especially a feedback mechanism, but I’ll be giving this project a rest soon so I can do some English Civil War work.

Marking Up Names: Part 2

[posted by Gavin Robinson, 3:01 pm, 19 January 2008]

My digital edition of Sandall’s History of 1/5th Lincolnshire Regiment now has a new index of people. In my last post I described how names were marked up in the text. This post is about how I linked them together.

(more…)

Marking Up Names: Part 1

[posted by Gavin Robinson, 3:55 pm, 15 January 2008]

On to the next stage of digitizing Sandall’s History of 5th Lincolnshire Regiment. Having marked up the structure of the text and written XSLT to split the book into several HTML pages with working internal links, I could move on to Phase 2: marking up name, dates, and abbreviations.

(more…)

Older posts