canonicalwebteam.django views

CanonicalWebTeam.django_views

Visualizações para aplicativos Django, principalmente para uso em aplicativos Django da Webteam.

Instalação

Você pode instalar este módulo diretamente com pip install canonicalwebteam.django_views ou, alternativamente, incluir canonicalwebteam.django_views no requirements.txt para o seu aplicativo.

Templatefinder

TemplateFinder é uma extensão do TemplateView que tenta carregar os modelos correspondentes diretamente dos URLs, sem a necessidade de escrever uma visualização para cada URL.

Ele pode carregar modelos HTML diretamente ou analisar arquivos de marcação que contêm uma tecla "wrapper_template".

Uso

Aqui está um exemplo de como fazer uso do TemplateFinder no seu aplicativo Django:

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

Correspondência de modelo

Quando o aplicativo analisar um URL, ele procurará modelos nos seguintes locais, em ordem:

• /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

Analisação de desmembramento

Se o TemplateFinder encontrar um arquivo de marcação (final .md ), ele procurará as seguintes teclas no YAML FrontMatter:

• wrapper_template obrigatório : (por exemplo: wrapper_template: /includes/markdown-wrapper.html ) Um caminho para um modelo html no qual colocar o conteúdo de marcação analisado. Se o caminho não tiver uma barra principal (por exemplo, "modelos/modplate.html" ou "../templates/template.html"), TemplateFinder pesquisará o modelo em relação à localização do arquivo de marcação em questão. Se o caminho
• context Opcional : (por exemplo: context: {title: "Welcome", description: "A welcome page"} ) Um dicionário de pares de chave / valor extra para passar para o contexto do modelo.
• markdown_includes Opcional : (por exemplo: markdown_includes: {nav: } ) Um mapeamento de nomes -chave para modelar os caminhos apontando para os arquivos de marcação a serem incluídos. Cada caminho de modelo será analisado, o HTML resultante será aprovado no contexto do modelo, sob a chave relevante.

Aqui está um exemplo de arquivo de marcação:

    ---
    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).