WordPress Plugins from OutlyerNet

Projects index

Index

Caveat emptor

Here I'll place plugins I've written or modified to fit my needs, but I'm not a WordPress hacker, so I might be re-inventing the wheel for built-in functions or pre-existing, much better plugins.
If you know that's the case, please contact me :).

I can't say for sure either if I'm inadvertently breaking something or punching security holes into WP although I can't see any such problems in the code I'm publishing.

These are plugins I wrote for my personal use, I've tried to make them usable by others before publishing but there're some rough edges.

Code here is published under the GPL license unless specified otherwise.

This plugin was integrated back into the main Interlinks so it is deprecated.

Download v1.0a+ (last update october 13th 2007)

Interlinks+ is based on Interlinks by Harley. The original adds a very nifty feature: it enables wiki-style interlinks (e.g. [[Some article]] will be converted to a link to the post/page titled "Some article".

There's a feature I missed in Interlinks: Support for piped links, continuing with the above example, [[Some article|That's a nicer title IMHO]] would link to "Some article" but the link text will be "That's a nicer title IMHO".

Additionally I added a couple extra modifications to generate valid XHTML, and made the link also display the article's title.

Let's compare Interlinks and Interlinks+:

* indicates a broken interlink
Interlinks Interlinks+
Code HTMLparsed as HTMLparsed as
[[My article]] <a href="http://example.invalid/my-article/">My article</a> My article <a href="http://example.invalid/my-article/" title="My article">My article</a> My article
[[My article|My first article]] * <font color='red'>My article|My first article</font> My article|My first article <a href="http://example.invalid/my-article/" title="My article">My first article</a> My first article
* [[Broken]] * <font color='red'>Broken</font> * Broken * <span style="color:red;" title="Broken">Broken</span> * Broken
I'm assuming default page slugs here.

I'm contacting Harley now to suggest her adopting my modifications (at least piped links and XHTML conformance), so with any luck this plugin will be ill-fated :).

Relative URLs

Download v1.5 (last update october 14th 2007)

Relative URLs (hereon RU) is mainly targeted at people with a local copy of their WordPress site and those that reorganise and/or change their pages hierarchy often although many standard installations can also take advantage of it.

RU can be seen as kind of complementary to Interlinks: It creates a valid URL or link from a relative path.
If you want to link to a post Interlinks or Interlinks+ are better alternatives, but if you want to link to a given file in your site none of them will help you.
I guess so far it isn't clear what's the need for such a plugin, so let's clarify a bit, note that:

Finally, if you use a local copy of WordPress to test stuff, chances are your local copy would have quite a different URL, e.g. http://localhost/~username/wordpress/ and you might want your URLs to point to the local copy and not the on-line site.

Usage

Enclose your local URL in double braces (e.g. {{myrelative/url}}), to get a full URL generated dinamically, e.g. to http://example.com/wordpress/myrelative/url.

Enclose your local URL in double braces along a text description (separated by a space) to get a dinamically generated link to the full URL.
{{the_url/file.txt The text file}} would become <a href="http://example.com/wordpress/the_url/file.txt">The text file</a>.

Note you'll have to encode any spaces in the url (e.g. to link to "the file" you'll have to encode the space (replace it with %20) i.e.: {{the%20file}}.

Escaping Relative URLs

If you want to write literal double curly brackets ({{) then you'll have to use an html entities such as &#x7b; and &#x7d; (or &#123; and &#125;). For maximum security use at least on each end, e.g. &#x7b;{ whatever &#x7d;} will be parsed correctly as {{ whatever }}.
BUT beware of the visual editor in WordPress (although if you use it you're probably used to fight it ;).

JS Base2

Download v1.0+0.9a (last update october 24th 2007). (Note 1.0 is the plugin version and 0.9a is the base2's version used in the plugin).

A completely trivial plugin that loads Dean Edwards' base2 JavaScript library (see [1] and [2]).

This library is mostly a cross-browser fix of the DOM plus a selectors API implementation (allowing selection from JS with CSS selectors).

It is used by the following plugin :)

JS Syntax Highlighter

Download v0.2 (last update october 25th 2007).

This plugin loads Alex Gorbatchev's SyntaxHighlighter JavaScript script. With a twist :)

SyntaxHighlighter is a script that will highlight code from JavaScript when marked appropriately, hence allowing you to post raw code that will be automagically prettyprinted on load.
I needed a couple workarounds to use it on my site and they were the motivation for this plugin:

First problem: Code must be enclosed in either a <pre> or a <textarea> tag, with their name attribute set to certain (user-selectable) value.
The problem is, <pre> has no name attribute so the page wouldn't validate.
My solution: (Note I opted to not modify SyntaxHighlighter code) Mark code with a class and then, on-the-fly, add the name attribute from JavaScript (this makes the HTML validate as the invalid attribute is only created in-memory).
Second problem: Each supported language has its own associated JavaScript file which you should load when writing code for a that language. I felt loading them site-wide was was overkill (and I don't know which languages I might need), while loading them as needed, in the article body felt cumbersome.
My solution: Load the common script, see if any languages are needed and load them dinamically. As a side effect the page will load faster (the required languages are loaded after the page ended loading).

So in short this plugin loads SyntaxHighlighter allowing your pages to validate and only loading language files as needed.

I also changed the CSS file a bit to use fonts I consider look better and added colours to functions and variables.

Usage

Plugin installation:

  1. Decompress in the wp-content/plugins folder, it will create its own folder.
  2. Activate it from WP's admin panel.

Syntax highlighting:

  1. Wrap your code in a <pre> or <textarea> with class 'syntax-highlight' and the appropriate class for the language of the block, e.g. 'cpp' for C++ (see the full list).
  2. There's no step 2 :P But remember the highlighting takes place a bit after loading the page.

Usage without base2

I dropped support for such a situation. You can try with an older version of loader.js but keep in mind that then languages won't be autoloaded.

Caveats of the current version

Passing options for a single block

Passing options for a block to SyntaxHighlighter needs a workaround as my loader won't detect the language then, the workaround is to use a hidden, empty block without options, i.e:
If you want to have something like

	<pre class="syntax-highlight javascript:firstline[10]">
	function doSomething() {
	}
	</pre>

Then you'll need to add a hidden block with the language class(es) needed. That block can have the classes of all needed languages:

	<!-- Hidden, meaningless, code block -->
	<div style="display:none !important;">
		<pre class="syntax-highlight html cpp"></pre>
	</div>

Disabled language aliases

Due to the way the code is written the following language name aliases won't be looked for (all of them have alternatives): c++, c#, vb.net.

They could be enabled with some escaping but I didn't feel the need :p

Customisation

There're a couple things you might want to tweak, to change them edit the file loader.js (note that the version actually loaded in the browser is the one in the js/ directory, but it is shipped packed with Dean Edwards' packer, which makes it quite harder to edit. I suggest you to edit the version in the full-js/ directory and once you're happy with it pack it again.

    bloggerMode: false,  // Set to true if the blogging software adds <br />'s
                         // See: <http://code.google.com/p/syntaxhighlighter/wiki/BloggerMode>
    opts: [              // Options for HighlightAll, see <http://code.google.com/p/syntaxhighlighter/wiki/HighlightAll>
            true,        // Show Gutter
            false,       // Show Controls (!*not default*)
            false,       // Collapse all
            1,           // First line
            false        // Show columns
        ],
    WAIT_TO_LOAD: 200,    // (ms) Period to wait between checks for language loading
    FAIL_TIMEOUT: 120000, // (ms) After this period will stop trying to load languages

These are the meaningful variables, I think they're self explanatory enough, a note of warning though: if some of the languages fails loading you'll have to wait for FAIL_TIMEOUT milliseconds before syntax highlighting gets enabled. Set it too low, though, and you'll get bogus failures.