urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

modernisation

master
joey 2006-08-20 21:06:57 +00:00
parent 0340194344
commit a96240d744
1 changed files with 27 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
doc/features.mdwn
View File

@ -1,26 +1,28 @@
Some of ikiwiki's features: Some of ikiwiki's features:
* [[Subversion]] * Uses a real RCS
Rather than implement its own system for storing page histories etc, Rather than implement its own system for storing page histories etc,
ikiwiki simply uses subversion. (It's also possible to [[plugins/write]] ikiwiki uses a real RCS. This isn't because we're lazy, it's because a
support for other systems, and ikiwiki also includes support for [[Git]] real RCS is a good thing to have, and there are advantages to using one
now.) that are not possible with a standard wiki.
Instead of editing pages in a stupid web form, you can use vim and commit 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 changes via svn. Or work disconnected using svk and push your changes out
when you come online. 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.)
ikiwiki can be run from a [[post-commit]] hook to update your wiki ikiwiki can be run from a [[post-commit]] hook to update your wiki
immediately whenever you commit. immediately whenever you commit.
Note that ikiwiki does not require subversion to function. If you want to 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. run a simple wiki without page history, it can do that too.
* [[MarkDown]] * Supports many markup languages
ikiwiki supports pages using [[MarkDown]] as their markup language. Any By default, pages in the wiki are written using the [[MarkDown]] format.
page with a filename ending in ".mdwn" is converted from markdown to html Any page with a filename ending in ".mdwn" is converted from markdown to html
by ikiwiki. Markdown understands text formatted as it would be in an email, by ikiwiki. Markdown understands text formatted as it would be in an email,
and is quite smart about converting it to html. The only additional markup and is quite smart about converting it to html. The only additional markup
provided by ikiwiki on top of regular markdown is the [[WikiLink]] and provided by ikiwiki on top of regular markdown is the [[WikiLink]] and
@ -28,8 +30,8 @@ Some of ikiwiki's features:
If you prefer to use some other markup language, ikiwiki allows others to If you prefer to use some other markup language, ikiwiki allows others to
easily be added by [[plugins]]. For example it also supports traditional easily be added by [[plugins]]. For example it also supports traditional
[[plugins/WikiText]] formatted pages or pages written as pure [[plugins/WikiText]] formatted pages, pages written as pure
[[plugins/HTML]]. [[plugins/HTML]], or pages written in [[reStructuredText|plugins/rst]].
* support for other file types * support for other file types
@ -38,10 +40,11 @@ Some of ikiwiki's features:
unchanged by ikiwiki as it builds your wiki. So you can check in an image, 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. program, or other special file and link to it from your wiki pages.
* [[SubPages|SubPage]] * Fast compiler
Arbitrarily deep hierarchies of pages with fairly simple and useful ikiwiki is fast and smart about updating a wiki, it only builds pages
[[SubPage/LinkingRules]] that have changed (and tracks things like creation of new pages and links
that can indirectly cause a page to need a rebuild)
* [[blogging|blog]] * [[blogging|blog]]
@ -62,12 +65,6 @@ Some of ikiwiki's features:
up in the ways you'd expect, like at the bottom of pages, in blogs, and up in the ways you'd expect, like at the bottom of pages, in blogs, and
in rss feeds. in rss feeds.
* Fast compiler
ikiwiki is fast and smart about updating a wiki, it only builds pages
that have changed (and tracks things like creation of new pages and links
that can indirectly cause a page to need a rebuild)
* valid html and css * valid html and css
ikiwiki aims to produce ikiwiki aims to produce
@ -75,6 +72,11 @@ Some of ikiwiki's features:
ikiwiki generates html using [[templates]], and uses css, so you can 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. change the look and layout of all pages in any way you would like.
* [[SubPages|SubPage]]
Arbitrarily deep hierarchies of pages with fairly simple and useful
[[SubPage/LinkingRules]]
* [[BackLinks]] * [[BackLinks]]
Automatically included on pages. Rather faster than eg MoinMoin and Automatically included on pages. Rather faster than eg MoinMoin and
@ -104,14 +106,14 @@ Some of ikiwiki's features:
* Smart merging and conflict resolution in your web browser * Smart merging and conflict resolution in your web browser
Since it uses subversion, ikiwiki takes advantage of its smart merging to Since it uses a real RCS, ikiwiki takes advantage of its smart merging to
avoid any conflicts when two people edit different parts of the same page avoid any conflicts when two people edit different parts of the same page
at the same time. No annoying warnings about other editors, or locking, at the same time. No annoying warnings about other editors, or locking,
etc, instead the other person's changes will be automatically merged with etc, instead the other person's changes will be automatically merged with
yours when you commit. yours when you commit.
In the rare cases where automatic merging fails due to the same part of a In the rare cases where automatic merging fails due to the same part of a
page being concurrently edited, regular subversion commit markers are page being concurrently edited, regular commit conflict markers are
shown in the file to resolve the conflict, so if you're already familiar shown in the file to resolve the conflict, so if you're already familiar
with that there's no new commit marker syntax to learn. with that there's no new commit marker syntax to learn.
@ -134,8 +136,9 @@ Some of ikiwiki's features:
Plugins can be used to add additional features to ikiwiki. The interface Plugins can be used to add additional features to ikiwiki. The interface
is quite flexible, allowing plugins to implement additional markup is quite flexible, allowing plugins to implement additional markup
languages, register [[PreProcessorDirective]]s, hook into [[CGI]] mode, languages, register [[PreProcessorDirective]]s, hook into [[CGI]] mode,
and more. Ikiwiki's backend RCS support is also pluggable, so support for and more. Most of ikiwiki's features are actually provided by plugins.
new revision control systems can be added to ikiwiki. Ikiwiki's backend RCS support is also pluggable, so support for new
revision control systems can be added to ikiwiki.
* [[todo/utf8]] * [[todo/utf8]]