canonicalwebteam.django views

canonicalwebteam.django_views

主にWebteam Djangoアプリで使用するためのDjangoアプリのビュー。

インストール

このモジュールはpip install canonicalwebteam.django_viewsで直接インストールできます。または、アプリのrequirements.txtにcanonicalwebteam.django_viewsを含めることもできます。

TemplateFinder

TemplateFinder 、各URLのビューを作成する必要なく、対応するテンプレートをURLから直接ロードしようとするTemplateViewの拡張機能です。

HTMLテンプレートを直接ロードするか、「wrapper_template」FrontMatterキーを含むマークダウンファイルを解析できます。

使用法

DjangoアプリでTemplateFinderを使用する方法の例は次のとおりです。

 # 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 MarkDownファイル（Ending .md ）に遭遇した場合、YAML FrontMatterで次のキーを探します。

• wrapper_template必須：（eg： wrapper_template: /includes/markdown-wrapper.html ）解析されたマークダウンコンテンツを配置するHTMLテンプレートへのパス。パスにリーディングスラッシュがない場合（「Templates/template.html」または「../templates/template.html」）、TemplateFinder TemplateFinder 、問題のMarkdownファイルの位置に対するテンプレートを検索します。パスの場合
• contextオプション：（eg： context: {title: "Welcome", description: "A welcome page"} ）テンプレートコンテキストに渡すための追加のキー /バリューペアの辞書。
• markdown_includesオプション：（例： markdown_includes: {nav: } ）キー名のマッピングは、インクルードするマークダウンファイルを指すパスへのテンプレートパスへのマッピング。各テンプレートパスは解析され、結果の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).