foo

[git.ikiwiki.info.git] / doc / setup.mdwn

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 1e2eee72e8953dcfd6d86d054a117e46884c2082..7e4aaecf9465cab258b8827365c04a17e52a7c21 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,13 +1,8 @@
-So you want to set up your own wiki using ikiwiki? This turorial will walk
+So you want to set up your own wiki using ikiwiki? This tutorial will walk

 you through setting up a wiki that is stored in [[Subversion]] and that has
 optional support for commits from the web.
 
 you through setting up a wiki that is stored in [[Subversion]] and that has
 optional support for commits from the web.
 

-1. [[Install]] ikiwiki.
-
-               apt-get install ikiwiki # soon
-
-   Ikiwiki requires [[MarkDown]] be installed, and also uses the following
-   perl modules: `CGI::Session` `CGI::FormBuilder` `HTML::Template`
+1. [[Install]] ikiwiki. See [[download]] for where to get it.

 
 2. Create the subversion repository for your wiki.
 
 
 2. Create the subversion repository for your wiki.
 


@@ -18,23 +13,24 @@ optional support for commits from the web.
 
                svn co file:///svn/wikirepo/trunk ~/wikiwc
 
 
                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.
+
+               ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
+                       --url=http://host/~you/wiki/

 
 

-               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
+   Replace the url with the real url to your wiki. You should now
+   be able to visit the url and see your wiki.

 
 

-5. Build your wiki for the first time.
+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:

 
 

-               ikiwiki --verbose ~/wikiwc/ \
-                  /usr/share/ikiwiki/templates ~/public_html/wiki/ \
-                  --url=http://host/~you/wiki/
+               cp /usr/share/ikiwiki/basewiki/index.mdwn ~/wikiwc
+               svn add ~/wikiwc/index.mdwn
+               $EDITOR ~/wikiwc/index.mdwn
+               svn commit ~/wikiwc/index.mdwn -m customised

 
 

-   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.
+   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
 
 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


@@ -50,8 +46,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
    `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
    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


@@ -72,10 +68,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 
 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:
 
    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.
 
    
    Then run `ikiwiki --setup ikiwiki.setup` again.