diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/features.mdwn | 5 | ||||
| -rw-r--r-- | doc/ikiwiki.setup | 2 | ||||
| -rw-r--r-- | doc/install.mdwn | 3 | ||||
| -rw-r--r-- | doc/plugins/wikitext.mdwn | 21 |
4 files changed, 27 insertions, 4 deletions
diff --git a/doc/features.mdwn b/doc/features.mdwn index c22d2be91..5152beffd 100644 --- a/doc/features.mdwn +++ b/doc/features.mdwn @@ -23,11 +23,12 @@ Some of ikiwiki's features: 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, and is quite smart about converting it to html. The only additional markup - provided by ikiwiki aside from regular markdown is the [[WikiLink]] and + provided by ikiwiki on top of regular markdown is the [[WikiLink]] and [[PreprocessorDirective]] If you prefer to use some other markup language, ikiwiki allows others to - be added by [[plugins]]. + easily be added by [[plugins]]. For example it also supports traditional + [[plugins/WikiText]] formatted pages. * support for other file types diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup index 9713d553b..8bc0e3336 100644 --- a/doc/ikiwiki.setup +++ b/doc/ikiwiki.setup @@ -71,7 +71,7 @@ use IkiWiki::Setup::Standard { #timeformat => '%c', # To add plugins, list them here. - #add_plugins => [qw{pagecount brokenlinks search smiley}], + #add_plugins => [qw{pagecount brokenlinks search smiley wikitext}], # If you want to disable any of the default plugins, list them here. #disable_plugins => [qw{inline htmlscrubber}], } diff --git a/doc/install.mdwn b/doc/install.mdwn index f65e1a227..d23c88e41 100644 --- a/doc/install.mdwn +++ b/doc/install.mdwn @@ -6,7 +6,8 @@ perl modules if available: `CGI::Session` `CGI::FormBuilder` (version `Date::Parse` (libtimedate-perl), `HTML::Scrubber`, `RPC::XML`, `XML::Simple` -If you want to install from the tarball, you should make sure that the required perl modules are installed, then run: +If you want to install from the tarball, you should make sure that the +required perl modules are installed, then run: perl Makefile.PL make diff --git a/doc/plugins/wikitext.mdwn b/doc/plugins/wikitext.mdwn new file mode 100644 index 000000000..5c5383fc5 --- /dev/null +++ b/doc/plugins/wikitext.mdwn @@ -0,0 +1,21 @@ +This plugin allows ikiwiki to process pages written in the original wiki +text format. To use it, you need to have the Text::WikiFormat perl module +installed, enable the plugin, then files with the extention `.wiki` will be +processed as wiki text. + +Wiki formatting is very simple. An item wrapped in three single quotes is +strong. An item wrapped in two single quotes is emphasized. Any word with +multiple CapitalLetters (e. g., StudlyCaps) will become a link (standard +[[WikiLinks|WikiLink]] work too). Four or more +hyphen characters at the start of a line create a horizontal line. +Newlines turn into the appropriate tags. Headers are matching equals signs +around the header text -- the more signs, the lesser the header. + +Lists are indented text, by one tab or four spaces. In unordered lists, +where each item has its own bullet point, each item needs a leading +asterisk and space. Ordered lists consist of items marked with combination +of one or more alphanumeric characters followed by a period and an optional +space. Any indented text without either marking is code, handled literally. +You can nest lists. + +This plugin is included in ikiwiki, but is not enabled by default. |