Skip to content

Commit 56c4ac1

Browse files
teebbstudiosteebbstudios
committed
modify docs
1 parent 9d6fb76 commit 56c4ac1

9 files changed

Lines changed: 36 additions & 35 deletions

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
#TEEBB内容管理系统使用文档
1+
# TEEBB内容管理系统使用文档
22
TEEBB是基于Symfony框架开发的一款可自由扩展的内容管理系统。您可以自由使用本软件来构建您的博客、网站等应用。本项目将会长期开发维护，欢迎使用。
33
TEEBB的原理设计参考了著名的Drupal，注重内容的扩展性与功能性，因为Drupal的学习曲线太高了，于是我开发了TEEBB，它更轻量也更容易上手。目前0.x版本已实现了内容管理和一些基本功能，
44
注重内容类型网站的开发。在后续版本中将实现I18N（国际化），RESTful API，消息队列，缓存等等功能。如果您是Symfony初学者，TEEBB用到了Symfony的多个组件，是个不错的学习案例。
55
欢迎您进行Fork，并提交Pull Request，我们一起开发维护TEEBB，如果后续TEEBB有获利计划，我将优先通知您参与并获取相应利益。
66
![alt TEEBB控制台](docs/teebb_images/teebb-dashboard.png "TEEBB控制台")
77

8-
###1.TEEBB的下载和安装说明
8+
### 1.TEEBB的下载和安装说明
99
TEEBB的运行环境：
1010
PHP 7.2.5及以上、Mysql 5.7.x、推荐安装：Symfony 命令行工具，详见：www.symfony.com
1111

@@ -32,14 +32,14 @@ open http://127.0.0.1:8000/admin
3232
> 初始管理员账号：admin
3333
> 初始管理员密码：admin
3434
35-
###2.TEEBB的版本号及开发周期说明
35+
### 2.TEEBB的版本号及开发周期说明
3636
TEEBB的版本号遵循语义化版本格式：主版本号.次版本号.修订号
3737
TEEBB的次版本号（例如：0.2.x，0.3.x）发布周期：至少每四个月发布一次。
3838
TEEBB的修订版本号（例如：0.1.1，0.1.2）发布周期：至少每三个星期发布一次。
3939

4040
> Tips:目前TEEBB 0.x版本的核心功能bundle仅包含在teebbstudios/core-bundle，并不利于后期维护，因此将在1.x版本重构TEEBB。
4141
42-
###3.TEEBB的使用介绍
42+
### 3.TEEBB的使用介绍
4343
TEEBB的主题是内容管理，但是现实中各种各样不同类型的内容太多了，为了满足各种不同的需求以及实现灵活的扩展性，原理上我借鉴了国外的两个著名开源项目Drupal和Godot。
4444
做个假设：
4545
> 在另一个平行时空，我不是程序员而是一个名不见经传的在线小报记者，每天都忙于收集各种新闻，并发表在新闻网站上。
@@ -76,7 +76,7 @@ TEEBB的主题是内容管理，但是现实中各种各样不同类型的内容
7676
- [3.7.2 菜单的显示](docs/3-7menu-system.md)
7777
[3.8 常用Twig函数及全局变量(将会有视频教程讲解，敬请期待)](docs/3-8twig-front-route.md)
7878

79-
###4.基于TEEBB的开发（将有免费视频教程，敬请期待）
79+
### 4.基于TEEBB的开发（将有免费视频教程，敬请期待）
8080
TEEBB的设计就是要高扩展性，因此我们可以在TEEBB上进行二次开发。TEEBB默认提供了内容bundle、分类bundle、评论bundle、用户bundle。
8181
如果有一天有个需求开发一个小型的在线商城。我们可以利用图像字段作为商品的图像信息，利用布尔值字段做为商品的上下架信息、全新或二手信息，利用小数字段为商品的价格信息等等。这样我们可以创建一个bundle作为SKU对象，再创建一个bundle做为商品对象并两者进行关联以实现商城功能。
8282
不止商城，其他类型的应用也完全可以在TEEBB上进行二次开发。
@@ -89,7 +89,7 @@ Wooooo！这就是我对TEEBB的设想，如果我们基于TEEBB的二次开发
8989
- 4.2.2 实现EntityType中的所有类
9090
> Tips: 此节内容较多，文字无法完全表述，将有免费的视频教程推出。基于TEEBB的开发将以视频教程的形式发布在www.teebb.com上，敬请期待。
9191
92-
###5.TEEBB的Roadmap
92+
### 5.TEEBB的Roadmap
9393
目前TEEBB发布了0.1.0版本，仍有不少功能急需完善，暂将一些未实现功能按优先级列下，暂不公布时间线，我把其他工作做完就会完善的，表着急啊：）。
9494
1. ckeditor编辑器的图像上传。
9595
2. 控制台Topbar及内容列表搜索过滤。
@@ -101,7 +101,7 @@ Wooooo！这就是我对TEEBB的设想，如果我们基于TEEBB的二次开发
101101
8. 控制台Topbar面包屑功能。
102102
9. bug修复。
103103

104-
###6.TEEBB开源协议
104+
### 6.TEEBB开源协议
105105
本软件遵循MIT协议。如果您能在页面上注明您的应用使用了TEEBB，本人将万分感谢。：）
106-
###7.写在最后
106+
### 7.写在最后
107107
本人可接Symfony开发的工作，正规公司资质，可开增值税发票，如有开发业务请与我联系。QQ/微信：443580003

‎docs/3-1conent-bundle.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
####3.1 内容bundle
1+
#### 3.1 内容bundle
22
内容bundle的主要功能是用于存储管理不同类型的内容。上文提到的新闻就由内容bundle存储管理。下文将完整实现一个新闻类型的创建及添加。
33

4-
#####3.1.1 创建第一个内容类型
4+
##### 3.1.1 创建第一个内容类型
55
Teebb已经内置了文章（article）和基本页面（page）两种内容类型，但是我们需要为我们的新闻创建新的类型，请看下图操作：
66
![alt 添加内容类型](teebb_images/create-content-type.png "添加内容类型")
77

‎docs/3-2field.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
####3.2 字段
1+
#### 3.2 字段
22

3-
#####3.2.1 TEEBB中的内置字段
3+
##### 3.2.1 TEEBB中的内置字段
44
TEEBB内置了多个字段，现将各字段用途作如下介绍：
55
常规类型：
66
- 链接：该字段会在创建内容时添加链接设置表单，在前台页面会生成对应超链接，可用于在内容中引用外部链接。
@@ -37,7 +37,7 @@ TEEBB内置了多个字段，现将各字段用途作如下介绍：
3737
下图我们首先设置好图像字段的标题并点击下方按钮进入字段设置页面：
3838
![alt 添加字段](teebb_images/add-image-field.png "添加字段")
3939

40-
#####3.2.2 TEEBB中常用字段的设置
40+
##### 3.2.2 TEEBB中常用字段的设置
4141
TEEBB中不同类型的字段有不同的设置，通用部分有：
4242
字段的标题：用于在添加内容表单或前台显示的字段标题。
4343
别名：用于获取字段的值或在URL中显示，此值必须唯一。

‎docs/3-3conent.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
####3.3 内容
1+
#### 3.3 内容
22

3-
#####3.3.1 添加内容
3+
##### 3.3.1 添加内容
44
我们的“新闻类型一“内容类型已经创建完成，现在我将发表我的第一篇新闻。
55
点击“内容”-> “添加内容”->“新闻类型一”:
66
![alt 添加内容](teebb_images/add-content.png "添加内容")
@@ -11,4 +11,4 @@ Bingo！您将会发现添加内容表单将各字段的表单都自动添加了
1111
1212
![alt 调整字段顺序](teebb_images/modify-field-index.png "调整字段顺序")
1313

14-
#####3.3.2 内容的查询（未实现，后续版本实现）
14+
##### 3.3.2 内容的查询（未实现，后续版本实现）

‎docs/3-4taxonomy-bundle.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
1-
####3.4 分类bundle
2-
分类bundle和内容bundle类似，不同的是分类bundle管理的是分类词汇（Term），不同的分类类型可以包含不同的字段。举例：常见的商城类APP分类中每个分类可能需要配一个小图片，我们可以创建分类类型，给分类类型添加图像字段以实现此效果。
1+
#### 3.4 分类bundle
2+
分类bundle和内容bundle类似，不同的是分类bundle管理的是分类词汇（Term），不同的分类类型可以包含不同的字段。
3+
举例：常见的商城类APP分类中每个分类可能需要配一个小图片，我们可以创建分类类型，给分类类型添加图像字段以实现此效果。
34

4-
#####3.4.1 创建分类类型
5+
##### 3.4.1 创建分类类型
56
和创建内容类型相似，点击：“添加分类”-> “保存”或 “保存并添加字段”。分类的别名将用于URL中也要全局唯一。
67

7-
#####3.4.2 分类类型中字段的设置
8+
##### 3.4.2 分类类型中字段的设置
89
分类的字段和内容类型中的字段设置操作一致。
910

10-
#####3.4.3 添加分类词汇
11+
##### 3.4.3 添加分类词汇
1112
当我们的内容类型中使用了“分类”字段，则需要首先在对应的分类类型下添加分类词汇。点击“管理分类”->选择对应的分类类型->“管理词汇”->“添加词汇”。如下图操作：
1213
![alt 管理分类](teebb_images/manage-taxonomy.png "管理分类")
1314

1415
![alt 添加分类词汇](teebb_images/add-term.png "添加分类词汇")
1516

16-
#####3.4.4 分类字段的使用
17+
##### 3.4.4 分类字段的使用
1718
在添加完几个词汇后，现在我们想给之前的“新闻分类一”添加一个分类引用。“内容”->“管理类型”->“管理字段”->“添加字段”->选择“分类”字段。如下图：
1819
![alt 添加分类字段](teebb_images/add-taxonomy-field.png "添加分类字段")
1920

‎docs/3-5comment-bundle.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
####3.5 评论bundle
1+
#### 3.5 评论bundle
22
评论bundle和内容bundle、分类bundle操作基本相同。
33

4-
#####3.5.1 创建评论类型
4+
##### 3.5.1 创建评论类型
55
TEEBB已经内置了“默认评论”类型。您也可以创建不同类型的评论。操作方法与创建内容类型相同。
66

7-
#####3.5.2 评论类型中字段的设置
7+
##### 3.5.2 评论类型中字段的设置
88
评论类型中字段的设置与前几节相同。
99

10-
#####3.5.3 评论字段的使用
10+
##### 3.5.3 评论字段的使用
1111
现在我们给“新闻类型一”的内容添加评论功能。和之前操作一样，给“新闻类型一”添加“评论”字段。“类型”->“管理类型”->“新闻类型一”->“管理字段”->“添加字段”->选择“评论”字段。
1212
> Tips：“评论”类型字段的显示顺序永远在内容页面最底部，多个“评论”字段则按字段顺序依次排列到页面底部。
1313
@@ -19,6 +19,6 @@ TEEBB已经内置了“默认评论”类型。您也可以创建不同类型的
1919

2020
> Tips: 评论功能只在前台页面显示。TEEBB默认只有已注册登录的用户可以发表评论，且评论内容经过审核后才可显示。
2121
22-
#####3.5.4 管理评论内容
22+
##### 3.5.4 管理评论内容
2323
“评论”->“管理评论类型”->“管理评论”。您可以在此页面对已提交的评论进行操作。
2424
![alt 管理评论](teebb_images/manage-submit-commtents.png "管理评论")

‎docs/3-6user-bundle-group.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
####3.6 用户与用户组
1+
#### 3.6 用户与用户组
22

3-
#####3.6.1 用户的概念
3+
##### 3.6.1 用户的概念
44
TEEBB中的用户（User）也用到了bundle，可以增加修改字段以实现用户信息的扩展性，但是用户只有默认一种类型。
55

6-
#####3.6.2 用户的字段设置（后续版本实现）
6+
##### 3.6.2 用户的字段设置（后续版本实现）
77

8-
#####3.6.3 用户组及权限
8+
##### 3.6.3 用户组及权限
99
在TEEBB中我们使用用户组也管理用户的权限，如果修改了用户所在的用户组，则用户的roles属性也会相应改变，此功能主是要为了方便的使用Symfony中的Security组件，对用户访问进行控制。
1010
![alt 管理用户组](teebb_images/user-group-role.png "管理用户组")
1111

‎docs/3-7menu-system.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
####3.7 菜单系统
1+
#### 3.7 菜单系统
22
菜单系统是我的最爱，虽然通常一个网站用到菜单不多，但我仍花了些心思在菜单上以使菜单能够更加灵活。菜单系统的设计参考了wordpress的菜单。
33
菜单功能的实现使用了KnpMenuBundle，这个bundle功能很全面，是做菜单系统的首选。
44

5-
#####3.7.1 创建第一个菜单
5+
##### 3.7.1 创建第一个菜单
66
点击“菜单”->“添加菜单”->输入菜单名、菜单别名、菜单描述->保存。和其他的别名一样，菜单别名也必须唯一，后期展示菜单时将用到菜单别名。
77
![alt 添加菜单](teebb_images/add-menu.png "添加菜单")
88

@@ -14,7 +14,7 @@
1414
3号标记：可以对菜单项链接名称进行调整。
1515
最后记得点击“保存菜单“按钮。这一步很关键。：）
1616

17-
#####3.7.2 菜单的显示
17+
##### 3.7.2 菜单的显示
1818
我们的菜单系统使用了KnpMenuBundle，我们使用KnpMenuBundle的Twig函数来显示菜单。
1919
```twig
2020
{#此处“demo“换成我们的菜单别名即可。#}

‎docs/3-8twig-front-route.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
####3.8 常用Twig函数及全局变量(将会有视频教程讲解，敬请期待)
1+
#### 3.8 常用Twig函数及全局变量(将会有视频教程讲解，敬请期待)
22
很可惜，TEEBB并没有设计模板系统。如果你经常用Twig，会发现使用Twig也能很快速的完成前端页面模板。
33
TEEBB中已经有了一些前台页面的Route路径，使用命令：
44
```

0 commit comments

Comments
 (0)