/
readme.txt
74 lines (44 loc) · 4.51 KB
/
readme.txt
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
=== RevCanonical ===
Contributors: whomwah
Donate Link: http://pledgie.org/campaigns/3803
Tags: revcanonical, shortening, links, simple, post, url
Requires at least: 2.6
Tested up to: 2.8
Stable tag: 1.2.5
A Wordpress plugin that creates and adds support for shortened urls plus the shortlink auto-discovery tag
== Description ==
RevCanonical generates a short url for your pages, as well as adding [link shortening discovery](http://laughingmeme.org/2009/04/03/url-shortening-hinting/). You can use this url on character restricted sites like [Twitter](http://twitter.com), in IM, or anytime you need a short link to your webpages. The discovery part means that other sites and [services](http://revcanonical.appspot.com/) can also use the short url should they need it. Oh and this short url is yours, from your website. It does not use any external service.
Here's what gets added to your pages. The link in the href is the short version you can use:
`<link rev="canonical" type="text/html" href="http://my-domain.me/p12p" />`
This tag can though be customised to suit your own preferences (at your own risk), for instance this:
`<link rel="shortlink" href="http://my-mini.me/p12p" />`
That’s it! You can now, not only use this url to pass around, and in sites like [Twitter](http://twitter.com) without having to go via a url shortening service, but [services](http://revcanonical.appspot.com/) or people that understand the rev=canonical link tag, will be able to use this shortened version over the longer canonical version. It also means that it’s persistence is down to you, and not to a 3rd party.
Oh and there's [a great bookmarklet](http://simonwillison.net/2009/Apr/11/revcanonical/) that makes hunting for existing short urls on a page really simple. You can read more about this plugin at my website http://littl.me/p136
What's changed? View [the CHANGELOG](http://github.com/whomwah/revcanonical/raw/master/CHANGELOG)
== Advanced ==
The default settings should suit most people, but if there are a couple of things you can change should you wish. There are also a few tags you can use within your own pages.
If your domain name is a bit long and you own a smaller domain you would like to use as your shortened domain, you can add this in the settings page. You would then just need to make sure that the new domain pointed to the original via a ProxyPass setting.
There are many ongoing conversations on the web about how to describe shortened links in HTML. There appears to be no absolute right way, so by default if will be rev=canonical. Should you want to use another way, you can also change this via the settings page.
And finally... there are a couple of tags you can use in your own templates, that will return the short link for that page. You need to pass them the post ID.
`<?php get_revcanonical_link($post->ID) ?> ===> Echo the shorturl to the screen`
`<?php $url = revcanonical_link($post->ID) ?> ===> Assign the shorturl to a variable`
== Frequently Asked Questions ==
= I just get a '404 page not found' when going to the shortlink? =
A few people have mentioned this, but due to the fact they were unable to send and debug information, I have not been able to fix it. It is likely to be a configuration setting on shared hosting or hosting on Windows. If you are having this problem and would be prepared to help debug, please drop me a line at duncan [at] whomwah [dot] com
= Does it work with earlier versions of Wordpress? =
Not sure is the simple answer, I currently run 2.8. If it works with ealier versions, please let me know via [Whomwah.com](http://whomwah.com).
= But my domain name is really long =
You can add you own shortened domain name if you own one via the settings page. This is for advanced users, as it's up to you to point your shortened domain back to the longer one. I do this via a ProxyPass line in that domains conf file. Here's my vhost.conf file. You can find out more about ProxyPass via the [Apache website](http://httpd.apache.org/docs/2.2/mod/mod_proxy.html#proxypass).
`
<VirtualHost *:80>
ServerName littl.me
ServerAlias www.littl.me
ProxyPass / http://whomwah.com/
</VirtualHost>
`
= Can I contribute to revcanonical? =
Sure, the code lives at the [Revcanonical github project page](http://whomwah.com/revcanonical "Revcanonical via Github"). You can download or fork it there.
== Installation ==
This section describes how to install the plugin and get it working.
1. Upload `revcanonical.php` to the `/wp-content/plugins/` directory
1. Activate the plugin through the 'Plugins' menu in WordPress