From: Rui Carmo
Title: Frequently Asked Questions
Date: 2007-03-03 22:41:42
Content-Type: text/x-textile

h1. Introduction

This "FAQ":docs/FAQ covers generic questions about "Yaki":Yaki. You might want to read the "Author FAQ":docs/FAQ/Authors or the "Deployment FAQ":docs/FAQ/Deployment as well.

h2. How can I edit via a browser?

You can't. There's no browser-based editing, by design. Some people will say it isn't a "Wiki":Wiki without that, but I'd much rather have a text file tree that I can index using "Spotlight":Spotlight and "rsync":rsync across, and I honestly don't want to fiddle with browser-based editing until "Safari":Tao:apps/Safari does it properly.

h2. What kind of markup do you support?

Right now, "Yaki":Yaki supports "HTML":HTML, "Textile":docs/Textile and "Markdown":docs/Markdown. There is implicit provision for any kind of "Wiki":Wiki markup you care to name, as long as you have a parser that generates "HTML":HTML.

Everything is rendered into "HTML":HTML, strained through the utterly, utterly amazing "Beautiful Soup":docs/Beautiful_Soup and pre-cached to kingdom come.

h2. Where's The Source, Luke?

"Here":http://code.google.com/p/yaki/source. Feel free to submit "bugs":http://code.google.com/p/yaki/issues/list, although I would rather receive patches instead.

h2. Where did you draw inspiration from?

Mostly from "my":people/Rui_Carmo own "PhpWiki":http://phpwiki.sourceforge.net customizations and my very first "PHP":PHP blogging engine, which relied on plaintext files. But as soon as I put up the first working server, folk like "Pedro Melo":people/Pedro_Melo started chipping in with stuff to look at (like "MultiMarkdown":http://fletcher.freeshell.org/wiki/MultiMarkdown, which adds metadata and other features to "Markdown":docs/Markdown), so some of those may end up having some influence in the design.

h2. Why "Snakelets":docs/Snakelets?

The full story is "here":Tao:Yaki and "here":Tao:blog/2006/06/15/1700, but basically it was because it implements an "application server" paradigm instead of brain-dead "CGI":CGI request handling, and allows me to host several applications atop a simple, lightweight and _fast_ "Python-based":Python server I can run anywhere.