diff options
Diffstat (limited to 'doc/plugins')
| -rw-r--r-- | doc/plugins/comments.mdwn | 2 | ||||
| -rw-r--r-- | doc/plugins/contrib.mdwn | 5 | ||||
| -rw-r--r-- | doc/plugins/contrib/headinganchors.mdwn | 2 | ||||
| -rw-r--r-- | doc/plugins/contrib/headinganchors/discussion.mdwn | 1 | ||||
| -rw-r--r-- | doc/plugins/contrib/mailbox.mdwn | 18 | ||||
| -rw-r--r-- | doc/plugins/contrib/mailbox/discussion.mdwn | 5 | ||||
| -rw-r--r-- | doc/plugins/contrib/po.mdwn | 29 | ||||
| -rw-r--r-- | doc/plugins/contrib/postal.mdwn | 35 | ||||
| -rw-r--r-- | doc/plugins/highlight.mdwn | 75 | ||||
| -rw-r--r-- | doc/plugins/more/discussion.mdwn | 7 | ||||
| -rw-r--r-- | doc/plugins/openid.mdwn | 10 | ||||
| -rw-r--r-- | doc/plugins/txt.mdwn | 2 |
12 files changed, 181 insertions, 10 deletions
diff --git a/doc/plugins/comments.mdwn b/doc/plugins/comments.mdwn index c13a6daa6..7e2232411 100644 --- a/doc/plugins/comments.mdwn +++ b/doc/plugins/comments.mdwn @@ -19,7 +19,7 @@ users can only post comments. Individual comments are stored as internal-use pages named something like `page/comment_1`, `page/comment_2`, etc. These pages internally use a -`\[[!_comment]]` [[ikiwiki/directive]]. +[[comment_directive|ikiwiki/directive/comment]]. There are some global options for the setup file: diff --git a/doc/plugins/contrib.mdwn b/doc/plugins/contrib.mdwn index e22b13f71..a03e6a95d 100644 --- a/doc/plugins/contrib.mdwn +++ b/doc/plugins/contrib.mdwn @@ -1,6 +1,5 @@ -Contributed [[plugins]]: - -(See [[install]] for installation help.) +These plugins are provided by third parties and are not currently +included in ikiwiki. See [[install]] for installation help. [[!inline pages="plugins/contrib/* and !*/Discussion" feedpages="created_after(plugins/contrib/navbar)" archive="yes" diff --git a/doc/plugins/contrib/headinganchors.mdwn b/doc/plugins/contrib/headinganchors.mdwn index c80cc0b49..becbf89a5 100644 --- a/doc/plugins/contrib/headinganchors.mdwn +++ b/doc/plugins/contrib/headinganchors.mdwn @@ -1,6 +1,6 @@ [[!template id=plugin name=headinganchors author="[[PaulWise]]"]] -This is a simple plugin to add ids to all headings, based on their text. It +This is a simple plugin to add ids (which will serve as [[anchor]]s) to all headings, based on their text. It works as a postprocessing filter, allowing it to work on mdwn, wiki, html, rst and any other format that produces html. The code is available here: diff --git a/doc/plugins/contrib/headinganchors/discussion.mdwn b/doc/plugins/contrib/headinganchors/discussion.mdwn new file mode 100644 index 000000000..91fe04a6d --- /dev/null +++ b/doc/plugins/contrib/headinganchors/discussion.mdwn @@ -0,0 +1 @@ +Isn't this functionality a part of what [[plugins/toc]] needs and does? Then probably the [[plugins/toc]] plugin's code could be split into the part that implements the [[plugins/contrib/headinganchors]]'s functionality and the TOC generation itself. That will bring more order into the code and the set of available plugins. --Ivan Z. diff --git a/doc/plugins/contrib/mailbox.mdwn b/doc/plugins/contrib/mailbox.mdwn new file mode 100644 index 000000000..b7a9f81c7 --- /dev/null +++ b/doc/plugins/contrib/mailbox.mdwn @@ -0,0 +1,18 @@ +[[!template id=plugin name=mailbox author="[[DavidBremner]]"]] +[[!tag type/format]] + +The `mailbox` plugin adds support to ikiwiki for +rendering mailbox file into a page displaying the mails +in the mailbox. It supports mbox, maildir, and MH folders, +does threading, and deals with MIME. + +One hitch I noticed was that it is not currently possible to treat a +maildir or an MH directory as a page (i.e. just call it foo.mh and have it +transformed to page foo). I'm not sure if this is possible and worthwhile +to fix. It is certainly workable to use a [[!mailbox ]] directive. +-- [[DavidBremner]] + +This plugin is not in ikiwiki yet, but can be downloaded +from <http://pivot.cs.unb.ca/git/ikimailbox.git> + + diff --git a/doc/plugins/contrib/mailbox/discussion.mdwn b/doc/plugins/contrib/mailbox/discussion.mdwn new file mode 100644 index 000000000..00fb0c05f --- /dev/null +++ b/doc/plugins/contrib/mailbox/discussion.mdwn @@ -0,0 +1,5 @@ +# The remote repo + +For some reason, `git fetch` from http://pivot.cs.unb.ca/git/ikimailbox.git/ didn't work very smoothly for me: it hung, and I had to restart it 3 times before the download was complete. + +I'm writing this just to let you know that there might be some problems with such connections to your http-server. --Ivan Z. diff --git a/doc/plugins/contrib/po.mdwn b/doc/plugins/contrib/po.mdwn index 5b33f6716..665e48343 100644 --- a/doc/plugins/contrib/po.mdwn +++ b/doc/plugins/contrib/po.mdwn @@ -153,6 +153,14 @@ Any thoughts on this? >> basewiki, which seems like it should be pretty easy to do, and would be >> a great demo! --[[Joey]] >> +>>> I have a complete translation of basewiki into danish, and am working with +>>> others on preparing one in german. For a complete translated user +>>> experience, however, you will also need templates translated (there are a few +>>> translatable strings there too). My not-yet-merged po4a Markdown improvements +>>> (see [bug#530574](http://bugs.debian.org/530574)) correctly handles multiple +>>> files in a single PO which might be relevant for template translation handling. +>>> --[[JonasSmedegaard]] +>> >>> I've merged your changes into my own branch, and made great >>> progress on the various todo items. Please note my repository >>> location has changed a few days ago, my user page was updated @@ -383,6 +391,9 @@ daring a timid "please pull"... or rather, please review again :) >>> "discussion". Also, I consider `$config{cgi}` and `%links` (etc) >>> documented parts of the plugin interface, which won't change; po could >>> rely on them to avoid this minor problem. --[[Joey]] +>>>> +>>>> Done in my branch. --[[intrigeri]] +>>>> > > * Is there any real reason not to allow removing a translation? > I'm imagining a spammy translation, which an admin might not @@ -423,3 +434,21 @@ daring a timid "please pull"... or rather, please review again :) >> --[[intrigeri]] >> >>> Did you get a chance to? --[[Joey]] + + * As discussed at [[todo/l10n]] the templates needs to be translatable too. They + should be treated properly by po4a using the markdown option - at least with my + later patches in [bug#530574](http://bugs.debian.org/530574)) applied. + + * It seems to me that the po plugin (and possibly other parts of ikiwiki) wrongly + uses gettext. As I understand it, gettext (as used currently in ikiwiki) always + lookup a single language, That might make sense for a single-language site, but + multilingual sites should emit all strings targeted at the web output in each own + language. + + So generally the system language (used for e.g. compile warnings) should be separated + from both master language and slave languages. + + Preferrably the gettext subroutine could be extended to pass locale as optional + secondary parameter overriding the default locale (for messages like "N/A" as + percentage in po plugin). Alternatively (with above mentioned template support) + all such strings could be externalized as templates that can then be localized. diff --git a/doc/plugins/contrib/postal.mdwn b/doc/plugins/contrib/postal.mdwn new file mode 100644 index 000000000..b2f875393 --- /dev/null +++ b/doc/plugins/contrib/postal.mdwn @@ -0,0 +1,35 @@ +[[!template id=plugin name=postal author="[[DavidBremner]]"]] +[[!tag type/useful]] + +The `postal` plugin allows users to send mail to +a special address to comment on a page. It uses the [[mailbox]] +plugin to display their comments in the wiki. + +This plugin is not in ikiwiki yet, but can be downloaded +from <http://pivot.cs.unb.ca/git/ikipostal.git> + +Details: + + * Adds a mailto: url to each page matching some pagespec + (currently every page gets a comment footer) + + * This mailto url goes to an address identifying the page (something like + user-iki-blog~I\_hate\_markdown@host.fqdn.tld). + [more details](http://www.cs.unb.ca/~bremner/blog/posts/encoding) + + * on the mail receiving end, these messages are either deleted, or ran through + a filter to be turned into blog posts. I have +[written](http://pivot.cs.unb.ca/git/?p=ikipostal.git;a=blob_plain;f=filters/postal-accept.pl;hb=HEAD) + a filter that decodes the address and writes the message into an appropriate +mailbox. The changes are then checked into version control; typically a hook then updates the html version of the wiki. + * work in progress can be + + - [cloned](http://pivot.cs.unb.ca/git/ikipostal.git), or + - [browsed](http://pivot.cs.unb.ca/git/?p=ikipostal.git;a=summary) + + * I would be interested in any ideas people have about security. + +The current version of this plugin is now running on my home page. See for example +[a recent post in my blog](http://www.cs.unb.ca/~bremner/blog/posts/can-i-haz-a-distributed-rss/). +Unfortunately although the [[mailbox|todo/mbox]] renderer supports threading, I haven't had +a chance to implement comments on comments yet. --[[DavidBremner]] diff --git a/doc/plugins/highlight.mdwn b/doc/plugins/highlight.mdwn new file mode 100644 index 000000000..44ced80f7 --- /dev/null +++ b/doc/plugins/highlight.mdwn @@ -0,0 +1,75 @@ +[[!template id=plugin name=highlight author="[[Joey]]"]] +[[!tag type/format]] + +This plugin allows ikiwiki to syntax highlight source code, using +a fast syntax highlighter that supports over a hundred programming +languages and file formats. + +## prerequisites + +You will need to install the perl bindings to the +[highlight library](http://www.andre-simon.de/), which in Debian +are in the [[!debpkg libhighlight-perl]] package. + +## embedding highlighted code + +To embed highlighted code on a page, you can use the +[[format]] plugin. + +For example: + + \[[!format c """ + void main () { + printf("hello, world!"); + } + """]] + + \[[!format diff """ + -bar + +foo + """]] + +You can do this for any extension or language name supported by +the [highlight library](http://www.andre-simon.de/) -- basically anything +you can think of should work. + +## highlighting entire source files + +To enable syntax highlighting of entire standalone source files, use the +`tohighlight` setting in your setup file to control which files should be +syntax highlighted. Here is a typical setting for it, enabling highlighting +for files with the extensions .c, etc, and also for any files named +"Makefile". + + tohighlight => ".c .h .cpp .pl .py Makefile:make", + +It knows what language to use for most filename extensions (see +`/etc/highlight/filetypes.conf` for a partial list), but if you want to +bind an unusual filename extension, or any file without an extension +(such as a Makefile), to a language, you can do so by appending a colon +and the name of the language, as illustrated for Makefiles above. + +With the plugin configured this way, source files become full-fledged +wiki pages, which means they can include [[WikiLinks|ikiwiki/wikilink]] +and [[directives|ikiwiki/directive]] like any other page can, and are also +affected by the [[smiley]] plugin, if it is enabled. This can be annoying +if your code accidentially contains things that look like those. + +On the other hand, this also allows your syntax highlighed +source code to contain markdown formatted comments and hyperlinks +to other code files, like this: + + /* \[[!format mdwn """ + This comment will be formatted as *markdown*! + + See \[[bar.h]]. + ""]] */ + +Finally, bear in mind that this lets anyone who can edit a page in your +wiki also edit source code files that are in your wiki. Use appropriate +caution. + +## colors + +The colors etc used for the syntax highlighting are entirely configurable +by CSS. See ikiwiki's [[style.css]] for the defaults. diff --git a/doc/plugins/more/discussion.mdwn b/doc/plugins/more/discussion.mdwn new file mode 100644 index 000000000..f369d1e12 --- /dev/null +++ b/doc/plugins/more/discussion.mdwn @@ -0,0 +1,7 @@ +# Test: + +[[!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/openid.mdwn b/doc/plugins/openid.mdwn index d4aa18c7d..91fc7cddc 100644 --- a/doc/plugins/openid.mdwn +++ b/doc/plugins/openid.mdwn @@ -4,10 +4,12 @@ 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 -users entering "https" OpenID urls. +The plugin needs the [[!cpan Net::OpenID::Consumer]] perl module. +Version 1.x is needed in order for OpenID v2 to work. + +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` to the url of a third-party site where users can sign up for an OpenID. If diff --git a/doc/plugins/txt.mdwn b/doc/plugins/txt.mdwn index 77d94d450..420898d09 100644 --- a/doc/plugins/txt.mdwn +++ b/doc/plugins/txt.mdwn @@ -8,7 +8,7 @@ Unlike other [[type/format]] plugins, no formatting of markup in txt files is done; the file contents is displayed to the user as-is, with html markup characters such as ">" escaped. -The only exceptions are that [[WikiLinks|WikiLink]] and +The only exceptions are that [[WikiLinks|ikiwiki/WikiLink]] and [[directives|ikiwiki/directive]] are still expanded by ikiwiki, and that, if the [[!cpan URI::Find]] perl module is installed, URLs in the txt file are converted to hyperlinks. |