[Django] #31511: Allow stopwords in slugs generated by ModelAdmin.prepopulated_fields
Django
-------------------------------------+-------------------------------------
Reporter: Andy | Owner: Scott Cranfill
Chosak |
Type: | Status: assigned
Cleanup/optimization |
Component: | Version: master
contrib.admin | Keywords: urlify, slugify,
Severity: Normal | slug
Triage Stage: | Has patch: 1
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 1 |
-------------------------------------+-------------------------------------
Automatic slug generation in ModelAdmin via
[https://docs.djangoproject.com/en/3.0/ref/contrib/admin/#django.contrib.admin.ModelAdmin.prepopulated_fields
prepopulated_fields] uses a
[https://github.com/django/django/blob/b2bd08bb7a912a1504f5fb5018f5317e6b5423cd/django/contrib/admin/static/admin/js/urlify.js
urlify.js] file which, among other behaviors,
[https://github.com/django/django/blob/b2bd08bb7a912a1504f5fb5018f5317e6b5423cd/django/contrib/admin/static/admin/js/urlify.js#L168-L176
removes certain stop words from the slug]. For example, a string like "To
be or not to be, that is the question" will generate a slug "be-or-not-be-
question", not "to-be-or-not-to-be-that-is-the-question" as one might
expect.
For reference, the current list is: a, an, as, at, before, but, by, for,
from, is, in, into, like, of, off, on, onto, per, since, than, the, this,
that, to, up, via, with.
The current list of stopwords being removed seems to have been the same
since at least 2005 (the earliest code I can find including this logic).
Some of these words feel a little unexpected, for example “before” and
“since”. It seems likely that stop word removal was introduced for SEO
purposes, but this no longer seems to be a modern best practice. I propose
removing this behavior so that these words are no longer stripped from
slugs generated via prepopulated_fields.
I posted this proposal to https://groups.google.com/forum/#!topic/django-
developers/9ayU7fTuuAM and received one supportive reply from Adam
Johnson. @Scotchester and I have collaborated on a patch.
(#30538 mentions this behavior as part of a more general comparison
between urlify.js and Python slugify. It was closed as wontfix due to
reasons of backwards compatibility. This ticket specifically addresses
stopword removal in the JS code only, not any other differences in
behavior between these two methods.)
--
Ticket URL: <https://code.djangoproject.com/ticket/31511>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
-------------------------------------+-------------------------------------
Type: | Status: new
Cleanup/optimization |
Component: contrib.admin | Version: master
Severity: Normal | Resolution:
Keywords: urlify, slugify, | Triage Stage:
slug | Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------
* owner: Scott Cranfill => (none)
* status: assigned => new
Comment:
Patch is available for review at:
https://github.com/django/django/pull/12785
--
Ticket URL: <https://code.djangoproject.com/ticket/31511#comment:1>
Django
-------------------------------------+-------------------------------------
Cleanup/optimization |
Component: contrib.admin | Version: master
Keywords: urlify, slugify, | Triage Stage:
slug | Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------
* status: new => closed
* resolution: => duplicate
Comment:
IMO it's a duplicate of #11157. Changing this behavior would be backward
incompatible, and similar issues were closed as wontfix multiple times in
the past. I'm not sure if one supportive comment is enough to reopen
#11157, we should reach a strong consensus and on the mailing list.
--
Ticket URL: <https://code.djangoproject.com/ticket/31511#comment:2>
Django
-------------------------------------+-------------------------------------
Type: | Status: closed
Cleanup/optimization |
Component: contrib.admin | Version: master
Severity: Normal | Resolution: duplicate
Keywords: urlify, slugify, | Triage Stage:
slug | Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------
Comment (by Scott Cranfill):
Hi Mariusz,
Thanks for your feedback. Andy and I weren't sure how long to wait for
more feedback on the mailing list discussion we opened, so we thought
starting the ticket and offering a patch might move things along. Happy to
take the discussion back there, but I will respond to your comment here,
since you haven't commented there yet.
We respectfully disagree that this is a duplicate of #11157. That ticket
was more general, addressing the question of whether `slugify` and
`URLify` should behave the same. The issue we are raising is about
changing a specific behavior that exists only in `URLify`, independent of
anything to do with `slugify`.
Looking forward to further discussion!
--
Ticket URL: <https://code.djangoproject.com/ticket/31511#comment:3>
Django
-------------------------------------+-------------------------------------
Type: | Status: closed
Cleanup/optimization |
Component: contrib.admin | Version: master
Severity: Normal | Resolution: duplicate
Keywords: urlify, slugify, | Triage Stage:
slug | Unreviewed
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 1
-------------------------------------+-------------------------------------
Comment (by felixxm):
Scott, we have multiple tickets about `slugify` and `URLify` that we can
basically split them into two categories, language specific behavior and
inconsistency. #11157 is about inconsistency with stopwords, your propose
is to not strip stopwords which will make their behavior consistent. IMO
we can treat this as a duplicate.
--
Ticket URL: <https://code.djangoproject.com/ticket/31511#comment:4>