web commit by JeremyReed: new topic: install selected docs?

[ikiwiki.git] / doc / setup.mdwn

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index a598ef71678801a0175a78522c6794e227b9bc0e..8e5653442e21265e75beca467ad1cd3dd8504b25 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -34,14 +34,14 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
                        All wikis are supposed to have a [[SandBox]],
                        so this one does too.
                        ----
                        All wikis are supposed to have a [[SandBox]],
                        so this one does too.
                        ----

-                       This wiki is powered by [ikiwiki](http://ikiwiki.kitenet.net).
+                       This wiki is powered by [ikiwiki](http://ikiwiki.info).

    """]]
    
    See [[HelpOnFormatting]] for details about the markup language.
 
    """]]
    
    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.
 
 
 4. Build your wiki for the first time.
 


@@ -66,7 +66,9 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    introduce setup files.
    
    A sample setup file is [[ikiwiki.setup]]. Download it (or copy it from
    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
    
    Most of the options, like `wikiname` in the setup file are the same as
    ikiwiki's command line options (documented in [[usage]]. `srcdir` and


@@ -152,6 +154,32 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
                        hg commit -m "initial import"
    """]]
 
                        hg commit -m "initial import"
    """]]
 

+   [[toggle id=monotone text="Monotone"]]
+   [[toggleable id=montone 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
+                       BRANCH=com.company.wikiname
+                       # 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 db init --db=$REPOSITORY
+                       mv $SRCDIR $SRCDIR-old
+                       cd $SRCDIR-old
+                       echo ".ikiwiki" > $SRCDIR-old/.mtn-ignore
+                       mtn --db=$REPOSITORY --branch=$BRANCH import . -m "initial import"
+                       cd ..
+                       mtn --db=$REPOSITORY --branch=$BRANCH checkout $SRCDIR
+                       mv $SRCDIR-old/.ikiwiki $SRCDIR
+                       cat << EOF > $SRCDIR/_MTN/monotonerc
+                       function get_passphrase (branchname)
+                           return "wikiKeyPass"
+                       end
+                       EOF
+                       rm -r $SRCDIR-old
+   """]]
+

 9. Configure ikiwiki to use revision control.
 
    Once your wiki is checked in to the revision control system,
 9. Configure ikiwiki to use revision control.
 
    Once your wiki is checked in to the revision control system,


@@ -168,4 +196,5 @@ This tutorial will walk you through setting up a wiki with ikiwiki.
    And in the web interface, RecentChanges should work, and files changed
    by web users will also be committed using revision control.
 
    And in the web interface, RecentChanges should work, and files changed
    by web users will also be committed using revision control.
 

-10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]].
+10. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]. And check out
+    [[tips]] to find out how to get more out of ikiwiki.