Cavemanon/cavemanon-wagtail-personalisation
Archived
8
Fork 0
Code Issues Pull Requests Activity

fixes a few code style issues and docs issues

Browse Source
This commit is contained in:
blurrah
2017-05-31 13:07:55 +02:00
parent 23537ac29b
commit d3d4e7ec92
3 changed files with 8 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/usage_guide.rst
View File

@@ -75,18 +75,18 @@ Method 2: Create a StreamField block
Method 3: Create a template block Method 3: Create a template block
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can add a template block that only shows it's contents to users of a You can add a template block that only shows its contents to users of a
specific segment. This is done using the "segment" block. specific segment. This is done using the "segment" block.
When editing templates make sure to add the `wagtail_personalisation_tags` When editing templates make sure to load the ``wagtail_personalisation_tags``
tag to the template:: tags library in the template::
{% load wagtail_personalisation_tags %} {% load wagtail_personalisation_tags %}
After that you can add a template block with the name of the segment you want After that you can add a template block with the name of the segment you want
the content to show up for:: the content to show up for::
{% segment name="My Segment"} {% segment name="My Segment" %}
<p>Only users within "My Segment" see this!</p> <p>Only users within "My Segment" see this!</p>
{% endsegment %} {% endsegment %}

10
src/wagtail_personalisation/templatetags/wagtail_personalisation_tags.py
View File

@@ -10,9 +10,7 @@ register = template.Library()
def do_segment(parser, token): def do_segment(parser, token):
"""Block that only shows content if user is in chosen segment. """Block that only shows content if user is in chosen segment."""
"""
# Parse the tag # Parse the tag
tag_name, _, kwargs = parse_tag(token, parser) tag_name, _, kwargs = parse_tag(token, parser)
@@ -33,9 +31,9 @@ register.tag('segment', do_segment)
class SegmentNode(template.Node): class SegmentNode(template.Node):
"""Node that only returns contents if user is in the segment. """Node that only returns contents if user is in the segment.
This node checks if the chosen segment exists and if the This node checks if the chosen segment exists and if the
user has been segmented in the chosen segment. user has been segmented in the chosen segment.
If not it will return nothing If not it will return nothing
""" """
def __init__(self, nodelist, name): def __init__(self, nodelist, name):

1
src/wagtail_personalisation/utils.py
View File

@@ -3,7 +3,6 @@ import time
from django.template.base import FilterExpression, kwarg_re from django.template.base import FilterExpression, kwarg_re
from django.utils import timezone from django.utils import timezone
def impersonate_other_page(page, other_page): def impersonate_other_page(page, other_page):
"""Function to change the page metadata so the user gets to see the """Function to change the page metadata so the user gets to see the
non-personalized path and page. non-personalized path and page.