diff options
Diffstat (limited to 'doc/plugins')
91 files changed, 308 insertions, 308 deletions
diff --git a/doc/plugins/amazon_s3.mdwn b/doc/plugins/amazon_s3.mdwn index caa0c0153..331dc4acf 100644 --- a/doc/plugins/amazon_s3.mdwn +++ b/doc/plugins/amazon_s3.mdwn @@ -1,12 +1,12 @@ -[[template id=plugin name=amazon_s3 author="[[Joey]]"]] -[[tag type/special-purpose]] +[[!template id=plugin name=amazon_s3 author="[[Joey]]"]] +[[!tag type/special-purpose]] This plugin allows ikiwiki to publish a wiki in the [Amazon Simple Storage Service](http://aws.amazon.com/s3) (S3). As pages are rendered, ikiwiki will upload them to Amazon S3. The entire wiki contents, aside from the ikiwiki CGI, can then be served directly out of Amazon S3. -You'll need the [[cpan Net::Amazon::S3]] and [[cpan File::MimeInfo]] perl +You'll need the [[!cpan Net::Amazon::S3]] and [[!cpan File::MimeInfo]] perl modules and an Amazon S3 account to use this plugin. ## configuration diff --git a/doc/plugins/anonok.mdwn b/doc/plugins/anonok.mdwn index 2afde29b3..2a8a922cd 100644 --- a/doc/plugins/anonok.mdwn +++ b/doc/plugins/anonok.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=anonok author="[[Joey]]"]] -[[tag type/auth]] +[[!template id=plugin name=anonok author="[[Joey]]"]] +[[!tag type/auth]] By default, anonymous users cannot edit the wiki. This plugin allows anonymous web users, who have not signed in, to edit any page in the wiki diff --git a/doc/plugins/attachment.mdwn b/doc/plugins/attachment.mdwn index ce04bcd2f..524a233fa 100644 --- a/doc/plugins/attachment.mdwn +++ b/doc/plugins/attachment.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=attachment core=0 author="[[Joey]]"]] -[[tag type/useful]] +[[!template id=plugin name=attachment core=0 author="[[Joey]]"]] +[[!tag type/useful]] This plugin allows files to be uploaded to the wiki over the web. @@ -24,7 +24,7 @@ If you enable this plugin, be sure to lock that down, by entering an [[enhanced_PageSpec|ikiwiki/pagespec/attachment]] in the "Allowed Attachments" field of the wiki admin's preferences page. -This plugin will use the [[cpan File::MimeInfo::Magic]] perl module, if +This plugin will use the [[!cpan File::MimeInfo::Magic]] perl module, if available, for mimetype checking. The `virusfree` [[PageSpec|ikiwiki/pagespec/attachment]] requires that diff --git a/doc/plugins/brokenlinks.mdwn b/doc/plugins/brokenlinks.mdwn index 208d7120b..25c44fef1 100644 --- a/doc/plugins/brokenlinks.mdwn +++ b/doc/plugins/brokenlinks.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=brokenlinks author="[[Joey]]"]] -[[tag type/link type/meta]] +[[!template id=plugin name=brokenlinks author="[[Joey]]"]] +[[!tag type/link type/meta]] This plugin generates a list of broken links on pages in the wiki. This is a useful way to find pages that still need to be written, or links that @@ -10,4 +10,4 @@ pages to search for broken links, default is search them all. If this plugin is turned on, here's a list of broken links on this wiki: -[[brokenlinks pages="* and !recentchanges"]] +[[!brokenlinks pages="* and !recentchanges"]] diff --git a/doc/plugins/calendar.mdwn b/doc/plugins/calendar.mdwn index d429bde88..20da26400 100644 --- a/doc/plugins/calendar.mdwn +++ b/doc/plugins/calendar.mdwn @@ -1,16 +1,16 @@ -[[template id=plugin name=calendar author="[[ManojSrivastava]]"]] -[[tag type/chrome]] +[[!template id=plugin name=calendar author="[[ManojSrivastava]]"]] +[[!tag type/chrome]] This plugin displays a calendar, similar to the typical calendars shown on some blogs. # examples - \[[calendar ]] + \[[!calendar ]] - \[[calendar type="month" pages="blog/* and !*/Discussion"]] + \[[!calendar type="month" pages="blog/* and !*/Discussion"]] - \[[calendar type="year" year="2005" pages="blog/* and !*/Discussion"]] + \[[!calendar type="year" year="2005" pages="blog/* and !*/Discussion"]] This plugin is inspired by the calendar plugin for Blosxom, but derives no code from it. This plugin is essentially a fancy front end diff --git a/doc/plugins/camelcase.mdwn b/doc/plugins/camelcase.mdwn index 81270f41a..1764b31b2 100644 --- a/doc/plugins/camelcase.mdwn +++ b/doc/plugins/camelcase.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=camelcase author="[[Joey]]"]] +[[!template id=plugin name=camelcase author="[[Joey]]"]] This plugin makes words in CamelCase be treated as a [[ikiwiki/WikiLink]]. That is to say, any two or more words capitalised and mashed together are @@ -7,4 +7,4 @@ link. If this plugin is enabled, this will be a link: SandBox -[[tag type/link]] +[[!tag type/link]] diff --git a/doc/plugins/conditional.mdwn b/doc/plugins/conditional.mdwn index 7a230fbae..5793cb30e 100644 --- a/doc/plugins/conditional.mdwn +++ b/doc/plugins/conditional.mdwn @@ -1,10 +1,10 @@ -[[template id=plugin name=conditional core=1 author="[[Joey]]"]] -[[tag type/format]] +[[!template id=plugin name=conditional core=1 author="[[Joey]]"]] +[[!tag type/format]] With this plugin, you can make text be conditionally displayed on a page. For example: - \[[if test="enabled(smiley)" + \[[!if test="enabled(smiley)" then="The smiley plugin is enabled :-)" else="No smiley plugin here.."]] diff --git a/doc/plugins/conditional/discussion.mdwn b/doc/plugins/conditional/discussion.mdwn index 79b8390fa..629d05940 100644 --- a/doc/plugins/conditional/discussion.mdwn +++ b/doc/plugins/conditional/discussion.mdwn @@ -14,9 +14,9 @@ is supposed to have *no* blank lines between... > The blank lines in this example are coming from the newline after `then="`, and also from the newline before the close quote. If you remove those newlines, I think it should work. --[[Joey]] >> No, that's unfortunately not it, see here: ->> [[if test="enabled(trallala)" then="foot"]] +>> [[!if test="enabled(trallala)" then="foot"]] >> Continued. But on the other ->> [[if test="enabled(trallala)" then="foot" else="hand:"]] +>> [[!if test="enabled(trallala)" then="foot" else="hand:"]] >> Continued. --[[tschwinge]] >>> Seems ok, no? The only linebreaks I see in the source are the ones you @@ -25,9 +25,9 @@ is supposed to have *no* blank lines between... >>>> Okay, that would explain the linebreak between 1 and 3. But then, why are all linebreaks removed between 3 and 5? >>>> 1 No, that's unfortunately not it, see here: ->>>> [[if test="enabled(trallala)" then="foot"]] +>>>> [[!if test="enabled(trallala)" then="foot"]] >>>> 3 Continued. But on the other ->>>> [[if test="enabled(trallala)" then="foot" else="hand:"]] +>>>> [[!if test="enabled(trallala)" then="foot" else="hand:"]] >>>> 5 Continued. --[[tschwinge]] >>>>> The conditional after 1 evaluates to "", so there's a blank line @@ -38,10 +38,10 @@ I have a sidebar that contains <pre> #### Archives - \[[calendar type="year" months_per_row="6" pages="blog/* and !*/Discussion"]] - \[[calendar type="month" pages="blog/* and !*/Discussion"]] + \[[!calendar type="year" months_per_row="6" pages="blog/* and !*/Discussion"]] + \[[!calendar type="month" pages="blog/* and !*/Discussion"]] <h4>Indices</h4> - \[[map pages="archives/* and !*/Discussion"]] + \[[!map pages="archives/* and !*/Discussion"]] </pre> I am trying to make it so that the archives and index only show up if the destpage is either blog/* or / -- the top of the wiki. Unfortunately, I don't think I am getting the conditional right -- I have a "]] left over at the end (looking at the rendered html). Ideally, I would like to be able to do todays calendar on the top level pagel and diff --git a/doc/plugins/contrib.mdwn b/doc/plugins/contrib.mdwn index d0b3fa750..7a28edaba 100644 --- a/doc/plugins/contrib.mdwn +++ b/doc/plugins/contrib.mdwn @@ -2,6 +2,6 @@ Contributed [[plugins]]: (See [[install]] for installation help.) -[[inline pages="plugins/contrib/* !*/Discussion" +[[!inline pages="plugins/contrib/* !*/Discussion" feedpages="created_after(plugins/contrib/navbar)" archive="yes" rootpage="plugins/contrib" postformtext="Add a new plugin named:" show=0]] diff --git a/doc/plugins/contrib/attach.mdwn b/doc/plugins/contrib/attach.mdwn index ab50715c7..f44125b10 100644 --- a/doc/plugins/contrib/attach.mdwn +++ b/doc/plugins/contrib/attach.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=attach author="[[Ben]]"]] +[[!template id=plugin name=attach author="[[Ben]]"]] **Note: This plugin is currently pending upload. It is also most assuredly beta.** diff --git a/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn b/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn index 27e0ffefd..168b35668 100644 --- a/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn +++ b/doc/plugins/contrib/default_content_for___42__copyright__42___and___42__license__42__.mdwn @@ -1,7 +1,7 @@ -[[template id=plugin name=copyright author="[[tschwinge]]"]] -[[template id=plugin name=license author="[[tschwinge]]"]] +[[!template id=plugin name=copyright author="[[tschwinge]]"]] +[[!template id=plugin name=license author="[[tschwinge]]"]] -[[meta title="default content for *copyright* and *license*"]] +[[!meta title="default content for *copyright* and *license*"]] Someone was just asking for it and I had written these two plugins already some months ago, so I'm now publishing them here. diff --git a/doc/plugins/contrib/gallery.mdwn b/doc/plugins/contrib/gallery.mdwn index 06c1844f7..ed9e17f32 100644 --- a/doc/plugins/contrib/gallery.mdwn +++ b/doc/plugins/contrib/gallery.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=gallery author="[[arpitjain]]"]] +[[!template id=plugin name=gallery author="[[arpitjain]]"]] This plugin would create a nice looking gallery of the images. It has been build over the img plugin in Ikiwiki @@ -6,7 +6,7 @@ SVN repository of plugin is located at <http://ned.snow-crash.org:8080/svn/ikiwi USAGE : -\[[gallery imagedir="images" option="value"]] +\[[!gallery imagedir="images" option="value"]] Available options : <br> * imagedir(required) => Directory containing images. It will scan all the files with jpg|png|gif extension from the directory and will put it in the gallery.<br> @@ -35,4 +35,4 @@ Additional details are available [here](http://myweb.unomaha.edu/~ajain/ikiwikig -- [[arpitjain]] -[[tag plugins]] [[tag patch]] [[tag soc]] [[tag wishlist]] +[[!tag plugins]] [[!tag patch]] [[!tag soc]] [[!tag wishlist]] diff --git a/doc/plugins/contrib/gallery/discussion.mdwn b/doc/plugins/contrib/gallery/discussion.mdwn index 37fa6f884..08fc2456f 100644 --- a/doc/plugins/contrib/gallery/discussion.mdwn +++ b/doc/plugins/contrib/gallery/discussion.mdwn @@ -6,13 +6,13 @@ rebased it onto the *origin/master*, built a Debian package and installed that o However, I can't even get simply things like this to work: $ cat web/index.mdwn - [[gallery imagedir="b" vcs="0"]] + [[!gallery imagedir="b" vcs="0"]] $ ls web/b/ 1.jpg 2.jpg 3.jpg 4.jpg $ ikiwiki [...] --plugin gallery web web.rendered [...] $ grep gallery web.rendered/index.html - <p>[[gallery Failed to Read Directory b.]]</p> + <p>[[!gallery Failed to Read Directory b.]]</p> When using `vcs="1"` it's no better: @@ -25,7 +25,7 @@ When using `vcs="1"` it's no better: Its probably because of the restriction of permissions by plugins in newer version of IkiWiki. For the time being, you can turn resizing off till I look into conditional underlay directory feature. -USAGE : [[gallery imagedir="directory" resize="0"]] +USAGE : [[!gallery imagedir="directory" resize="0"]] New version updated at SVN REPO : http://ned.snow-crash.org:8080/svn/ikiwiki-gallery/ diff --git a/doc/plugins/contrib/googlemaps.mdwn b/doc/plugins/contrib/googlemaps.mdwn index 93f415fb5..953f296ab 100644 --- a/doc/plugins/contrib/googlemaps.mdwn +++ b/doc/plugins/contrib/googlemaps.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=googlemaps author="Christian Mock"]] -[[tag type/special-purpose todo/geotagging]] +[[!template id=plugin name=googlemaps author="Christian Mock"]] +[[!tag type/special-purpose todo/geotagging]] `googlemaps` is a plugin that allows using the [Google Maps API][2] from ikiwiki. diff --git a/doc/plugins/contrib/headinganchors.mdwn b/doc/plugins/contrib/headinganchors.mdwn index 287afa0f5..ef2fa122a 100644 --- a/doc/plugins/contrib/headinganchors.mdwn +++ b/doc/plugins/contrib/headinganchors.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=headinganchors author="[[PaulWise]]"]] +[[!template id=plugin name=headinganchors author="[[PaulWise]]"]] This is a simple plugin to add ids to all headings, based on their text. It works as a postprocessing filter, allowing it to work on mdwn, wiki, html, diff --git a/doc/plugins/contrib/img.mdwn b/doc/plugins/contrib/img.mdwn index c55338bf5..6c25966e0 100644 --- a/doc/plugins/contrib/img.mdwn +++ b/doc/plugins/contrib/img.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=img author="Christian Mock"]] -[[tag type/chrome]] +[[!template id=plugin name=img author="Christian Mock"]] +[[!tag type/chrome]] `img` is an enhanced image handling plugin. diff --git a/doc/plugins/contrib/img/discussion.mdwn b/doc/plugins/contrib/img/discussion.mdwn index d4b38fb61..ea4ccb042 100644 --- a/doc/plugins/contrib/img/discussion.mdwn +++ b/doc/plugins/contrib/img/discussion.mdwn @@ -10,18 +10,18 @@ differently scaled versions of the image, why not just create three pages and use the plugin once per page? Something like this on the first one if it's got multiple clickable thumbnails: - \[[img foo.jpg width=256 link=page2]] + \[[!img foo.jpg width=256 link=page2]] This on the second: - \[[img foo.jpg width=1024 link=page3]] + \[[!img foo.jpg width=1024 link=page3]] \[[small|page1]] \[[medium|page2]] \[[large|page3]] This on the third: - \[[img foo.jpg link=page3]] + \[[!img foo.jpg link=page3]] \[[small|page1]] \[[medium|page2]] \[[large|parge3]] diff --git a/doc/plugins/contrib/linguas.mdwn b/doc/plugins/contrib/linguas.mdwn index 204910290..0c3366846 100644 --- a/doc/plugins/contrib/linguas.mdwn +++ b/doc/plugins/contrib/linguas.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=linguas author="Jordà Polo"]] +[[!template id=plugin name=linguas author="Jordà Polo"]] Linguas ======= @@ -20,14 +20,14 @@ Translatable pages and translations must have the following format: `pagename.$LANG`, where `$LANG` is a ISO639-1 (two-letter) language code. To enable linguas, add the following line in the source code of the page: - \[[linguas ]] + \[[!linguas ]] Note that linguas is only required in one of the pages (the original, for instance); the rest of translations will be automatically updated. Additionally, it is also possible to specify the title of the translation: - \[[linguas title="Translated title"]] + \[[!linguas title="Translated title"]] Template @@ -103,4 +103,4 @@ The following fixes it: + push @links, IkiWiki::htmllink($page, $destpage, $trans, noimageinline => 0, forcesubpage => 0, linktext => $link); } - my $otherlinguas = 'Translations:';
\ No newline at end of file + my $otherlinguas = 'Translations:'; diff --git a/doc/plugins/contrib/navbar.mdwn b/doc/plugins/contrib/navbar.mdwn index 830179999..061e4588c 100644 --- a/doc/plugins/contrib/navbar.mdwn +++ b/doc/plugins/contrib/navbar.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=navbar author="[[TobiOetiker]]"]] +[[!template id=plugin name=navbar author="[[TobiOetiker]]"]] The Navbar Plugin renders a Navigation Bar into your page. It is based on code from the [[sidebar_plugin|plugins/sidebar]]. diff --git a/doc/plugins/contrib/sar.mdwn b/doc/plugins/contrib/sar.mdwn index a28f79e20..77c41a955 100644 --- a/doc/plugins/contrib/sar.mdwn +++ b/doc/plugins/contrib/sar.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=sar author="[[VictorMoral]]"]] -[[tag type/chrome type/slow ]] +[[!template id=plugin name=sar author="[[VictorMoral]]"]] +[[!tag type/chrome type/slow ]] The `sar` plugin is useful to make global or local search and replace operations using common or specific terms. @@ -14,19 +14,19 @@ The global dictionary page is like this: ## Sites and projects - - [[sar search="ikiwiki" first="[IkiWiki](http://ikiwiki.info)" next="_IkiWiki_"]] - - [[sar search="debian" first="[Debian](http://debian.org)" next="_Debian_"]] - - [[sar search="perl" first="[Perl](http://perl.org)" next="_Perl_"]] - - [[sar search="linux" replace="GNU/Linux"]] + - [[!sar search="ikiwiki" first="[IkiWiki](http://ikiwiki.info)" next="_IkiWiki_"]] + - [[!sar search="debian" first="[Debian](http://debian.org)" next="_Debian_"]] + - [[!sar search="perl" first="[Perl](http://perl.org)" next="_Perl_"]] + - [[!sar search="linux" replace="GNU/Linux"]] ## Persons - - [[sar search="joey" first="[Joey Hess](http://ikiwiki.info/users/joey]]" next="_Joey_" ]] - - [[sar search="angel" first="[Angel](http://triptico.com)" next="Angel"]] + - [[!sar search="joey" first="[Joey Hess](http://ikiwiki.info/users/joey]]" next="_Joey_" ]] + - [[!sar search="angel" first="[Angel](http://triptico.com)" next="Angel"]] ## Technical terms - - [[sar search="smtp" first="\[[wp SMTP]]" next="‘SMTP‘"]] - - [[sar search="pop3" first="\[[wp POP3]]" next="’POP3’"]] + - [[!sar search="smtp" first="\[[!wp SMTP]]" next="‘SMTP‘"]] + - [[!sar search="pop3" first="\[[!wp POP3]]" next="’POP3’"]] The search expressions must be surrounded by double dashes in a source ikiwiki page, like this: @@ -70,11 +70,11 @@ value is `*`, but a recommended value is `link(tag/sar)`. In a ikiwiki source page we can write this - \[[sar search=debian replace="__Debian__"]] + \[[!sar search=debian replace="__Debian__"]] for define a global replace for the term `--debian--` or - \[[sar search=ibm first=’[IBM](http://www.ibm.com)’ + \[[!sar search=ibm first=’[IBM](http://www.ibm.com)’ next="_IBM_"]] to define a replace for the first match of the string `--ibm--` and a different diff --git a/doc/plugins/contrib/siterel2pagerel.mdwn b/doc/plugins/contrib/siterel2pagerel.mdwn index 06c9bbc29..956b6728f 100644 --- a/doc/plugins/contrib/siterel2pagerel.mdwn +++ b/doc/plugins/contrib/siterel2pagerel.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=siterel2pagerel author="[[PaulWise]]"]] +[[!template id=plugin name=siterel2pagerel author="[[PaulWise]]"]] This is a simple plugin to convert all site-relative links to page-relative links (converts /foo into ../../../foo or similar). It works as a diff --git a/doc/plugins/contrib/syntax.mdwn b/doc/plugins/contrib/syntax.mdwn index 3ea3b8e32..5ca6311f9 100644 --- a/doc/plugins/contrib/syntax.mdwn +++ b/doc/plugins/contrib/syntax.mdwn @@ -1,7 +1,7 @@ -[[template id=plugin name=syntax author="[[VictorMoral]]"]] -[[tag type/chrome type/slow]] +[[!template id=plugin name=syntax author="[[VictorMoral]]"]] +[[!tag type/chrome type/slow]] -The `syntax` plugin adds support to ikiwiki for syntax highlighting through the *vim* editor and its perl interface [[cpan Text::VimColor]]. It depends on a functional vim installation. +The `syntax` plugin adds support to ikiwiki for syntax highlighting through the *vim* editor and its perl interface [[!cpan Text::VimColor]]. It depends on a functional vim installation. The plugin inserts a fragment of HTML with special marks from a file or a string text. It accepts the following parameters: @@ -17,7 +17,7 @@ In the case of file parameter, `syntax` will build a html link for direct downlo Example: - \[[syntax type="perl" text=""" + \[[!syntax type="perl" text=""" #!/usr/bin/perl my $a = "World"; @@ -26,7 +26,7 @@ Example: or - \[[syntax file="/examples/hello.pl" description="My first perl program"]] + \[[!syntax file="/examples/hello.pl" description="My first perl program"]] This plugin create the following CSS styles: diff --git a/doc/plugins/contrib/texinfo.mdwn b/doc/plugins/contrib/texinfo.mdwn index c33a370ea..595bd27aa 100644 --- a/doc/plugins/contrib/texinfo.mdwn +++ b/doc/plugins/contrib/texinfo.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=texinfo author="[[tschwinge]]"]] +[[!template id=plugin name=texinfo author="[[tschwinge]]"]] [[I|tschwinge]] started writing a plugin to render [GNU Texinfo](http://www.gnu.org/software/texinfo/) diff --git a/doc/plugins/creole.mdwn b/doc/plugins/creole.mdwn index b2496adad..b6861ab26 100644 --- a/doc/plugins/creole.mdwn +++ b/doc/plugins/creole.mdwn @@ -1,9 +1,9 @@ -[[template id=plugin name=creole author="BerndZeimetz"]] -[[tag type/format]] +[[!template id=plugin name=creole author="BerndZeimetz"]] +[[!tag type/format]] This plugin allows ikiwiki to process pages written in [WikiCreole](http://www.wikicreole.org/) format. -To use it, you need to have the [[cpan Text::WikiCreole]] perl +To use it, you need to have the [[!cpan Text::WikiCreole]] perl module installed, enable the plugin, then files with the extention `.creole` will be processed as creole. diff --git a/doc/plugins/ddate.mdwn b/doc/plugins/ddate.mdwn index b2c6df05d..e82760d88 100644 --- a/doc/plugins/ddate.mdwn +++ b/doc/plugins/ddate.mdwn @@ -1,8 +1,8 @@ -[[template id=plugin name=ddate author="[[Joey]]"]] -[[tag type/fun]] +[[!template id=plugin name=ddate author="[[Joey]]"]] +[[!tag type/fun]] Enables use of Discordian dates. `--timeformat` can be used to change the date format; see `ddate(1)`. -This plugin requires the [[cpan DateTime]] and -[[cpan DateTime::Calendar::Discordian]] perl modules. +This plugin requires the [[!cpan DateTime]] and +[[!cpan DateTime::Calendar::Discordian]] perl modules. diff --git a/doc/plugins/editdiff.mdwn b/doc/plugins/editdiff.mdwn index 61c36a9d6..6351c563f 100644 --- a/doc/plugins/editdiff.mdwn +++ b/doc/plugins/editdiff.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=editdiff author="[[JeremieKoenig]]"]] -[[tag type/useful]] +[[!template id=plugin name=editdiff author="[[JeremieKoenig]]"]] +[[!tag type/useful]] This plugin adds a "Diff" button when a page is being edited. When clicked, a diff between the stored page and provided content diff --git a/doc/plugins/edittemplate.mdwn b/doc/plugins/edittemplate.mdwn index 8140b4f41..a68f7f0a1 100644 --- a/doc/plugins/edittemplate.mdwn +++ b/doc/plugins/edittemplate.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=edittemplate author="[[Joey]]"]] -[[tag type/useful]] +[[!template id=plugin name=edittemplate author="[[Joey]]"]] +[[!tag type/useful]] This plugin allows registering template pages, that provide default content for new pages created using the web frontend. To register a @@ -19,7 +19,7 @@ something like: Reproducible: y/n Details: -The template page can also contain [[cpan HTML::Template]] directives, +The template page can also contain [[!cpan HTML::Template]] directives, similar to other ikiwiki [[templates]]. Currently only one variable is set: `<TMPL_VAR name>` is replaced with the name of the page being created. diff --git a/doc/plugins/embed.mdwn b/doc/plugins/embed.mdwn index ba327da8d..1d43061e0 100644 --- a/doc/plugins/embed.mdwn +++ b/doc/plugins/embed.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=embed author="[[Joey]]"]] -[[tag type/html]] +[[!template id=plugin name=embed author="[[Joey]]"]] +[[!tag type/html]] This plugin allows embedding content from external sites on wiki pages. diff --git a/doc/plugins/favicon.mdwn b/doc/plugins/favicon.mdwn index 52dbf6a2f..7941f8a6c 100644 --- a/doc/plugins/favicon.mdwn +++ b/doc/plugins/favicon.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=favicon author="[[Joey]]"]] -[[tag type/chrome]] +[[!template id=plugin name=favicon author="[[Joey]]"]] +[[!tag type/chrome]] If this plugin is enabled, then an icon link is added to pages, for web browsers to display. The icon is currently hardcoded to be a favicon.ico, diff --git a/doc/plugins/fortune.mdwn b/doc/plugins/fortune.mdwn index b855c18f3..c47c02e6f 100644 --- a/doc/plugins/fortune.mdwn +++ b/doc/plugins/fortune.mdwn @@ -1,15 +1,15 @@ -[[template id=plugin name=fortune author="[[Joey]]"]] -[[tag type/fun]] +[[!template id=plugin name=fortune author="[[Joey]]"]] +[[!tag type/fun]] This just uses the `fortune` program to insert a fortune into the page. Usage: - \[[fortune ]] + \[[!fortune ]] -[[if test="enabled(fortune)" then=""" +[[!if test="enabled(fortune)" then=""" Here's a fortune for you: ---- -[[fortune ]] +[[!fortune ]] """]] diff --git a/doc/plugins/goodstuff.mdwn b/doc/plugins/goodstuff.mdwn index ca888910d..adf2b0a5b 100644 --- a/doc/plugins/goodstuff.mdwn +++ b/doc/plugins/goodstuff.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=goodstuff author="[[Joey]]"]] -[[tag type/bundle]] +[[!template id=plugin name=goodstuff author="[[Joey]]"]] +[[!tag type/bundle]] This plugin enables a bunch of other plugins -- basically all the ones that are not too intrusive, work well with little configuration, and are nice to diff --git a/doc/plugins/googlecalendar.mdwn b/doc/plugins/googlecalendar.mdwn index 6d7429d14..bca2ae74f 100644 --- a/doc/plugins/googlecalendar.mdwn +++ b/doc/plugins/googlecalendar.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=googlecalendar author="[[Joey]]"]] -[[tag type/special-purpose]] +[[!template id=plugin name=googlecalendar author="[[Joey]]"]] +[[!tag type/special-purpose]] *Note*: This plugin is deprecated. Please switch to the [[embed]] plugin. @@ -11,7 +11,7 @@ content. This plugin is an example of how to deal with this in ikiwiki. Example use: - \[[googlecalendar html=""" + \[[!googlecalendar html=""" <iframe src="http://www.google.com/calendar/embed?src=adkrdken8mupngh13jshlbenoc%40group.calendar.google.com&title=OSEL%20Calendar&chrome=NAVIGATION&bgcolor=%2371d873&height=588" style=" border-width:0 " width="480" frameborder="0" height="588"></iframe> """]] diff --git a/doc/plugins/graphviz.mdwn b/doc/plugins/graphviz.mdwn index fb669ae21..f8cf094f4 100644 --- a/doc/plugins/graphviz.mdwn +++ b/doc/plugins/graphviz.mdwn @@ -1,13 +1,13 @@ -[[template id=plugin name=graphviz author="[[JoshTriplett]]"]] -[[tag type/chrome type/format]] +[[!template id=plugin name=graphviz author="[[JoshTriplett]]"]] +[[!tag type/chrome type/format]] This plugin allows embedding [graphviz](http://www.graphviz.org/) graphs in a page. Example usage: - \[[graph src="a -> b -> c; a -> c;"]] + \[[!graph src="a -> b -> c; a -> c;"]] Note that graphs will only show up in previews if your browser has -[[wikipedia data: URI]] support, or if the same graph already exists on that +[[!wikipedia data: URI]] support, or if the same graph already exists on that page. Security implications: graphviz does not seem to have any syntax exploitable to @@ -31,11 +31,11 @@ The `graph` directive supports the following parameters: in inches. You must specify both to limit the size; otherwise, graphviz will choose a size, without any limit. -[[if test="enabled(graphviz)" then=""" +[[!if test="enabled(graphviz)" then=""" Some example graphs: -[[graph src="a -> b -> c; a -> b;"]] -[[graph src="a -- b -- c -- a;" prog="circo" type="graph"]] +[[!graph src="a -> b -> c; a -> b;"]] +[[!graph src="a -- b -- c -- a;" prog="circo" type="graph"]] """]] -This plugin uses the [[cpan Digest::SHA1]] perl module. +This plugin uses the [[!cpan Digest::SHA1]] perl module. diff --git a/doc/plugins/haiku.mdwn b/doc/plugins/haiku.mdwn index 259669d67..ac340e42d 100644 --- a/doc/plugins/haiku.mdwn +++ b/doc/plugins/haiku.mdwn @@ -1,12 +1,12 @@ -[[template id=plugin name=haiku author="[[Joey]]"]] -[[tag type/fun]] +[[!template id=plugin name=haiku author="[[Joey]]"]] +[[!tag type/fun]] This plugin allows inserting a randomly generated haiku into a wiki page. Just type: - \[[haiku hint="argument"]] + \[[!haiku hint="argument"]] -[[haiku hint="argument test"]] +[[!haiku hint="argument test"]] The hint parameter can be omitted, it only provides the generator a hint of what to write the haiku about. If no hint is given, it might base it on the diff --git a/doc/plugins/hnb.mdwn b/doc/plugins/hnb.mdwn index 647fe19c1..afe04c943 100644 --- a/doc/plugins/hnb.mdwn +++ b/doc/plugins/hnb.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=hnb author="[[XTaran]]"]] -[[tag type/format type/slow]] +[[!template id=plugin name=hnb author="[[XTaran]]"]] +[[!tag type/format type/slow]] This plugin allows ikiwiki to process `.hnb` XML files, as created by the Hierachical Notebook [hnb](http://hnb.sourceforge.net/). To use it, you need to have diff --git a/doc/plugins/html.mdwn b/doc/plugins/html.mdwn index 8efefcbcb..55e11bff0 100644 --- a/doc/plugins/html.mdwn +++ b/doc/plugins/html.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=html author="[[Joey]]"]] -[[tag type/html type/format]] +[[!template id=plugin name=html author="[[Joey]]"]] +[[!tag type/html type/format]] This plugin lets html pages be used as source pages for the wiki. The html pages will still be wrapped in the same html template as any other diff --git a/doc/plugins/htmlscrubber.mdwn b/doc/plugins/htmlscrubber.mdwn index b32c264df..b651ffc99 100644 --- a/doc/plugins/htmlscrubber.mdwn +++ b/doc/plugins/htmlscrubber.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=htmlscrubber core=1 author="[[Joey]]"]] -[[tag type/html]] +[[!template id=plugin name=htmlscrubber core=1 author="[[Joey]]"]] +[[!tag type/html]] This plugin is enabled by default. It sanitizes the html on pages it renders to avoid XSS attacks and the like. @@ -13,7 +13,7 @@ All attributes that can be used to specify an url are checked to make sure that the url is in a known, safe scheme, and to block embedded javascript in such urls. -It uses the [[cpan HTML::Scrubber]] perl module to perform its html +It uses the [[!cpan HTML::Scrubber]] perl module to perform its html sanitisation, and this perl module also deals with various entity encoding tricks. diff --git a/doc/plugins/htmltidy.mdwn b/doc/plugins/htmltidy.mdwn index dae812df2..f675a01ae 100644 --- a/doc/plugins/htmltidy.mdwn +++ b/doc/plugins/htmltidy.mdwn @@ -1,6 +1,6 @@ -[[template id=plugin name=htmltidy author="Faidon Liambotis"]] -[[tag type/html]] -[[tag type/slow]] +[[!template id=plugin name=htmltidy author="Faidon Liambotis"]] +[[!tag type/html]] +[[!tag type/slow]] This plugin uses [tidy](http://tidy.sourceforge.net/) to tidy up the html emitted by ikiwiki. Besides being nicely formatted, this helps ensure that diff --git a/doc/plugins/httpauth.mdwn b/doc/plugins/httpauth.mdwn index 26f258bd3..fbf366291 100644 --- a/doc/plugins/httpauth.mdwn +++ b/doc/plugins/httpauth.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=httpauth author="Alec Berryman"]] -[[tag type/auth]] +[[!template id=plugin name=httpauth author="Alec Berryman"]] +[[!tag type/auth]] This plugin allows HTTP basic authentication to be used to log into the wiki. To use the plugin, your web server should be set up to perform HTTP diff --git a/doc/plugins/img.mdwn b/doc/plugins/img.mdwn index a4661f1a8..898609a29 100644 --- a/doc/plugins/img.mdwn +++ b/doc/plugins/img.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=img author="Christian Mock"]] -[[tag type/chrome]] +[[!template id=plugin name=img author="Christian Mock"]] +[[!tag type/chrome]] This is an image handling plugin. While ikiwiki supports inlining full-size images by making a [[ikiwiki/WikiLink]] that points to the image, using @@ -14,7 +14,7 @@ Note that this is a stripped down version of Christian Mock's ## usage - \[[img image1.jpg size="200x200" alt="clouds"]] + \[[!img image1.jpg size="200x200" alt="clouds"]] The image file will be searched for using the same rules as used to find the file pointed to by a [[ikiwiki/WikiLink]]. @@ -35,7 +35,7 @@ to another page instead, or "link=no" to disable the link, or You can also set default values that will be applied to all later images on the page, unless overridden. Useful when including many images on a page. - \[[img defaults size=200x200 alt="wedding photo"]] - \[[img photo1.jpg]] - \[[img photo2.jpg]] - \[[img photo3.jpg size=200x600]] + \[[!img defaults size=200x200 alt="wedding photo"]] + \[[!img photo1.jpg]] + \[[!img photo2.jpg]] + \[[!img photo3.jpg size=200x600]] diff --git a/doc/plugins/inline.mdwn b/doc/plugins/inline.mdwn index fc6f9e8af..e66c9103f 100644 --- a/doc/plugins/inline.mdwn +++ b/doc/plugins/inline.mdwn @@ -1,9 +1,9 @@ -[[template id=plugin name=inline core=1 author="[[Joey]]"]] +[[!template id=plugin name=inline core=1 author="[[Joey]]"]] This is a [[ikiwiki/PreProcessorDirective]] that allows including one wiki page inside another. For example: - \[[inline pages="blog/*"]] + \[[!inline pages="blog/*"]] The most common use of inlining is generating blogs and RSS or Atom feeds. See [[ikiwiki/blog]] for details. diff --git a/doc/plugins/install.mdwn b/doc/plugins/install.mdwn index 3efcb4c4b..900662eec 100644 --- a/doc/plugins/install.mdwn +++ b/doc/plugins/install.mdwn @@ -1,4 +1,4 @@ -[[meta title="Installing third party plugins"]] +[[!meta title="Installing third party plugins"]] Most ikiwiki plugins are perl modules and should be installed somewhere in the perl module search path. See the @INC list at the end of the output of diff --git a/doc/plugins/link.mdwn b/doc/plugins/link.mdwn index 03f299282..330e0040e 100644 --- a/doc/plugins/link.mdwn +++ b/doc/plugins/link.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=link core=1 author="[[Joey]]"]] -[[tag type/link]] +[[!template id=plugin name=link core=1 author="[[Joey]]"]] +[[!tag type/link]] This plugin implements standard [[WikiLinks|WikiLink]]. diff --git a/doc/plugins/linkmap.mdwn b/doc/plugins/linkmap.mdwn index 6cd23b5cb..935f3d3cd 100644 --- a/doc/plugins/linkmap.mdwn +++ b/doc/plugins/linkmap.mdwn @@ -1,10 +1,10 @@ -[[template id=plugin name=linkmap author="[[Joey]]"]] -[[tag type/meta]] -[[tag type/slow]] +[[!template id=plugin name=linkmap author="[[Joey]]"]] +[[!tag type/meta]] +[[!tag type/slow]] This plugin uses [graphviz](http://www.graphviz.org/) to generate a graph showing the links between a set of pages in the wiki. Example usage: - \[[linkmap pages="* and !blog/* and !*/Discussion"]] + \[[!linkmap pages="* and !blog/* and !*/Discussion"]] Only links between mapped pages will be shown; links pointing to or from unmapped pages will be omitted. If the pages to include are not specified, @@ -22,8 +22,8 @@ directive: in inches. Both must be specified for the limiting to take effect, otherwise the map's size is not limited. -[[if test="enabled(linkmap)" then=""" +[[!if test="enabled(linkmap)" then=""" Here is an example link map, of the index page and all pages it links to: -[[linkmap pages="index or (backlink(index) and !*.png)"]] +[[!linkmap pages="index or (backlink(index) and !*.png)"]] """]] diff --git a/doc/plugins/lockedit.mdwn b/doc/plugins/lockedit.mdwn index 8dd448558..01b0f157d 100644 --- a/doc/plugins/lockedit.mdwn +++ b/doc/plugins/lockedit.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=lockedit core=1 author="[[Joey]]"]] -[[tag type/auth]] +[[!template id=plugin name=lockedit core=1 author="[[Joey]]"]] +[[!tag type/auth]] This plugin enables [[page_locking]]. It is enabled by default. diff --git a/doc/plugins/map.mdwn b/doc/plugins/map.mdwn index 472f62461..3700fadd8 100644 --- a/doc/plugins/map.mdwn +++ b/doc/plugins/map.mdwn @@ -1,7 +1,7 @@ -[[template id=plugin name=map author="Alessandro Dotti Contra"]] -[[tag type/meta]] +[[!template id=plugin name=map author="Alessandro Dotti Contra"]] +[[!tag type/meta]] -[[meta description="some page description"]] +[[!meta description="some page description"]] This plugin generates a hierarchical page map for the wiki. Example usage: @@ -19,7 +19,7 @@ the [[meta]] plugin). For example: Hint: To limit the map to displaying pages less than a certain level deep, use a [[ikiwiki/PageSpec]] like this: `pages="* and !*/*/*"` -[[if test="enabled(map)" then=""" +[[!if test="enabled(map)" then=""" Here's an example map, for the plugins section of this wiki: [[!map pages="(plugins or plugins/*) and !*/*/*"]] diff --git a/doc/plugins/map/discussion.mdwn b/doc/plugins/map/discussion.mdwn index 814e4f934..c724a6492 100644 --- a/doc/plugins/map/discussion.mdwn +++ b/doc/plugins/map/discussion.mdwn @@ -16,5 +16,5 @@ Thoughts, anyone? --[[KarlMW]] We'd also very much like to have an option to display the title of the page instead of the filename in the map plugin. --Andrew -There's a patch implementing this in [[debbug 484510]]. It needs a few fixes +There's a patch implementing this in [[!debbug 484510]]. It needs a few fixes before I merge it. Now applied. --[[Joey]] diff --git a/doc/plugins/mdwn.mdwn b/doc/plugins/mdwn.mdwn index b5ce9c79c..6ad1fb229 100644 --- a/doc/plugins/mdwn.mdwn +++ b/doc/plugins/mdwn.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=mdwn core=1 author="[[Joey]]"]] -[[tag type/format]] +[[!template id=plugin name=mdwn core=1 author="[[Joey]]"]] +[[!tag type/format]] This plugin lets ikwiki convert files with names ending in ".mdwn" to html. It uses the [[ikiwiki/markdown]] minimal markup language. @@ -10,9 +10,9 @@ are also available in other plugins. There are several implementations of markdown support that can be used by this plugin. The [original version of markdown](http://daringfireball.net/projects/markdown/) can be used, or the -[[cpan Text::Markdown]] perl module. +[[!cpan Text::Markdown]] perl module. -[[cpan Text::Markdown]] also includes a markdown variant called +[[!cpan Text::Markdown]] also includes a markdown variant called [multimarkdown](http://fletcherpenney.net/MultiMarkdown/), which supports tables, footnotes, and other new features. Multimarkdown is not enabled by default, but can be turned on via the `multimarkdown` option in the setup diff --git a/doc/plugins/meta.mdwn b/doc/plugins/meta.mdwn index b1e0cb757..599d9cbd8 100644 --- a/doc/plugins/meta.mdwn +++ b/doc/plugins/meta.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=meta author="[[Joey]]"]] -[[tag type/meta]] +[[!template id=plugin name=meta author="[[Joey]]"]] +[[!tag type/meta]] This plugin allows inserting arbitrary metadata into the source of a page. Enter the metadata as follows: @@ -55,7 +55,7 @@ Supported fields: * date Specifies the creation date of the page. The date can be entered in - nearly any format, since it's parsed by [[cpan TimeDate]]. + nearly any format, since it's parsed by [[!cpan TimeDate]]. * stylesheet diff --git a/doc/plugins/mirrorlist.mdwn b/doc/plugins/mirrorlist.mdwn index 25bad0585..89022e5ab 100644 --- a/doc/plugins/mirrorlist.mdwn +++ b/doc/plugins/mirrorlist.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=mirror author="[[Joey]]"]] -[[tag type/special-purpose]] +[[!template id=plugin name=mirror author="[[Joey]]"]] +[[!tag type/special-purpose]] This plugin allows adding links a list of mirrors to each page in the wiki. For each mirror, a name and an url should be specified. Pages are diff --git a/doc/plugins/more.mdwn b/doc/plugins/more.mdwn index 44a777813..a17e78eb2 100644 --- a/doc/plugins/more.mdwn +++ b/doc/plugins/more.mdwn @@ -1,10 +1,10 @@ -[[template id=plugin name=more author="Ben"]] -[[tag type/format]] +[[!template id=plugin name=more author="Ben"]] +[[!tag type/format]] This plugin provides a way to have a "more" link on a page in a blog, that leads to the full version of the page. Use it like this: - \[[more linktext="click for more" text=""" + \[[!more linktext="click for more" text=""" This is the rest of my post. Not intended for people catching up on their blogs at 30,000 feet. Because I like to make things difficult. diff --git a/doc/plugins/opendiscussion.mdwn b/doc/plugins/opendiscussion.mdwn index cf0036c4c..b2ba68bf7 100644 --- a/doc/plugins/opendiscussion.mdwn +++ b/doc/plugins/opendiscussion.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=opendiscussion author="[[Joey]]"]] -[[tag type/auth]] +[[!template id=plugin name=opendiscussion author="[[Joey]]"]] +[[!tag type/auth]] This plugin allows editing of Discussion pages by anonymous users who have not logged into the wiki. diff --git a/doc/plugins/openid.mdwn b/doc/plugins/openid.mdwn index a85727eca..d4aa18c7d 100644 --- a/doc/plugins/openid.mdwn +++ b/doc/plugins/openid.mdwn @@ -1,12 +1,12 @@ -[[template id=plugin name=openid core=1 author="[[Joey]]"]] -[[tag type/auth]] +[[!template id=plugin name=openid core=1 author="[[Joey]]"]] +[[!tag type/auth]] This plugin allows users to use their [OpenID](http://openid.net/) to log into the wiki. -The plugin needs the [[cpan Net::OpenID::Consumer]] perl module. The -[[cpan LWPx::ParanoidAgent]] perl module is used if available, for added -security. Finally, the [[cpan Crypt::SSLeay]] perl module is needed to support +The plugin needs the [[!cpan Net::OpenID::Consumer]] perl module. The +[[!cpan LWPx::ParanoidAgent]] perl module is used if available, for added +security. Finally, the [[!cpan Crypt::SSLeay]] perl module is needed to support users entering "https" OpenID urls. This plugin has a configuration option. You can set `--openidsignup` diff --git a/doc/plugins/orphans.mdwn b/doc/plugins/orphans.mdwn index f7a856ef1..136ce42a7 100644 --- a/doc/plugins/orphans.mdwn +++ b/doc/plugins/orphans.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=orphans author="[[Joey]]"]] -[[tag type/meta]] +[[!template id=plugin name=orphans author="[[Joey]]"]] +[[!tag type/meta]] This plugin generates a list of possibly orphaned pages -- pages that no other page links to. @@ -11,10 +11,10 @@ Note that it takes [[BackLinks]] into account, but does not count inlining a page as linking to it, so will generally count many blog-type pages as orphans. -[[if test="enabled(orphans)" then=""" +[[!if test="enabled(orphans)" then=""" Here's a list of orphaned pages on this wiki: -[[orphans pages="* and !news/* and !todo/* and !bugs/* and !users/* and +[[!orphans pages="* and !news/* and !todo/* and !bugs/* and !users/* and !recentchanges and !examples/* and !tips/* and !sandbox/* and !templates/* and !wikiicons/* and !plugins/*"]] """]] diff --git a/doc/plugins/otl.mdwn b/doc/plugins/otl.mdwn index 013a5072a..d890b0126 100644 --- a/doc/plugins/otl.mdwn +++ b/doc/plugins/otl.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=otl author="[[Joey]]"]] -[[tag type/format]] +[[!template id=plugin name=otl author="[[Joey]]"]] +[[!tag type/format]] This plugin allows ikiwiki to process `.otl` outline files, as created by [vimoutliner](http://www.vimoutliner.org/). To use it, you need to have diff --git a/doc/plugins/pagecount.mdwn b/doc/plugins/pagecount.mdwn index 8f7029df8..790f033ca 100644 --- a/doc/plugins/pagecount.mdwn +++ b/doc/plugins/pagecount.mdwn @@ -1,7 +1,7 @@ -[[template id=plugin name=pagecount author="[[Joey]]"]] -[[tag type/meta]] +[[!template id=plugin name=pagecount author="[[Joey]]"]] +[[!tag type/meta]] -Provides a \\[[pagecount ]] [[ikiwiki/PreProcessorDirective]] that is +Provides a \\[[!pagecount ]] [[ikiwiki/PreProcessorDirective]] that is replaced with the total number of pages currently in the wiki. The optional parameter "pages" can be a [[ikiwiki/PageSpec]] specifying the @@ -10,5 +10,5 @@ pages to count, default is to count them all. This plugin is included in ikiwiki, but is not enabled by default. If it is turned on it can tell us that this wiki includes -[[pagecount pages="* and !recentchanges"]] -pages, of which [[pagecount pages="*/Discussion"]] are discussion pages. +[[!pagecount pages="* and !recentchanges"]] +pages, of which [[!pagecount pages="*/Discussion"]] are discussion pages. diff --git a/doc/plugins/pagestats.mdwn b/doc/plugins/pagestats.mdwn index f766a1ac8..ab32fb002 100644 --- a/doc/plugins/pagestats.mdwn +++ b/doc/plugins/pagestats.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=pagestats author="Enrico Zini"]] -[[tag type/meta type/tags]] +[[!template id=plugin name=pagestats author="Enrico Zini"]] +[[!tag type/meta type/tags]] This plugin can generate stats about how pages link to each other. It can produce either a del.icio.us style cloud, or a table counting the number of @@ -7,8 +7,8 @@ links to each page. Here's how to use it to create a [[tag]] cloud: - \[[pagestats pages="tags/*"]] + \[[!pagestats pages="tags/*"]] And here's how to create a table of all the pages on the wiki: - \[[pagestats style="table"]] + \[[!pagestats style="table"]] diff --git a/doc/plugins/pagetemplate.mdwn b/doc/plugins/pagetemplate.mdwn index bea154340..57d78483d 100644 --- a/doc/plugins/pagetemplate.mdwn +++ b/doc/plugins/pagetemplate.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=pagetemplate author="[[Joey]]"]] -[[tag type/chrome]] +[[!template id=plugin name=pagetemplate author="[[Joey]]"]] +[[!tag type/chrome]] This plugin allows a page to be created using a different [[template|wikitemplates]]. The page text is inserted into the template, so @@ -11,4 +11,4 @@ This plugin can only use templates that are already installed in /usr/share/ikiwiki/templates (or wherever ikiwiki is configured to look for them). You can choose to use any .tmpl files in that directory. Example: - \[[pagetemplate template=my_fancy.tmpl]] + \[[!pagetemplate template=my_fancy.tmpl]] diff --git a/doc/plugins/passwordauth.mdwn b/doc/plugins/passwordauth.mdwn index 473424764..fe680a0f8 100644 --- a/doc/plugins/passwordauth.mdwn +++ b/doc/plugins/passwordauth.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=passwordauth core=1 author="[[Joey]]"]] -[[tag type/auth]] +[[!template id=plugin name=passwordauth core=1 author="[[Joey]]"]] +[[!tag type/auth]] This plugin lets ikiwiki prompt for a user name and password when logging into the wiki. It also handles registering users, resetting passwords, and @@ -18,7 +18,7 @@ as an "ask an existing member to get an account" system.) Users' passwords are stored in the `.ikiwiki/userdb` file, which needs to be kept safe to prevent exposure of passwords. If the -[[cpan Authen::Passphrase]] perl module is installed, only hashes of the +[[!cpan Authen::Passphrase]] perl module is installed, only hashes of the passwords will be stored. This is strongly recommended. The `password_cost` configuration option can be used to make the stored diff --git a/doc/plugins/pingee.mdwn b/doc/plugins/pingee.mdwn index 03eeb581c..d012004f9 100644 --- a/doc/plugins/pingee.mdwn +++ b/doc/plugins/pingee.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=pingee author="[[Joey]]"]] -[[tag type/special-purpose]] +[[!template id=plugin name=pingee author="[[Joey]]"]] +[[!tag type/special-purpose]] This plugin causes ikiwiki to listen for pings, typically delivered from another ikiwiki instance using the [[pinger]] plugin. When a ping is diff --git a/doc/plugins/pinger.mdwn b/doc/plugins/pinger.mdwn index f747a9f0b..f2dd12e62 100644 --- a/doc/plugins/pinger.mdwn +++ b/doc/plugins/pinger.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=pinger author="[[Joey]]"]] -[[tag type/special-purpose]] +[[!template id=plugin name=pinger author="[[Joey]]"]] +[[!tag type/special-purpose]] This plugin allows ikiwiki to be configured to hit a URL each time it updates the wiki. One way to use this is in conjunction with the [[pingee]] @@ -16,9 +16,9 @@ the pinging. This is used to prevent ping loops. The "to" parameter is the url to ping. The example shows how to ping another ikiwiki instance. -The [[cpan LWP]] perl module is used for pinging. Or the [[cpan +The [[!cpan LWP]] perl module is used for pinging. Or the [[!cpan LWPx::ParanoidAgent]] perl module is used if available, for added security. -Finally, the [[cpan Crypt::SSLeay]] perl module is needed to support pinging +Finally, the [[!cpan Crypt::SSLeay]] perl module is needed to support pinging "https" urls. By default the pinger will try to ping a site for 15 seconds before timing diff --git a/doc/plugins/poll.mdwn b/doc/plugins/poll.mdwn index 94d5fa339..17b1c4efc 100644 --- a/doc/plugins/poll.mdwn +++ b/doc/plugins/poll.mdwn @@ -1,10 +1,10 @@ -[[template id=plugin name=poll author="[[Joey]]"]] -[[tag type/useful]] +[[!template id=plugin name=poll author="[[Joey]]"]] +[[!tag type/useful]] This plugin allows you to create online polls in the wiki. Here's an example use: - \[[poll 0 "red" 0 "green" 0 "blue"]] + \[[!poll 0 "red" 0 "green" 0 "blue"]] The numbers indicate how many users voted for that choice. When a user votes for a choice in the poll, the page is modified and the number diff --git a/doc/plugins/polygen.mdwn b/doc/plugins/polygen.mdwn index 8d6794073..09195e694 100644 --- a/doc/plugins/polygen.mdwn +++ b/doc/plugins/polygen.mdwn @@ -1,29 +1,29 @@ -[[template id=plugin name=polygen author="Enrico Zini"]] -[[tag type/fun]] +[[!template id=plugin name=polygen author="Enrico Zini"]] +[[!tag type/fun]] This plugin allows inserting text generated by polygen into a wiki page. For example: - \[[polygen grammar="genius"]] + \[[!polygen grammar="genius"]] It's also possible to specify a starting nonterminal for the grammar by including `symbol="text"` in the directive. -[[if test="enabled(polygen)" then=""" +[[!if test="enabled(polygen)" then=""" ---- Here are a few notes about ikiwiki, courtesy of polygen: -Ikiwiki is internally based on a [[polygen grammar="designpatterns"]] -coupled to a [[polygen grammar="designpatterns"]], as described in -"[[polygen grammar="paper"]]" by [[polygen grammar="nipponame"]] of -[[polygen grammar="boyband"]]. +Ikiwiki is internally based on a [[!polygen grammar="designpatterns"]] +coupled to a [[!polygen grammar="designpatterns"]], as described in +"[[!polygen grammar="paper"]]" by [[!polygen grammar="nipponame"]] of +[[!polygen grammar="boyband"]]. Ikiwiki reviews: <ul> -<li>[[polygen grammar="reviews"]]</li> -<li>[[polygen grammar="reviews"]]</li> -<li>[[polygen grammar="reviews"]]</li> +<li>[[!polygen grammar="reviews"]]</li> +<li>[[!polygen grammar="reviews"]]</li> +<li>[[!polygen grammar="reviews"]]</li> </ul> """]] diff --git a/doc/plugins/postsparkline.mdwn b/doc/plugins/postsparkline.mdwn index d716022e1..73c6801a1 100644 --- a/doc/plugins/postsparkline.mdwn +++ b/doc/plugins/postsparkline.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=postsparkline author="[[Joey]]"]] -[[tag type/chrome]] +[[!template id=plugin name=postsparkline author="[[Joey]]"]] +[[!tag type/chrome]] This plugin uses the [[sparkline]] plugin to create a sparkline of statistics about a set of pages, such as posts to a blog. @@ -7,11 +7,11 @@ statistics about a set of pages, such as posts to a blog. # examples Post interval: - \[[postsparkline pages="blog/* and !*/Discussion" max=100 + \[[!postsparkline pages="blog/* and !*/Discussion" max=100 formula=interval style=bar barwidth=2 barspacing=1 height=13]] Posts per month this year: - \[[postsparkline pages="blog/* and !*/Discussion" max=12 + \[[!postsparkline pages="blog/* and !*/Discussion" max=12 formula=permonth style=bar barwidth=2 barspacing=1 height=13]] # usage diff --git a/doc/plugins/prettydate.mdwn b/doc/plugins/prettydate.mdwn index 49feaa8e6..9a67f5dca 100644 --- a/doc/plugins/prettydate.mdwn +++ b/doc/plugins/prettydate.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=prettydate author="[[Joey]]"]] -[[tag type/format]] +[[!template id=plugin name=prettydate author="[[Joey]]"]] +[[!tag type/format]] Enabling this plugin changes the dates displayed on pages in the wiki to a format that is nice and easy to read. Examples: "late Wednesday evening, @@ -16,4 +16,4 @@ The format used for the date can be customised using the `prettydateformat` configuration variable in the setup file. `%X` will be expanded to the prettified time value. The default prettydateformat is `"%X, %B %o, %Y"`. -This plugin uses the [[cpan TimeDate]] perl module. +This plugin uses the [[!cpan TimeDate]] perl module. diff --git a/doc/plugins/rawhtml.mdwn b/doc/plugins/rawhtml.mdwn index 237fb1db6..3b2d3d06c 100644 --- a/doc/plugins/rawhtml.mdwn +++ b/doc/plugins/rawhtml.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=rawhtml author="[[Joey]]"]] -[[tag type/html type/format]] +[[!template id=plugin name=rawhtml author="[[Joey]]"]] +[[!tag type/html type/format]] This plugin changes how ikiwiki handles html files, making it treat html or xhtml files not as source files but as data files that are copied diff --git a/doc/plugins/recentchanges.mdwn b/doc/plugins/recentchanges.mdwn index b48dcbacf..4ab2cd078 100644 --- a/doc/plugins/recentchanges.mdwn +++ b/doc/plugins/recentchanges.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=recentchanges core=1 author="[[Joey]]"]] +[[!template id=plugin name=recentchanges core=1 author="[[Joey]]"]] This plugin examines the [[revision_control_system|rcs]] history and generates a page describing each recent change made to the wiki. These @@ -8,19 +8,19 @@ pages can be joined together with [[inline]] to generate the Typically only the RecentChanges page will use the pages generated by this plugin, but you can use it elsewhere too if you like. It's used like this: - \[[inline pages="internal(recentchanges/change_*)" + \[[!inline pages="internal(recentchanges/change_*)" template=recentchanges show=0]] Here's an example of how to show only changes to "bugs/*". This matches against the title of the change, which includes a list of modified pages. - \[[inline pages="internal(recentchanges/change_*) and title(*bugs/*)" + \[[!inline pages="internal(recentchanges/change_*) and title(*bugs/*)" template=recentchanges show=0]] Here's an example of how to show only changes that Joey didn't make. (Joey commits sometimes as user `joey`, and sometimes via openid.) - \[[inline pages="internal(recentchanges/change_*) and + \[[!inline pages="internal(recentchanges/change_*) and !author(joey) and !author(http://joey.kitenet.net*)" template=recentchanges show=0]] diff --git a/doc/plugins/recentchangesdiff.mdwn b/doc/plugins/recentchangesdiff.mdwn index f805eabe1..a7b113ade 100644 --- a/doc/plugins/recentchangesdiff.mdwn +++ b/doc/plugins/recentchangesdiff.mdwn @@ -1,4 +1,4 @@ -[[template id=plugin name=recentchangesdiff core=0 author="[[Joey]]"]] +[[!template id=plugin name=recentchangesdiff core=0 author="[[Joey]]"]] This plugin extends the [[recentchanges]] plugin, adding a diff for each change. The diffs are by default hidden from display on the recentchanges diff --git a/doc/plugins/rst.mdwn b/doc/plugins/rst.mdwn index 49dd81e70..b415ecdb9 100644 --- a/doc/plugins/rst.mdwn +++ b/doc/plugins/rst.mdwn @@ -1,9 +1,9 @@ -[[template id=plugin name=rst author="martin f. krafft"]] -[[tag type/format]] +[[!template id=plugin name=rst author="martin f. krafft"]] +[[!tag type/format]] This plugin lets ikwiki convert files with names ending in ".rst" to html. It uses the [reStructuredText](http://docutils.sourceforge.net/rst.html) -markup syntax. You need to have [[cpan RPC::XML]], python and the +markup syntax. You need to have [[!cpan RPC::XML]], python and the python-docutils module installed to use it. Note that this plugin does not interoperate very well with the rest of diff --git a/doc/plugins/search.mdwn b/doc/plugins/search.mdwn index 9336b2403..cc8190567 100644 --- a/doc/plugins/search.mdwn +++ b/doc/plugins/search.mdwn @@ -1,10 +1,10 @@ -[[template id=plugin name=search author="[[Joey]]"]] -[[tag type/useful]] +[[!template id=plugin name=search author="[[Joey]]"]] +[[!tag type/useful]] This plugin adds full text search to ikiwiki, using the [xapian](http://xapian.org/) engine, its [omega](http://xapian.org/docs/omega/overview.html) frontend, and the -[[cpan Search::Xapian]], [[cpan Digest::SHA1]], and [[cpan HTML::Scrubber]] +[[!cpan Search::Xapian]], [[!cpan Digest::SHA1]], and [[!cpan HTML::Scrubber]] perl modules. The [[ikiwiki/searching]] page describes how to write search queries. diff --git a/doc/plugins/shortcut.mdwn b/doc/plugins/shortcut.mdwn index 8a31a9bd1..e879debbd 100644 --- a/doc/plugins/shortcut.mdwn +++ b/doc/plugins/shortcut.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=shortcut author="[[Joey]]"]] -[[tag type/format]] +[[!template id=plugin name=shortcut author="[[Joey]]"]] +[[!tag type/format]] This plugin allows external links to commonly linked to sites to be made more easily using shortcuts. diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn index 9ddfa19fb..36982eff3 100644 --- a/doc/plugins/sidebar.mdwn +++ b/doc/plugins/sidebar.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=sidebar author="Tuomo Valkonen"]] -[[tag type/chrome]] +[[!template id=plugin name=sidebar author="Tuomo Valkonen"]] +[[!tag type/chrome]] If this plugin is enabled, then a sidebar is added to pages in the wiki. The content of the sidebar is simply the content of a page named diff --git a/doc/plugins/signinedit.mdwn b/doc/plugins/signinedit.mdwn index 525a90fe8..814ab5508 100644 --- a/doc/plugins/signinedit.mdwn +++ b/doc/plugins/signinedit.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=signinedit core=1 author="[[Joey]]"]] -[[tag type/auth]] +[[!template id=plugin name=signinedit core=1 author="[[Joey]]"]] +[[!tag type/auth]] This plugin, which is enabled by default, requires users be logged in before editing pages in the wiki. diff --git a/doc/plugins/smiley.mdwn b/doc/plugins/smiley.mdwn index 4e03f09e4..e4153c612 100644 --- a/doc/plugins/smiley.mdwn +++ b/doc/plugins/smiley.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=smiley author="[[Joey]]"]] -[[tag type/chrome]] +[[!template id=plugin name=smiley author="[[Joey]]"]] +[[!tag type/chrome]] This plugin makes it easy to insert smileys and other special symbols into pages in the wiki. The symbols are all listed on the [[smileys]] page, diff --git a/doc/plugins/sparkline.mdwn b/doc/plugins/sparkline.mdwn index 9a5d0eb74..19b07b812 100644 --- a/doc/plugins/sparkline.mdwn +++ b/doc/plugins/sparkline.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=sparkline author="[[Joey]]"]] -[[tag type/chrome]] +[[!template id=plugin name=sparkline author="[[Joey]]"]] +[[!tag type/chrome]] This plugin allows for easily embedding sparklines into wiki pages. A sparkline is a small word-size graphic chart, that is designed to be @@ -15,32 +15,32 @@ to use the plugin, you will need: php can find it when `sparkline/Sparkline.php` is required. * The GD PHP module used by the Sparkline library. * A "php" program in the path, that can run standalone php programs. -* [[cpan Digest::SHA1]] +* [[!cpan Digest::SHA1]] On a Debian system, this can be accomplished by installing these packages: `libsparkline-php` `php5-gd` `php5-cli` `libdigest-sha1-perl` -This plugin also uses the [[cpan Digest::SHA1]] perl module. +This plugin also uses the [[!cpan Digest::SHA1]] perl module. # examples - \[[sparkline 1 3 5 -3 10 0 width=40 height=16 + \[[!sparkline 1 3 5 -3 10 0 width=40 height=16 featurepoint="4,-3,red,3" featurepoint="5,10,green,3"]] This creates a simple line graph, graphing several points. -[[if test="enabled(sparkline)" then=""" -[[sparkline 1 3 5 -3 10 0 width=40 height=16 +[[!if test="enabled(sparkline)" then=""" +[[!sparkline 1 3 5 -3 10 0 width=40 height=16 featurepoint="4,-3,red,3" featurepoint="5,10,green,3"]] """]] It will be drawn 40 pixels wide and 16 pixels high. The high point in the line has a green marker, and the low point has a red marker. - \[[sparkline 1 -1(red) 1 -1(red) 1 1 1 -1(red) -1(red) style=bar barwidth=2 + \[[!sparkline 1 -1(red) 1 -1(red) 1 1 1 -1(red) -1(red) style=bar barwidth=2 barspacing=1 height=13]] This more complex example generates a bar graph. -[[if test="enabled(sparkline)" then=""" -[[sparkline 1 -1(red) 1 -1(red) 1 1 1 -1(red) -1(red) +[[!if test="enabled(sparkline)" then=""" +[[!sparkline 1 -1(red) 1 -1(red) 1 1 1 -1(red) -1(red) style=bar barwidth=2 barspacing=1 height=13]] """]] The bars are 2 pixels wide, and separated by one pixel, and the graph is 13 diff --git a/doc/plugins/table.mdwn b/doc/plugins/table.mdwn index 6920c8f80..b99bb7cd5 100644 --- a/doc/plugins/table.mdwn +++ b/doc/plugins/table.mdwn @@ -1,21 +1,21 @@ -[[template id=plugin name=table author="[[VictorMoral]]"]] -[[tag type/format]] +[[!template id=plugin name=table author="[[VictorMoral]]"]] +[[!tag type/format]] This plugin can build HTML tables from data in CSV (comma-separated values) or DSV (delimiter-separated values) format. -It needs the perl module [[cpan Text::CSV]] for the CSV data. +It needs the perl module [[!cpan Text::CSV]] for the CSV data. ## examples - \[[table data=""" + \[[!table data=""" Customer|Amount Fulanito|134,34 Menganito|234,56 Menganito|234,56 """]] - \[[table class="book_record" format=csv file="data/books/record1"]] + \[[!table class="book_record" format=csv file="data/books/record1"]] In this second example the `record1` page should be similar to: @@ -26,7 +26,7 @@ In this second example the `record1` page should be similar to: To make a cell span multiple columns, follow it with one or more empty cells. For example: - \[[table data=""" + \[[!table data=""" left||right| a|b|c|d this cell spans 4 columns||| diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn index edae03887..a2f0c7e57 100644 --- a/doc/plugins/tag.mdwn +++ b/doc/plugins/tag.mdwn @@ -1,9 +1,9 @@ -[[template id=plugin name=tag author="[[Joey]]"]] -[[tag type/tags type/link]] +[[!template id=plugin name=tag author="[[Joey]]"]] +[[!tag type/tags type/link]] This plugin allows tagging pages. List tags as follows: - \[[tag tech life linux]] + \[[!tag tech life linux]] The tags work the same as if you had put a (hidden) [[ikiwiki/WikiLink]] on the page for each tag, so you can use a [[ikiwiki/PageSpec]] match all @@ -14,8 +14,8 @@ in RSS and Atom feeds. If you want a visible [[ikiwiki/WikiLink]] along with the tag, use taglink instead: - \[[taglink foo]] - \[[taglink tagged_as_foo|foo]] + \[[!taglink foo]] + \[[!taglink tagged_as_foo|foo]] This plugin has a configuration option. Set --tagbase=tags and links to tags will be located under the specified base page. If ikiwiki is configured @@ -24,7 +24,7 @@ tags/tech, tags/life, and tags/linux. This is a useful way to avoid having to write the full path to tags, if you want to keep them grouped together out of the way. -[[if test="enabled(tag)" then=""" +[[!if test="enabled(tag)" then=""" This wiki has the tag plugin enabled, so you'll see a note below that this page is tagged with the "tags" tag. """]] diff --git a/doc/plugins/tag/discussion.mdwn b/doc/plugins/tag/discussion.mdwn index 7e830fc13..7e7b88bc5 100644 --- a/doc/plugins/tag/discussion.mdwn +++ b/doc/plugins/tag/discussion.mdwn @@ -1,4 +1,4 @@ -I'd like to modify this plugin such that the tag pages are automatically created and populated with a list of relevant posts. The content of the tag page is simply `"\[[inline pages="link(tag/$tag)"]]`. The tag plugin will have to determine whether a page for the given tag already exists, and if not use that Markdown fragment to generate it. +I'd like to modify this plugin such that the tag pages are automatically created and populated with a list of relevant posts. The content of the tag page is simply `"\[[!inline pages="link(tag/$tag)"]]`. The tag plugin will have to determine whether a page for the given tag already exists, and if not use that Markdown fragment to generate it. There are clearly many ways to do this, but any opinions on which is the cleanest? diff --git a/doc/plugins/template.mdwn b/doc/plugins/template.mdwn index daa2403cc..9652bf8ee 100644 --- a/doc/plugins/template.mdwn +++ b/doc/plugins/template.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=template author="[[Joey]]"]] -[[tag type/format]] +[[!template id=plugin name=template author="[[Joey]]"]] +[[!tag type/format]] With this plugin, you can set up templates, and cause them to be filled out and inserted into pages in the wiki. It's documented and existing templates diff --git a/doc/plugins/testpagespec.mdwn b/doc/plugins/testpagespec.mdwn index 9a13ab590..a173f5a96 100644 --- a/doc/plugins/testpagespec.mdwn +++ b/doc/plugins/testpagespec.mdwn @@ -1,23 +1,23 @@ -[[template id=plugin name=testpagespec author="[[Joey]]"]] -[[tag type/useful]] +[[!template id=plugin name=testpagespec author="[[Joey]]"]] +[[!tag type/useful]] This plugin allows testing a [[ikiwiki/PageSpec]] to see if it matches a page, and to see the part that matches, or causes the match to fail. Example uses: - \[[testpagespec pagespec="foopage and barpage" match="foopage"]] + \[[!testpagespec pagespec="foopage and barpage" match="foopage"]] This will print out something like "no match: barpage does not match foopage", highlighting which part of the [[ikiwiki/PageSpec]] is causing the match to fail. - \[[testpagespec pagespec="foopage or !bar*" match="barpage"]] + \[[!testpagespec pagespec="foopage or !bar*" match="barpage"]] This will print out something like "no match: bar* matches barpage", since the part of the [[ikiwiki/PageSpec]] that fails is this negated match. - \[[testpagespec pagespec="foopage or barpage" match="barpage"]] + \[[!testpagespec pagespec="foopage or barpage" match="barpage"]] This will print out something like "match: barpage matches barpage", indicating the part of the [[ikiwiki/PageSpec]] that caused it to match. diff --git a/doc/plugins/teximg.mdwn b/doc/plugins/teximg.mdwn index 588bf5407..1908cfb79 100644 --- a/doc/plugins/teximg.mdwn +++ b/doc/plugins/teximg.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=teximg author="[[PatrickWinnertz]]"]] -[[tag type/chrome type/slow]] +[[!template id=plugin name=teximg author="[[PatrickWinnertz]]"]] +[[!tag type/chrome type/slow]] This plugin renders LaTeX formulas into images. @@ -9,14 +9,14 @@ may not be part of a regular texlive installation. ## examples - \[[teximg code="\ce{[Cu(NH3)3]^{2+}}"]] - \[[teximg code="\frac{1}{2}"]] - \[[teximg code="E = - \frac{Z^2 \cdot \mu \cdot e^4}{32\pi^2 \epsilon_0^2 \hbar^2 n^2}" ]] + \[[!teximg code="\ce{[Cu(NH3)3]^{2+}}"]] + \[[!teximg code="\frac{1}{2}"]] + \[[!teximg code="E = - \frac{Z^2 \cdot \mu \cdot e^4}{32\pi^2 \epsilon_0^2 \hbar^2 n^2}" ]] To scale the image, use height=x: - \[[teximg code="\ce{[Cu(NH3)3]^{2+}}" height="17"]] - \[[teximg code="\ce{[Cu(NH3)3]^{2+}}" height="8"]] + \[[!teximg code="\ce{[Cu(NH3)3]^{2+}}" height="17"]] + \[[!teximg code="\ce{[Cu(NH3)3]^{2+}}" height="8"]] If no height is choosen the default height 12 is used. Valid heights are: 8, 9, 10, 11, 12, 14, 17, 20. If another height is entered, the closest available @@ -24,6 +24,6 @@ height is used. To add an alt text to the image, use alt="text": - \[[teximg code="\frac{1}{2}" alt="1/2"]] + \[[!teximg code="\frac{1}{2}" alt="1/2"]] See [this site](http://www.der-winnie.de/opensource/gsoc2007) for rendered images. diff --git a/doc/plugins/textile.mdwn b/doc/plugins/textile.mdwn index c32b55e4b..4ed7d4e81 100644 --- a/doc/plugins/textile.mdwn +++ b/doc/plugins/textile.mdwn @@ -1,6 +1,6 @@ -[[template id=plugin name=syntax author="mazirian"]] -[[tag type/format]] +[[!template id=plugin name=syntax author="mazirian"]] +[[!tag type/format]] Textile is a versatile markup language. So here's a plugin that will use the Textile markup language to render .txtl files in your data directory. -You must have [[cpan Text::Textile]] installed for it to work. +You must have [[!cpan Text::Textile]] installed for it to work. diff --git a/doc/plugins/toc.mdwn b/doc/plugins/toc.mdwn index c1f8f25f0..149ac041e 100644 --- a/doc/plugins/toc.mdwn +++ b/doc/plugins/toc.mdwn @@ -1,20 +1,20 @@ -[[template id=plugin name=toc author="[[Joey]]"]] -[[tag type/chrome]] +[[!template id=plugin name=toc author="[[Joey]]"]] +[[!tag type/chrome]] Add a table of contents to a page: - \[[toc ]] + \[[!toc ]] The table of contents will be automatically generated based on the headers of the page. By default only the largest headers present on the page will be shown; to control how many levels of headers are shown, use the `levels` parameter: - \[[toc levels=2]] + \[[!toc levels=2]] The toc plugin will take the level of the first header as the topmost level, even if there are higher levels seen later in the file. The table of contents will be created as an ordered list. If you want an unordered list instead, you can change the list-style in your local -style sheet.
\ No newline at end of file +style sheet. diff --git a/doc/plugins/toggle.mdwn b/doc/plugins/toggle.mdwn index b33575824..5e0b8392a 100644 --- a/doc/plugins/toggle.mdwn +++ b/doc/plugins/toggle.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=toggle author="[[Joey]]"]] -[[tag type/chrome]] +[[!template id=plugin name=toggle author="[[Joey]]"]] +[[!tag type/chrome]] With this plugin you can create links on pages that, when clicked, toggle display of other parts of the page. @@ -9,15 +9,15 @@ always see the full page content. Example use: - \[[toggle id="ipsum" text="show"]] + \[[!toggle id="ipsum" text="show"]] - \[[toggleable id="ipsum" text=""" + \[[!toggleable id="ipsum" text=""" Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. - [[toggle id="ipsum" text="hide"]] + [[!toggle id="ipsum" text="hide"]] """]] Note that you can include wiki markup in the toggleable text, diff --git a/doc/plugins/txt.mdwn b/doc/plugins/txt.mdwn index 8d8cb55c2..c27728929 100644 --- a/doc/plugins/txt.mdwn +++ b/doc/plugins/txt.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=txt author="[[Gabriel]]"]] -[[tag type/format]] +[[!template id=plugin name=txt author="[[Gabriel]]"]] +[[!tag type/format]] This plugin makes ikiwiki treat files with names ending in ".txt" as wiki pages. @@ -10,5 +10,5 @@ with html markup characters such as ">" escaped. The only exceptions are that [[WikiLinks|WikiLink]] and [[PreprocessorDirectives|PreprocessorDirective]] are still expanded by -ikiwiki, and that, if the [[cpan URI::Find]] perl module is installed, URLs +ikiwiki, and that, if the [[!cpan URI::Find]] perl module is installed, URLs in the txt file are converted to hyperlinks. diff --git a/doc/plugins/typography.mdwn b/doc/plugins/typography.mdwn index b03c2a086..030ef8052 100644 --- a/doc/plugins/typography.mdwn +++ b/doc/plugins/typography.mdwn @@ -1,12 +1,12 @@ -[[template id=plugin name=typography author="[[Roktas]]"]] -[[tag type/format]] +[[!template id=plugin name=typography author="[[Roktas]]"]] +[[!tag type/format]] This plugin, also known as [SmartyPants](http://daringfireball.net/projects/smartypants/), translates plain ASCII punctuation characters into ``smart'' typographic punctuation HTML -entities. To use it, you need to have the [[cpan Text::Typography]] module +entities. To use it, you need to have the [[!cpan Text::Typography]] module installed. This plugin has a configuration option. To change the attributes, set `--typographyattributes=whatever`. See the documentation for -[[cpan Text::Typography]] for available attributes. +[[!cpan Text::Typography]] for available attributes. diff --git a/doc/plugins/version.mdwn b/doc/plugins/version.mdwn index ec9062947..7c076362e 100644 --- a/doc/plugins/version.mdwn +++ b/doc/plugins/version.mdwn @@ -1,5 +1,5 @@ -[[template id=plugin name=version author="[[Joey]]"]] -[[tag type/useful]] +[[!template id=plugin name=version author="[[Joey]]"]] +[[!tag type/useful]] This plugin allows inserting the version of ikiwiki onto a page. @@ -8,4 +8,4 @@ updating the version number. Use is simple: - \[[version ]] + \[[!version ]] diff --git a/doc/plugins/wikitext.mdwn b/doc/plugins/wikitext.mdwn index a87ab06fd..483712130 100644 --- a/doc/plugins/wikitext.mdwn +++ b/doc/plugins/wikitext.mdwn @@ -1,8 +1,8 @@ -[[template id=plugin name=wikitext author="[[Joey]]"]] -[[tag type/format]] +[[!template id=plugin name=wikitext author="[[Joey]]"]] +[[!tag type/format]] This plugin allows ikiwiki to process pages written in the original wiki -text format. To use it, you need to have the [[cpan Text::WikiFormat]] perl +text format. To use it, you need to have the [[!cpan Text::WikiFormat]] perl module installed, enable the plugin, then files with the extention `.wiki` will be processed as wiki text. diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index b4acb237d..22bd5d114 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -3,7 +3,7 @@ written to extend ikiwiki in many ways. Despite the length of this page, it's not really hard. This page is a complete reference to everything a plugin might want to do. There is also a quick [[tutorial]]. -[[toc levels=2]] +[[!toc levels=2]] ## Types of plugins @@ -189,7 +189,7 @@ ikiwiki, like generating a page, or part of a blog page, or an rss feed, or a cgi. This hook allows modifying the variables available on those templates. The function is passed named parameters. The "page" and "destpage" parameters are the same as for a preprocess hook. The "template" -parameter is a [[cpan HTML::Template]] object that is the template that +parameter is a [[!cpan HTML::Template]] object that is the template that will be used to generate the page. The function can manipulate that template object. @@ -325,7 +325,7 @@ It can modify the content as desired, and should return the content. hook(type => "formbuilder_setup", id => "foo", call => \&formbuilder_setup); hook(type => "formbuilder", id => "foo", call => \&formbuilder); -These hooks allow tapping into the parts of ikiwiki that use [[cpan +These hooks allow tapping into the parts of ikiwiki that use [[!cpan CGI::FormBuilder]] to generate web forms. These hooks are passed named parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively, the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a @@ -433,7 +433,7 @@ the entire wiki build and make the wiki unusable. #### `template($;@)` -Creates and returns a [[cpan HTML::Template]] object. The first parameter +Creates and returns a [[!cpan HTML::Template]] object. The first parameter is the name of the file in the template directory. The optional remaining parameters are passed to `HTML::Template->new`. diff --git a/doc/plugins/write/external.mdwn b/doc/plugins/write/external.mdwn index 47834567a..cbcd9bf19 100644 --- a/doc/plugins/write/external.mdwn +++ b/doc/plugins/write/external.mdwn @@ -13,7 +13,7 @@ easier you can do the same thing in your favorite language. ;-) There's now a second external plugin, the [[rst]] plugin, written in python. It uses a `proxy.py`, a helper library for ikiwiki python plugins. -[[toc ]] +[[!toc ]] ## How external plugins use XML RPC @@ -85,7 +85,7 @@ language as part of their XML RPC interface. XML RPC has a limitation that it does not have a way to pass undef/NULL/None. There is an extension to the protocol that supports this, -but it is not yet available in the [[cpan XML::RPC]] library used by +but it is not yet available in the [[!cpan XML::RPC]] library used by ikiwiki. Until the extension is available, ikiwiki allows undef to be communicated diff --git a/doc/plugins/write/tutorial.mdwn b/doc/plugins/write/tutorial.mdwn index 94b72c763..5b810a18f 100644 --- a/doc/plugins/write/tutorial.mdwn +++ b/doc/plugins/write/tutorial.mdwn @@ -5,7 +5,7 @@ What should the plugin do? Let's make it calculate and output the Fibonacci sequence. To output the next number in the sequence, all a user has to do is write this on a wiki page: - [[fib ]] + [[!fib ]] When the page is built, the [[ikiwiki/PreProcessorDirective]] will be replaced by the next number in the sequence. @@ -44,7 +44,7 @@ that "fib" has shown up again. It doesn't actually have to match the module name this time, but it generally will. This "fib" is telling ikiwiki what kind of PreprocessorDirective to handle, namely one that looks like this: - [[fib ]] + [[!fib ]] Notice the `\&preprocess`? This is how you pass a reference to a function, and the `preprocess` function is the one that ikiwiki will call to expand @@ -98,7 +98,7 @@ And let's change the `preprocess` sub to use it: Feel free to try it out with a simple page like this: - [[fib ]], [[fib ]], [[fib ]], [[fib ]], [[fib ]] + [[!fib ]], [[!fib ]], [[!fib ]], [[!fib ]], [[!fib ]] Looks like it works ok, doesn't it? That creates a page that lists: @@ -139,7 +139,7 @@ Ok, one more enhancement. Just incrementing the numbers is pretty boring. It would be nice to be able to jump directly to a given point in the sequence: - \[[fib seed=20]], [[fib ]], [[fib ]] + \[[!fib seed=20]], [[!fib ]], [[!fib ]] Just insert these lines of code inside `preprocess`, in the appropriate spot: |