NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-17 04:32:51 -06:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity

12685 use markdown for custom fields added to form (#13828)

Browse Source 
* 12685 use markdown for custom fields added to form

* 13809 change markdown to use utilities

* Add help_text for CustomField description indicating Markdown support

---------

Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>
This commit is contained in:
Arthur Hanson 2023-09-20 11:06:04 -07:00 committed by GitHub
parent 7a410dfd00
commit 6e4b4a553b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
netbox/extras/forms/model_forms.py
View File

@ -76,7 +76,8 @@ class CustomFieldForm(BootstrapMixin, forms.ModelForm):
'type': _( 'type': _(
"The type of data stored in this field. For object/multi-object fields, select the related object " "The type of data stored in this field. For object/multi-object fields, select the related object "
"type below." "type below."
) ),
'description': _("This will be displayed as help text for the form field. Markdown is supported.")
} }
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):

3
netbox/extras/models/customfields.py
View File

@ -28,6 +28,7 @@ from utilities.forms.fields import (
from utilities.forms.utils import add_blank_choice from utilities.forms.utils import add_blank_choice
from utilities.forms.widgets import APISelect, APISelectMultiple, DatePicker, DateTimePicker from utilities.forms.widgets import APISelect, APISelectMultiple, DatePicker, DateTimePicker
from utilities.querysets import RestrictedQuerySet from utilities.querysets import RestrictedQuerySet
from utilities.templatetags.builtins.filters import render_markdown
from utilities.validators import validate_regex from utilities.validators import validate_regex
__all__ = ( __all__ = (
@ -498,7 +499,7 @@ class CustomField(CloningMixin, ExportTemplatesMixin, ChangeLoggedModel):
field.model = self field.model = self
field.label = str(self) field.label = str(self)
if self.description: if self.description:
field.help_text = escape(self.description) field.help_text = render_markdown(self.description)
# Annotate read-only fields # Annotate read-only fields
if enforce_visibility and self.ui_visibility == CustomFieldVisibilityChoices.VISIBILITY_READ_ONLY: if enforce_visibility and self.ui_visibility == CustomFieldVisibilityChoices.VISIBILITY_READ_ONLY: