windfall

An inheritance based CMS

npm install windfall
4 downloads in the last month

Windfall

========

Generic, simple CMS for Node.js

========

Brainstorm

Card

{

    'name': { // Combined with 'namespace', provides a unique identifier
        'type':         'slug'
    },
    'slug': { // Defaults to 'name', lets you change the URL arbitrarily
        'type':         'slug',
        'value':        '&name' // A value starting with & refers to another property
    },
    'prototype': { // Card this iherits all properties from, including 'value' if not set
        'prototype':    'card',
        'value':        '&parent'
    },
    'parent': { // Shorthand for setting prototype and namespace
        'type':         'card',
        'value':        ''
    },
    'namespace': { // Allows for multiple cards to have the same name
        'type':         'card',
        'value':        '&parent'
    }
}

## Use Case

You need **posts** and **pages**, but also **products**, or **portfolio examples**. More importantly, you're looking for content type *inheritance*.

## Overview

### Content

The basic unit in Windfall is a ``card``. A card represents both a content unit, and a template. Any card inherit any other card, pulling in the data fields, each defaulting to the value of the parent card.

#### Example Post Inheritance

##### Post:
<pre>
{
    'name':         'post',
    'slug':         'blog',
    'title':    {
        'dataType':     'text',
        'value':        'Hello World'
    },
    'author':   {
        'dataType':     'slug',
        'value':        'first_last',
    },
    'date':     {
        'dataType':     'date',
        'value':        '11-20-1984'
    },
    'tags':     {
        'dataType':     'text',
        'list':         true
    },
    'content':  {
        'dataType':     'text'
        'format':   'markdown',
        'body':     '## Lorum Ipsum
                    1. First
                    2. Second
                    3. Third
                    Paragraph text.'
    }
}
</pre>

Here ``post`` inherits ``card``, which only gives it the ``name`` and ``slug`` fields by default. ``Post`` then defines its own fields, as well as populates content for them.

##### Review
<pre>
{
    'name':         'review',
    'inherits':     'post',
    'title':        'Clever Pun',
    'subtitle': {
        'dataType':     'text',
        'format':       'markdown',
        'value':        'Something a bit more descriptive'
    },
    'date':         '12-24-2012',
    'score': {
        'dataType:      'percent',
        'value':        '.75'
    },
    'tags':         ['technology', 'devices'],
    content':       '## Specs
                    Lorum ipsum
                    ## Look and Feel
                    Etc etc'
    }
}
</pre>

``review`` gets a couple things by inheriting ``post``. It doesn't need to declare data types for inherited properties, and it doesn't even name the post author, as all (or most) reviews are written by the author declared in ``post``.

Let's check out a real example, something you'd actually want to display on your site:

##### Example Review
<pre>
{
    'name':         'iphone-5',
    'inherits':     'review',
    'title':        'Long in the Tooth',
    'subtitle':     'iPhone gets a bigger screen and 4G. **Is that enough?**',
    'date':         '9-15-2012',
    'tags':         ['apple', 'iphone5, 'iphone, 'phone'],
    'score':        '.7',
    'content':      'We've had some time with the latest and greatest from Cupertino. It\'s better than the 4S, 
                    but can\'t quite match the competion.'
}
</pre>

All that inheritance gives this post a nice, simple structure, but still validates and casts its fields.

#### URLs

All the inheritance also gives us a default URL structure. Let's check it out.

The URL for our iPhone 5 review: ``/blog/review/iphone-5``

The URL gets constructed by hopping up the inheritance chain, prepending the 'name' attribute of each parent unless a 'slug' is defined (this makes the URL root ``/blog`` instead of ``/post``). You can actually have more than one post with the name "iphone-5", as long as they each have a unique direct parent. E.g. if you wanted a page that just listed all the iPhone 5 specs, it could inherit your ``spec-list`` card and still have the ``iphone-5`` name, getting ``/spec-list/iphone-5`` as the URL.

#### Complex Data Structure

I know what you're thinking: this is super cool, but not really compelling enough to switch from Wordpress. While that is false, the real hook is are the nested data structures.

##### Hero Slide Example

Let's say you want a hero with 5 slides, each with a title, an image, and a series of "hotzones" over the image that popover some text when hovered. Trust me, this is a pain in Wordpress, but crazy easy in Windfall.

{ 'name': 'slide-show', 'slides': { 'dataType': 'collection', 'memberType': 'image-detail', 'ordered': true } { 'name': 'iphone-5' 'inherits': 'slide-show', 'title': 'Anatomy of iPhone 5', 'slides': ['front', 'back', 'top', 'bottom', 'side'], 'loop': false }

{ 'name': 'image-detail', 'image': { 'dataType': 'url', 'value': '/images/missing.png' } 'hotzones': { 'dataType': 'hotzone' }

{ 'name': 'front', 'inherits': 'image-detail', 'parent': 'slide-show/iphone-5', 'image': '/images/iphone-5-front.png', 'hotzones': [ 'home-button': { 'topLeft': ['.45', '.55'], 'bottomRight': ['.8', '.9'] }, 'volume-rocker': { 'topLeft': ['.1', '.15'], 'bottomRight': ['.2', '.35'] } ], 'subtitle': 'Front' }

{ 'name': 'hotzone', 'inherits': 'post', 'topLeft': { 'dataType': 'coordinates', }, 'bottomRigth': { dataType': 'coordinates', }

{ 'name': 'home-button', 'inherits': 'hotzone', 'parent': 'hero/iphone-5/front', 'title': 'Home Button', 'content': 'Exactly the same as the 4S' }

{ 'name': 'volume-rocker', 'inherits': 'hotzone', 'parent': 'hero/iphone-5/front', 'title': 'Volume Rocker', 'content': 'Still best-in-class' }


OK that was a lot of stuff, but we accomplished a lot, too. Let's take a look at the ``front`` card once it pulls in its hotzones:

{ 'name': 'front', 'inherits': 'image-detail', 'parent': 'slide-show/iphone-5', 'image': '/images/iphone-5-front.png', 'hotzones': [ 'home-button': { 'title': 'Home Button', 'content': 'Exactly the same as the 4S', 'x': ['.45', '.55'], 'y': ['.8', '.9'] }, 'volume-rocker': { 'title': 'Volume Rocker', 'content': 'Still best-in-class', 'x': ['.1', '.15'], 'y': ['.2', '.35'] } ], 'subtitle': 'Front' } ````

Why not just include the hotzone title and content right in the front slide? Because we might want to re-use those, e.g. as a list of specs, but the x and y coordinates are necessarily a relation of the slide to the hotzones.

One of the coolest things here is the ordered attribute. In your content editor, non-ordered lists of content like tags will just let you add, edit, and remove items. With ordered applied, you can easily give your editor the ability to move items around relative to each other. The best part is that we're not relying on some ordinal number property of the slides: MongoDB can store data natively as arrays, so we can push and shift and pop and splice to our hearts content.

npm loves you