django-treemenus 0.9.2

安装官方版本

django-treemenus可在PyPI上找到，并可以使用Pip安装

pip install django-treemenus

或者，官方源代码发布可以在https://pypi.python.org/pypi/django-treemenus找到

下载.zip发行文件，解压它。其中包含一个名为setup.py的脚本。运行以下命令

python setup.py install

…然后软件包将自动安装。

安装开发版本

如果您希望定期更新Django Tree Menus以获取最新的错误修复和改进，在官方版本中包含之前，请使用git clone

git clone https://github.com/jphalip/django-treemenus

然后将treemenus文件夹添加到您的PYTHONPATH或符号链接（如果是Windows系统，则是junction），例如在Python的site-packages目录下。

将树形菜单链接到您的项目

1. 将treemenus添加到Django项目的INSTALLED_APPS设置中。

2. 通过在项目根目录运行以下命令创建django-treemenus表

   python manage.py syncdb

3. 在项目模板文件夹中创建并添加您自定义的模板。这些模板是必要的，用于指定您希望在网站上显示菜单的方式（以下将提供更多有关模板使用的详细信息）。包中也提供了一些示例模板，以帮助您开始。

treemenus/menu.html

指定如何显示菜单的模板。

上下文

• menu

  要显示的菜单的指针。您可以使用menu.root_item访问其根项。

• menu_type（可选）

  如果在使用模板标签调用时指定了此变量，则此变量将存在。（有关更多详细信息，请参阅“模板标签”部分）。

此模板的示例:

{% load tree_menu_tags %}

{% ifequal menu_type "unordered-list" %}
    <ul>
        {% for menu_item in menu.root_item.children %}
            {% show_menu_item menu_item %}
        {% endfor %}
    </ul>
{% endifequal %}
{% ifequal menu_type "ordered-list" %}
    <ol>
        {% for menu_item in menu.root_item.children %}
            {% show_menu_item menu_item %}
        {% endfor %}
    </ol>
{% endifequal %}

treemenus/menu_item.html

指定如何显示菜单项的模板。

上下文

• menu_item

  要显示的菜单项的指针。您可以直接访问其所有方法和变量。

• menu_type（可选）

  如果在使用模板标签调用时指定了此变量，则此变量将可访问。（有关更多详细信息，请参阅“模板标签”部分）。

此模板的示例:

{% load tree_menu_tags %}
<li><a href="{{ menu_item.url }}">{{ menu_item.caption }}</a>
    {% if menu_item.children %}
    <ul>
        {% for child_item in menu_item.children %}
        {% show_menu_item child_item %}
        {% endfor %}
    </ul>
    {% endif %}
</li>

show_menu

这是起点。您可以在任何需要显示菜单的地方调用它（通常是在网站的基模板中）。

有两个属性

• menu_name

  要显示的菜单的名称，就像通过管理界面保存的那样。

• menu_type

  此属性是可选的。如果提供了它，它将简单地传递给treemenus/menu.html模板。它没有特定的预定义功能，但可以通过（% ifequal menu_type “sometype” %}来测试以确定如何显示菜单（有关模板treemenus/menu.html的示例，请参阅上方）。

使用示例:

{% show_menu "TopMenu" %}
...
{% show_menu "LeftMenu" "vertical" %}
...
{% show_menu "RightMenu" "horizontal" %}

show_menu_item

此标签允许您显示一个菜单项，它只有一个属性。

使用示例:

{% show_menu_item menu_item %}

reverse_named_url

此标签允许您反转菜单项的命名URL，该URL作为单个字符串传递。要了解更多关于命名URL的信息，请参阅Django模板文档。例如，传递的值可以是“latest_news”或“show_profile user.id”，这将反转到相应的URL（在您的URLConf中定义）。

使用示例:

<li><a href="{% reverse_named_url menu_item.named_url %}">{{ menu_item.caption }}</a></li>

菜单

只有一个可用的属性：root_item，它指向…没错，菜单的根项。

菜单项

• menu

  返回它所属的菜单。

• url

  返回项的URL。

  使用示例:

  <li><a href="{{ menu_item.url }}">{{ menu_item.caption }}</a></li>

• parent

  返回菜单项的父项（即另一个菜单项）。

• rank

  返回项在其兄弟中的排名。分支的第一个项的排名为0，第二个项的排名为1，依此类推。要更改项的排名，您可以通过管理界面将其向上或向下移动。

  使用示例:

  <li><a class="menuitem-{{ menu_item.rank }}" href="{{ menu_item.url }}">{{ menu_item.caption }}</a></li>

• level

  返回项在层次结构中的级别。这是由系统自动计算的。例如，根项的级别为0，其子项的级别为1。

  使用示例:

  {% ifequal menu_item.level 1 %}
      <li><a class="top-item" href="{{ menu_item.url }}">{{ menu_item.caption }}</a></li>
  {% else %}
      <li><a href="{{ menu_item.url }}">{{ menu_item.caption }}</a></li>
  {% endifequal %}

• caption

  返回项的标题。

• named_url

  如果您想使用命名URL而不是原始URL，请使用此属性。

  使用示例:

  <li><a href="{% reverse_named_url menu_item.named_url %}">{{ menu_item.caption }}</a></li>

• has_children

  如果项有一些子项，则返回True，否则返回False。

• children

  返回一个列表，包含菜单项的子项，按排名排序。

  使用示例:

  {% if menu_item.has_children %}
      <li><a class="daddy" href="{{ menu_item.url }}">{{ menu_item.caption }}</a>
          <ul>
              {% for child in menu_item.children %}
                  {% show_menu_item child %}
              {% endfor %}
          </ul>
      </li>
  {% else %}
      <li><a href="{{ menu_item.url }}">{{ menu_item.caption }}</a></li>
  {% endif %}

• siblings

  返回一个列表，包含菜单项的兄弟项（即所有具有相同父项的其他项），按排名排序。

国际化

如果您使用 Django 国际化 模块，使您的菜单多语言化非常简单。您可以做的就是在菜单项的 caption 属性上应用翻译。例如

{% load i18n %}
...
<li><a href="{{ menu_item.url }}">{% trans menu_item.caption %}</a></li>

然后，手动在您的 *.po 文件中添加翻译条目。

如果您使用更复杂或定制的翻译系统，您可以简单地定义您的扩展类（或者如果您还没有创建，则创建它）并使用一个管理翻译的方法，例如

class MenuItemExtension(models.Model):
    menu_item = models.OneToOneField (MenuItem, related_name="extension")
    ...

    def translation():
        translation = do_something_with(self.menu_item.caption)
        return translation

然后在您的模板中

<li><a href="{{ menu_item.url }}">{% trans menu_item.extension.translation %}</a></li>

登录限制

如果您想要使某些菜单项私有，并且仅对已登录用户可用，这是很简单的事情！只需像以下那样定义您的扩展类（或者如果您还没有创建，则创建它）

class MenuItemExtension(models.Model):
    menu_item = models.OneToOneField (MenuItem, related_name="extension")
    protected = models.BooleanField(default=False)
    ...

然后在您的模板中

{% if menu_item.extension.protected %}
    {% if user.is_authenticated %}
        <li><a href="{{ menu_item.url }}">{{ menu_item.caption }}</a></li>
    {% endif %}
{% else %}
    <li><a href="{{ menu_item.url }}">{{ menu_item.caption }}</a></li>
{% endif %}

(假设上下文变量‘user’代表当前已登录用户)

自动选择菜单项

在此，我将解释如何在访问您网站上的给定页面时自动选择菜单项。这是一个说明扩展如何自定义菜单行为的强大功能的良好示例。对于此示例，让我们假设您希望在访问网址‘http://www.example.com/contact/’时，在视觉上选择菜单项‘联系’

首先，定义您的扩展类（或者如果您还没有创建，则创建它），如下所示

class MenuItemExtension(models.Model):
    menu_item = models.OneToOneField (MenuItem, related_name="extension")
    selected_patterns = models.TextField(blank=True)

selected_patterns 是一个属性，它将指定菜单项应具有哪个 URL 的“selected”状态。有关如何将扩展类连接到菜单的说明，请参阅上面的扩展部分。

现在，在管理员部分，编辑‘联系’菜单项，并在其 selected_patterns 文本框中输入以下行

^/contact/$

我们在这里使用正则表达式，这为我们提供了指定“selected”URL模式的灵活性。有关更多信息，请参阅 正则表达式语法 的官方 Python 文档。在此示例中，我们仅使用一个正则表达式模式 (^/contact/$)，但您可以通过在文本框的每一行中输入不同的模式来添加尽可能多的模式。

然后，在您的 menu_item.html 模板中，使用以下“if”语句

{% load menu_extension_filters %}
...
<li><a href="{{ menu_item.url }}" class="{% if menu_item.extension.selected_patterns|match_path:request.path %}selected{% endif %}">{{ menu_item.caption }}</a></li>

使用此代码，将匹配当前 URL 的任何菜单项的属性 selected_patterns 将被赋予“selected”CSS类（您需要根据您的样式表定义“selected”类实际执行的操作 - 例如更改颜色或字体？）。在此示例中，我们分配了特殊样式以在视觉上区分选定的菜单项，但您显然可以使用上述“if”语句执行任何形式的区分（例如显示选定菜单的所有子菜单等）。别忘了加载我们即将创建的 menu_extension_filters 模块。

现在我们需要创建一个名为‘match_path’的过滤器。在你的 menu_extension 应用程序（或者你给菜单扩展应用程序取的任何名字）中，创建一个名为 templatetags 的目录，该目录包含两个文件： __init__.py（保持为空）和包含以下代码的 menu_extension_filters.py 文件。

import re
from django import template

register = template.Library()

def match_path(patterns, path):
    if patterns:
        for pattern in patterns.splitlines():
            if re.compile(pattern).match(path):
                return True
    return False
register.filter('match_path', match_path)

它的作用是测试每行中的每个模式（记住，你可以在 selected_patterns 文本字段的每行添加一个模式）并返回 true，如果这些模式中的任何一个与给定的路径匹配。

最后，为了能够在模板中通过 request.path 访问当前 URL，你需要做两件事

1) 将 django.core.context_processors.request 添加到你的 TEMPLATE_CONTEXT_PROCESSORS 设置中（有关详细信息，请参阅 Django 文档中的 上下文处理器）。

2) 在你的视图中使用 RequestContext 对象并将其传递到你的模板中。（请参阅 Django 文档中的 RequestContext）。