dc-django-base 0.1.0

Settings

Start the site’s settings by importing the base_settings file.

from dcbase.base_settings import *

Refer to this file to see the complete list of settings that are included by default. The following are settings that your site must provide:

• BASE_DIR (typically os.path.dirname(os.path.dirname(__file__)))

• SECRET_KEY (source the production key from a secure place, not a text file in a public source repository)

• ROOT_URLCONF

• WSGI_APPLICATION

• DATABASES

• EMAIL_BACKEND (consider using django.core.mail.backends.console.EmailBackend for testing)

Add the site’s apps to INSTALLED_APPS by prepending them to the base apps:

INSTALLED_APPS = (
    'some_app',
    'allauth.socialaccount.providers.google',
) + INSTALLED_APPS

Other “list” settings can be modified in a similar way.

Because the order of middleware is important it may be required to copy and modify the entire MIDDLEWARE_CLASSES setting to inject a new middleware class in the middle of the list.

Urls

Include the following urls in the site’s urlconf:

url(r'', include('dcbase.urls')),

Templates

Create a base.html in the root of your templates directory. Extend dcbase/base.html and override blocks that are global to your site. For example:

{% extends "dcbase/base.html" %}

{% block headerBarBrand %}My Site Brand{% endblock %}
{% block footerBar %}
    Footer content!
{% endblock %}

Base

The dcbase/base.html provides the basic page framework and layout. Provide your site’s base template by extending this template and overriding the following blocks.

• pageTitle: title of the page, as it will appear in the browser window’s title bar

• style: inline CSS to include in the page style tag. you need to include your own enclosing <style> element.

• head: extra content to include in the page head tag. use this to link external css, add meta tags, etc.

• headerBarBrand: content for the “brand” link in the upper right, usually the app title or site logo

• headerBarBrandLink: target of the “brand” link, usually the app’s home page. default is site root.

• headerBarRight: extra nav items (<li>’s) to include on the right side of the header bar

• content: the main content of the page. should normally start with a div with class “container” or “container-fluid”

• footerBar: content for the footer nav bar. this is a bootstrap navbar so the content here should probably be a <ul>

• script: any additional scripts or script links the page needs. inline scripts must supply their own enclosing <script> tag

Forms

Include dcbase/form.html or dcbase/form-horizontal.html to create consistently styled forms. These templates expect a context variable called form.

Set the autofocus context variable to the id of a form field which should be automatically focused when the page loads. For example:

{% include "dcbase/form.html" with autofocus="id_important_field" %}