aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-09-04 06:15:54 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-09-04 06:15:54 +0000
commit99d52a1794f25ee2efc7a580e8e9bc8819811bd9 (patch)
tree24ebb1b465bca20923cf908790c7d4a14d2726a1 /doc
parent44c8d863398565860b2f94bbaa28f057a5199565 (diff)
downloadikiwiki-99d52a1794f25ee2efc7a580e8e9bc8819811bd9.tar
ikiwiki-99d52a1794f25ee2efc7a580e8e9bc8819811bd9.tar.gz
* Add support for tla, contributed by Clint Adama. Closes: #385936
Diffstat (limited to 'doc')
-rw-r--r--doc/features.mdwn6
-rw-r--r--doc/ikiwiki.setup5
-rw-r--r--doc/index.mdwn2
-rw-r--r--doc/install.mdwn2
-rw-r--r--doc/roadmap.mdwn2
-rw-r--r--doc/setup.mdwn20
-rw-r--r--doc/todo/tla.mdwn2
7 files changed, 32 insertions, 7 deletions
diff --git a/doc/features.mdwn b/doc/features.mdwn
index 2b06a7917..d5fa4026b 100644
--- a/doc/features.mdwn
+++ b/doc/features.mdwn
@@ -10,9 +10,9 @@ that are not possible with a standard wiki.
Instead of editing pages in a stupid web form, you can use vim and commit
changes via svn. Or work disconnected using svk and push your changes out
-when you come online. Or use git to work in a distributed fashion all the
-time. (It's also possible to [[plugins/write]] a plugin to support other
-systems.)
+when you come online. Or use git or tla to work in a distributed fashion
+all the time. (It's also possible to [[plugins/write]] a plugin to support
+other systems.)
ikiwiki can be run from a [[post-commit]] hook to update your wiki
immediately whenever you commit.
diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index ee5e394be..95d2d46af 100644
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -30,6 +30,11 @@ use IkiWiki::Setup::Standard {
#historyurl => "http://git.host/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
#diffurl => "http://git.host/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
+ # Tla stuff.
+ #rcs => "tla"
+ #historyurl => ??,
+ #diffurl => ??,
+
wrappers => [
#{
# # The cgi wrapper.
diff --git a/doc/index.mdwn b/doc/index.mdwn
index 8f3911bd9..67f099210 100644
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -2,7 +2,7 @@
ikiwiki is a **wiki compiler**. It converts wiki pages
into html pages suitable for publishing on a website. Unlike a traditional
wiki, ikiwiki does not have its own means of storing page history.
-Instead it can use [[Subversion]] (or [[Git]]).
+Instead it can use [[Subversion]] (or [[Git]] or [[tla]]).
* [[News]] is a blog (built using ikiwiki) of news items about ikiwiki.
It's the best way to find out when there's a new version to [[Download]].
diff --git a/doc/install.mdwn b/doc/install.mdwn
index 029323ada..575598546 100644
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -9,6 +9,8 @@ installed, and also uses the following perl modules if available:
`HTML::Template` `Mail::Sendmail` `Time::Duration` `Date::Parse`,
`HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`.
+The [[tla]] support also needs the `MailTools` perl module.
+
Various [[plugins]] use other libraries and utlities; see their individual
documentation for details.
diff --git a/doc/roadmap.mdwn b/doc/roadmap.mdwn
index 2cbf6dd1c..4bd9ab671 100644
--- a/doc/roadmap.mdwn
+++ b/doc/roadmap.mdwn
@@ -24,7 +24,7 @@ Released 29 April 2006.
* Improved scalable [[logo]]. _(status: done)_
* Support for at least one RCS aside from svn. Once it supports two, it should
quickly grow to support them all.. See [[about_rcs_backends]]
- _(status: supports git in tree)_
+ _(status: supports git and tla in tree)_
* Support for one other markup language, probably restructured text.
_(status: done, but the rst plugin needs improvement)_
* No serious known [[bugs]]
diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index eef068dae..b3620fb3c 100644
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -1,6 +1,6 @@
So you want to set up your own wiki using ikiwiki? This tutorial will walk
-you through setting up a wiki that is stored in [[Subversion]] or [[Git]],
-and that has optional support for commits from the web.
+you through setting up a wiki that is stored in [[Subversion]], [[Git]], or
+[[TLA]], and that has optional support for commits from the web.
1. [[Install]] ikiwiki. See [[download]] for where to get it.
@@ -19,6 +19,11 @@ and that has optional support for commits from the web.
git add .
git commit -m create -a
+ # TLA
+ mkdir /tla
+ tla make-archive me@localhost--wiki /tla/wikirepo
+ tla my-id "<me@localhost>"
+
3. Check out the repository to make the working copy that ikiwiki will use.
# Subversion
@@ -27,6 +32,13 @@ and that has optional support for commits from the web.
# Git
git clone /git/wikirepo ~/wikiwc
+ # TLA
+ mkdir ~/wikiwc
+ cd ~/wikiwc
+ tla archive-setup me@localhost--wiki/wiki--0
+ tla init-tree me@localhost--wiki/wiki--0
+ tla import
+
4. Build your wiki for the first time.
ikiwiki --verbose ~/wikiwc/ ~/public_html/wiki/ \
@@ -52,6 +64,10 @@ and that has optional support for commits from the web.
git commit -m customised index.mdwn
git push origin
+ # TLA
+ tla add index.mdwn
+ tla commit
+
You can also add any files you like from scratch of course.
6. Repeat steps 4 and 5 as desired, editing or adding pages and rebuilding
diff --git a/doc/todo/tla.mdwn b/doc/todo/tla.mdwn
new file mode 100644
index 000000000..3cca686a4
--- /dev/null
+++ b/doc/todo/tla.mdwn
@@ -0,0 +1,2 @@
+* Need to get post commit hook code working.
+* Need some example urls for web based diffs.