From 49aa4838ec8fe84a368b6ca0e15814d65dd55567 Mon Sep 17 00:00:00 2001 From: Janos Guljas Date: Thu, 8 Oct 2015 11:51:04 -0700 Subject: Apply changes in README and add LICENCE from the git Last-Update: 2010-01-06 Patch-Name: 01_doc-sync.diff --- LICENCE | 27 +++++++++++++++++ README | 104 ++++++++++++++++++++++++++++++++-------------------------------- 2 files changed, 79 insertions(+), 52 deletions(-) create mode 100644 LICENCE diff --git a/LICENCE b/LICENCE new file mode 100644 index 0000000..94954ed --- /dev/null +++ b/LICENCE @@ -0,0 +1,27 @@ +Copyright (c) 2008 Simon Willison and Jacob Kaplan-Moss +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + + 1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + 3. Neither the name of this project nor the names of its contributors may be + used to endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README b/README index 0d6b3b4..b6a15ee 100644 --- a/README +++ b/README @@ -1,7 +1,7 @@ django-shorturls ================ -A custom URL shortening app for Django, including easy ``rev=cannonical`` +A custom URL shortening app for Django, including easy ``rev=canonical`` support. Most code was originally by Simon Willison; see @@ -15,43 +15,43 @@ Usage So, you want to host your own short URLs on your Django site: - 1. In your settings, define a set of prefixes for short URLs:: +1. In your settings, define a set of prefixes for short URLs:: - SHORTEN_MODELS = { - 'A': 'myapp.animal', - 'V': 'myapp.vegetable', - 'M': 'myapp.mineral' - } + SHORTEN_MODELS = { + 'A': 'myapp.animal', + 'V': 'myapp.vegetable', + 'M': 'myapp.mineral' + } + + The keys are string prefixes; they can be any string, actually, + but since we're going for short a single character is probably good. + + Values are the (hopefully-familiar) ``"."`` used + by Django to identify a model. Remember: ``app-name`` is the + (case-sensitive) last bit of your app's name in ``INSTALLED_APPS``, and + ```` is your model class's name, lowercased. + + Make sure your models have a ``get_absolute_url()`` method defined. - The keys are string prefixes; they can be any string, actually, - but since we're going for short a single character is probably good. +2. Wire up the redirect view by adding to your URLconf:: + + ('^short/', include('shorturls.urls')) - Values are the (hopefully-familiar) ``"."`` used - by Django to identify a model. Remember: ``app-name`` is the - (case-sensitive) last bit of your app's name in ``INSTALLED_APPS``, and - ```` is your model class's name, lowercased. +3. If you'd like to quickly link to shortened URLs in your templates, stick + ``"shorturls"`` in ``INSTALLED_APPS``, and then in your templates do:: + + {% load shorturl %} + ... - Make sure your models have a ``get_absolute_url()`` method defined. + (where ``object`` is a model instance). + + Alternatively:: + + {% load shorturl %} + {% revcanonical object %} - 2. Wire up the redirect view by adding to your URLconf:: - - ('^short/', include('shorturls.urls')) - - 3. If you'd like to quickly link to shortened URLs in your templates, stick - ``"shorturls"`` in ``INSTALLED_APPS``, and then in your templates do:: - - {% load shorturls %} - ... - - (where ``object`` is a model instance). - - Alternatively:: - - {% load shorturls %} - {% recanonical object %} - - This generates the whole ```` tag for - you. + This generates the whole ```` tag for + you. That's it. @@ -62,22 +62,22 @@ Settings Available settings are: - ``SHORTEN_MODELS`` - You've seen this one. - - ``SHORT_BASE_URL`` - If defined, the ``shorturl`` and ``revcanonical`` template tags will - prefix generated URLs with this value. Use this if you've got a shorter - domain name you'd like to use for small URLs. - - For example, given ``SHORT_BASE_URL = 'http://exm.pl/'``, ``{% shorturl - obj %}`` would return something like ``http://exm.pl/AbCd``. - - ``SHORTEN_FULL_BASE_URL`` - The domain to redirect to when redirecting away from the small URL. - Again, you'll use this if your short URL base and your "real" site - differ. - - If not defined, the redirect view will try to guess the proper domain by - consulting the ``django.contrib.sites`` framework, if installed, or the - requested domain, if not. \ No newline at end of file +``SHORTEN_MODELS`` + You've seen this one. + +``SHORT_BASE_URL`` + If defined, the ``shorturl`` and ``revcanonical`` template tags will + prefix generated URLs with this value. Use this if you've got a shorter + domain name you'd like to use for small URLs. + + For example, given ``SHORT_BASE_URL = 'http://exm.pl/'``, ``{% shorturl + obj %}`` would return something like ``http://exm.pl/AbCd``. + +``SHORTEN_FULL_BASE_URL`` + The domain to redirect to when redirecting away from the small URL. + Again, you'll use this if your short URL base and your "real" site + differ. + + If not defined, the redirect view will try to guess the proper domain by + consulting the ``django.contrib.sites`` framework, if installed, or the + requested domain, if not.