Отображение строки документации модели в приложении администратора

Question

В администраторе Django для указания указывается атрибут help_text для отдельных полей. Тем не менее, я хотел бы включить аналогичную функцию для целых моделей.

В коде я использую строки документации для хранения общих инструкций о моделях, и было бы очень полезно, если бы я мог отобразить их в админке Django. Идеальный способ - использовать первую строку строки документации модели на страницах индекса и все содержимое на страницах списка и формы.

Существуют ли какие-либо модули / фрагменты, решающие это, или я должен просто написать свой собственный? ;).

Answer 1

Не "идеальный способ", который вы описали, но есть django.contrib.admindocs

Для «идеального способа» вы можете создать небольшой шаблонный фильтр, который возвращает строку документации модели, и использовать ее в своих перегрузках или admin / change_form.html и admin / change_list.html.

Поправьте меня, если я ошибаюсь, но строки документации не идеальное место для содержимого, которое следует локализовать.

Если у вас достаточно короткого текста для локализации модели, например, одно или два предложения, вот несколько соображений:

• Небольшое количество текста может храниться в переменной Python.
• Переменная Python может быть передана с помощью django.utils.translation.ugettext.
• Класс может содержать переменную Python.

Так что я бы попробовал что-то вроде:

from django.utils.translation import ugettext as _

class Foo(models.Model):
    help_text = _(u'Documentation of Foo model to localize')