# Wirks Engine: a model to inspire progressive textbook design

## About

Our wealth of knowledge doesn't lend itself well to linear information streams; everything is connected to each other. If one visualized this, they would see a large map, perhaps a tree, of that knowledge. Because textbooks are made of paper (and don't work well in a *Choose Your Own Adventure* format) they use a linear format. This format is *horrendous* for learning 'woven' subjects like science or math, where models build in complexity by using less-complex models as framework: exactly like classes in object-oriented languages.

The Wirks Engine solves this, not by bolting on interactivity (looking at you, Apple iBooks) but by making interactivity *necessary*. Inspired by [progressive education](http://en.wikipedia.org/wiki/Progressive_education), Wirks Engine encourages readers to learn through exploration. Rather than dumping a curriculum's-worth of subject matter on a student, Wirks Engine is non-intimidating by growing that curriculum from the root topics to the highest level concepts; this is how knowledge is gained, so it should also be how it's presented.

## Donations

[![Donate with PayPal](https://www.paypal.com/en_US/i/btn/x-click-but04.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=M8YHQLEVSZBF4 "Donate with PayPal")

If you like or use this project, I'd greatly appreciate a donation to aid further development.

## Demo

Coming soon...

## Creating content

To generate your own books quickly, see my associated project: [Wirks Engine Author](https://github.com/davisr/Wirks-Engine-Author).

Wirks Engine-compatible books are just JSON files following the following schema:

```javascript
{
	"Categories" : [
		{
			"Sample Category Name" : [
				{
					"uuid"				: "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx",
					"title"				: "Sample Title",
					"bigPic"			: "Sample_BigPicture.png",
					"backgroundColor"	: "#ffffff",
					"subtitle"			: "Sample Subtitle",
					"body"				: "This is just a *sample* item.\n\nMarkdown can be used.",
					"seeAlso"			: [
											{ "hyperlink" : "Related Sample Item Name" }
										],
					"isVisible"			: false,
					"prerequisites"		: [
											{ "required" : "Related Sample Item Name" }
										]
				}
			]
		}
	],
	{ ... }
}
```

## Cost for use

| User         | Cost |
| ------------ | ---- |
| Individual   | $0   |
| Educational  | $100 |
| Commercial   | [Contact me](mailto:d@visr.me) |

Educational institutions may obtain a mailing address by [sending me an email](mailto:d@visr.me?Subject=%5BWirks%20Engine%5D%20Educational%20institution%20payment&Body=I%27d%20like%20to%20deploy%20Wirks%20Engine%20with%20our%20content%3B%20may%20I%20please%20have%20your%20mailing%20address%20to%20send%20you%20a%20check%20for%20%24100.00%3F) where a check may be sent, or send a payment through PayPal.

## License

Copyright © 2012-2013 [Davis D. Remmel](http://davisr.me/). All rights reserved.

Redistribution and use in source and compressed-source forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions in source and compressed-source forms must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

2. Redistributions in source and compressed-source forms must not be used for commercial purposes, nor deployed within educational institutions, without specific prior written permission.

This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. in no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.