Ver índice de contenidos del libro

10.6. Usar la referencia de plantillas incorporadas

La interfaz de administración de Django incluye una referencia completa de todas las etiquetas y filtros de plantillas disponibles para un sitio determinado. Está designada para ser una herramienta que los programadores Django proveen a los desarrolladores de plantillas. Para verla, ve a la interfaz de administración y haz click en el enlace Documentación en la zona superior derecha de la página.

La referencia está dividida en cuatro secciones: etiquetas, filtros, modelos y vistas. Las secciones etiquetas y filtros describen todas las etiquetas incluidas (en efecto, las referencias de etiquetas y filtros del Capítulo 4 han sido extraídas directamente de esas páginas) así como cualquier librería de etiquetas o filtros personalizados disponible.

La página views es la más valiosa. Cada URL en tu sitio tiene allí una entrada separada. Si la vista relacionada incluye una docstring, haciendo click en la URL te mostrará lo siguiente:

  • El nombre de la función de vista que genera esa vista.
  • Una breve descripción de qué hace la vista.
  • El contexto, o una lista de variables disponibles en la plantilla de la vista.
  • El nombre de la plantilla o plantillas usados para esa vista.

Para un ejemplo detallado de la documentación de vistas, lee el código fuente de la vista genérica de Django object_list la cual se encuentra en django/views/generic/list_detail.py.

Debido a que los sitios implementados con Django generalmente usan objetos de bases de datos, las páginas models describen cada tipo de objeto en el sistema así como todos los campos disponibles en esos objetos.

En forma conjunta, las páginas de documentación deberían proveerte cada etiqueta, filtro, variable y objeto disponible para su uso en una plantilla arbitraria.