Views

Views are provided for the majority of common tasks when working with fiction_outlines. Once again, these views are where the object permission model is enforced, so always subclass rather than just replace them.

For the most part, these operate as generic views and all the same functionality applies.

Note

Basic templates for all of these views are provided, but it is expected that you will override them with your own as needed.

class fiction_outlines.views.SeriesListView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.list.ListView

Generic view for viewing a list of series objects.

class fiction_outlines.views.SeriesDetailView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view to see series details.

class fiction_outlines.views.SeriesUpdateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating a series object.

class fiction_outlines.views.SeriesCreateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating series object.

class fiction_outlines.views.SeriesDeleteView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic view for deleting a series.

class fiction_outlines.views.CharacterListView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.list.ListView

Generic view for viewing character list.

class fiction_outlines.views.CharacterDetailView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for character details.

class fiction_outlines.views.CharacterUpdateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

Generic update view for character.

class fiction_outlines.views.CharacterCreateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating a character.

class fiction_outlines.views.CharacterDeleteView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Generic view for deleting a character.

class fiction_outlines.views.CharacterInstanceListView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.list.ListView

Generic view for seeing a list of all character instances for a particular character.

class fiction_outlines.views.CharacterInstanceDetailView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic detail view for character instance.

class fiction_outlines.views.CharacterInstanceUpdateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating a character instance.

class fiction_outlines.views.CharacterInstanceCreateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Generic create view for a character instance.

class fiction_outlines.views.CharacterInstanceDeleteView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Generic view for deleting character instances.

class fiction_outlines.views.LocationListView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.list.ListView

Generic view for locations.

class fiction_outlines.views.LocationDetailView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for location details.

class fiction_outlines.views.LocationUpdateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.UpdateView

Generic view for updating locations.

class fiction_outlines.views.LocationCreateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating locations

class fiction_outlines.views.LocationDeleteView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic view for deleting locations.

class fiction_outlines.views.LocationInstanceListView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.list.ListView

Generic view for looking at all location instances for a location.

class fiction_outlines.views.LocationInstanceDetailView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for a location instance detail view.

class fiction_outlines.views.LocationInstanceUpdateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating a location instance. Not used since there are not details. But it’s here if you want to subclass LocationInstance and customize it.

class fiction_outlines.views.LocationInstanceCreateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating a location instance on a outline.

class fiction_outlines.views.LocationInstanceDeleteView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Generic delete view for Location Instance.

class fiction_outlines.views.OutlineListView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.list.ListView

Generic view for Outline Outline list

class fiction_outlines.views.OutlineDetailView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for Outline detail

class fiction_outlines.views.OutlineExport(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view to get an export of an outline record.

Takes a url kwarg of outline as the pk of the fiction_outlines.models.Outline The url kwarg of format determines the type returned. Current supported formats are opml, json, or md.

A view that can return a dowloadable export of an outline with structure preserved. Formats supported: OPML, JSON, Markdown For fullest fidelity of data, JSON is the best choice. OPML and Markdown necessarily force the application to strip out quite a bit of nested data.

class fiction_outlines.views.OutlineUpdateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.UpdateView

Generic update view for outline details.

class fiction_outlines.views.OutlineCreateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating initial outline.

class fiction_outlines.views.OutlineDeleteView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic delete view for an outline.

class fiction_outlines.views.ArcListView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.list.ListView

Generic list view for arcs in a outline

class fiction_outlines.views.ArcDetailView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

Generic view for arc details.

class fiction_outlines.views.ArcUpdateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, django.views.generic.edit.UpdateView

Generic view for updating arc details

class fiction_outlines.views.ArcCreateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Generic view for creating an arc.

class fiction_outlines.views.ArcDeleteView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.DeleteView

Generic view for deleting an arc

class fiction_outlines.views.ArcNodeDetailView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

View for looking at the details of an atomic node as opposed to the whole tree.

class fiction_outlines.views.ArcNodeUpdateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

View for editing details of an arc node (but not it’s tree position).

class fiction_outlines.views.ArcNodeCreateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Create view for an arc node. Assumes that the target position has already been passed to it via kwargs.

class fiction_outlines.views.ArcNodeDeleteView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

View for deleting an arc node.

Incorporates logic to ensure that if the node represents the Hook or Resolution of the Seven Point Story Structure, it cannot be deleted.

class fiction_outlines.views.ArcNodeMoveView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.UpdateView

View for executing a move method on an arcnode.

class fiction_outlines.views.StoryNodeCreateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Creation view for a story node. Assumes the target and pos have been passed as kwargs.

class fiction_outlines.views.StoryNodeMoveView(**kwargs)

Bases: fiction_outlines.views.StoryNodeUpdateView

View for executing a move method on an arcnode.

class fiction_outlines.views.StoryNodeDetailView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.detail.DetailView

View for looking at the details of an atomic story node as opposed to the whole tree.

class fiction_outlines.views.StoryNodeUpdateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.UpdateView

View for doing basic updates to a story node, but not regarding its position in the tree.

Will add additional form errors if it is attempted to edit the story_element_type in a manner which would break the structure of the outline.

class fiction_outlines.views.StoryNodeCreateView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, django.views.generic.edit.CreateView

Creation view for a story node. Assumes the target and pos have been passed as kwargs.

class fiction_outlines.views.StoryNodeDeleteView(**kwargs)

Bases: django.contrib.auth.mixins.LoginRequiredMixin, rules.contrib.views.PermissionRequiredMixin, braces.views._queries.SelectRelatedMixin, braces.views._queries.PrefetchRelatedMixin, django.views.generic.edit.DeleteView

Genric view for deleting a story node.