Django-Sitetree 技术文档

1. 安装指南

安装步骤

1. 通过 pip 安装：

   pip install django-sitetree
   

2. 在 Django 项目中配置：

   • 将 'sitetree' 添加到 INSTALLED_APPS 中：

     INSTALLED_APPS = [
         ...
         'sitetree',
         ...
     ]
     

3. 运行迁移：

   python manage.py migrate
   

4. 配置 URL：

   • 在项目的 urls.py 中包含 sitetree 的 URL：

     from django.urls import include, path
     
     urlpatterns = [
         ...
         path('sitetree/', include('sitetree.urls')),
         ...
     ]
     

2. 项目的使用说明

创建站点树

1. 通过 Django 管理界面创建：

   • 登录 Django 管理界面，进入 Site Trees 部分。
   • 创建一个新的站点树，并为每个页面添加 URI 和标题。

2. 使用模板标签：

   • 在模板中使用 sitetree 提供的模板标签来生成菜单、面包屑和完整的站点树。
   • 示例：

     {% load sitetree %}
     <ul>
         {% sitetree_menu from "my_site_tree" include "trunk" %}
     </ul>
     

动态定义站点树

• 可以在代码中动态定义站点树，而不是通过管理界面。
• 示例：

  from sitetree.models import TreeItem
  
  tree = Tree.objects.create(title='Dynamic Tree')
  TreeItem.objects.create(tree=tree, title='Home', url='/')
  TreeItem.objects.create(tree=tree, title='About', url='/about/')
  

3. 项目 API 使用文档

主要 API

1. sitetree_menu：

   • 生成菜单。
   • 参数：
     • from：指定站点树。
     • include：指定包含的节点类型（如 trunk、children 等）。

2. sitetree_breadcrumbs：

   • 生成面包屑导航。
   • 参数：
     • from：指定站点树。

3. sitetree_tree：

   • 生成完整的站点树。
   • 参数：
     • from：指定站点树。

4. sitetree_page_title：

   • 获取当前页面的标题。

5. sitetree_page_description：

   • 获取当前页面的描述。

4. 项目安装方式

通过 pip 安装

pip install django-sitetree

手动安装

1. 下载项目源码。
2. 解压后进入项目目录。
3. 运行以下命令进行安装：

   python setup.py install
   

依赖项

• Python 3.6+
• Django 2.0+
• Django Auth contrib package
• Django Admin contrib package (可选)

通过以上步骤，您可以成功安装并使用 django-sitetree 来管理您的 Django 项目中的站点树、菜单和面包屑导航。