ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / txt.mdwn
1 [[!template id=plugin name=txt author="[[Gabriel]]"]]
2 [[!tag type/format]]
3
4 This plugin makes ikiwiki treat files with names ending in ".txt"
5 as wiki pages.
6
7 Unlike other [[type/format]] plugins, no formatting of markup in 
8 txt files is done; the file contents is displayed to the user as
9 pre-formatted text, with html markup characters such as ">" escaped.
10
11 The only exceptions are that [[WikiLinks|ikiwiki/WikiLink]] and
12 [[directives|ikiwiki/directive]] are still expanded by
13 ikiwiki, and that, if the [[!cpan URI::Find]] perl module is installed, URLs
14 in the txt file are converted to hyperlinks.
15
16 ----
17
18 As a special case, a file `robots.txt` will be copied intact into the
19 `destdir`, as well as creating a wiki page named "robots".