Share
Embed
What the Wagtail Docs Don't Tell You
The importance of the Page model, saving Pages and Redirects programmatically, and doing more with the User model!
Lacey Williams Henschel
June 14, 2018
Transcript
67 slides
-
What the Wagtail Docs Don't Tell You Lacey Williams Henschel
Wagtail Space US 2018 ! @laceynwilliams | @revsys -
the docs are great ✓ upgrading ✓ ge*ng started ✓
end users @laceynwilliams | @revsys -
... but there are some possibili0es for sprint projects in
there too! @laceynwilliams | @revsys -
why do I care about the Page class? ✓ avoid
duplica+on ✓ helpful methods ✓ dealing with Pages programma+cally @laceynwilliams | @revsys -
class Page(AbstractPage): title = models.CharField() draft_title = models.CharField() slug =
models.SlugField() live = models.BooleanField() url_path = models.TextField() owner = models.ForeignKey(settings.AUTH_USER_MODEL) seo_title = models.CharField() show_in_menus = models.BooleanField() search_description = models.TextField() go_live_at = models.DateTimeField() expire_at = models.DateTimeField() expired = models.BooleanField() locked = models.BooleanField() first_published_at = models.DateTimeField() last_published_at = models.DateTimeField() latest_revision_created_at = models.DateTimeField() live_revision = models.ForeignKey() @laceynwilliams | @revsys -
class Page(AbstractPage): title = models.CharField() draft_title = models.CharField() slug =
models.SlugField() live = models.BooleanField() url_path = models.TextField() owner = models.ForeignKey(settings.AUTH_USER_MODEL) seo_title = models.CharField() show_in_menus = models.BooleanField() search_description = models.TextField() go_live_at = models.DateTimeField() expire_at = models.DateTimeField() expired = models.BooleanField() locked = models.BooleanField() first_published_at = models.DateTimeField() last_published_at = models.DateTimeField() latest_revision_created_at = models.DateTimeField() live_revision = models.ForeignKey() @laceynwilliams | @revsys -
class Page(AbstractPage): title = models.CharField() draft_title = models.CharField() slug =
models.SlugField() live = models.BooleanField() url_path = models.TextField() owner = models.ForeignKey(settings.AUTH_USER_MODEL) seo_title = models.CharField() show_in_menus = models.BooleanField() search_description = models.TextField() go_live_at = models.DateTimeField() expire_at = models.DateTimeField() expired = models.BooleanField() locked = models.BooleanField() first_published_at = models.DateTimeField() last_published_at = models.DateTimeField() latest_revision_created_at = models.DateTimeField() live_revision = models.ForeignKey() @laceynwilliams | @revsys -
class Page(AbstractPage): title = models.CharField() draft_title = models.CharField() slug =
models.SlugField() live = models.BooleanField() url_path = models.TextField() owner = models.ForeignKey(settings.AUTH_USER_MODEL) seo_title = models.CharField() show_in_menus = models.BooleanField() search_description = models.TextField() go_live_at = models.DateTimeField() expire_at = models.DateTimeField() expired = models.BooleanField() locked = models.BooleanField() first_published_at = models.DateTimeField() last_published_at = models.DateTimeField() latest_revision_created_at = models.DateTimeField() live_revision = models.ForeignKey() @laceynwilliams | @revsys -
class Page(AbstractPage): """ Wildly truncated """ def save_revision(self, user=None, submitted_for_moderation=False,
approved_go_live_at=None, changed=True): ... revision = self.revisions.create( content_json=self.to_json(), user=user, submitted_for_moderation=submitted_for_moderation, approved_go_live_at=approved_go_live_at, ) ... return revision @laceynwilliams | @revsys -
sprint ideas 1. Expand on "Page Models" in Usage Guide?
@laceynwilliams | @revsys -
...but it's right there in the docs ✓ Docs were
a li,le too light for me ✓ This rela3onship is important @laceynwilliams | @revsys -
from wagtail.core.models import Page class PostIndexPage(Page): # some attributes... parent_page_types
= ['homepage.Homepage'] subpage_types = ['posts.PostPage'] class PostPage(Page): # some attributes... parent_page_types = ['posts.PostIndexPage'] @laceynwilliams | @revsys -
parent_page_types What pages can create this kind of page? Who
can your parents be? @laceynwilliams | @revsys -
subpage_types What pages can this page create? Who can your
children be? @laceynwilliams | @revsys -
from wagtail.core.models import Page class PostIndexPage(Page): # some attributes... parent_page_types
= ['homepage.Homepage'] subpage_types = ['posts.PostPage'] class PostPage(Page): # some attributes... parent_page_types = ['posts.PostIndexPage'] @laceynwilliams | @revsys -
from wagtail.core.models import Page class PostIndexPage(Page): # some attributes... parent_page_types
= ['homepage.Homepage'] subpage_types = ['posts.PostPage'] class PostPage(Page): # some attributes... parent_page_types = ['posts.PostIndexPage'] @laceynwilliams | @revsys -
from wagtail.core.models import Page class PostIndexPage(Page): # some attributes... parent_page_types
= ['homepage.Homepage'] subpage_types = ['posts.PostPage'] class PostPage(Page): # some attributes... parent_page_types = ['posts.PostIndexPage'] @laceynwilliams | @revsys -
from wagtail.core.models import Page class PostIndexPage(Page): # some attributes... parent_page_types
= ['homepage.Homepage'] subpage_types = ['posts.PostPage'] class PostPage(Page): # some attributes... parent_page_types = ['posts.PostIndexPage'] @laceynwilliams | @revsys -
If you want to limit a page to have only
one type of child and limit its child to have only one type of parent you have to tell both models. @laceynwilliams | @revsys -
sprint ideas 1. Expand on "Page Models" in Usage Guide?
2. Add example to "Parent page / subpage type rules"? @laceynwilliams | @revsys -
why do I care about saving pages? ✓ content migra,ons
✓ backda,ng ✓ making changes to pages outside the UI @laceynwilliams | @revsys -
assumptions ✓ Model PostPage ✓ Index page PostIndexPage ✓ All
data is valid @laceynwilliams | @revsys -
from .models import PostPage, PostIndexPage def create_new_post(fields): post = PostPage()
post.title = fields['title'] post.latest_revision_created_at = fields['latest_revision_created_at'] post.first_published_at = fields['first_published_at'] # rest of fields post_index = PostIndexPage.objects.get(slug='posts') post_index.add_child(instance=post) revision = post.save_revision(submitted_for_moderation=False) post.save() if post.live: revision.publish() return post @laceynwilliams | @revsys -
from .models import PostPage, PostIndexPage def create_new_post(fields): post = PostPage()
post.title = fields['title'] post.latest_revision_created_at = fields['latest_revision_created_at'] post.first_published_at = fields['first_published_at'] # rest of fields post_index = PostIndexPage.objects.get(slug='posts') post_index.add_child(instance=post) revision = post.save_revision(submitted_for_moderation=False) post.save() if post.live: revision.publish() return post @laceynwilliams | @revsys -
from .models import PostPage, PostIndexPage def create_new_post(fields): post = PostPage()
post.title = fields['title'] post.latest_revision_created_at = fields['latest_revision_created_at'] post.first_published_at = fields['first_published_at'] # rest of fields post_index = PostIndexPage.objects.get(slug='posts') post_index.add_child(instance=post) revision = post.save_revision(submitted_for_moderation=False) post.save() if post.live: revision.publish() return post @laceynwilliams | @revsys -
from .models import PostPage, PostIndexPage def create_new_post(fields): post = PostPage()
post.title = fields['title'] post.latest_revision_created_at = fields['latest_revision_created_at'] post.first_published_at = fields['first_published_at'] # rest of fields post_index = PostIndexPage.objects.get(slug='posts') post_index.add_child(instance=post) revision = post.save_revision(submitted_for_moderation=False) post.save() if post.live: revision.publish() return post @laceynwilliams | @revsys -
from .models import PostPage, PostIndexPage def create_new_post(fields): post = PostPage()
post.title = fields['title'] post.latest_revision_created_at = fields['latest_revision_created_at'] post.first_published_at = fields['first_published_at'] # rest of fields post_index = PostIndexPage.objects.get(slug='posts') post_index.add_child(instance=post) revision = post.save_revision(submitted_for_moderation=False) post.save() if post.live: revision.publish() return post @laceynwilliams | @revsys -
from .models import PostPage, PostIndexPage def create_new_post(fields): post = PostPage()
post.title = fields['title'] post.latest_revision_created_at = fields['latest_revision_created_at'] post.first_published_at = fields['first_published_at'] # rest of fields post_index = PostIndexPage.objects.get(slug='posts') post_index.add_child(instance=post) revision = post.save_revision(submitted_for_moderation=False) post.save() if post.live: revision.publish() return post @laceynwilliams | @revsys -
sprint ideas 1. Expand on "Page Models" in Usage Guide?
2. Add example to "Parent page / subpage type rules"? 3. Method to add a new page instance? Or more docs? @laceynwilliams | @revsys -
why do I care about redirects? ✓ avoiding 404s in
content migra1ons ✓ needing to add a lot of redirects @laceynwilliams | @revsys -
assumptions ✓ No custom Redirect class ✓ One site ✓
Redirects are permanent ✓ URL definitely 404s ✓ Redirec9ng to a Page instance @laceynwilliams | @revsys -
from wagtail.contrib.redirects.models import Redirect def add_redirect(old_url, post_page): redirect = Redirect()
redirect.old_path = old_url.rstrip('/') redirect.is_permanent = True redirect.redirect_page = post_page redirect.save() return redirect @laceynwilliams | @revsys -
from wagtail.contrib.redirects.models import Redirect def add_redirect(old_url, post_page): redirect = Redirect()
redirect.old_path = old_url.rstrip('/') redirect.is_permanent = True redirect.redirect_page = post_page redirect.save() return redirect @laceynwilliams | @revsys -
from wagtail.contrib.redirects.models import Redirect def add_redirect(old_url, post_page): redirect = Redirect()
redirect.old_path = old_url.rstrip('/') redirect.is_permanent = True redirect.redirect_page = post_page redirect.save() return redirect @laceynwilliams | @revsys -
from wagtail.contrib.redirects.models import Redirect def add_redirect(old_url, post_page): redirect = Redirect()
redirect.old_path = old_url.rstrip('/') redirect.is_permanent = True redirect.redirect_page = post_page redirect.save() return redirect @laceynwilliams | @revsys -
from wagtail.contrib.redirects.models import Redirect def add_redirect(old_url, post_page): redirect = Redirect()
redirect.old_path = old_url.rstrip('/') redirect.is_permanent = True redirect.redirect_page = post_page redirect.save() return redirect @laceynwilliams | @revsys -
from wagtail.contrib.redirects.models import Redirect def add_redirect(old_url, post_page): redirect = Redirect()
redirect.old_path = old_url.rstrip('/') redirect.is_permanent = True redirect.redirect_page = post_page redirect.save() return redirect @laceynwilliams | @revsys -
sprint ideas 1. Expand on "Page Models" in Usage Guide?
2. Add example to "Parent page / subpage type rules"? 3. Method to add a new page instance? Or more docs? 4. Method to add redirect programmatically? @laceynwilliams | @revsys -
why do I care about the User model? ✓ People
✓ Easy access in admin @laceynwilliams | @revsys -
# team/models.py from django.contrib.auth import get_user_model from wagtail.core.models import Page
User = get_user_model() class TeamMemberPage(Page): ... user = models.ForeignKey(User) @laceynwilliams | @revsys -
# team/models.py from django.contrib.auth import get_user_model from wagtail.core.models import Page
User = get_user_model() class TeamMemberPage(Page): ... user = models.ForeignKey(User) @laceynwilliams | @revsys -
# team/models.py from django.contrib.auth import get_user_model from wagtail.core.models import Page
User = get_user_model() class TeamMemberPage(Page): ... user = models.ForeignKey(User) @laceynwilliams | @revsys -
So then just ForeignKey directly to TeamMemberPage from PostPage ,
right? @laceynwilliams | @revsys -
# posts/models.py from django.contrib.auth import get_user_model from wagtail.core.models import Page
User = get_user_model() class PostPage(Page): author = models.ForeignKey(User) # or author = models.ForeignKey('team.TeamMemberPage') @laceynwilliams | @revsys -
# posts/models.py from wagtail.admin.edit_handlers import PageChooserPanel from wagtail.core.models import Page
class PostPage(Page): author = models.ForeignKey('wagtailcore.Page') content_panels = Page.content_panels + [ PageChooserPanel('author', ['team.TeamMemberPage']), ] @laceynwilliams | @revsys -
# posts/models.py from wagtail.admin.edit_handlers import PageChooserPanel from wagtail.core.models import Page
class PostPage(Page): author = models.ForeignKey('wagtailcore.Page') content_panels = Page.content_panels + [ PageChooserPanel('author', ['team.TeamMemberPage']), ] @laceynwilliams | @revsys -
# posts/models.py from wagtail.admin.edit_handlers import PageChooserPanel from wagtail.core.models import Page
class PostPage(Page): author = models.ForeignKey('wagtailcore.Page') content_panels = Page.content_panels + [ PageChooserPanel('author', ['team.TeamMemberPage']), ] @laceynwilliams | @revsys -
sprint ideas 1. Expand on "Page Models" in Usage Guide?
2. Add example to "Parent page / subpage type rules"? 3. Method to add a new page instance? Or more docs? 4. Method to add redirect programmatically? 5. Expand on User model docs? @laceynwilliams | @revsys -
Look again at those docs. That's here. That's home. That's
us. — Carl Sagan, probably @laceynwilliams | Source: Ma4eo Fusco via Unsplash