summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-10-15 19:36:48 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-10-15 19:36:48 -0400
commit1f7f5d5e0e21920c5f15290cd34594ad91077071 (patch)
treea19302c57ed6ea46c4bf05a1ed8d840725643069 /doc/plugins
parent917f54a777d152ee5963acd81bf8a2800a0507b1 (diff)
parent20e691fe20ead76d826ab77501c6e9cbc7b487e8 (diff)
Merge branch 'master' into darcs
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/attachment.mdwn2
-rw-r--r--doc/plugins/contrib/gallery.mdwn1
-rw-r--r--doc/plugins/contrib/sourcehighlight.mdwn4
-rw-r--r--doc/plugins/editdiff.mdwn2
-rw-r--r--doc/plugins/edittemplate.mdwn2
-rw-r--r--doc/plugins/google.mdwn12
-rw-r--r--doc/plugins/lockedit.mdwn22
-rw-r--r--doc/plugins/orphans/discussion.mdwn11
-rw-r--r--doc/plugins/poll.mdwn2
-rw-r--r--doc/plugins/remove.mdwn2
-rw-r--r--doc/plugins/rename.mdwn2
-rw-r--r--doc/plugins/search.mdwn2
-rw-r--r--doc/plugins/type/web.mdwn1
-rw-r--r--doc/plugins/version.mdwn2
-rw-r--r--doc/plugins/websetup.mdwn2
15 files changed, 58 insertions, 11 deletions
diff --git a/doc/plugins/attachment.mdwn b/doc/plugins/attachment.mdwn
index 2aa8490ed..4fcd714f8 100644
--- a/doc/plugins/attachment.mdwn
+++ b/doc/plugins/attachment.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=attachment core=0 author="[[Joey]]"]]
-[[!tag type/useful]]
+[[!tag type/web]]
This plugin allows files to be uploaded to the wiki over the web.
diff --git a/doc/plugins/contrib/gallery.mdwn b/doc/plugins/contrib/gallery.mdwn
index ed9e17f32..7148de3ef 100644
--- a/doc/plugins/contrib/gallery.mdwn
+++ b/doc/plugins/contrib/gallery.mdwn
@@ -32,6 +32,7 @@ It uses templated named [Lightbox](http://www.hudddletogether.com).
For any feedback or query, feel free to mail me at arpitjain11 [AT] gmail.com
Additional details are available [here](http://myweb.unomaha.edu/~ajain/ikiwikigallery.html).
+> That link is broken. --[[JosephTurian]]
-- [[arpitjain]]
diff --git a/doc/plugins/contrib/sourcehighlight.mdwn b/doc/plugins/contrib/sourcehighlight.mdwn
index 0f1ab1b21..2eb22e6ed 100644
--- a/doc/plugins/contrib/sourcehighlight.mdwn
+++ b/doc/plugins/contrib/sourcehighlight.mdwn
@@ -17,4 +17,6 @@ because they both generate page working/dir/foo.
It looks to me like ikiwiki is hardcoded to strip the extension in `pagename()` (IkiWiki.pm).
This problem with sourcehighlight needs to be fixed before it is very useful.
-[[DavidBremner]]
+- Is there a way to configure the colors used by source-highlight (other than editing the globally installed "default.style" file)? It would help if I could pass the command arbitrary command-line arguments; then I could configure which config file it's supposed to use. For instance, I'm not a fan of hard-coding the colors into the HTML output. IMHO, css-style formatting should be preferred. All that can be set via the command line ... --Peter
+
+> I don't really have time right now, but it should be easy to add, if you look at how src-lang is handled. Patches are welcome :-) --[[DavidBremner]]
diff --git a/doc/plugins/editdiff.mdwn b/doc/plugins/editdiff.mdwn
index 6351c563f..8d9daa0ff 100644
--- a/doc/plugins/editdiff.mdwn
+++ b/doc/plugins/editdiff.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=editdiff author="[[JeremieKoenig]]"]]
-[[!tag type/useful]]
+[[!tag type/web]]
This plugin adds a "Diff" button when a page is being edited.
When clicked, a diff between the stored page and provided content
diff --git a/doc/plugins/edittemplate.mdwn b/doc/plugins/edittemplate.mdwn
index ca4a9ac45..85dfdfc2d 100644
--- a/doc/plugins/edittemplate.mdwn
+++ b/doc/plugins/edittemplate.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=edittemplate author="[[Joey]]"]]
-[[!tag type/useful]]
+[[!tag type/web]]
This plugin provides the [[ikiwiki/directive/edittemplate]] [[ikiwiki/directive]].
This directive allows registering template pages, that provide default
diff --git a/doc/plugins/google.mdwn b/doc/plugins/google.mdwn
new file mode 100644
index 000000000..7c61e637b
--- /dev/null
+++ b/doc/plugins/google.mdwn
@@ -0,0 +1,12 @@
+[[!template id=plugin name=google author="Peter Simons"]]
+[[!tag type/web]]
+
+This plugin adds a search form to the wiki, using google's site search.
+
+Google is asked to search for pages in the domain specified in the wiki's
+`url` configuration parameter. Results will depend on whether google has
+indexed the site, and how recently. Also, if the same domain has other
+content, outside the wiki's content, it will be searched as well.
+
+The [[search]] plugin offers full text search of only the wiki, but
+requires that a search engine be installed on your site.
diff --git a/doc/plugins/lockedit.mdwn b/doc/plugins/lockedit.mdwn
index 01b0f157d..71bf232ab 100644
--- a/doc/plugins/lockedit.mdwn
+++ b/doc/plugins/lockedit.mdwn
@@ -1,4 +1,24 @@
[[!template id=plugin name=lockedit core=1 author="[[Joey]]"]]
[[!tag type/auth]]
-This plugin enables [[page_locking]]. It is enabled by default.
+This plugin allows the administrator of a wiki to lock some pages, limiting
+who can edit them using the online interface. This doesn't prevent anyone
+who can commit to the underlying revision control system from editing the
+pages, however.
+
+The `locked_pages` setting configures what pages are locked. It is a
+[[ikiwiki/PageSpec]], so you have lots of control over what kind of pages
+to lock. For example, you could choose to lock all pages created before
+2006, or all pages that are linked to from the page named "locked". More
+usually though, you'll just list some names of pages to lock.
+
+One handy thing to do if you're using ikiwiki for your blog is to lock
+"* and !*/Discussion". This prevents others from adding to or modifying
+posts in your blog, while still letting them comment via the Discussion
+pages.
+
+Wiki administrators can always edit locked pages. The [[ikiwiki/PageSpec]]
+can specify that some pages are not locked for some users. For example,
+"important_page and !user(joey)" locks `important_page` while still
+allowing joey to edit it, while "!*/Discussion and user(bob)" prevents bob
+from editing pages except for Discussion pages.
diff --git a/doc/plugins/orphans/discussion.mdwn b/doc/plugins/orphans/discussion.mdwn
index 2b2532bfe..3165e5968 100644
--- a/doc/plugins/orphans/discussion.mdwn
+++ b/doc/plugins/orphans/discussion.mdwn
@@ -9,3 +9,14 @@ In my wiki, the page "realname" shows up as an orphan although it's being linked
> reason to use other link mechanisms provided by eg, markdown for internal
> links in the wiki (indeed, using them is likely to cause broken links
> when doing things like inlining or renaming pages). --[[Joey]]
+
+
+The orphans plugin fails with an error when it has to deal with a page that contains '+' characters as part of the filename. Apparently the code uses regular expressions and forgets to quote that string at some cruicial point. The error message I see is:
+
+ \[[!orphans Error: Nested quantifiers in regex;
+ marked by <-- HERE in m/^(c++ <-- HERE |)$/ at
+ /usr/lib/perl5/vendor_perl/5.8.8/IkiWiki/Plugin/orphans.pm line 43.]]
+
+--Peter
+
+> Fixed. BTW, for an important bug like this, use [[bugs]]. --[[Joey]]
diff --git a/doc/plugins/poll.mdwn b/doc/plugins/poll.mdwn
index 160fd2ffa..510f67798 100644
--- a/doc/plugins/poll.mdwn
+++ b/doc/plugins/poll.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=poll author="[[Joey]]"]]
-[[!tag type/useful]]
+[[!tag type/web]]
This plugin provides the [[ikiwiki/directive/poll]] [[ikiwiki/directive]],
which allows inserting an online poll into a page.
diff --git a/doc/plugins/remove.mdwn b/doc/plugins/remove.mdwn
index be382e1d8..47993f44b 100644
--- a/doc/plugins/remove.mdwn
+++ b/doc/plugins/remove.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=remove core=0 author="[[Joey]]"]]
-[[!tag type/useful]]
+[[!tag type/web]]
This plugin allows pages or other files to be removed using the web
interface.
diff --git a/doc/plugins/rename.mdwn b/doc/plugins/rename.mdwn
index dcb569b31..ddaede8b0 100644
--- a/doc/plugins/rename.mdwn
+++ b/doc/plugins/rename.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=rename core=0 author="[[Joey]]"]]
-[[!tag type/useful]]
+[[!tag type/web]]
This plugin allows pages or other files to be renamed using the web
interface.
diff --git a/doc/plugins/search.mdwn b/doc/plugins/search.mdwn
index cc8190567..92cc5945a 100644
--- a/doc/plugins/search.mdwn
+++ b/doc/plugins/search.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=search author="[[Joey]]"]]
-[[!tag type/useful]]
+[[!tag type/web]]
This plugin adds full text search to ikiwiki, using the
[xapian](http://xapian.org/) engine, its
diff --git a/doc/plugins/type/web.mdwn b/doc/plugins/type/web.mdwn
new file mode 100644
index 000000000..b60e26a29
--- /dev/null
+++ b/doc/plugins/type/web.mdwn
@@ -0,0 +1 @@
+These plugins enhance the web interface.
diff --git a/doc/plugins/version.mdwn b/doc/plugins/version.mdwn
index 257f8f303..43027bdd7 100644
--- a/doc/plugins/version.mdwn
+++ b/doc/plugins/version.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=version author="[[Joey]]"]]
-[[!tag type/useful]]
+[[!tag type/meta]]
This plugin provides the [[ikiwiki/directive/version]]
[[ikiwiki/directive]], which inserts the current version
diff --git a/doc/plugins/websetup.mdwn b/doc/plugins/websetup.mdwn
index 694429fe1..f1756ba8f 100644
--- a/doc/plugins/websetup.mdwn
+++ b/doc/plugins/websetup.mdwn
@@ -1,5 +1,5 @@
[[!template id=plugin name=websetup core=0 author="[[Joey]]"]]
-[[!tag type/useful]]
+[[!tag type/web]]
This plugin allows wiki admins to configure the wiki using a web interface,
rather than editing the setup file directly. A "Wiki Setup" button is added