From: Rui Carmo
Title: Frequently Asked Questions (for Authors)
Date: 2007-09-03 18:28:52
Content-Type: text/x-textile

h2. How do I create a "Wiki":Wiki Node?

Find your content root directory, and create a folder inside it containing an @index.txt@ file with the correct "structure":Docs/Storage_Format.

h2. I just added a node and it doesn't show up anywhere! What's up?

Nothing, really. You see, "Yaki":Yaki is designed based on the assumption that content is meant to be "indexed":Indexing before it is listed anywhere in the site (after all, your average Web site spends a lot more time being _read_ than _written to_, and it pays to only render content when it's absolutely necessary.)

If you do want to view your page immediately, type the full "URL":Tao:URL to it. Otherwise, "Yaki":Yaki will only list it in the "Recent Changes":meta/RecentChanges and other pages when it gets around to indexing it (which is every half hour or so).

h2. Why do I have to use @cid:@ to reference images and media?

Because that prefix was the only way to ensure disambiguation in all contexts, and I wanted a consistent way to reference things. It's a "MIME":Tao:MIME schema, in case you haven't noticed yet.

h2. How do I insert... X?

Check the "Plugins":docs/Plugins listing to see if I solved that for you. Otherwise, just use plain "HTML":Tao:HTML.

h2. Where do I add acronym definitions, inter-wiki links, etc.?

Check out the @meta@ pages. In particular, "meta/Acronyms":meta/Acronyms and "meta/InterWikiMap":meta/InterWikiMap

h2. What about versioning?

I don't consider versioning an integral part of the "Wiki":Wiki engine, because there are too many ways to do it. The one I use is to keep the entire "Yaki":Yaki page store (the @space@ tree) in a "Mercurial":Tao:Mercurial repository.

This may eventually be exposed to the site visitor via some sort of back-end integration with an "SCM":Tao:SCM, but I have found very little point in doing so as yet.