使用admin中的readonly_fields在TextField中保留格式文本

时间:2013-02-04 00:06:30

标签: django django-admin django-models

我有一个TextField,文本来自admin中的txt文件。我的txt有换行符。问题是当TextField位于readonly_fields时,所有换行符都会消失,所有内容都会被分组。 如何在readonly_fields模式下使用此字段保留格式? 不在readonly_fields时不会发生这个问题。 谢谢!

3 个答案:

答案 0 :(得分:3)

我还在使用django 1.3,最后想出了一个解决方案。所以万一其他人还在这艘船上:

覆盖模板fieldset.html(从pythondir / djangodir / django / contrib / admin / templates / admin / includes / fieldset.html复制到djangoprojectdir / templates / admin / includes / fieldset.html)

它包含以下行:

                        {% if field.is_readonly %}
                            <p>{{ field.contents }}</p>

将它们更改为:

                        {% if field.is_readonly %}
                            <p>{{ field.contents|linebreaksbr }}</p>

这是在尝试Danny的解决方案结束后发现它不起作用,因为从内容函数返回的文本被转义为用转义码替换标签(“&lt;”表示“&lt;”等),然后阅读这个:https://code.djangoproject.com/ticket/19226

答案 1 :(得分:2)

当您查看页面来源时,您会看到换行符。该空白在浏览器中显示为单个空格。您需要将所有换行符(\n)转换为HTML换行符(<br />),以使其看起来像您想要的那样。

选项1:jQuery救援。

这样的事情:

    <script type="text/javascript">
      (function($) {

        $(document).ready(function() {
       // Adjustments for read-only fields:
       // a) Convert quoted HTML entities back to HTML
            $('.readonly').each(function() {
                // Ensure there isn't valid html in the field
                // The RegEx checks for any valid html opening tag
                {% comment %}
                TODO: It would be better to check against a special class name
                on the widget
                {% endcomment %}
                if ($(this).html().match(/<(\w+)((?:\s+\w+(?:\s*=\s*(?:(?:"[^"]*")|(?:'[^']*')|[^>\s]+))?)*)\s*(\/?)>/) == null) {
                  $(this).html($(this).text());
                  $('ul', this).addClass('with_bullet');
                  $('li', this).addClass('with_bullet');
                }
            });

            // b) Insert &nbsp; into empty <p>'s (m2m fields) so they don't break layout
            // (see comment on text nodes: http://api.jquery.com/empty-selector/)
            $('p.readonly:empty').each(function() { $(this).html('&nbsp;') })
        });
      })(django.jQuery);
    </script>

(注意:我们添加了“with_bullet”类因为我们正在使用grappelli而且ul和li的样式没有子弹(list-style-type:none)所以这是一种让它们重新出现的方式自己的CSS ...) 另请注意最后的布局修复,我认为在grappelli的更高版本中不需要。

选项2:monkeypatch django.contrib.admin.helpers.AdminReadonlyField:

from django.contrib.admin import helpers
from django.contrib.admin.util import (lookup_field,
    display_for_field, label_for_field, help_text_for_field)
from django.core.exceptions import ObjectDoesNotExist
from django.db.models.fields.related import ManyToManyRel
from django.forms.util import flatatt
from django.template.defaultfilters import capfirst
from django.utils.encoding import force_unicode, smart_unicode
from django.utils.html import escape, conditional_escape
from django.utils.safestring import mark_safe


class BetterAdminReadonlyField(object):
    def __init__(self, form, field, is_first, model_admin=None):
        label = label_for_field(field, form._meta.model, model_admin)
        # Make self.field look a little bit like a field. This means that
        # {{ field.name }} must be a useful class name to identify the field.
        # For convenience, store other field-related data here too.
        if callable(field):
            class_name = field.__name__ != '<lambda>' and field.__name__ or ''
        else:
            class_name = field
        self.field = {
            'name': class_name,
            'label': label,
            'field': field,
            'help_text': help_text_for_field(class_name, form._meta.model)
        }
        self.form = form
        self.model_admin = model_admin
        self.is_first = is_first
        self.is_checkbox = False
        self.is_readonly = True

    def label_tag(self):
        attrs = {}
        if not self.is_first:
            attrs["class"] = "inline"
        label = self.field['label']
        contents = capfirst(force_unicode(escape(label))) + u":"
        return mark_safe('<label%(attrs)s>%(contents)s</label>' % {
            "attrs": flatatt(attrs),
            "contents": contents,
        })

    def contents(self):
        from django.contrib.admin.templatetags.admin_list import _boolean_icon
        from django.contrib.admin.views.main import EMPTY_CHANGELIST_VALUE
        field, obj, model_admin = self.field['field'], self.form.instance, self.model_admin
        try:
            f, attr, value = lookup_field(field, obj, model_admin)
        except (AttributeError, ValueError, ObjectDoesNotExist):
            result_repr = EMPTY_CHANGELIST_VALUE
        else:
            if f is None:
                boolean = getattr(attr, "boolean", False)
                if boolean:
                    result_repr = _boolean_icon(value)
                else:
                    result_repr = smart_unicode(value)
                    if getattr(attr, "allow_tags", False):
                        result_repr = mark_safe(result_repr)
            else:
                if value is None:
                    result_repr = EMPTY_CHANGELIST_VALUE
                elif isinstance(f.rel, ManyToManyRel):
                    result_repr = ", ".join(map(unicode, value.all()))
                else:
                    result_repr = display_for_field(value, f)
        return conditional_escape(result_repr)

helpers.AdminReadonlyField = BetterAdminReadonlyField

您可以将其放在“monkeypatches”文件夹中,并将其命名为“admin_readonly_field.py”(不要忘记添加空__init__.py以使该文件夹成为模块)。 然后在您的应用__init__.py添加

from monkeypatches import admin_readonly_field

你离开了。

上面的代码只包含monkeypatch AdminReadonlyField的相关导入和代码(在本例中是从Django 1.3复制的)。目前还没有从原来的课程中改变。改变你认为在你的情况下最有用的任何东西。

在您的特定情况下,您可以将这两行添加到倒数第二行:

        result_repr = display_for_field(value, f)

        if isinstance(field, models.TextField):
            result_repr = result_repr.replace('\n', '<br />')

(和from django.db import models位于顶部)

对不起,但Django附带的课程非常糟糕,选项2是我推荐的做法。您的TextField不是唯一一种在只读模式下看起来很糟糕的字段...

答案 2 :(得分:1)

文字中的换行符通常由字符\n\r或经常\r\n表示(有关详细信息,请查看此article on wikipedia)。

您遇到的问题是这些字符将用于在文本编辑字段中显示新行,但它们不代表html中的新行(它们被忽略)。

如果您希望它们显示在只读字段中,则可以使用<br/>元素替换它们。

如果您可以将字符串标记为safe(即,如果您可以安全地添加HTML代码而不会有任何人使用该字段添加恶意代码的风险),那么您可以覆盖模型上的save方法以进行交换输出html换行符的文本换行符 -

from django.utils.safestring import mark_safe

def save(self, *args, **kwargs):
    self.text_field = mark_safe(self.text_field.replace("\n", "<br/>"))
    super(YourModel, self).save(*args, **kwargs)

另一种方法是使用django-tinymce等插件添加全文格式功能。

我的最后一个建议是用javascript破解它。将管理文件夹添加到模板中,然后创建一个base_site.html文件,该文件扩展原始文件并添加一个简单的javascript函数(如here所述)。像 -

这样的东西
{% extends "admin/base.html" %}

{% block extrahead %}
    <script type="text/javascript">
        window.onload = function () {
            var p_elements = document.getElementById('content-main').getElementsByTagName('p');
            var unixNewLine = new RegExp("\n", "g");
            for (var i = p_elements.length - 1; i >= 0; i--) {
                p_elements[i].innerHTML = p_elements[i].innerHTML.replace(unixNewLine, '<br/>');
            }
        }
    </script>
{% endblock %}

您需要为文字中的每种新行添加replace(例如\r\r\n)。虽然这可能会做你需要的,但它似乎是最脏的黑客。