Django Stories v0.5.1 documentation

This Page

Settings

Here are several settings that you can use to customize Stories. Each of the following are keys in STORY_SETTINGS.

Note

The settings have been refactored in version 0.8. The old settings still work, but raise a DeprecationWarning.

STATUS_CHOICES

A story can be in several different states, for example draft vs. live. Your workflow might have several states that a story goes through, but there can only be one choice that is considered “Published”.

Choices are specified as a list or tuple of integer - string tuples. The integer is the code for the choice and the string is the description that the user sees.

Defaults:

DEFAULT_SETTINGS = {
    'STATUS_CHOICES': (
        (1, 'DRAFT'),
        (2, 'READY FOR EDITING'),
        (3, 'READY TO PUBLISH'),
        (4, 'PUBLISHED'),
        (5, 'REJECTED'),
        (6, 'UN-PUBLISHED'),
    )
}

Draft: A work-in-progress.

Ready for Editing: The story is ready for an editor’s touch.

Ready to Publish: The editing is finished and the story is ready to go on to the web site.

Published: The story is on the web site, as long as it is past the story’s publish date and time.

Rejected: The editor didn’t like something and the author needs to work on it some more.

Un-published: The story has been removed from the site for some reason.

DEFAULT_STATUS

When a story is created, what should the the status default to?

Default:

DEFAULT_SETTINGS = {
    'DEFAULT_STATUS': 1 # Draft
}

PUBLISHED_STATUS

Which one of the possible statuses is considered “Show This On Site.”

Default:

DEFAULT_SETTINGS = {
    'PUBLISHED_STATUS': 4 # Published
}

ORIGIN_CHOICES

It is possible that stories could be coming in from several sources, such as a wire service, an editorial front end, or an FTP site. This settings allows you to mark which stories originated from which source, so you can potentially do something different depending on the source. For example, include all stories in the RSS feed, except ones that came from a wire service.

Choices are specified as a list or tuple of integer - string tuples. The integer is the code for the choice and the string is the description that the user sees.

Default:

DEFAULT_SETTINGS = {
    'ORIGIN_CHOICES': (
        (0, 'Admin'),
    )
}

DEFAULT_ORIGIN

When a story is created from the Django Admin, which choice of origin should it default to?

Default:

DEFAULT_SETTINGS = {
    'DEFAULT_ORIGIN': 0 # Admin
}

INCLUDE_PRINT

Should the fields related to print production be included in the database. The fields are print_pub_date, print_section, and print_page.

Default:

DEFAULT_SETTINGS = {
    'INCLUDE_PRINT': False
}

RELATION_MODELS

A story can relate to several other things, such as other stories, photographs, photo galleries, and external links. Stories links to the Django Content Types application, which would normally show all sorts of things that don’t matter to the author and end users. This setting specifies which specific models are relatable to a story.

The value should be a tuple of ‘appname.modelname’ strings.

If this setting is empty or None, the story relations are not available in the admin. If at a later time you decide to set this, you must syncdb before it will work properly.

Default:

DEFAULT_SETTINGS = {
    'RELATION_MODELS': [] # Not enabled
}

THROW_404

Default:

DEFAULT_SETTINGS = {
    'THROW_404': True
}

AUTHOR_MODEL

Default:

DEFAULT_SETTINGS = {
    'AUTHOR_MODEL': u'auth.User'
}

AUTHOR_MODEL_LIMIT_CHOICES

Default:

DEFAULT_SETTINGS = {
    'AUTHOR_MODEL_LIMIT_CHOICES': {'is_staff': True}
}

USE_CATEGORIES

Default:

DEFAULT_SETTINGS = {
    'USE_CATEGORIES': True and 'categories' in settings.INSTALLED_APPS
}

USE_REVERSION

Default:

DEFAULT_SETTINGS = {
    'USE_REVERSION': True and 'reversion' in settings.INSTALLED_APPS
}