public
Description: A few tools I've written to aid development and production of my WordPress theme, Tarski.
Homepage: http://tarskitheme.com/
Clone URL: git://github.com/ionfish/tarski-utilities.git
tarski-utilities / README.markdown
100644 23 lines (16 sloc) 2.128 kb

Tarski Utilities

The files included in this repository constitute a toolset for working with Tarski, a WordPress theme. Hopefully they will prove useful to someone.

Files

  • Rakefile: some Rake tasks to tag and branch releases, create zip archives, generate an HTML version of the changelog file and update a version feed.
  • lib/tarski_version.rb: generates a version feed. Plugins mostly live in the WP plugin repository now, and get update notification for free, but since themes don't get this and update notification wasn't in WP core when I did it, I rolled my own.
  • conf/config.yml: a general tarski-utilities configuration file; specify public paths and the like.
  • conf/version.yml: a configuration file for the version feed generator.
  • conf/changelog-structure.html: a wrapper for the HTML generated by the changelog task.

Required Gems

These tools are written in Ruby, so they require the RubyGems packaging system and the following gems:

  • Rake: to run the tasks.
  • YAML: reader and writer for the YAML file format, needed to read the config file. Part of the Ruby standard library.
  • Builder: programmatic XML generation, required to create the Tarski version feed.
  • BlueCloth: Markdown format reader and writer, used to read Tarski's changelog file.
  • Hpricot: DOM scripting in Ruby for HTML and XML, used to parse the Tarski changelog and generate a list of links to each version's entry in the changelog.
  • open-uri: A wrapper for some other libraries which provide network protocol access, used to read remote files where necessary. Part of the Ruby standard library.