ppl 4.0.2 → 4.0.3

data/gh-pages/_stylesheets/ppl/typography.less

@@ -0,0 +1,59 @@
+
+body {
+  font-family: "Arvo", sans-serif;
+  font-size: 16px;
+  line-height: 24px;
+}
+
+code {
+  font-family: "Inconsolata", monospace;
+  font-size: 16px;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-size: 1em;
+  font-weight: normal;
+}
+
+h2 {
+  font-size: 22px;
+  font-weight: bold;
+  small {
+    font-size: 16px;
+  }
+}
+
+h3 {
+  font-size: 18px;
+  font-weight: bold;
+}
+
+.front-page {
+  h1.big-welcome {
+    font-size: 32px;
+  }
+  .little-welcome {
+    font-size: 18px;
+  }
+}
+
+.command-list {
+  h2 {
+    font-size: 18px;
+    font-weight: normal;
+  }
+}
+
+.navbar .nav > .active > a,
+.navbar .nav > .active > a:hover,
+.navbar .nav > .active > a:focus {
+  text-shadow: none;
+}
+
+footer.global {
+  font-size: 12px;
+  a:link, a:visited {
+    text-decoration: underline;
+  }
+}
+

data/gh-pages/development/changelog/index.md

@@ -0,0 +1,18 @@
+---
+title: Changelog
+layout: development
+section: development
+---
+
+<dl class="version-history">
+{% for post in site.categories.changelog %}
+  <dt>
+    <a href="{{site.url}}/development/changelog/{{post.title}}">
+      {{post.title}}
+    </a>
+  </dt>
+  <dd>
+    {{post.summary}}
+  </dd>
+{% endfor %}
+</dl>

data/gh-pages/development/changelog/split.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require "rugged"
+
+repo = Rugged::Repository.new("/home/hnrysmth/src/ppl")
+index = File.read("development/changelog/index.md")
+
+changes = index.split("### ")
+
+def find_date(repo, version)
+  tag = repo.refs.find { |r| r.name == "refs/tags/#{version}" }
+  commit = repo.lookup(tag.target).target
+  commit.time
+end
+
+def generate_post(front_matter, body)
+  post = ["---"]
+  front_matter.each do |name, value|
+    post << "#{name}: #{value}"
+  end
+  post << "---"
+  post << ""
+  post << body
+
+  post.join "\n"
+end
+
+changes.each do |change|
+
+  version = change.scan(/^([0-9.]+)/)[0]
+  next if version.nil?
+
+  version = version[0]
+  date = find_date(repo, version).strftime("%Y-%m-%d")
+  body = change.split("\n")[2..-1].join("\n")
+
+  post = generate_post({
+    :title      => version,
+    :date       => date,
+    :layout     => "changelog",
+    :section    => "development",
+    :categories => "[changelog]",
+    :permalink  => "/development/changelog/#{version}",
+  }, body)
+
+  filename = "_posts/#{date}-#{version}.md"
+
+  File.open(filename, "w") { |f| f.write(post) }
+
+end
+

data/gh-pages/development/index.html

@@ -0,0 +1,32 @@
+---
+title: Development
+layout: development
+section: development
+---
+
+<p>
+  You'd like to contribute to the development of ppl? Great!
+  Here's a quick introduction.
+</p>
+
+<h3>Report A Bug</h3>
+<p>
+  This project uses Github Issues to track bug reports. The tracker is at
+  <a href="https://github.com/hnrysmth/ppl/issues">github.com/hnrysmth/ppl/issues</a>.
+</p>
+
+<h3>Get The Code</h3>
+<p>
+  The main source repository for ppl is hosted on GitHub at <a
+  href="https://github.com/hnrysmth/ppl">github.com/hnrysmth/ppl</a>.
+</p>
+
+<h3>Do Your Best</h3>
+<p>
+  For low-level code style issues relating to issues such as syntax and
+  indentation, <a href="https://github.com/styleguide/ruby">GitHub's Ruby
+  Styleguide</a> is the standard to follow*. This project doesn't necessarily
+  follow the guide perfectly, but pull requests that improve adherence to the
+  guide are welcomed whereas pull requests that stray even further are
+  discouraged.
+</p>

data/gh-pages/development/roadmap/index.md

@@ -0,0 +1,15 @@
+---
+title: Roadmap
+layout: development
+section: development
+---
+
+As of January 2018 this project is in quite a stable state, with no major
+increases in functionality planned. That being said, I'm not actually against
+adding more functionality to this thing if somebody out there feels like taking
+on the implementation work. I'm very very open to adding lots more stuff, just
+not interested in creating it myself.
+
+Please don't hesitate to get in touch if you have ideas for ppl that you want to
+build and contribute!
+

data/gh-pages/documentation/about/index.html

@@ -0,0 +1,63 @@
+---
+title: About ppl
+layout: page
+section: documentation
+---
+
+<h2>About ppl</h2>
+
+<div class="row">
+  <div class="span8">
+    <h3>Why?</h3>
+    <p>
+      ppl was created to address the need for a decentralized address book
+      storage system. There are a lot of different contact details storage
+      solutions out there and they all have their own strengths. What was
+      lacking was one that I felt I could count on to entrust with the "master
+      copy" of all the disparate contact information I possess.
+    </p>
+    <p>
+      It's also intended to address the apparent lack of a proper CLI address
+      book. There are people who enjoy the conversational nature of CLI
+      interaction. You ask "Whose birthdays are coming up soon?", the computer
+      answers immediately, and your interaction with the software is over with
+      no further requirements that you close a window or slide a widget.
+    </p>
+
+    <h3>Why the CLI?</h3>
+    <p>
+      The command-line is a good fit for address book software because data
+      about contacts is usually 100% plain text. It also works well because a
+      given user interaction with an address book typically consists of one
+      short operation: reading or writing a single piece of data. And since we
+      normally want to keep our address book data for our entire lives, the
+      command-line's immunity to the shifting sands of GUI toolkits and
+      discontinued SaaS products is a big plus.
+    </p>
+
+    <h3>Why Git?</h3>
+    <p>
+      ppl uses git as its storage backend. Git's decentralised approach really
+      suits this usage as it allows continued read/write access to the address
+      book in the face of network downtime and cloud outages. And because git
+      never destroys data, no botched sync attempt can permanently wipe an
+      entire address book by accident.
+    </p>
+
+    <h3>Who?</h3>
+    <p>
+      This software was conceived and created by me, Henry Smith.
+      I have a bunch of <a href="http://github.com/hnrysmth/">other stuff on
+      GitHub too</a>!
+    </p>
+
+    <h3>When?</h3>
+    <p>
+      According to the project's git logs, work on ppl first began on November
+      10th 2012. Apparently I had nothing more exciting to be doing at 11pm on a
+      Saturday night.
+    </p>
+
+  </div>
+</div>
+

data/gh-pages/documentation/commands/add/index.md

@@ -0,0 +1,43 @@
+---
+title: ppl add Manual Page
+layout: command
+section: documentation
+command: add
+---
+
+### Name
+
+ppl add - Add a new contact
+
+### Synopsis
+
+    ppl add <contact> <name>
+
+### Description
+
+This command adds a new contact to the address book. The first parameter,
+`<contact>`, is an alphanumeric string used to uniquely identify the contact
+within the address book. The second parameter, `<name>`, is the contact's actual
+name.
+
+The `<contact>` parameter must not already be in use as the identifier of
+another contact in the address book. Ideally you'll want to pick something short
+and easy to type, so if you're adding a contact named "John Doe", then "john" or
+"jdoe" might be good choices if they aren't already in use.
+
+The `<name>` parameter should be the full name of the contact, and is identical
+to its namesake expected by the [ppl name](../name) command.  Usually, this
+means it needs to be enclosed in quotation marks to indicate that all the words
+in the name are part of the same parameter. 
+
+The first word in the `<name>` will also be stored as the contact's given name,
+with the remainder of the string being treated as their family name.
+
+### Examples
+
+    ppl add jdoe "John Doe"
+
+### See Also
+
+[ppl name](../name)
+

data/gh-pages/documentation/commands/age/add/index.md

@@ -0,0 +1,40 @@
+---
+title: ppl add Manual Page
+layout: command
+section: documentation
+command: add
+---
+
+### Name
+
+ppl add - Add a new contact
+
+### Synopsis
+
+    ppl add <contact> <name>
+
+### Description
+
+This command adds a new contact to the address book. The first parameter,
+`<contact>`, is an alphanumeric string used to uniquely identify the contact
+within the address book. The second parameter, `<name>`, is the contact's actual
+name.
+
+The `<contact>` parameter must not already be in use as the identifier of
+another contact in the address book. Ideally you'll want to pick something short
+and easy to type, so if you're adding a contact named "John Doe", then "john" or
+"jdoe" might be good choices if they aren't already in use.
+
+The `<name>` parameter should be the full name of the contact, and is identical
+to its namesake expected by the [ppl name](../name) command.  Usually, this
+means it needs to be enclosed in quotation marks to indicate that all the words
+in the name are part of the same parameter. 
+
+### Examples
+
+    ppl add jdoe "John Doe"
+
+### See Also
+
+[ppl name](../name)
+

data/gh-pages/documentation/commands/age/index.md

@@ -0,0 +1,38 @@
+---
+title: ppl age Manual Page
+layout: command
+section: documentation
+command: age
+---
+
+### Name
+
+ppl age - List or show contacts' ages
+
+### Synopsis
+
+    ppl age [<contact>]
+
+### Description
+
+This command calculates contacts' current ages in years based on their date of
+birth. The purpose of this command is to provide easy access to an often-needed
+piece of information which is indirectly available from the data in the address
+book.
+
+Invoked without any arguments, all contacts are listed with their respective
+ages. If a `<contact>` is specified, only the age of that contact will be shown.
+
+### Examples
+
+    $ ppl bday jdoe 1980-01-01
+    $ ppl age jdoe
+    33
+    $ ppl age
+    fred: 25
+    jdoe: 33
+
+### See Also
+
+* [ppl bday](../bday)
+* [color output](/documentation/configuration/color_age)

data/gh-pages/documentation/commands/bday/index.md

@@ -0,0 +1,44 @@
+---
+title: ppl bday Manual Page
+layout: command
+section: documentation
+command: bday
+---
+
+### Name
+
+ppl bday - List, show or change birthdays
+
+### Synopsis
+
+    ppl bday
+    ppl bday <contact>
+    ppl bday <contact> <date>
+
+### Description
+
+With no arguments, the dates of birth of each contact in the address book are
+listed.
+
+If a `<contact>` is specified, the date of birth of that contact is shown.
+
+If both a `<contact>` and a `<date>` are given, then the date is stored as the
+date of birth of that contact. The `<date>` parameter must be a valid date
+string parseable by Ruby's
+[Date.parse](http://ruby-doc.org/stdlib-1.9.3/libdoc/date/rdoc/Date.html\#method-c-parse)
+function.
+
+### Examples
+
+    $ ppl bday jdoe 1970-01-01
+    $ ppl bday adam 1975-06-01
+    $ ppl bday jdoe
+    1970-01-01
+    $ ppl bday
+    adam:  1975-06-01
+    jdoe:  1970-01-01
+
+### See Also
+
+* [Date.parse](http://ruby-doc.org/stdlib-1.9.3/libdoc/date/rdoc/Date.html\#method-c-parse)
+* [color output](/documentation/configuration/color_bday)

data/gh-pages/documentation/commands/completion/index.md

@@ -0,0 +1,38 @@
+---
+title: ppl completion Manual Page
+layout: command
+section: documentation
+command: completion
+---
+
+### Name
+
+ppl completion - Output a completion function for shell integration
+
+### Synopsis
+
+    ppl completion <shell>
+
+### Description
+
+Output a shell autocomplete function to enable automatic completion of commands
+
+The following shells are supported:
+
+* `bash`
+* `zsh`
+
+### Examples
+
+    $ ppl completion bash
+    _ppl()
+    {
+      ....
+    }
+    complete -F _ppl ppl
+
+### See Also
+
+* [Bash Integration Guide](/documentation/integration/bash)
+* [ZSH Integration Guide](/documentation/integration/zsh)
+