releasing version 2.31.1

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

diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index 1e84120c084b93371a5443274776f81940899dce..9d7aecabdf26bb53b27794fe5056217cffe84146 100644 (file)
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,8 +1,10 @@
 This tutorial will walk you through setting up a wiki with ikiwiki.
 
 This tutorial will walk you through setting up a wiki with ikiwiki.
 

-### 1. [[Download]] and [[install]] ikiwiki.
+[[toc ]]

 
 

-### 2. Decide where your wiki's files will go.
+## [[Download]] and [[install]] ikiwiki.
+
+## 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.  If you keep your wiki in
 
 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


@@ -18,7 +20,7 @@ for these locations, and use those variables in the commands that follow.
 Note that ikiwiki owns the working copy directory; do not perform your own
 edits in ikiwiki's working copy.
 
 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.
+## Create the beginnings of your wiki.

 
 This will create a simple main page for the wiki.
 
 
 This will create a simple main page for the wiki.
 


@@ -39,23 +41,22 @@ In the editor, you could start by entering a simple page like
        This wiki is powered by [ikiwiki](http://ikiwiki.info).
 """]]
    
        This wiki is powered by [ikiwiki](http://ikiwiki.info).
 """]]
    

-See [[HelpOnFormatting]] for details about the markup language.
+See [[ikiwiki/formatting]] for details about the markup language.

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

 
        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.
 
 
        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. Add content to your wiki.
+## Add content to your wiki.

 
 

-Repeat steps 3 and 4 as desired, editing or adding pages and rebuilding the
-wiki.
+Continue editing or adding pages and rebuilding 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
    
 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


@@ -65,7 +66,7 @@ You can experiment with other ikiwiki parameters such as `--wikiname`
 and `--rebuild` too. Get comfortable with its command line (see
 [[usage]]).
 
 and `--rebuild` too. Get comfortable with its command line (see
 [[usage]]).
 

-### 6. Add a setup file.
+## Add a setup file.

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


@@ -85,7 +86,7 @@ read through and configure the rest of the file to your liking.
 When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
 will set everything up.
 
 When you're satisfied, run `ikiwiki --setup ikiwiki.setup`, and it
 will set everything up.
 

-### 7. Turn on additional features.
+## Turn on additional features.

 
 Now you have a basic wiki with a configuration file. Time to experiment
 with ikiwiki's many features. 
 
 Now you have a basic wiki with a configuration file. Time to experiment
 with ikiwiki's many features. 


@@ -100,62 +101,44 @@ can uncomment, configure, and enable by re-running
 `ikiwiki --setup ikiwiki.setup`. Be sure to browse through all the
 [[plugins]]..
 
 `ikiwiki --setup ikiwiki.setup`. Be sure to browse through all the
 [[plugins]]..
 

-### 8. Put your wiki in revision control.
+## Put your wiki in revision control.

 
 At this point you might want to check your wiki in to a revision control
 system so you can keep track of changes and revert edits. Depending
 on the revision control system you choose, the way this is done varies.
 
 
 At this point you might want to check your wiki in to a revision control
 system so you can keep track of changes and revert edits. Depending
 on the revision control system you choose, the way this is done varies.
 

-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 that ikiwiki supports. 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
+revision control.

 
 [[toggle id=subversion text="Subversion"]]
 [[toggleable id=subversion text="""
        REPOSITORY=~/wikirepo
 
 [[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"
+       ikiwiki-makerepo svn $SRCDIR $REPOSITORY

 """]]
 
 [[toggle id=git text="Git"]]
 [[toggleable id=git text="""
 """]]
 
 [[toggle id=git text="Git"]]
 [[toggleable id=git text="""

-When using Git, you probably want to set up two repositories, of which
-one should be bare (meaning that it does not have a working tree
-checked out). We call the bare repository the "repository" and the
-other will be the "srcdir" (which `ikiwiki` uses to compile the wiki).
-There are [other
-ways](http://blog.madduck.net/vcs/2007.07.11_publishing-git-repositories)
-to do the following, but this might be easiest:
-

        REPOSITORY=~/wiki.git
        REPOSITORY=~/wiki.git

-       GIT_DIR=$REPOSITORY git --bare init --shared
-       cd $SRCDIR
-       git init
-       echo /.ikiwiki > .gitignore
-       git add .
-       git commit -m "initial commit"
-       git remote add origin $REPOSITORY
-       git config branch.master.merge refs/heads/master
-       git push --all
-
-It is **paramount** that you **never** push to the Git repository in
-`$SRCDIR` ([this FAQ entry explains
-why](http://git.or.cz/gitwiki/GitFaq#head-b6a3d85f677763313159eb39f7dbf4579d4ee28b)).
-Instead, if you want to work on the wiki from a remote machine, clone
-`$REPOSITORY`, using either the `git` transport (if available), or
-`ssh`.
-
-If at any point you commit changes in `$SRCDIR`, make sure to `git
-push` them to the `$REPOSITORY`. ikiwiki will do this automatically
-for any changes made via the web.
-
-Finally, see [[Git_pitfalls]] if you experience problems.
+       ikiwiki-makerepo git $SRCDIR $REPOSITORY
+
+Please see [[rcs/git]] for detailed documentation about how
+ikiwiki uses git repositories, and some important caveats
+about using the git repositories.
+"""]]
+
+[[toggle id=mercurial text="Mercurial"]]
+[[toggleable id=mercurial text="""
+       REPOSITORY=$SRCDIR
+       ikiwiki-makerepo mercurial $SRCDIR
+"""]]
+
+[[toggle id=mercurial text="Bazaar"]]
+[[toggleable id=bazaar text="""
+       REPOSITORY=$SRCDIR
+       ikiwiki-makerepo bzr $SRCDIR

 """]]
 
 [[toggle id=tla text="TLA"]]
 """]]
 
 [[toggle id=tla text="TLA"]]


@@ -172,15 +155,6 @@ Finally, see [[Git_pitfalls]] if you experience problems.
        tla import
 """]]
 
        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"
-"""]]
-

 [[toggle id=monotone text="Monotone"]]
 [[toggleable id=monotone text="""
        # These instructions are standard instructions to import a directory into monotone
 [[toggle id=monotone text="Monotone"]]
 [[toggleable id=monotone text="""
        # These instructions are standard instructions to import a directory into monotone


@@ -207,13 +181,12 @@ Finally, see [[Git_pitfalls]] if you experience problems.
        rm -r $SRCDIR-old
 """]]
 
        rm -r $SRCDIR-old
 """]]
 

-### 9. Configure ikiwiki to use revision control.
+## Configure ikiwiki to use revision control.

 
 Once your wiki is checked in to the revision control system,
 you should configure ikiwiki to use revision control. Edit your
 ikiwiki.setup, and uncomment the lines for the revision control system
 
 Once your wiki is checked in to the revision control system,
 you should configure ikiwiki to use revision control. Edit your
 ikiwiki.setup, and uncomment the lines for the revision control system

-you chose to use. Be sure to set `svnrepo` to $REPOSITORY, if using
-subversion. Uncomment the block for the wrapper for your revision
+you chose to use. Uncomment the block for the wrapper for your revision

 control system, and configure the wrapper path in that block
 appropriately (for Git, it should be `$REPOSITORY/hooks/post-update`).
 
 control system, and configure the wrapper path in that block
 appropriately (for Git, it should be `$REPOSITORY/hooks/post-update`).
 


@@ -223,7 +196,7 @@ control system to commit them, and the wiki will automatically update.
 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!
+## Enjoy your new wiki!

 
 Add yourself to [[IkiWikiUsers]]. And check out
 the [[tips]] to find out how to get more out of ikiwiki.
 
 Add yourself to [[IkiWikiUsers]]. And check out
 the [[tips]] to find out how to get more out of ikiwiki.