如何描述你的模块

Administrator

前情回顾

我们已经会创建模块了,并且很快速的就成功了。那么,我们肯定要写一个非常惊艳的模块....

首先,当我们点击应用菜单,进入应用看板视图,看到了什么?

除了模块的图标,还有一个名称和一个简短的介绍(我们称为模块的摘要)。是的,我们要在看板那个有限的地方向用户展示模块的功能特点。

图标:我们需要在模块的根目录下创建一个static目录,然后在static目录中创建一个description目录,将图标文件命名为icon.png,扔到description目录即可。

名称:模块根目录中__manifest__.py文件中的name属性值。

摘要:模块根目录中__manifest__.py文件中的summary属性值。

----------------------寂寞的分隔线-----------------------

我们想浏览一下模块,看看有什么能为我们所用的。突然,发现了一个问题:模块的名称和概述还是不足以向我们展示模块的功能,我们点击看板视图想进一步了解模块的功能,却发现有的模块的介绍图文混排的,瞬间感觉好高大上,而有的只是一段文字。

一段文字:我们可以通过模块根目录中__manifest__.py文件中的description属性值来详细介绍模块功能。注意:这里断行要空两行。

图文混排:我们可以在static/description目录中写一个index.html文件,系统会自动将文件的内容替换__manifest__.py文件中的description属性值,实现图文混排。至于具体操作,你可以找一个模块参考一下,例如crm模块。

注意:你贸然拷贝人家的index.html进行更改是很容易引起乱码的,文件要另存为utf-8编码才能为我们中国人所用。


留下评论

你应该 登入 张贴评论