Wagtail是一款基于Django的CMS开源框架,集成的功能非常多,很适合做定制站点开发。本文是从Wagtail官网翻译的一篇教程(官网教程:Your first Wagtail site),由于原文比较长,我把它分成了三个部分,今天这篇文章是第一部分,包括搭建Wagtail环境、编写第一个Wagtail的Model以及HomePage。
安装依赖
Wagtail 支持Python 3.7, 3.8, 3.9 and 3.10,请确保您的Python版本大于等于3.7。检查Python的版本命令:
$ python3 --version
创建虚拟环境
教程使用的是Window的venv虚拟环境,Python3.8已经自带了创建虚拟环境命令。
Windows命令行命令 (cmd.exe):
> python3 -m venv mysite\env>mysite\env\Scripts\activate.bat
在GNU/Linux或者MacOS中的命令 (bash):
$ python3 -m venv mysite/env$ sourcemysite/env/bin/activate
安装Wagtail
在虚拟环境中使用pip命令:
$ pip install wagtail
创建站点
Wagtail提供start命令,有点类似django-admin start project。运行wagtail start mysite 会生成 mysite 文件夹,文件夹内会生成一些Wagtail特有的内容,包括一个项目需要的Settings,一个空的Homepage model和带着基本模板的“home”应用以及一个“search”查询应用。
$ wagtail start mysite
安装项目依赖
$ cd mysite$ pip install -r requirements.txt
这个依赖文档很贴心的将Wagtail、Django以及其他必须的程序一次性安装好。
创建数据库
默认会使用sqlite数据库,创建命令和Django程序一样。
$ python manage.py migrate
创建管理员用户
$ python manage.py createsuperuser
启动服务
$ python manage.py runserver
如果一切顺利,在浏览器中输入http://127.0.0.1:8000 会显示欢迎界面。
访问后台
http://127.0.0.1:8000/admin
扩展HomePage model
打开home app 中的定义空的HomePage model的models.py,按照如下代码编辑home/models.py, 主要是在Model中增加了 body 字段:
from django.db import models
from wagtail.models import Page
from wagtail.fields import RichTextField
from wagtail.admin.panels import FieldPanel
class HomePage(Page):
body = RichTextField(blank=True)
content_panels = Page.content_panels+ [
FieldPanel('body',classname="full"),
]
body被定义为 RichTextField, 这是一个特定的Wagtail字段。设置blank=True代表这个字段不是必输并且可以为空。当然,定义Model中的字段,你可以使用任何Django的原生字段。content_panels定义了在后台编辑时的布局,当我们往content_panels中添加字段时,这个字段则会显示在Wagtail后台的content_panels界面。修改好Model后,运行migrate命令:
python manage.py makemigrations
python manage.py migrate
牢记每次变更Model的内容后都要执行上述两个命令。
执行完成后,现在我们可以在Waggtail admin后台编辑homepage(选中Pages菜单Homepage, 然后选择Edit) 的body字段了。
在body字段中输入一些文字,例如“Welcome to my website”,注意我们把welcome单词加粗了,然后选择发布(publish)。
现在需要更新一下网页模板显示刚刚修改过的内容。Wagtail采用Django模板技术来渲染网页。默认情况,HomePage类对应的网页模板就是home/home_page.html。这个是Django模板默认查找规则,这里的例子全部遵循这个规则。
根据如下内容修改
home/templates/home/home_page.html如下:
{% extends "base.html" %}
{% load wagtailcore_tags %}
{% block body_class %}template-homepage{%endblock %}
{% block content %}
{{ page.body|richtext }}
{% endblock %}
base.html代表父模板,通常每一个模板都继承自这个模板。这样的好处就是会节省很多时间,因为我们不用再编写相似的框架代码。我们只需要在继承的模板中重写Block中的代码,就可以覆盖或者继承父模板指定区域的代码。
Wagtail模板标签 template tags
Wagtial提供了一系列自带的标签及过滤器,使用这些仅需要在模板中引入{% load wagtailcore_tags %} 即可。刚才的模板中,我们使用richtext过滤器来过滤并打印RichTextField的内容。
{% load wagtailcore_tags %}
{{ page.body|richtext }}
前台显示效果(注意Welcome是加粗的)如下:
备注:wagtailcore_tags提供了一些wagtail的附加标签,在模板中必须先引用。如果没有引用{% load wagtailcore_tags %}。Django的前台界面会抛出TemplateSyntaxError。
原文链接:
https://docs.wagtail.org/en/stable/getting_started/tutorial.html
文章同步更新至公众号“Django编程”