usage

vcki usage
==========

I'd like to think that vcki's designed well enough that it explains itself &#8212; but that's likely not the case. So here's a quick rundown:

* A **node** is analogous to a directory in common filesystem parlance. Nodes can contain many a **leaf**, or other nodes.
* A **leaf** is a node that contains the contents of a vcki page, or, more precisely, a leaf is a node that doesn't contain any other nodes (or leaves). Leaves are analogous to files in filesystem parlance.
* Leaves can be edited either by clicking the **Edit** action in the upper-right corner, or by replacing the action part of a leaf's URI with edit (i.e. `http://<host>/vcki/`**_`show`_**`/mypage` becomes `http://<host>/vcki/`**_`edit`_**`/mypage`)
* Editing a node (by using the appropriate URI or clicking the pound/hash/number-sign/'#' next to a node in the menu) lets you choose which child (either a node or a leaf) should be shown by default.
* When vcki is asked to show a node, it actually shows its default child. If the default child is another node, then the the tree of contents is recursively expanded along the default path until a default leaf is reached, and then displayed. If there is no default child then the child that's first in alphanumeric order is displayed (and if it's a node...etc. etc. etc.).
* In general you can tell a node from a leaf by observing that node names are typically followed by a **'/'**, while leaves are simply names without any **'/'**s.
* To create a new leaf, just point your browser at its **_edit_** URI (or to its **_show_** URI and choose the **Edit** action) and save the leaf with your desired content. Voila; you've just created a brand new vcki-page. Could it be much easier? (Well, possibly, but much simpler? ...Perhaps. But I think it just about kippers the herring as it is.)

(No, I don't know what that means either.)

vcki for you, vcki for me
projects/vcki/usage ShowHistoryRemove vcki usage ========== I'd like to think that vcki's designed well enough that it explains itself — but that's likely not the case. So here's a quick rundown: * A node is analogous to a directory in common filesystem parlance. Nodes can contain many a leaf, or other nodes. * A leaf is a node that contains the contents of a vcki page, or, more precisely, a leaf is a node that doesn't contain any other nodes (or leaves). Leaves are analogous to files in filesystem parlance. * Leaves can be edited either by clicking the Edit action in the upper-right corner, or by replacing the action part of a leaf's URI with edit (i.e. `http://<host>/vcki/`_`show`_`/mypage` becomes `http://<host>/vcki/`_`edit`_`/mypage`) * Editing a node (by using the appropriate URI or clicking the pound/hash/number-sign/'#' next to a node in the menu) lets you choose which child (either a node or a leaf) should be shown by default. * When vcki is asked to show a node, it actually shows its default child. If the default child is another node, then the the tree of contents is recursively expanded along the default path until a default leaf is reached, and then displayed. If there is no default child then the child that's first in alphanumeric order is displayed (and if it's a node...etc. etc. etc.). * In general you can tell a node from a leaf by observing that node names are typically followed by a '/', while leaves are simply names without any '/'s. * To create a new leaf, just point your browser at its _edit_ URI (or to its _show_ URI and choose the Edit action) and save the leaf with your desired content. Voila; you've just created a brand new vcki-page. Could it be much easier? (Well, possibly, but much simpler? ...Perhaps. But I think it just about kippers the herring as it is.) (No, I don't know what that means either.) use Markdown syntax Comment: Password:
# settings Powered by vcki © Copyright 2007 Eli Marschner

projects/vcki/usage