X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/cd6234f8660c651199d636595308aec0cc221f2e..f68b0797a6535c4626ad14661ed26c89b4144129:/doc/setup.mdwn diff --git a/doc/setup.mdwn b/doc/setup.mdwn index 41c42a723..3c7230f20 100644 --- a/doc/setup.mdwn +++ b/doc/setup.mdwn @@ -1,11 +1,13 @@ This tutorial will walk you through setting up a wiki with ikiwiki. -1. [[Install]] ikiwiki. See [[download]] for where to get it. +1. [[Download]] and [[install]] ikiwiki. 2. Decide where your wiki's files will go. - As a wiki compiler, ikiwiki builds a wiki from files in a source - directory, and outputs the files to a destination directory. + As a wiki compiler, ikiwiki builds a wiki from files in a source directory, + and outputs the files to a destination directory. If you keep your wiki in + a version control system, the source directory will contain a working copy + checked out from the version control system. For the purposes of this tutorial, we'll set shell variables for these locations, and use those variables in the commands that follow. @@ -13,6 +15,9 @@ This tutorial will walk you through setting up a wiki with ikiwiki. SRCDIR=~/wikiwc DESTDIR=~/public_html/wiki/ + Note that ikiwiki owns the working copy directory; do not perform your own + edits in ikiwiki's working copy. + 3. Create the beginnings of your wiki. This will create a simple main page for the wiki. @@ -29,18 +34,18 @@ This tutorial will walk you through setting up a wiki with ikiwiki. All wikis are supposed to have a [[SandBox]], so this one does too. ---- - This wiki is powered by [ikiwiki](http://ikiwiki.kitenet.net). + This wiki is powered by [ikiwiki](http://ikiwiki.info). """]] See [[HelpOnFormatting]] for details about the markup language. - Note that several standard wiki pages will be added to your wiki, from - files in `/usr/share/ikiwiki/basewiki/`, so your wiki will automatically - get a [[SandBox]], and some other useful pages. + Note that several [[standard_wiki_pages|basewiki]] will be added to your + wiki, from files in `/usr/share/ikiwiki/basewiki/`, so your wiki will + automatically get a [[SandBox]], and some other useful pages. 4. Build your wiki for the first time. - ikiwiki --verbose $SRCDIR $DESTDIR --url=http://host/~you/wiki/ + ikiwiki --verbose $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/ Replace the url with the real url to your wiki. You should now be able to visit the url and see your wiki. @@ -61,7 +66,9 @@ This tutorial will walk you through setting up a wiki with ikiwiki. introduce setup files. A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from - `doc/ikiwiki.setup` in the ikiwiki sources), and edit it. + `doc/ikiwiki.setup` in the ikiwiki sources), and edit it. Note that this + file should *not* be put in your wiki's directory with the rest of the + files. A good place to put it is in a ~/.ikiwiki/ subdirectory. Most of the options, like `wikiname` in the setup file are the same as ikiwiki's command line options (documented in [[usage]]. `srcdir` and