Update tips for configration registeration of flask-admin

greyli · greyli · commit 2af915bccdd5 · 2020-06-28T08:53:08.000+08:00
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -24,14 +24,18 @@ When using Flask-WTF/WTForms, you have to pass the field name as ``name`` in ``c
        {{ ckeditor.config(name='description') }}
    </body>
 
-When using Flask-Admin, the default form field name is ``text``, so normally you will use this:
+When using Flask-Admin, the name value will be the field name you overwritten with ``form_overrides = dict(the_field_name=CKEditorField)``.
+For example:
 
  .. code-block:: jinja
 
-   <body>
+    {% extends 'admin/model/edit.html' %}
+
+    {% block tail %}
+        {{ super() }}
        ...  <!-- {{ ckeditor.load() }} or <script src="/path/to/ckeditor.js"> -->
-       {{ ckeditor.config(name='text') }}
-   </body>
+       {{ ckeditor.config(name='the_field_name') }}
+    {% endblock %}
 
 If you create the CKEditor through ``ckeditor.create()``, the default value (``name='ckeditor'``) will be used.
 
diff --git a/examples/flask-admin-upload/templates/edit.html b/examples/flask-admin-upload/templates/edit.html
@@ -3,6 +3,6 @@
 {% block tail %}
     {{ super() }}
     {{ ckeditor.load() }}
-    {# the name value must be 'text' #}
+    {# The name value should be the name of the CKEditor form field, here is `text`. #}
     {{ ckeditor.config(name='text') }}
 {% endblock %}
diff --git a/examples/flask-admin/templates/edit.html b/examples/flask-admin/templates/edit.html
@@ -6,7 +6,7 @@
     {# 
     if you have set the configuration variables more than CKEDITOR_SERVE_LOCAL and CKEDITOR_PKG_TYPE, 
     or you need to config the CKEditor textarea, use the line below to register the configuration.
-    The name value should be the name of the CKEditor form field, it defaults to "text" in Flask-Admin.
+    The name value should be the name of the CKEditor form field.
     #}
     {{ ckeditor.config(name='text') }}
 {% endblock %}
