Wordfaire

publisher documentation

Remember that embedding your live blog on your own site is:

Sign up for the publisher newsletter; right now it's the only way to get in touch with you about updates, changes and notifications.


Here's the code you need to include:

<script type="text/javascript">
var _wf = _wf || {};

// ===== ONLY MODIFY THE TWO VARIABLES BELOW =====

// Your blog URL on Wordfaire - if you blog is at wordfaire.com/myblog, then set it to 'myblog'.
_wf.blogUrl = 'myblog';

// The ID of the element that you want to display the liveblog in. This can also be a HTML element reference or any other jQuery selector (which returns a single element).
_wf.holder = '#liveblog';

// ===== ONLY MODIFY THE TWO VARIABLES ABOVE =====

_wf.baseUrl = ('https:' == document.location.protocol ? 'https://' : 'http://') + 'wordfaire.appspot.com/';
_wf.blogBaseUrl = _wf.baseUrl + _wf.blogUrl + '/';
(function() {
	var wfs = document.createElement('script'); wfs.type = 'text/javascript'; wfs.async = true;
	wfs.src = _wf.baseUrl + 'static/scripts/output/reader.js.compiled.js';
	var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(wfs, s);
})();
</script>

Required Settings

There are two options that need to be set for the script to work:

_wf.blogUrl : Set this to the last part of the URL that your blog is hosted on. If you have a blog at www.wordfaire.com/myblog, then set it to 'myblog'

_wf.holder : Set this to the ID of whichever element you want to blog to show in. This can also be an actual reference to a HTML element or a jQuery style selector (just make sure it returns a single element).

HTML Markup

The HTML loaded into your page for each post will be identical to the HTML used currently on Wordfaire.com. Feel free to style it any way you want, and hide whichever parts you don't require using CSS statements like display: none;. The post content will be passed through a filter and Markdown parser, just like the blogs hosted on Wordfaire itself.

We do understand that you might want to write your own HTML templates, and possibly render content as is, so we will add custom templates before this feature comes out of beta.

Globals & Dependencies

The Wordfaire script is written to be self contained with no dependencies, and only requires the _wf variable to be set.

A variable named PUSHER will also be created once the script loads. These two variables are the only side effects of adding the script.


Pricing

Pricing for self-published Wordfaire blogs hasn't been finalized, so until then we will not be measuring usage; we'll contact you on the newsletter about 30 days before pricing is enforced. These are the simple monthly plans that will probably be available:

Price Live updates
Free / Demo 1,000
$19.99 100,000
$99.99 1,000,000
Talk to us > 1,000,000

All prices are per blog per month, in USD. A live update is one instance of sending information to a reader - so if you've had 10 readers reading your blog at a time, and you made 10 posts, you've used 100 live updates. The same goes for edits and deletes.

Even with the $19.99 plan, you usually won't have to worry about the numbers. Since the updates are counted only for readers online at the very moment you make the udpate, you'll usually hit a much lower number than what you expect; far less than the number of people who actually read the blog. We don't charge based on the number to users who actually read the blog - this can by any number.


Questions & Contact Info

Feel free to send any questions to publish@wordfaire.com. You can also ask a question on stackoverflow.com with the 'wordfaire' tag - you might actually get a faster response. It's also a great place to see the commonly asked questions about Wordfaire installation.