X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/f0d7a5ee1a9fe6ea28b63544904e5126faad12ec..851106585246c183e33c6bf9bce01443cd55115c:/doc/setup.mdwn

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index df553cfb3..29ce068b8 100644
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -7,7 +7,9 @@ optional support for commits from the web.
 		apt-get install ikiwiki # soon
 
    Ikiwiki requires [[MarkDown]] be installed, and also uses the following
-   perl modules: `CGI::Session` `CGI::FormBuilder` `HTML::Template`
+   perl modules: `CGI::Session` `CGI::FormBuilder` (version 3.02.02 or
+   newer) `HTML::Template` `Mail::SendMail` `Time::Duration` `Date::Parse`
+   (libtimedate-perl)
 
 2. Create the subversion repository for your wiki.
 
@@ -18,27 +20,29 @@ optional support for commits from the web.
 
 		svn co file:///svn/wikirepo/trunk ~/wikiwc
 
-4. Create some files and add them into subversion. Or you might copy the
-   files from /usr/share/ikiwiki/basewiki and check those in to get a
-   head start on creating your wiki.
+4. Build your wiki for the first time.
 
-		echo "Welcome to my empty wiki." > ~/wikiwc/index.mdwn
-		echo "Feel free to edit this page" > ~/wikiwc/sandbox.mdwn
-		svn add ~/wikiwc/*.mdwn
-		svn commit ~/wikiwc -m add
+		ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
+			--url=http://host/~you/wiki/
 
-5. Build your wiki for the first time.
+   Replace the url with the real url to your wiki. You should now
+   be able to visit the url and see your wiki.
 
-		ikiwiki --verbose ~/wikiwc/ \
-                  /usr/share/ikiwiki/templates ~/public_html/wiki/ \
-                  --url=http://host/~you/wiki/
+5. Customise your wiki. The files in `/usr/share/ikiwiki/basewiki/` are
+   used if you don't have a custom version, so let's start by making a
+   custom version of the wiki's index page:
 
-   Replace the url with the right url to your wiki. You should now
-   be able to visit the url and see your page that you created earlier.
+   		cp /usr/share/ikiwiki/basewiki/index.mdwn ~/wikiwc
+		svn add ~/wikiwc/index.mdwn
+		$EDITOR ~/wikiwc/index.mdwn
+		svn commit ~/wikiwc/index.mdwn -m customised
+
+   You can also add any files you like from scratch of course.
 
 6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
    the wiki. You can play around with other ikiwiki parameters such as
-   --wikiname too. Get confortable with its command line.
+   `--wikiname` and `--rebuild` too. Get comfortable with its command line
+   (see [[usage]]).
 
 7. By now you should be getting tired of typing in all the command line
    options each time you change something in your wiki's setup. And it's
@@ -49,8 +53,8 @@ optional support for commits from the web.
    `doc/ikiwiki.setup` in the ikiwiki sources), and edit it. 
    
    Most of the options, like `wikiname` in the setup file are the same as
-   ikiwiki's command line options (documented in [[usage]]. `srcdir`,
-   `templatedir` and `destdir` are the three directories you specify when
+   ikiwiki's command line options (documented in [[usage]]. `srcdir`
+   and `destdir` are the two directories you specify when
    running ikiwiki by hand. `svnrepo` is the path to your subversion 
    repository. Make sure that all of these are pointing to the right
    directories, and read through and configure the rest of the file to your
@@ -71,10 +75,10 @@ optional support for commits from the web.
 9. Add [[PageHistory]] links to the top of pages. This requires you to have
    setup [[ViewCVS]] or something similar to access your [[Subversion]]
    repository.  The `historyurl` setting makes ikiwiki add the links, and 
-   in that url, "[[]]" is replaced with the name of the file to view. So
+   in that url, "\[[file]]" is replaced with the name of the file to view. So
    edit ikiwiki.setup and set `historyurl` to something like this:
 
-   	`http://svn.host/trunk/[[]]?root=wiki`
+   	`http://svn.host/trunk/\[[file]]?root=wiki`
    
    Then run `ikiwiki --setup ikiwiki.setup` again.