wik is a tool for creating, managing, rendering and serving wikis. It provides an easy to use GUI, but you can also use it from the command line. The command line options are documented here.

Quickstart

Create a standalone wiki server:

You can view/edit your wiki at http://127.0.0.1:8000 (assuming you accepted the defaults in wik init)

You can also render your wiki to static HTML:

Wik Reference

Usage

wik command ...

Normally wik assumes that the wiki is in the current directory. If that is not the case you can run it as:

Primary Commands

wik init

Initialize a wiki in the current directory. It will prompt you for information it needs.

You can initialize a wiki by ...

• Using an existing TiddlyWiki
• Using an existing set of text (.txt) files.
• Creating a brand new wiki, with your choice of storage formats:
  • Text files
  • A TiddlyWiki
  • An SQLite database
• You can read more about these options at WhichFormat?

The wiki will be populated with a default set of items to help you get started.

The configuration is saved to .wik/conf in each wiki directory, should you wish to adjust it later. It is a plain text file.

wik serve

Start a standalone server to provide your content over HTTP with full multiuser editing.

For example, to serve content from /usr/doc/mywiki:

wik -d /usr/doc/mywiki serve

You would then view your wiki through http://localhost:8000
(Using the default server parameters as an example.)

To serve behind Apache, instead of as a standalone server, see BehindApache.

wik render

Render the wiki to a static set of HTML files. This is useful especially if you want to edit your wiki locally (through wik serve) and place the final set of HTML files on a webserver.

wik gui

Launch the GUI "command center". This is a GUI tool that lets you easily manage your locally stored wikis. (This is also the default command if you run wik.exe or wikgui.exe with no arguments.)

Secondary Commands

wik ls

List the contents of the wiki.

wik skip

Interactively edit the list of items that will not be rendered.

wik clean

Remove all generated files and clear out the cache.

wik cache

Interactively edit the list of items that will not be cached.

wik conv

Convert underlying wiki storage to another format. You can freely convert between any of the supported types.

Caveat

When you convert to the TiddlyWiki format, the markup style of your content will changed to TiddlyWiki (since this is the only markup style that a native TiddlyWiki supports). This may alter the presentation of your content somewhat. When converting from a TiddlyWiki, the content type will be left as TiddlyWiki.

Converting to/from a text or SQLite wiki will not alter the content type.

wik makeboot

Add a small bootstrap file to your wiki to help in running BehindApache.

wik trustall

Useful when importing an existing TiddlyWiki. Creates (non-login) accounts for all existing authors and marks them as trusted users. (So that their content will render in full mode instead of safe mode.)

blog comments powered by Disqus