Briq
/
django-admin-sortable-fixwin
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor updates to documentation.

master
Brandon Taylor 2015-12-27 12:17:21 -05:00
parent 8c30ef88e8
commit aa685a6c8f
2 changed files with 8 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -59,7 +59,7 @@ Inlines may be drag-and-dropped into any order directly from the change form.
## Usage ## Usage
### Models ### Models
To add sortability to a model, you need to inherit `SortableMixin` and at minimum, define: To add "sortability" to a model, you need to inherit `SortableMixin` and at minimum, define:
- The field which should be used for `Meta.ordering`, which must resolve to one of the integer fields defined in Django's ORM: - The field which should be used for `Meta.ordering`, which must resolve to one of the integer fields defined in Django's ORM:
- `PositiveIntegerField` - `PositiveIntegerField`
@ -106,7 +106,6 @@ A common use case is to have child objects that are sortable relative to a paren
# ordering field # ordering field
category_order = models.PositiveIntegerField(default=0, editable=False, db_index=True) category_order = models.PositiveIntegerField(default=0, editable=False, db_index=True)
order_field_name = 'category_order'
class Project(SortableMixin): class Project(SortableMixin):
class Meta: class Meta:
@ -117,7 +116,6 @@ A common use case is to have child objects that are sortable relative to a paren
# ordering field # ordering field
project_order = models.PositiveIntegerField(default=0, editable=False, db_index=True) project_order = models.PositiveIntegerField(default=0, editable=False, db_index=True)
order_field_name = 'project_order'
def __unicode__(self): def __unicode__(self):
return self.title return self.title
@ -152,7 +150,6 @@ Sometimes you might have a parent model that is not sortable, but has child mode
# ordering field # ordering field
project_order = models.PositiveIntegerField(default=0, editable=False, db_index=True) project_order = models.PositiveIntegerField(default=0, editable=False, db_index=True)
order_field_name = 'project_order'
def __unicode__(self): def __unicode__(self):
return self.title return self.title
@ -429,15 +426,13 @@ the extrahead block with:
<link rel="stylesheet" type="text/css" href="{% static 'adminsortable/css/admin.sortable.inline.css' %}" /> <link rel="stylesheet" type="text/css" href="{% static 'adminsortable/css/admin.sortable.inline.css' %}" />
{% endblock extrahead %} {% endblock extrahead %}
Sorting within Django-CMS is really only feasible for inline models of a Sorting within Django-CMS is really only feasible for inline models of a plugin as Django-CMS already includes sorting for plugin instances. For tabular inlines, just substitute:
plugin as Django-CMS already includes sorting for plugin instances. For tabular inlines,
just substitute:
<script type="text/javascript" src="{% static 'adminsortable/js/admin.sortable.stacked.inlines.js' %}"></script> <script src="{% static 'adminsortable/js/admin.sortable.stacked.inlines.js' %}"></script>
with: with:
<script type="text/javascript" src="{% static 'adminsortable/js/admin.sortable.tabular.inlines.js' %}"></script> <script src="{% static 'adminsortable/js/admin.sortable.tabular.inlines.js' %}"></script>
### Rationale ### Rationale

11
README.rst
View File

@ -75,8 +75,8 @@ Usage
Models Models
~~~~~~ ~~~~~~
To add sortability to a model, you need to inherit ``SortableMixin`` and To add "sortability" to a model, you need to inherit ``SortableMixin``
at minimum, define: and at minimum, define:
- The field which should be used for ``Meta.ordering``, which must - The field which should be used for ``Meta.ordering``, which must
resolve to one of the integer fields defined in Django's ORM: resolve to one of the integer fields defined in Django's ORM:
@ -134,7 +134,6 @@ set up your models and admin options:
# ordering field # ordering field
category_order = models.PositiveIntegerField(default=0, editable=False, db_index=True) category_order = models.PositiveIntegerField(default=0, editable=False, db_index=True)
order_field_name = 'category_order'
class Project(SortableMixin): class Project(SortableMixin):
class Meta: class Meta:
@ -145,7 +144,6 @@ set up your models and admin options:
# ordering field # ordering field
project_order = models.PositiveIntegerField(default=0, editable=False, db_index=True) project_order = models.PositiveIntegerField(default=0, editable=False, db_index=True)
order_field_name = 'project_order'
def __unicode__(self): def __unicode__(self):
return self.title return self.title
@ -183,7 +181,6 @@ as such:
# ordering field # ordering field
project_order = models.PositiveIntegerField(default=0, editable=False, db_index=True) project_order = models.PositiveIntegerField(default=0, editable=False, db_index=True)
order_field_name = 'project_order'
def __unicode__(self): def __unicode__(self):
return self.title return self.title
@ -565,13 +562,13 @@ tabular inlines, just substitute:
:: ::
<script type="text/javascript" src="{% static 'adminsortable/js/admin.sortable.stacked.inlines.js' %}"></script> <script src="{% static 'adminsortable/js/admin.sortable.stacked.inlines.js' %}"></script>
with: with:
:: ::
<script type="text/javascript" src="{% static 'adminsortable/js/admin.sortable.tabular.inlines.js' %}"></script> <script src="{% static 'adminsortable/js/admin.sortable.tabular.inlines.js' %}"></script>
Rationale Rationale
~~~~~~~~~ ~~~~~~~~~