canonicalwebteam.django views

canonicalwebtam.django_views

Vues pour les applications Django, principalement pour une utilisation dans les applications WebTeam Django.

Installation

Vous pouvez installer ce module directement avec pip install canonicalwebteam.django_views , ou alternativement, inclure canonicalwebteam.django_views dans requirements.txt pour votre application.

TemplateFinder

TemplateFinder est une extension de TemplateView qui tente de charger les modèles correspondants directement à partir des URL, sans avoir besoin d'écrire une vue pour chaque URL.

Il peut charger directement des modèles HTML, ou analyser les fichiers de marque qui contiennent une touche Frontmatter "wrapper_template".

Usage

Voici un exemple de la façon d'utiliser TemplateFinder dans votre application Django:

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

Modèle correspondant

Lorsque l'application analyse une URL, elle recherchera des modèles dans les emplacements suivants, dans l'ordre:

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

Analyse de marque

Si le TemplateFinder rencontre un fichier Markdown (terminant .md ), il recherchera les touches suivantes dans YAML Frontmatter:

• wrapper_template Obligatoire : (par exemple: wrapper_template: /includes/markdown-wrapper.html ) un chemin vers un modèle HTML à l'intérieur desquels placer le contenu de la marque analysé. Si le chemin n'a pas de slash leader (par exemple "Modèles / template.html" ou "../TEMPlates/template.html"), TemplateFinder recherchera le modèle par rapport à l'emplacement du fichier de démarrage en question. Si le chemin
• context facultatif : (par exemple: context: {title: "Welcome", description: "A welcome page"} ) Un dictionnaire de paires de clés / valeur supplémentaires à passer au contexte du modèle.
• markdown_includes facultatif : (par exemple: markdown_includes: {nav: } ) Un mappage des noms de clés aux chemins de modèle pointant vers des fichiers de démarque à inclure. Chaque chemin de modèle sera analysé, le HTML résultant sera passé dans le contexte du modèle, sous la clé pertinente.

Voici un exemple de fichier Markdown:

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