Como crear un mapa de sitio con Django

Archivada en Desarrollo Web

Como crear un mapa de sitio con Django

Inspirado en un artículo anterior sobre como crear mapas de sitio con WordPress me dispongo a crear la página equivalente para namespace.mx que utiliza Django. El mapa del sitio es un archivo que contiene enlaces a todas las categorías, a todos los años y meses que contenga el blog, y a las 100 entradas más recientes.

Definiendo la URL

Empiezo definiendo la URL del mapa del sitio, y preciso que se encuentre escribiendo /mapa/ en la barra de direcciones, así que en mi archivo urls.py agrego la línea con la expresión regular, la función y nombre para usarla más fácilmente.

url(r'^mapa/$', 'conxb.views.mapa', name='mapa'),

Agrego un patrón de búsqueda formado por r('^mapa/$'), donde la r indica que es una cadena raw, es decir, sin formato, el símbolo ^ indica en sintaxis regex el inicio del patrón y el símbolo $ indica el fin del dicho patrón de búsqueda.

La función que será llamada cuando se encuentre el patrón es conxb.views.mapa, sin argumentos. Tiene atajo, definido en name='mapa' que permite usar este atajo con la función reverse en una vista o la función url en una plantilla o template.

La vista para el mapa

Recordemos que Django funciona bajo un esquema MVC que separa la definción del objeto, la lógica y la plantilla. En este caso, el modelo es la Entrada que ya está definida y debemos generar la view o vista, es decir, la programación que enviaremos a la plantilla.

La lista de páginas

Django proporciona un modelo similar a las páginas en WordPress que se llama flatapages o páginas simples. Debemos hacer una consulta para saber con qué páginas simples cuenta nuestro blog.

Entonces el primer paso es importar el modelo, que se llama FlatPage del módulo django.contrib.flatpages, y hacer una consulta para extraer todas las páginas.

from django.contrib.flatpages.models import FlatPage
flats = FlatPage.objects.all()

La lista de categorías

Repetimos el procedimiento para las categorías, importamos el modelo y creamos una variable con el queryset o consulta.

from blog.models import Categoria
cats = Categoria.objects.all()

Archivos mensuales

Para crear los archivos mensuales usamos el modelo Entry que defines las entradas en este blog y obtenemos los meses en los que existen entradas agrupando los resultados.

Para esto Django proporciona un manager o administrador de consultas muy útil que se llama dates. Toma como argumentos el campo que contiene la fecha, que en este caso es pub_date; el campo de ordenación, que puede ser anual (year), mensual (year) y diario (diario) y un tercero que es opcional para indicar la ordenación (order='DESC')

from blog.models import Entry
meses = Entry.objects.dates('pub_date', 'month', order='DESC')

La lista de artículos

Para obtener los 100 posts más recientes, hacemos una nueva consulta al modelo Entry, especificando este límite.

La consulta pide que los resultados se ordenen por fecha descendentemente, de ahí el signo menos (-pub_date) y dentro por índice de las entradas (id o pk). Limitamos el número de resultados con notación slice.

entries = Entry.objects.all().order_by('-pub_date','id')[:100]

La vista completa

Con estos datos terminados la consulta, que queda de la siguiente manera. Observa que uso un decorardor @render_to de la app annoying que ahorra un montón de código.

# Modulos del blog
from blog.models import Entry
from django.contrib.flatpages.models import FlatPage
from blog.models import Categoria
# Decorador de views
from annoying.decorators import render_to

@render_to('indice/mapa.html')
def mapa(request):
    flats = FlatPage.objects.all()
    cats = Categoria.objects.all()
    meses = Entry.objects.dates('pub_date', 'month', order='DESC')
    entries = Entry.objects.all().order_by('-pub_date','id')[:100]
    return {'flats': flats, 'cats':cats, 'meses':meses, 'entries':entries}

Y con estos datos pasamos a la plantilla.

La plantilla del mapa

Para asegurar la consistencia en la presentación de la información y para asegurar una experiencia de usuario coherente con el resto del sitio, iniciamos extendiendo el archivo base y generamos nuestras columnas.

La primera columna, igual que en el ejemplo de WordPress contiene las listas de páginas, categorías y meses.

Usamos ciclos for para crear la lista de páginas, como se muestra a continuación, para las páginas. La función get_absolute_url() es un estándar en Django para este tipo de vistas. Pero como verás a continuación, yo uso una propia llama permalink, aunque su función es la misma.

<!-- listado de páginas -->
{% for page in flats %}
<li><a href="{{page.get_absolute_url}}">{{page.title}}</a></li>
{% endfor %}

En realidad, todos los listados son iguales, como el de categorías:

{% for cat in cats %}
  <li><a href="{{cat.permalink}}">{{cat.title}}</a></li>
{% endfor %}

En el caso de los meses, debemos convertir la fecha en una URL correcta y usamos el filtro date de las plantillas de Django.

{% for mes in meses %}
    <li><a href="{{mes|date:'/Y/m/'}}">{{mes|date:"F \d\e\l Y"}}</a></li>
{% endfor %}

Y con esto terminamos la columna izquierda de nuestro mapa.

La columna derecha se forma con el listado de artículos, de forma idéntica a las listas anteriores.

{% for entry in entries %}
<li><a href="{{entry.permalink}}">{{entry.title}}</a></li>
{% endfor %}

El resultado final lo puedes ver en el mapa del sitio.

Javier Sanchez Toledano

Auditor Líder ISO 9000 ● Desarrollo Web Full Stack ● Django/Python ● JavaScript · NodeJS · Angular · VueJS · EmberJS ● Swift 4 ● WordPress · Genesis Framework ● Lector ● Fotografo aficionado ● Generación X ● Soy de Tlaxcala

Tlaxcala, México

Comentarios