editpage, comment: Clean up title when editing or creating a page or comment.

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

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 6382c06b22a3cce4f71cf4fd71b52ab21dbe385d..40581eb725bff0e41a58482fd6606bd929693502 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -22,6 +22,8 @@ Or, set up a blog with ikiwiki, run this command instead.
 
        % ikiwiki -setup /etc/ikiwiki/auto-blog.setup
 
 
        % ikiwiki -setup /etc/ikiwiki/auto-blog.setup
 

+`librpc-xml-perl` and `python-docutils` dependencies are needed.
+

 Either way, it will ask you a couple of questions.
 
        What will the wiki be named? foo
 Either way, it will ask you a couple of questions.
 
        What will the wiki be named? foo


@@ -47,8 +49,7 @@ Now you can go to the url it told you, and edit pages in your new wiki
 using the web interface.
 
 (If the web interface doesn't seem to allow editing or login, you may
 using the web interface.
 
 (If the web interface doesn't seem to allow editing or login, you may

-need to configure [[apache|tips/apache_cgi]] or 
-[[lighttpd|tips/lighttpd_cgi]].)
+need to [[configure_the_web_server|tips/dot_cgi]].)

 
 ## Checkout and edit wiki source
 
 
 ## Checkout and edit wiki source
 


@@ -66,8 +67,10 @@ source. (Remember to replace "foo" with the real directory name.)
 
        git clone foo.git foo.src
        svn checkout file://`pwd`/foo.svn/trunk foo.src
 
        git clone foo.git foo.src
        svn checkout file://`pwd`/foo.svn/trunk foo.src

+       cvs -d `pwd`/foo get -P ikiwiki

        bzr clone foo foo.src
        hg clone foo foo.src
        bzr clone foo foo.src
        hg clone foo foo.src

+       darcs get foo.darcs foo.src

        # TODO monotone, tla
 
 Now to edit pages by hand, go into the directory you checked out (ie,
        # TODO monotone, tla
 
 Now to edit pages by hand, go into the directory you checked out (ie,


@@ -89,7 +92,7 @@ These range from changing the wiki's name, to enabling [[plugins]],
 to banning users and locking pages.
 
 If you log in as the admin user you configured earlier, and go to
 to banning users and locking pages.
 
 If you log in as the admin user you configured earlier, and go to

-your Preferences page, you can click on "Wiki Setup" to customize many
+your Preferences page, you can click on "Setup" to customize many

 wiki settings and plugins.
 
 Some settings cannot be configured on the web, for security reasons or
 wiki settings and plugins.
 
 Some settings cannot be configured on the web, for security reasons or


@@ -102,6 +105,12 @@ After making changes to this file, you need to tell ikiwiki to use it:
 
        % ikiwiki -setup foo.setup
 
 
        % ikiwiki -setup foo.setup
 

+Alternatively, you can ask ikiwiki to change settings in the file for you:
+
+       % ikiwiki -changesetup foo.setup -plugin goodstuff
+
+See [[usage]] for more options.
+

 ## Customizing file locations
 
 As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
 ## Customizing file locations
 
 As a wiki compiler, ikiwiki builds a wiki from files in a source directory,


@@ -111,26 +120,24 @@ a working copy checked out from the version control system repository.
 When you used `auto.setup`, ikiwiki put the source directory, destination
 directory, and repository in your home directory, and told you the location
 of each. Those locations were chosen to work without customization, but you
 When you used `auto.setup`, ikiwiki put the source directory, destination
 directory, and repository in your home directory, and told you the location
 of each. Those locations were chosen to work without customization, but you

-might want to move them to different directories. There are three steps to
-this process.
-
-1. Move the destination directory and repository around.
-
->      % mv public_html/foo /srv/web/foo.com
->      % mv foo.git /srv/git/foo.git
-
-2. Create a new source directory checkout. If you moved the repository
-   to a new location, checkouts pointing at the old location won't work,
-   and the easiest way to deal with this is to delete them and re-checkout
-   from the new repository location.
-
->      % rm -rf foo
->      % git clone /src/git/foo.git
-
-3. Edit the setup file. Modify the settings for `srcdir`, `destdir`,
-   `url`, `cgiurl`, `cgi_wrapper`, `git_wrapper`, etc to reflect where
-   you moved things. Remember to run `ikiwiki -setup` after editing the
-   setup file.
+might want to move them to different directories.
+
+First, move the destination directory and repository around.
+   
+       % mv public_html/foo /srv/web/foo.com
+       % mv foo.git /srv/git/foo.git
+
+If you moved the repository to a new location, checkouts pointing at the
+old location won't work, and the easiest way to deal with this is to delete
+them and re-checkout from the new repository location.
+   
+       % rm -rf foo
+       % git clone /srv/git/foo.git
+
+Finally, edit the setup file. Modify the settings for `srcdir`, `destdir`,
+`url`, `cgiurl`, `cgi_wrapper`, `git_wrapper`, etc to reflect where
+you moved things. Remember to run `ikiwiki -setup` after editing the
+setup file.

 
 ## Enjoy your new wiki!
 
 
 ## Enjoy your new wiki!