Merge branch 'master' of github.com:sshwsfc/django-xadmin

sshwsfc · sshwsfc · commit 12a21b1ada7d · 2013-04-12T15:07:37.000+08:00
diff --git a/xadmin/plugins/refresh.py b/xadmin/plugins/refresh.py
@@ -1,5 +1,31 @@
+# coding=utf-8
+"""
+数据刷新
+========
 
+功能
+----
 
+该插件在数据列表页面提供了数据导出功能, 可以导出 Excel, CSV, XML, json 格式.
+
+截图
+----
+
+.. image:: /images/plugins/export.png
+
+使用
+----
+
+.. note:: 如果想要导出 Excel 数据, 需要安装 `xlwt <http://pypi.python.org/pypi/xlwt>`_.
+
+默认情况下, xadmin 会提供 Excel, CSV, XML, json 四种格式的数据导出. 您可以通过设置 OptionClass 的 ``list_export`` 属性来指定使用
+哪些导出格式 (四种各使用分别用 ``xls``, ``csv``, ``xml``, ``json`` 表示), 或是将 ``list_export`` 设置为 ``None`` 来禁用数据导出功能. 示例如下::
+
+    class MyModelAdmin(object):
+
+        list_export = ('xls', xml', 'json')
+
+"""
 from django.template import loader
 
 from xadmin.sites import site
