+ Writing Entries

[why the lucky stiff]

=== Today's Tip: Writing Blog Entries ===

Adding a new entry to your Hobix site basically boils down to just
adding a YAML file to your `entries' directory.  If you are using Hobix
with your editor, the `post' command will open a blank post in your
editor.

Yesterday, I posted an entry about a circuit-bent Furby.

  hobix post why clog/wander/forcingShortCircuit

This opened Vim with the following empty post:

  --- !hobix.com,2004/entry
  title: Forcing Short Circuit
  author: why
  content:

The `title' field is filled in with an approximation of the title, based
on the shortName you provided.

The basic Hobix entry consists of a title, an author and content.  The
content defaults to a RedCloth string.

Here's a list of all available fields for a Hobix entry:

  title::            The heading for this entry. (String)
  tagline::          The subheading for this entry. (String)
  author::           The author's username. (String)
  contributors::     An Array of contributors' usernames. (Array of
                     Strings.)
  modified::         A modification time. (Time)
  created::          The time the Entry was initially created. (Time)
  summary::          A brief description of this entry.  Can be used
                     for an abbreviated text of a long article. (String)
  content::          The full text of the entry. (String)

You can force a creation time with the `created' field and Hobix will
honor it.

You must use YAML syntax for adding the various types.  See the YAML
Cookbook <http://yaml4r.sf.net/cookbook/> for brief examples.  For a
quick introduction, <http://yaml.kwiki.org/?YamlInFiveMinutes>.

If you're not happy with the structure of Hobix entries, you can design
your own formats.  In fact, you are encouraged to design your own types
of content to ease maintenance of your site.  In the next few days, I'll
go over how to do this.

_why