X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/54cf5a62cab254e923c8d73ae8bd043a1f33c3b1..d3e190ecec67ae45891d8aee3e3c8af9fc9f8cf9:/doc/features.mdwn?ds=inline diff --git a/doc/features.mdwn b/doc/features.mdwn index 05aeebfc9..149908db6 100644 --- a/doc/features.mdwn +++ b/doc/features.mdwn @@ -4,15 +4,13 @@ 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 because we're +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. Instead of editing pages in a stupid web form, you can use vim and commit -changes via [[Subversion]]. Or work disconnected using svk and push your -changes out when you come online. Or use [[git]], [[tla]], or [[mercurial]] -to work in a distributed fashion all the time. (It's also possible to -[[plugins/write]] a plugin to support other systems.) +changes via [[Subversion|rcs/svn]], [[rcs/git]], or any of a number of other +[[Revision_Control_Systems|rcs]]. ikiwiki can be run from a [[post-commit]] hook to update your wiki immediately whenever you commit a change using the RCS. @@ -39,14 +37,15 @@ provided by ikiwiki on top of regular markdown is the [[WikiLink]] and If you prefer to use some other markup language, ikiwiki allows others to easily be added by [[plugins]]. For example it also supports traditional [[plugins/WikiText]] formatted pages, pages written as pure -[[plugins/HTML]], or pages written in [[reStructuredText|plugins/rst]]. +[[plugins/HTML]], or pages written in [[reStructuredText|plugins/rst]] +or [[Textile|plugins/textile]]. ikiwiki also supports files of any other type, including plain text, images, etc. These are not converted to wiki pages, they are just copied unchanged by ikiwiki as it builds your wiki. So you can check in an image, program, or other special file and link to it from your wiki pages. -## [[Blogging|blog]] +## Blogging You can turn any page in the wiki into a [[blog]]. Pages matching a specified [[PageSpec]] will be displayed as a weblog within the blog @@ -67,9 +66,9 @@ you would care to syndicate. ## Valid html and [[css]] ikiwiki aims to produce -[valid XHTML 1.0](http://validator.w3.org/check?url=referer). -ikiwiki generates html using [[templates]], and uses [[css]], so you can -change the look and layout of all pages in any way you would like. +[valid XHTML 1.0](http://validator.w3.org/check?url=referer). ikiwiki +generates html using [[templates|wikitemplates]], and uses [[css]], so you +can change the look and layout of all pages in any way you would like. ## [[Plugins]] @@ -80,6 +79,10 @@ 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. +The standard language for ikiwiki plugins is perl, but ikiwiki also supports +[[plugins/write/external]] plugins: Standalone programs that can be written in +any language and communicate with ikiwiki using XML RPC. + ## [[todo/utf8]] After rather a lot of fiddling, we think that ikiwiki correctly and fully @@ -128,7 +131,7 @@ and can be enabled by enabling [[CGI]]. ### User registration -Can optionally be configured to allow only registered users to post +Can optionally be configured to allow only registered users to edit pages. User registration can be done using a web form, or ikiwiki can be @@ -141,14 +144,17 @@ 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. -### Page locking +### Edit controls -Wiki admins can lock pages so that only other admins can edit them. +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. ### [[PageHistory]] Well, sorta. Rather than implementing YA history browser, it can link to -[[ViewCVS]] or the like to browse the history of a wiki page. +[[ViewVC]] or the like to browse the history of a wiki page. ### Full text search