X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/3cb1c8fa3b1fac58f8a84deef9b72b334c17c97a..93024e5193e01904b9e9688a4553d24cee23c490:/doc/features.mdwn diff --git a/doc/features.mdwn b/doc/features.mdwn index 8e3c0799c..3925d78ef 100644 --- a/doc/features.mdwn +++ b/doc/features.mdwn @@ -4,9 +4,10 @@ An overview of some of ikiwiki's features: ## Uses a real RCS Rather than implement its own system for storing page histories etc, -ikiwiki uses a real Revision Control System. This isn't (just) because we're -lazy, it's because a real RCS is a good thing to have, and there are -advantages to using one that are not possible with a standard wiki. +ikiwiki uses a real [[Revision_Control_System|rcs]]. This isn't (just) +because we're lazy, it's because a real RCS is a good thing to have, and +there are advantages to using one 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 [[Subversion|rcs/svn]], [[rcs/git]], or any of a number of other @@ -15,6 +16,10 @@ changes via [[Subversion|rcs/svn]], [[rcs/git]], or any of a number of other ikiwiki can be run from a [[post-commit]] hook to update your wiki immediately whenever you commit a change using the RCS. +It's even possible to securely let +[[anonymous_users_git_push_changes|tips/untrusted_git_push]] +to the wiki. + Note that ikiwiki does not require a RCS to function. If you want to run a simple wiki without page history, it can do that too. @@ -47,7 +52,7 @@ program, or other special file and link to it from your wiki pages. ## Blogging -You can turn any page in the wiki into a [[ikiwiki/blog]]. Pages matching a +You can turn any page in the wiki into a [[blog]]. Pages matching a specified [[ikiwiki/PageSpec]] will be displayed as a weblog within the blog page. And RSS or Atom feeds can be generated to follow the blog. @@ -72,12 +77,11 @@ can change the look and layout of all pages in any way you would like. ## [[Plugins]] -Plugins can be used to add additional features to ikiwiki. The interface -is quite flexible, allowing plugins to implement additional markup -languages, register [[directives|ikiwiki/directive]], hook into [[CGI]] mode, -and more. Most of ikiwiki's features are actually provided by plugins. -Ikiwiki's backend RCS support is also pluggable, so support for new -revision control systems can be added to ikiwiki. +Plugins can be used to add additional features to ikiwiki. The interface is +quite flexible, allowing plugins to implement additional markup languages, +register [[directives|ikiwiki/directive]], provide a [[RCS]] backend, hook +into [[CGI]] mode, and much more. Most of ikiwiki's features are actually +provided by plugins. The standard language for ikiwiki plugins is perl, but ikiwiki also supports [[plugins/write/external]] plugins: Standalone programs that can be written in @@ -142,14 +146,15 @@ authentication, or other methods implemented via plugins. Thanks to subpages, every page can easily and automatically have a /Discussion subpage. By default, these links are included in the -[[templates]] for each page. +[[templates]] for each page. If you prefer blog-syle +[[plugins/comments]], that is available too. ### Edit controls -Wiki admins can [[lock_pages|page_locking]] so that only other admins can -edit them. Or a wiki can be set up to allow anyone to edit Discussion -pages, but only registered users to edit other pages. These are just two -possibilities, since page edit controls can be changed via plugins. +Wiki admins can lock pages so that only other admins can edit them. Or a +wiki can be set up to allow anyone to edit Discussion pages, but only +registered users to edit other pages. These are just two possibilities, +since page edit controls can be changed via plugins. ### [[PageHistory]] @@ -161,6 +166,11 @@ Well, sorta. Rather than implementing YA history browser, it can link to ikiwiki can use the xapian search engine to add powerful full text [[plugins/search]] capabilities to your wiki. +### Translation via po files + +The [[plugins/po]] plugin allows translating individual wiki pages using +standard `po` files. + ### [[w3mmode]] Can be set up so that w3m can be used to browse a wiki and edit pages