The plug-in is rather simple, but since a web search turned up nothing similar (which is kind of surprising), and someone might find it useful, I thought I’d post it here.

Here is the code for “wikindx.php”:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

<?php
/* 
Plugin Name: Wikindx
Plugin URL: http://stargrads.net/blogs/davinci/2009/09/wikindx-macro-plug-in-for-wordpress
Description: Adds a macro to WordPress to insert bibliography information from Wikindx.
Author: D. L. Yonge-Mallo
Version: 1.0
Author URI: http://stargrads.net/blogs/davinci/
*/
 
function parse_wikindx($content) {
    $WikindxPath="http://path.to/wikindx/";
 
    preg_match_all('#<wikindx( resource="([ \w]+)")?(>(.*)</wikindx>| ?/>)#Usi', $content, $wikindxs, PREG_SET_ORDER);
 
    if ( count($wikindxs) > 0 ) {
        foreach ( (array) $wikindxs as $wikindx ) {
            if( empty($wikindx[2]) ) {
                $output = "ERROR: WIKINDX MISSING RESOURCE ARGUMENT";
            } else {
                $resourceId = $wikindx[2];
                $string = file_get_contents("{$WikindxPath}cmsprint.php?action=getResource&id={$resourceId}");
                if($string) {
                    $array = unserialize(base64_decode($string));
                    $output = $array[$resourceId] . " ([{$WikindxPath}index.php?action=resourceView&id={$resourceId} details])";
 
                } else {
                    $output = "ERROR: WIKINDX RESOURCE ".$resourceId." NOT FOUND";
                }
            }
            $content = str_replace($wikindx[0], $output, $content);
        }
    }
 
    return $content;
}
add_filter('the_content', 'parse_wikindx', 2);
?>

Replace “http://path.to/wikindx/” in the above with the URL to your installation of Wikindx, obviously. For example, mine is “http://stargrads.net/bibliography/”.

Put the file into the “plugins” directory on WordPress, or if you are using WordPress^μ, then into its “mu-plugins” directory.

The plug-in creates a new macro “wikindx” with one parameter “resource”, which can be used inside WordPress posts like this:

<wikindx resource="68" />

Replace “68″ in the example with the resource ID of the bibliography entry whose information you want. (This ID can be found in the URL of the resource’s page on Wikindx.) The result is that the macro is replaced by the bibliographical information for that resource. For the above example, this would be:

R. Cleve, D. Gavinsky, and D. L. Yonge-Mallo, “Quantum Algorithms for Evaluating Min-Max Trees,” in Proc. TQC 2008, Tokyo, Japan, 2008, (details)

This plug-in can be used to good effect with Rob Miller’s Footnotes plug-in for WordPress, like this:

<ref name="CGMSY08"><wikindx resource="206" /></ref>

The result^[1] can be seen in the footnote below.

– davinci 11780

Update (Sept. 15, 2009): I’ve added the plug-in to the WordPress Plugin Directory.

Related posts:

1. Using the Ajaxified Expand Post Now plug-in with Rob Miller’s Footnotes plug-in
2. Annotate With Jarnal Plug-In Module for Wikindx
3. Using jsMath with WordPress, bbPress, and Wikindx

Because I’m using Jarnal to annotate these papers, I wanted to integrate the ability to launch Jarnal into Wikindx itself, and also to store the annotations in Wikindx along with the attached documents.

I wrote the Annotate With Jarnal plug-in module for Wikindx initially for my private use, so it’s not very polished. But it gets the job done.

The module adds an “Annotate With Jarnal” menu item to the “Resources” menu in Wikindx. To use it, copy the URL of an attached PDF file, and paste it into the module’s input box. The module then generates a Jarnal Meta File which (if everything is set up correctly) launches Jarnal with the PDF file as the background.

Here is a series of screen shots showing the module in action:

The result of the above sequence of steps is that Jarnal fetches the PDF file from Wikindx, and displays it for annotation:

The annotations can be saved using Jarnal’s “Network Save” feature. This writes the Jarnal file back to the “attachments” subdirectory in the Wikindx directory on the web server, with a file name created from appending the “.jaj” extension to the hash code of the annotated file. The next time the PDF file is opened through the module, the annotations will be loaded along with the PDF file.

A user must be logged in to Wikindx to use the module. However, beyond that, there is currently not a lot of security. Furthermore, the interface is not very easy to use. Ideally, there would be an “annotate” button or link next to each attached PDF file, so that the user does not have to bother with copying the URL and pasting it. Right now, there’s nothing to stop the user from entering a malformed or nonsense URL, but in most cases the module will respond by displaying an error message or doing nothing.

The module can also be used with the Macro Expander plug-in for WordPress, to provide a link to directly annotate a PDF file from a WordPress blog entry. I kept my research notes in a private WordPress blog on my laptop, and this feature allowed me to link to and annotate the relevant papers directly from my research notes.

For more information, and the source files, see the module’s web site on launchpad.net.

– davinci 11779

Related posts:

1. Wikindx macro plug-in for WordPress
2. Using the Ajaxified Expand Post Now plug-in with Rob Miller’s Footnotes plug-in
3. Converting DigiMemo files to Jarnal format