add example wrapper and fix formatting

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

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 6aabf53db83f482ac4f391c58acc85fe1fa54a5f..5657111115bb9ccd803a7a3a690f745ae5d53784 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,9 +1,12 @@
 This tutorial will walk you through setting up a wiki with ikiwiki.
 
 This tutorial will walk you through setting up a wiki with ikiwiki.
 

-[[toc ]]
+[[!toc ]]

 
 ## [[Download]] and [[install]] ikiwiki.
 
 
 ## [[Download]] and [[install]] ikiwiki.
 

+If you're using Debian or Ubuntu, ikiwiki is an `apt-get install ikiwiki` away.
+If you're not, see the [[download]] and [[install]] pages.
+

 ## Decide where your wiki's files will go.
 
 As a wiki compiler, ikiwiki builds a wiki from files in a source directory,
 ## Decide where your wiki's files will go.
 
 As a wiki compiler, ikiwiki builds a wiki from files in a source directory,


@@ -29,8 +32,8 @@ This will create a simple main page for the wiki.
        $EDITOR index.mdwn
 
 In the editor, you could start by entering a simple page like
        $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="""
+[[!toggle id=page text="this one"]].
+[[!toggleable id=page text="""

        Welcome to your new wiki.
 
        All wikis are supposed to have a \[[SandBox]],
        Welcome to your new wiki.
 
        All wikis are supposed to have a \[[SandBox]],


@@ -71,11 +74,16 @@ and `--rebuild` too. Get comfortable with its command line (see
 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.
 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. 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.
+
+To generate a setup file, use `ikiwiki --dumpsetup`. You can pass
+all the options have you been including at the command line, and they
+will be stored in the setup file.
+
+       ikiwiki $SRCDIR $DESTDIR --url=http://example.org/~you/wiki/ --dumpsetup ikiwiki.setup
+
+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
    
 Most of the options, like `wikiname` in the setup file are the same as
 ikiwiki's command line options (documented in [[usage]]. `srcdir` and


@@ -88,7 +96,7 @@ will set everything up.
 
 ## Turn on additional features.
 
 
 ## Turn on additional features.
 

-Now you have a basic wiki with a configuration file. Time to experiment
+Now you have a basic wiki with a setup file. Time to experiment

 with ikiwiki's many features. 
    
 Let's first enable a key wiki feature and set up [[CGI]] to allow
 with ikiwiki's many features. 
    
 Let's first enable a key wiki feature and set up [[CGI]] to allow


@@ -110,17 +118,17 @@ on the revision control system you choose, the way this is done varies.
 Note that the .ikiwiki subdirectory is where ikiwiki keeps its state, and
 should be preserved, but not checked into revision control.
 
 Note that the .ikiwiki subdirectory is where ikiwiki keeps its state, and
 should be preserved, but not checked into revision control.
 

-The new [[ikiwiki-makerepo]] command automates setting up a wiki in
+The [[ikiwiki-makerepo]] command automates setting up a wiki in

 revision control.
 
 revision control.
 

-[[toggle id=subversion text="Subversion"]]
-[[toggleable id=subversion text="""
+[[!toggle id=subversion text="Subversion"]]
+[[!toggleable id=subversion text="""

        REPOSITORY=~/wikirepo
        ikiwiki-makerepo svn $SRCDIR $REPOSITORY
 """]]
 
        REPOSITORY=~/wikirepo
        ikiwiki-makerepo svn $SRCDIR $REPOSITORY
 """]]
 

-[[toggle id=git text="Git"]]
-[[toggleable id=git text="""
+[[!toggle id=git text="Git"]]
+[[!toggleable id=git text="""

        REPOSITORY=~/wiki.git
        ikiwiki-makerepo git $SRCDIR $REPOSITORY
 
        REPOSITORY=~/wiki.git
        ikiwiki-makerepo git $SRCDIR $REPOSITORY
 


@@ -129,20 +137,20 @@ ikiwiki uses git repositories, and some important caveats
 about using the git repositories.
 """]]
 
 about using the git repositories.
 """]]
 

-[[toggle id=mercurial text="Mercurial"]]
-[[toggleable id=mercurial text="""
+[[!toggle id=mercurial text="Mercurial"]]
+[[!toggleable id=mercurial text="""

        REPOSITORY=$SRCDIR
        ikiwiki-makerepo mercurial $SRCDIR
 """]]
 
        REPOSITORY=$SRCDIR
        ikiwiki-makerepo mercurial $SRCDIR
 """]]
 

-[[toggle id=bazaar text="Bazaar"]]
-[[toggleable id=bazaar text="""
+[[!toggle id=bazaar text="Bazaar"]]
+[[!toggleable id=bazaar text="""

        REPOSITORY=$SRCDIR
        ikiwiki-makerepo bzr $SRCDIR
 """]]
 
        REPOSITORY=$SRCDIR
        ikiwiki-makerepo bzr $SRCDIR
 """]]
 

-[[toggle id=tla text="TLA"]]
-[[toggleable id=tla text="""
+[[!toggle id=tla text="TLA"]]
+[[!toggleable id=tla text="""

        REPOSITORY=~/wikirepo
        tla make-archive me@localhost--wiki $REPOSITORY
        tla my-id "<me@localhost>"
        REPOSITORY=~/wikirepo
        tla make-archive me@localhost--wiki $REPOSITORY
        tla my-id "<me@localhost>"


@@ -155,8 +163,8 @@ about using the git repositories.
        tla import
 """]]
 
        tla import
 """]]
 

-[[toggle id=monotone text="Monotone"]]
-[[toggleable id=monotone text="""
+[[!toggle id=monotone text="Monotone"]]
+[[!toggleable id=monotone text="""

        # These instructions are standard instructions to import a directory into monotone
        # and set it up so that you don't need any passwords to use it
        REPOSITORY=~/.ikiwiki/mtn.db
        # These instructions are standard instructions to import a directory into monotone
        # and set it up so that you don't need any passwords to use it
        REPOSITORY=~/.ikiwiki/mtn.db


@@ -164,7 +172,7 @@ about using the git repositories.
        # remember the password you use in the next step and
        # substitute it for 'wikiKeyPass' in the get_passphrase() hook below
        # note the you should never generate two monotone keys with the same name
        # remember the password you use in the next step and
        # substitute it for 'wikiKeyPass' in the get_passphrase() hook below
        # note the you should never generate two monotone keys with the same name

-       mtn genkey web@machine.company.com
+       mtn genkey web@example.com

        mtn db init --db=$REPOSITORY
        mv $SRCDIR $SRCDIR-old
        cd $SRCDIR-old
        mtn db init --db=$REPOSITORY
        mv $SRCDIR $SRCDIR-old
        cd $SRCDIR-old