X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/c03adfbaeeb26ebb3f65bd916446555c63b8d8b1..b0ce62eb2cd5667f532c70d466c95c9bebe9fd38:/doc/setup.mdwn?ds=inline

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 5332555f1..3c7230f20 100644
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,57 +1,74 @@
 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.
 
-		SRCDIR=~/wikiwc
-		DESTDIR=~/public_html/wiki/
+			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.
 
-   		mkdir $SRCDIR
-		cd $SRCDIR
-		$EDITOR index.mdwn
-
-   In the editor, you could start by entering a simple page like this one:
-
-		Welcome to your new wiki.
-		All wikis are supposed to have a [[SandBox]], so this one does too.
-		----
-		This wiki is powered by [ikiwiki](http://ikiwiki.kitenet.net).
+   			mkdir $SRCDIR
+			cd $SRCDIR
+			$EDITOR index.mdwn
 
+   In the editor, you could start by entering a simple page like 
+   [[toggle id=page text="this one"]].
+   
+   [[toggleable id=page text="""
+   			Welcome to your new wiki.
+	   		All wikis are supposed to have a [[SandBox]],
+	   		so this one does too.
+	   		----
+	   		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.
 
 5. Repeat steps 3 and 4 as desired, editing or adding pages and rebuilding
-   the wiki. You can play around with other ikiwiki parameters such as
-   `--wikiname` and `--rebuild` too. Get comfortable with its command line
-   (see [[usage]]).
+   the wiki. 
+   
+   To quickly get started on a common task like blogging with ikiwiki, you
+   can copy in files from the [[examples]]. The examples are located in
+   `doc/examples/` in the ikiwiki source package.
+
+   You can play around with other ikiwiki parameters such as `--wikiname`
+   and `--rebuild` too. Get comfortable with its command line (see
+   [[usage]]).
 
 6. 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. Time to
    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
@@ -85,41 +102,57 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    
    There's little that's ikiwiki specific about these instructions; this is
    just how you put a directory under revision control using the various
-   systems ikiwiki supports:
+   systems that ikiwiki supports. Note that the .ikiwiki subdirectory is
+   where ikiwiki keeps its state, and should be preserved, but not checked
+   into revision control.
+
+   [[toggle id=subversion text="Subversion"]]
+   [[toggleable id=subversion text="""
+			REPOSITORY=~/wikirepo
+			svnadmin create $REPOSITORY
+			svn mkdir file://$REPOSITORY/trunk -m "create trunk"
+			cd $SRCDIR
+			svn co file://$REPOSITORY/trunk .
+			svn add *
+			svn commit -m "initial import"
+   """]]
    
-		# Subversion
-   		REPOSITORY=~/wikirepo
-		svnadmin create $REPOSITORY
-		svn import $SRCDIR file://$REPOSITORY/trunk -m "initial import"
-		rm -rf $SRCDIR
-		svn co file://$REPOSITORY/trunk $SRCDIR
-		 
-		# Git
-   		REPOSITORY=~/wikirepo
-		mkdir $REPOSITORY
-		cd $REPOSITORY
-		git init-db
-		cp -a $SRCDIR/* .
-		git add .
-		git commit -m "initial import" -a
-		rm -rf $SRCDIR
-		git clone -l -s $REPOSITORY $SRCDIR
-
-		# TLA
-   		REPOSITORY=~/wikirepo
-		tla make-archive me@localhost--wiki $REPOSITORY
-		tla my-id "<me@localhost>"
-		cd $SRCDIR
-		tla archive-setup me@localhost--wiki/wiki--0
-		tla init-tree me@localhost--wiki/wiki--0
-	        # Edit {arch}/=tagging-method and change the precious
-		# line to add the .ikiwiki directory to the regexp.
-		tla add *
-		tla import
-
-		# Mercurial
-		REPOSITORY=$SRCDIR
-		hg init $REPOSITORY
+   [[toggle id=git text="Git"]]
+   [[toggleable id=git text="""
+   			REPOSITORY=~/wikirepo
+   			mkdir $REPOSITORY
+   			cd $REPOSITORY
+   			git init-db
+   			cp -a $SRCDIR/* .
+   			git add .
+   			git commit -m "initial import" -a
+			mv $SRCDIR/.ikiwiki .
+   			rm -rf $SRCDIR
+   			git clone -l -s $REPOSITORY $SRCDIR
+   """]]
+
+   [[toggle id=tla text="TLA"]]
+   [[toggleable id=tla text="""
+   			REPOSITORY=~/wikirepo
+   			tla make-archive me@localhost--wiki $REPOSITORY
+   			tla my-id "<me@localhost>"
+   			cd $SRCDIR
+   			tla archive-setup me@localhost--wiki/wiki--0
+   			tla init-tree me@localhost--wiki/wiki--0
+   			# Edit {arch}/=tagging-method and change the precious
+   			# line to add the .ikiwiki directory to the regexp.
+   			tla add *
+   			tla import
+   """]]
+
+   [[toggle id=mercurial text="Mercurial"]]
+   [[toggleable id=mercurial text="""
+			REPOSITORY=$SRCDIR
+			hg init $REPOSITORY
+			cd $REPOSITORY
+			hg add *
+			hg commit -m "initial import"
+   """]]
 
 9. Configure ikiwiki to use revision control.