]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/setup.mdwn
note that format of historyurl changed too..
[ikiwiki.git] / doc / setup.mdwn
index cc830c0b965f06063fa6d3b1702e2dcf326bb7e3..44e60ae973bb04331584dc759a513888c0b5b56e 100644 (file)
@@ -18,7 +18,9 @@ optional support for commits from the web.
 
                svn co file:///svn/wikirepo/trunk ~/wikiwc
 
-4. Create some files and add them into subversion.
+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.
 
                echo "Welcome to my empty wiki." > ~/wikiwc/index.mdwn
                echo "Feel free to edit this page" > ~/wikiwc/sandbox.mdwn
@@ -28,7 +30,7 @@ optional support for commits from the web.
 5. Build your wiki for the first time.
 
                ikiwiki --verbose ~/wikiwc/ \
-                  /usr/lib/ikiwiki/templates ~/public_html/wiki/ \
+                  /usr/share/ikiwiki/templates ~/public_html/wiki/ \
                   --url=http://host/~you/wiki/
 
    Replace the url with the right url to your wiki. You should now
@@ -36,7 +38,8 @@ optional support for commits from the web.
 
 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
@@ -54,24 +57,25 @@ optional support for commits from the web.
    directories, and read through and configure the rest of the file to your
    liking.
 
-   Note that the default file will enable a [[post-commit]] hook to
-   update the wiki, but has cgi support turned off.
+   Note that the default file has a block to configure a svn wrapper. This
+   sets up a [[post-commit]] hook to update the wiki.
 
-   When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it will
-   generate the subversion [[post-commit]] hook and update your wiki.
+   When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
+   will set everything up and update your wiki.
 
 8. Set up [[CGI]] to allow editing the wiki from the web.
 
-   Just edit ikiwiki.setup, change cgiwrapper to 1, and optioanlly anonok
-   to 1, run `ikiwiki --setup ikiwiki.setup`, and you're done!
+   Just edit ikiwiki.setup, uncomment the block for the cgi wrapper, make
+   sure the filename for the cgi wrapper is ok, run 
+   `ikiwiki --setup ikiwiki.setup`, and you're done!
 
 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.