2.1. Requirements¶

2.2. Installation¶

We’re assuming you’re already running a functional version of Django CMS. If not, follow their tutorial first:

pip install goscalecms

INSTALLED_APPS = (
    ...
    'goscale',
    'goscale.plugins.videos',
    'goscale.plugins.pictures',
    'goscale.plugins.feeds',
    'goscale.plugins.forms',
    'goscale.plugins.calendar',
    'goscale.plugins.presentations',
)

urlpatterns = patterns('',
    url(r'^admin/', include(admin.site.urls)),
    url(r'^goscale/', include('goscale.urls')),
    url(r'^', include('cms.urls')),
)

python manage.py syncdb
python manage.py migrate

1.1. Calendar¶

Application: ‘goscale.plugins.calendar’

Configuration options:

• url - Calendar feed URL (XML link from “Private Address” in your “Calendar Settings”)
• page_size - Events per page (0 for unlimited)
• show_past - Show past events (If set past events will be shown)

Templates:

• events.html - Events list
• events_mini.html - Events mini list (for sidebar for example)
• datepicker.html - Date picker widget

Single post template: event.html

Additional templates can be added by setting GOSCALE_CALENDAR_CUSTOM_PLUGIN_TEMPLATES tuple in your settings.py

1.2. Feed¶

Application: ‘goscale.plugins.feeds’

Configuration options:

• url - Feed URL
• page_size - Posts per page (0 for unlimited)
• show_date - Show date in posts (If checked the date will be shown along with the post content)
• external_links - Open external links (If checked posts will link to the original source, otherwise will open internally)
• disqus - DICQUS shortname (Use it if you want to enable disqus.com comments)

Templates:

• posts.html - Posts
• posts_small.html - Small posts (for sidebar for example)

Single post template: post.html (default)

Additional templates can be added by setting GOSCALE_FEEDS_CUSTOM_PLUGIN_TEMPLATES tuple in your settings.py

1.3. Blogger and Tumblr¶

Application: ‘goscale.plugins.feeds’

Configuration options:

• url - Blog URL
• page_size - Posts per page (0 for unlimited)
• show_date - Show date in posts (If checked the date will be shown along with the post content)
• external_links - Open external links (If checked posts will link to the original source, otherwise will open internally)
• disqus - DICQUS shortname (Use it if you want to enable disqus.com comments)

Templates:

• posts.html - Posts
• posts_small.html - Small posts (for sidebar for example)

Single post template: post.html (default)

Additional templates can be added by setting GOSCALE_FEEDS_CUSTOM_PLUGIN_TEMPLATES tuple in your settings.py

1.4. Form¶

Application: ‘goscale.plugins.forms’

Configuration options:

• url - Google Form URL
• form_class - Additional class attribute to add to the form element

Templates:

• form.html - Inline Form
• form_popup.html - Form in a lightbox

Additional templates can be added by setting GOSCALE_FORMS_CUSTOM_PLUGIN_TEMPLATES tuple in your settings.py

1.5. Picasa¶

Application: ‘goscale.plugins.pictures’

Configuration options:

• url - Picasa or Google+ user or album link
• width - Container width (Width of a slideshow container or a lightbox)
• height - Container height (Height of a slideshow container or a lightbox)
• thumbnail_width - Thumbnail width (Width of a thumbnail)
• thumbnail_height - Thumbnail height (Height of a thumbnail)
• autoplay - Autoplay (If set slideshow will start automatically)

Templates:

• grid.html - Grid
• slideshow.html - Slideshow
• slideshow_with_thumbnails.html - Slideshow with thumbnails
• slideshow_mini.html - Mini slideshow (for sidebar for example)
• carousel_mini.html - Mini carousel

Additional templates can be added by setting GOSCALE_PICTURES_CUSTOM_PLUGIN_TEMPLATES tuple in your settings.py

1.6. YouKu¶

Application: ‘goscale.plugins.videos’

Configuration options:

• playlist - Youku playlist URL
• lightbox - Open videos in a lightbox (If checked videos will open in a lightbox, otherwise inline)

Templates:

• videos.html - Videos

Additional templates can be added by setting GOSCALE_VIDEOS_CUSTOM_PLUGIN_TEMPLATES tuple in your settings.py

1.7. Google Presentation¶

Application: ‘goscale.plugins.presentations’

Configuration options:

• embed - Embed code (From the “</> Embed” link)
• width - Width of a presentation container
• height - Height of a presentation container
• ratio - Aspect ratio (Ratio of width:height used for the presentation if manual size isn’t set)
• embed_as_is - Embed “as is” (If set embed code will not be changed)
• delay - Delay between slides
• autoplay - If set presentation will start automatically
• loop - If set presentation will restart after the last slide

Templates:

• presentation.html - Presentation

Additional templates can be added by setting GOSCALE_PRESENTATIONS_CUSTOM_PLUGIN_TEMPLATES tuple in your settings.py

1.8. Slideshare Presentation¶

Application: ‘goscale.plugins.presentations’

Configuration options:

• embed - Embed code (From the “</> Embed” link)
• width - Width of a presentation container
• height - Height of a presentation container
• ratio - Aspect ratio (Ratio of width:height used for the presentation if manual size isn’t set)
• embed_as_is - Embed “as is” (If set embed code will not be changed)
• start - Number of the first slide
• without_related_content - If set related slideshows will not be displayed

Templates:

• presentation.html - Presentation

Additional templates can be added by setting GOSCALE_PRESENTATIONS_CUSTOM_PLUGIN_TEMPLATES tuple in your settings.py

1.9. Speakerdeck Presentation¶

Application: ‘goscale.plugins.presentations’

Configuration options:

• embed - Embed code (From the “</> Embed” link)
• width - Width of a presentation container
• height - Height of a presentation container
• ratio - Aspect ratio (Ratio of width:height used for the presentation if manual size isn’t set)
• embed_as_is - Embed “as is” (If set embed code will not be changed)
• start - Number of the first slide

Templates:

• presentation.html - Presentation

Additional templates can be added by setting GOSCALE_PRESENTATIONS_CUSTOM_PLUGIN_TEMPLATES tuple in your settings.py

2.1. Plugins settings¶

GOSCALE_VIDEOS_CUSTOM_PLUGIN_TEMPLATES

Additional templates list for goscale.plugins.videos. (default: ())

GOSCALE_CALENDAR_CUSTOM_PLUGIN_TEMPLATES

Additional templates list for goscale.plugins.calendar. (default: ())

GOSCALE_FEEDS_CUSTOM_PLUGIN_TEMPLATES

Additional templates list for goscale.plugins.feeds. (default: ())

GOSCALE_FORMS_CUSTOM_PLUGIN_TEMPLATES

Additional templates list for goscale.plugins.forms. (default: ())

GOSCALE_PICTURES_CUSTOM_PLUGIN_TEMPLATES

Additional templates list for goscale.plugins.pictures. (default: ())

2.2. Global settings¶

GOSCALE_DEFAULT_POST_PLUGIN

Default template to use for a single post. (default: ‘post.html’)

GOSCALE_POSTS_UPDATE_FREQUENCY

How often to update posts for plugins. (default: 60*30, 30 minutes)

GOSCALE_UPDATE_FROM_ADMIN

Should GoScale update posts right after saving the plugin in Django admin. (default: False)

GOSCALE_CACHE_DURATION

Cache duration for plugins content. (default: CMS_CACHE_DURATIONS[‘content’], the same as content cache duration in Django CMS)

GOSCALE_POST_SUMMARY_LIMIT

Where to trim post summary text. (default: 300)

GOSCALE_DEFAULT_PAGE_SIZE

Default number of posts per page. (default: 10)

GOSCALE_DEFAULT_CONTENT_ORDER

Default sorting for posts. (default: ‘-published’)

2.3. Theme settings¶

SITE_ALIASES

Allows to enable multiple hosts for one theme (for example local, dev, staging servers).

THEME

Sets currently enabled default theme (if not set by request).

3.1. goscale¶

All the commands in GoScale CMS are grouped under one command “goscale”. Run it with –help option to list all available commands:

python manage.py goscale --help

3.2. update_slugs¶

Re-saves all posts for all GoScale plugins and re-generates slugs based on post titles and IDs.

Usage:

python manage.py goscale update_slugs

3.1. update_posts¶

Updates posts for all GoScale plugins.

You can put run it manually or as a cron job to keep your plugins content up-to-date and cached. But the best way to do it is by using Celery task queue!

Available options:

• -s, –site - Site ID to filter plugins.
• -t, –theme - Theme name to filter plugins.

Usage:

python manage.py goscale update_posts --site=2

4.1. update_goscale_plugins¶

Periodic task that goes through all goscale plugins and sends tasks to update them.

4.2. update_goscale_plugin_posts¶

Updates posts for a single plugin.

Usually scheduled by update_goscale_plugins task or when saving a plugin from Django admin.

1.1. Paginator¶

Provides a simple reusable pagination for GoScale plugin posts.

{% goscale_paginator %}

{% goscale_paginator template="infinite_scrolling.html" %}

1.2. Plugin filters¶

If your plugin uses any complex filters or query string params for it’s data you can use this tag to generate links to pass these filters to your plugin (or even all plugins on a page with the “global” param).

It renders the whole query string with added filters for the current plugin so any other query string params will be preserved. You can ignore this default behavior by using “exclusive” param.

One of the examples is in the paginator tag to generate page links and in calendar plugin to generate start date links.

<a href="{% goscale_plugin_filters page=page.previous_page_number %}">{% trans "Prev" %}</a>

<a href="{% goscale_plugin_filters start=start_date global='true' exclusive='true' %}">{{start_date}}</a>

1.3. Plugin post¶

Used to render a link for a single post.

<a href="{% goscale_plugin_post post %}">{{ post.title }}</a>

1.4. GoScale Placeholder¶

Simply an extension of Django CMS placeholder tag. It acts exactly the same but allows you to define if you want to render single posts into this placeholder.

For example if you want to render posts from “sidebar” placeholder plugins into “content” placeholder which can often be a case.

If you don’t use it you will still be able to access single posts inside of your plugin in a {{ post }} context variable.

{% goscale_placeholder content %}

{% goscale_placeholder content render_posts='true' %}

1.5. GoScale AddtoBlock¶

Simply an extension of django-sekizai addtoblock tag. It acts exactly the same but allows you to use it with AJAX requests.

If a CMS plugin where you use it will be rendered inside of an AJAX request it will simply render the contents of addtoblock tag instead of adding them into page context which wouldn’t work with ajax anyway.

{% goscale_addtoblock js %}

1.6. User¶

Renders a user bar for Login and Registration links and User Info.

{% goscale_user %}

{% goscale_user template="userbar.html" %}

1.7. Login¶

Renders a Login Form to use outside of the /accounts/login/ page.

{% goscale_login %}

{% goscale_login template="custom_login.html" %}

2.1. Templates¶

The “plugins” folder contains all the plugins (each plugin having its own folder at its name). In their “templates” sub folders are their templates, each one corresponding to a specific view, that you can choose in the “template” dropdown of a plugin in the admin.

In all these templates you have access to 2 main variables :

• {{ title }} : a string containing the title of the page, set in the “title” field of a plugin in the admin
• {{ posts }} : a dictionary containig the content to display on the page (videos, rss feeds, pictures, ...)

Then, each plugin has it’s own specific secondary variables to display additional information or choose a specific layout.

For each new plugin, always use the same structure as the other plugin’s templates (to include the base css and js files). To include plugin’s specific js and css files (used by dependencies like jquery plugins), use these URLs:

{{ STATIC_URL }}goscale/css/your.css.file.css
{{ STATIC_URL }}goscale/js/your.js.file.js

Also, if your plugin needs you to add specific css to make its default style and/or specific js to make it run, use these URLs:

{{ STATIC_URL }}goscale/css/goscale.plugins.pluginname.css
{{ STATIC_URL }}goscale/js/goscale.plugins.pluginname.js

In these URLs, replace pluginname by the name of your plugin.

2.2. Static files¶

They should all be in the “static” subfolder, in “js” for the javascript files, “css” for the css files and “img” for the images.

In the specific js file, you should create a jquery plugin that’s called only if a certain class is found on the page, example:

(function($) {
    $.fn.goscalePluginsVideos = function() { // jquery plugin creation
                // your plugin's js here
        };
        $(function() {
                $('.goscale-plugins-videos').goscalePluginsVideos(); // check for the specific class to run the jquery plugin
        });
})(jQuery);

2.3. Ajaxlinks¶

In order to make the ajaxlinks plugin work with the goscale’s plugins, you’ll need to add a “data-callback” attribute to the javascript files in your plugin’s template containing the name of the function you need to call each time a page containing your plugin is loaded. Example:

<script type="text/javascript" src="{{ STATIC_URL }}goscale/js/goscale.plugins.videos.js" data-callback="plugins.goscalePluginsVideos"></script>

3.1. Installation¶

To use themes add ‘goscale.themes’ to INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'goscale',
    'goscale.themes',
)

Add ‘static’ context processor:

TEMPLATE_CONTEXT_PROCESSORS = (
    ...
    'goscale.themes.context_processors.static',
)

Add ‘SiteOnFlyDetectionMiddleware’ middleware before any other:

MIDDLEWARE_CLASSES = (
    'goscale.themes.site_middleware.SiteOnFlyDetectionMiddleware',
    ...
)

3.2. Usage¶

Create a new Theme in django admin and upload a theme tarball (tar.gz) file or put your theme files into ‘themes’ directory in your project and input the theme name.

Choose a Site to which this theme should apply.

After that you should have theme templates in your Page editing form.

For more information refer to django-cms-themes website.

3.3. Using theme files in templates¶

For theme static files:

{{ STATIC_THEME_URL }}

For current theme name:

{{ GOSCALE_THEME }}

3.4. Theme switching on request¶

The beauty of goscale.themes app is that you can serve multiple themes and sites from the same django project instance. It’s enabled by SiteOnFlyDetectionMiddleware from django-dynamicsites.

You can switch themes dynamically by hosts in your browser.

For more information refer to django-dynamicsites documentation.

To enable multiple hosts for one theme (for example local, dev, staging servers) use SITE_ALIASES setting:

SITE_ALIASES = {
    'goscalecms.ru': 'goscalecms.com',
}

3.5. Debugging theme switching¶

The pattern for theme switching locally is:

{{theme}}.127.0.0.1.xip.io:{{port}}

So let’s say you’re running your server on localhost:8000. And you want to open theme goscale, then open:

http://goscale.127.0.0.1.xip.io:8000/

4.1. Installation¶

Just follow the tutorial from django-allauth README. Here’s a brief summary:

Install django the requirements:

pip install django-allauth==0.9.0 django-avatar
./manage.py syncdb
./manage.py migrate

settings.py:

TEMPLATE_CONTEXT_PROCESSORS = (
    ...
    "django.core.context_processors.request",
    ...
    "allauth.account.context_processors.account",
    "allauth.socialaccount.context_processors.socialaccount",
    ...
)

AUTHENTICATION_BACKENDS = (
    ...
    # Needed to login by username in Django admin, regardless of `allauth`
    "django.contrib.auth.backends.ModelBackend",

    # `allauth` specific authentication methods, such as login by e-mail
    "allauth.account.auth_backends.AuthenticationBackend",
    ...
)

INSTALLED_APPS = (
    ...
    'avatar',
    'allauth',
    'allauth.account',
    'allauth.socialaccount',
    # ... include the providers you want to enable:
    'allauth.socialaccount.providers.facebook',
    'allauth.socialaccount.providers.google',
    'allauth.socialaccount.providers.github',
    'allauth.socialaccount.providers.linkedin',
    'allauth.socialaccount.providers.openid',
    'allauth.socialaccount.providers.persona',
    'allauth.socialaccount.providers.soundcloud',
    'allauth.socialaccount.providers.stackexchange',
    'allauth.socialaccount.providers.twitter',
    'allauth.socialaccount.providers.weibo',
    ...
)

urls.py:

urlpatterns = patterns('',
    ...
    (r'^accounts/', include('allauth.urls')),
    (r'^goscale/', include('goscale.urls')),
    ...
)

Example settings (consult the docs for more customizaton):

LOGIN_REDIRECT_URL = '/'
ACCOUNT_AUTHENTICATION_METHOD = 'username_email'
ACCOUNT_EMAIL_VERIFICATION = 'optional'
SOCIALACCOUNT_PROVIDERS = {
    'google': {
        'SCOPE': [
            'https://www.googleapis.com/auth/userinfo.profile',
            'https://www.googleapis.com/auth/userinfo.email'
        ],
        'AUTH_PARAMS': { 'access_type': 'online' }
    }
}

Make sure to create social apps in the admin for all the providers you choose.

4.2. Usage¶

You can use it as is the way intended by django-allauth . Or you can use GoScale combined Sign In / Sign Up view:

{% load url from future %}
{% load i18n %}
{% load account %}

<a href="{% url 'goscale_account_signup' %}" rel="next">{% trans "Log in" %} / {% trans "Register" %}</a>

We also already have a template tag that handles the whole “User bar”:

{% load goscale_tags %}

{% goscale_user %}