模版

模板用于渲染从一组上下文数据生成的HTML内容。NetBox提供了一组适用于插件视图的内置模板。插件作者可以扩展这些模板，以最小化创建自定义模板所需的工作量，同时确保它们生成的内容与NetBox的布局和样式匹配。这些模板都是用Django模板语言（DTL）编写的。

模板文件结构

插件模板应位于插件根目录下的templates/<plugin-name>/路径中。例如，如果您的插件的名称是my_plugin并且您创建了一个名为foo.html的模板，它应该保存在templates/my_plugin/foo.html中。（当然，您也可以在此点下使用子目录。）这确保了Django的模板引擎可以定位要渲染的模板。

标准块

以下模板块在所有模板上都可用。

名称	必需	描述
`title`	是	页面标题
`content`	是	页面内容
`head`	-	包含在HTML `<head>`元素中的内容
`footer`	-	页脚内容
`footer_links`	-	页脚的链接部分
`javascript`	-	包含在HTML `<body>`元素末尾的Javascript内容

Note

有关模板块的工作原理的更多信息，请查阅Django文档。

基础模板

layout.html

路径：base/layout.html

NetBox提供了一个基本模板，以确保一致的用户体验，插件可以在其中扩展其自己的内容。这是一个通用模板，当下面列出的功能特定模板都不适用时，可以使用它。

块

名称	必需	描述
`header`	-	页面头部
`tabs`	-	水平导航选项卡
`modals`	-	Bootstrap 5模态元素

示例

下面包含一个扩展layout.html的插件模板的示例。

{% extends 'base/layout.html' %}

{% block header %}
  <h1>我的自定义标题</h1>
{% endblock header %}

{% block content %}
  <p>{{ some_plugin_context_var }}</p>
{% endblock content %}

模板的第一行指示Django扩展NetBox基本模板，并且block部分将我们的自定义内容注入其中的header和content块中。

Note

Django使用其自己的自定义模板语言来呈现模板。这与Jinja2非常相似，但在创建新模板之前，作者需要了解一些重要的区别。在尝试创建新模板之前，请务必熟悉Django的模板语言。

通用视图模板

object.html

路径：generic/object.html

此模板由ObjectView通用视图使用，用于显示单个对象。

块

名称	必需	描述
`breadcrumbs`	-	面包屑列表项（HTML `<li>`元素）
`object_identifier`	-	对象的唯一标识符（字符串）
`extra_controls`	-	要显示的其他操作按钮

上下文

名称	必需	描述
`object`	是	正在查看的对象实例

object_edit.html

路径：generic/object_edit.html

此模板由ObjectEditView通用视图使用，用于创建或修改单个对象。

块

名称	必需	描述
`form`	-	自定义表单内容（在HTML `<form>`元素内部
`buttons`	-	表单提交按钮

上下文

名称	必需	描述
`object`	是	正在修改的对象实例（或无，如果正在创建）
`form`	是	用于创建/修改对象的表单类
`return_url`	是	用户在提交表单后重定向的URL

object_delete.html

路径：generic/object_delete.html

此模板由ObjectDeleteView通用视图使用，用于删除单个对象。

块

无

上下文

名称	必需	描述
`object`	是	正在删除的对象实例
`form`	是	用于确认对象删除的表单类
`return_url`	是	用户在提交表单后重定向的URL

object_list.html

路径：generic/object_list.html

此模板由ObjectListView通用视图使用，用于显示多个对象的可过滤列表。

块

名称	必需	描述
`extra_controls`	-	其他操作按钮
`bulk_buttons`	-	要在对象列表下方显示的其他批量操作按钮

上下文

名称	必需	描述

bulk_import.html

路径：generic/bulk_import.html

此模板由BulkImportView通用视图使用，用于一次性从CSV数据导入多个对象。

块

无

上下文

名称	必需	描述
`model`	是	对象类
`form`	是	CSV导入表单类
`return_url`	-	在提交批量操作表单时传递的返回URL
`fields`	-	表单字段的字典，用于显示导入选项

bulk_edit.html

路径：generic/bulk_edit.html

此模板由BulkEditView通用视图使用，用于同时修改多个对象。

块

无

上下文

名称	必需	描述
`model`	是	对象类
`form`	是	批量编辑表单类
`table`	是	用于呈现对象列表的表格类
`return_url`	是	用户在提交表单后重定向的URL

bulk_delete.html

路径：generic/bulk_delete.html

此模板由BulkDeleteView通用视图使用，用于同时删除多个对象。

块

名称	必需	描述
`message_extra`	-	附加警告消息内容

上下文

名称	必需	描述
`model`	是	对象类
`form`	是	批量删除表单类
`table`	是	用于呈现对象列表的表格类
`return_url`	是	用户在提交表单后重定向的URL

过滤器

以下自定义模板过滤器在NetBox中可用。

Info

这些过滤器会由模板后端自动加载：您无需在模板中包含{% load %}标签以激活它们。

`bettertitle(value)`

Alternative to the builtin title(). Ensures that the first letter of each word is uppercase but retains the original case of all others.

`content_type(model)`

Return the ContentType for the given object.

`content_type_id(model)`

Return the ContentType ID for the given object.

`linkify(instance, attr=None)`

Render a hyperlink for an object with a get_absolute_url() method, optionally specifying the name of an attribute to use for the link text. If no attribute is given, the object's string representation will be used.

If the object has no get_absolute_url() method, return the text without a hyperlink element.

`meta(model, attr)`

Return the specified Meta attribute of a model. This is needed because Django does not permit templates to access attributes which begin with an underscore (e.g. _meta).

Parameters:

Name	Type	Description	Default
`model`		A Django model class or instance	required
`attr`		The attribute name	required

`placeholder(value)`

Render a muted placeholder if the value equates to False.

`render_json(value)`

Render a dictionary as formatted JSON. This filter is invoked as "json":

{{ data_dict|json }}

`render_markdown(value)`

Render a string as Markdown. This filter is invoked as "markdown":

{{ md_source_text|markdown }}

`render_yaml(value)`

Render a dictionary as formatted YAML. This filter is invoked as "yaml":

{{ data_dict|yaml }}

`split(value, separator=',')`

Wrapper for Python's split() string method.

Parameters:

Name	Type	Description	Default
`value`		A string	required
`separator`		String on which the value will be split	`','`

`tzoffset(value)`

Returns the hour offset of a given time zone using the current time.

Name	Description	Default
`value`	The value to be displayed within the badge	required
`bg_color`	Background color CSS name	`None`
`show_empty`	If true, display the badge even if value is None or zero	`False`

Name	Description	Default
`value`	True or False	required
`show_false`	Show false values	`True`
`true`	Text label for true values	`'Yes'`
`false`	Text label for false values	`'No'`

Name	Type	Description	Default
`customfield`		A CustomField instance	required
`value`		The custom field value applied to an object	required

Name	Type	Description	Default
`value`		A Tag instance	required
`viewname`		If provided, the tag will be a hyperlink to the specified view's URL	`None`

模版

模板文件结构

标准块

基础模板

layout.html

块

示例

通用视图模板

object.html

块

上下文

object_edit.html

块

上下文

object_delete.html

块

上下文

object_list.html

块

上下文

bulk_import.html

块

上下文

bulk_edit.html

块

上下文

bulk_delete.html

块

上下文

标签

badge(value, bg_color=None, show_empty=False)

checkmark(value, show_false=True, true='Yes', false='No')

customfield_value(customfield, value)

tag(value, viewname=None)

过滤器

bettertitle(value)

content_type(model)

content_type_id(model)

linkify(instance, attr=None)

meta(model, attr)

placeholder(value)

render_json(value)

render_markdown(value)

render_yaml(value)

split(value, separator=',')

tzoffset(value)

`badge(value, bg_color=None, show_empty=False)`

`checkmark(value, show_false=True, true='Yes', false='No')`

`customfield_value(customfield, value)`

`tag(value, viewname=None)`