canonicalwebteam.django views

CanonicalWebteam.django_views

Просмотры для приложений Django, в первую очередь для использования в приложениях Django WebTeam.

Установка

Вы можете установить этот модуль непосредственно с помощью pip install canonicalwebteam.django_views или, в качестве альтернативы, включить canonicalwebteam.django_views in requirements.txt для вашего приложения.

Шаблон

TemplateFinder - это расширение TemplateView , которое пытается загрузить соответствующие шаблоны непосредственно из URL, без необходимости записать представление для каждого URL.

Он может загружать шаблоны HTML непосредственно или разрабатывать файлы разметки, которые содержат ключ передней панели «warper_template».

Использование

Вот пример того, как использовать TemplateFinder в вашем приложении Django:

 # urls.py
from django . conf . urls import url
from canonicalwebteam . django_views import TemplateFinder
# ...
urlpatterns += url ( r"$^" , TemplateFinder . as_view ()),

Шаблон сопоставление

Когда приложение анализирует URL, оно будет искать шаблоны в следующих местах, в порядке:

• /parent/location/ => templates/parent/location.html
• /parent/location/ => templates/parent/location/index.html
• /parent/location/ => templates/parent/location.md
• /parent/location/ => templates/parent/location/index.md

Расположение маркировки

Если TemplateFinder снимает файл разметки (конец .md ), он будет искать следующие клавиши в передней части YAML:

• wrapper_template Обязательно : (например: wrapper_template: /includes/markdown-wrapper.html ) Путь к шаблону HTML, в котором можно разместить аналитическое содержание отметки. Если путь не имеет ведущей черты (например, «шаблоны/шаблон.html» или «../templates/template.html»), то TemplateFinder будет искать шаблон относительно местоположения рассматриваемого файла разметки. Если путь
• context необязательно : (например: context: {title: "Welcome", description: "A welcome page"} ) Словарь паров дополнительных ключей / значения для перехода в контекст шаблона.
• markdown_includes Необязательно : (например, markdown_includes: {nav: } ) отображение имен ключей с путями шаблона, указывающих на файлы Markdown для включения. Каждый путь шаблона будет проанализирован, полученный HTML будет проходить в контексте шаблона в соответствии с соответствующим ключом.

Вот пример файла разметки:

    ---
    wrapper_template: "/includes/markdown-wrapper.html"
    markdown_includes:
      nav: "includes/nav.md"
    context:
      title: "Welcome"
      description: "A welcome page"
    ---
    
    Welcome to my website.
    
    ## GitHub
    
    I also have [a GitHub page](https://github.com/me).