diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..affca18b6afe242b67d206cea2aea233b4ad9b7a --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,153 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PinaxSymposion.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PinaxSymposion.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/PinaxSymposion" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PinaxSymposion" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..a61535768802f58929363e255116457d66999cb0 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,242 @@ +# -*- coding: utf-8 -*- +# +# Pinax Symposion documentation build configuration file, created by +# sphinx-quickstart on Sun Feb 5 17:31:13 2012. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Pinax Symposion' +copyright = u'2012, Eldarion Team' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.5' +# The full version, including alpha/beta/rc tags. +release = '0.5dev' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'PinaxSymposiondoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'PinaxSymposion.tex', u'Pinax Symposion Documentation', + u'Eldarion Team', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'pinaxsymposion', u'Pinax Symposion Documentation', + [u'Eldarion Team'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'PinaxSymposion', u'Pinax Symposion Documentation', + u'Eldarion Team', 'PinaxSymposion', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' diff --git a/docs/conference.rst b/docs/conference.rst new file mode 100644 index 0000000000000000000000000000000000000000..213a626b8250f3af28f8f1e0f2da78435d97396f --- /dev/null +++ b/docs/conference.rst @@ -0,0 +1,40 @@ +Conference App +============== + +The overall conference settings are managed via the ``conference`` app. + +Conferences and their sections are added and configured via the Django admin. + + +Models +------ + +Each conference needs an instance of a ``Conference`` model. In most cases you +will only need one of these but Symposion does support multiple conferences +sharing a database. Similar to the Django Sites framework, the conference your +project is for is selected by the ``CONFERENCE_ID`` setting which defaults to +``1`` but can be changed to the pk of another conference if you have more than +one. + +The conference model has an optional ``start_date`` and ``end_date`` +indicating when the conference will run. These are optional so you can begin +to configure your conference even if you don't know the exact dates. + +The conference model also has a ``timezone`` field which you should set to the +timezone your conference will be in. + +There is also a ``Section`` model. This is useful if your conference has +different parts to it that run of different days with a different management, +review or scheduling process. Example of distinct sections might be +"Tutorials", "Talks", "Workshops", "Sprints", "Expo". Many aspects of +Symposion can be configured on a per-section basis. + +Each section has an optional ``start_date`` and ``end_date`` similar to the +overall conference. + + +Helper Functions +---------------- + +A ``conference.models.current_conference()`` function exists to retrieve the +``Conference`` selected by ``CONFERENCE_ID``. diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..0b7abda1c2bfdec47a5875f17e82bf349a84bf8c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,34 @@ +Pinax Symposion +=============== + +Pinax Symposion is an open-source conference management system written in +Django. Symposion includes support for content management, proposal +submission, reviews, scheduling and sponsor management. + + +.. toctree:: + :maxdepth: 2 + + project + conference + content + proposals + sponsorship + speakers + schedule + + +About +----- + +Symposion came out of development done by Eldarion for DjangoCon US and US PyCon +but has been independently used for a number of other conferences. +The project homepage is http://eldarion.com/symposion/ + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/project.rst b/docs/project.rst new file mode 100644 index 0000000000000000000000000000000000000000..8a59b8dba8e5c3799c363a94fbfd0a09c3dcebe0 --- /dev/null +++ b/docs/project.rst @@ -0,0 +1,10 @@ +Project Template +================ + +The `pinax-project-symposion `_ repository +is a starter project demonstrating how to create a minimal symposion instance. + +TODO: + * initial data + * overriding templates + * deployment diff --git a/docs/proposals.rst b/docs/proposals.rst new file mode 100644 index 0000000000000000000000000000000000000000..bb578ee81f89052cb482ffb606568e277d6aa115 --- /dev/null +++ b/docs/proposals.rst @@ -0,0 +1,111 @@ +Proposals App +============= + + +Models +------ + + +ProposalSection +~~~~~~~~~~~~~~~ + +Recall that a symposion instance consists of one or more ``Conference``s each +made up of one or more ``Section``s. + +Different sections can have different open / close dates for proposals. +This is managed through a ``ProposalSection`` which is a one-to-one with +``Section`` where you can define a ``start`` date, an ``end`` date and/or +simply toggle proposals for the section ``closed``. + +A section is available for proposals iff: + * it is after the ``start`` (if there is one) and + * it is before the ``end`` (if there is one) and + * ``closed`` is NULL or False + +In other words, ``closed`` can be used as an override, regardless of ``start`` +and ``end`` and, if you want, you can just manually use ``closed`` rather than +setting dates. + +This model is currently managed by conference staff via the Django admin +although given it's part of "conference setup", it may often just be a +fixture that's loaded. + + +ProposalKind +~~~~~~~~~~~~ + +A conference, even within a section, may have different kinds of +presentations, e.g. talks, panels, tutorials, posters. + +If these have different requirements for what fields should be in the +proposal form, they should be modeled as different ``ProposalKind``s. For +example, you may want talk proposals to include an intended audience level +but not require that for poster submissions. + +Note that if you have different deadlines, reviews, etc. you'll want to +distinguish the **section** as well as the kind. + +This model is currently managed by conference staff via the Django admin +although given it's part of "conference setup", it may often just be a +fixture that's loaded. + + +ProposalBase +~~~~~~~~~~~~ + +Each proposal kind should have a subclass of ``ProposalBase`` defining the +fields for proposals of that kind. We discuss below how that association is +made. + +``ProposalBase`` provides fields for a ``title``, a single-paragraph +plain-text ``description`` and an ``abstract`` which can contain markup. + +There is also an ``additional_notes`` field which can be used for speakers to +communicate additional information about their proposal to reviewers that is +not intended to be shared with others. + +This base model supports each proposal having multiple speakers (although +the submitting speaker is always treated differently) and also supports +the attachments of supporting documents for reviewers that are, like the +``additional_notes`` not intended to be shared with others. + +A ``cancelled`` boolean field is also provided to indicate that a proposal +has been cancelled or withdrawn. + + +AdditionalSpeaker +~~~~~~~~~~~~~~~~~ + +Used for modeling the additional speakers on a proposal in additional to the +submitting speaker. The status of an additional speaker may be ``Pending``, +``Accepted`` or ``Declined``. + +.. todo:: see note in speakers docs about explaining the flow + + +SupportingDocument +~~~~~~~~~~~~~~~~~~ + +Used for modeling the supporting documents that can be attached to a proposal. + + +How to Add Custom Proposal Kinds +-------------------------------- + +For each kind: + + * create a ``ProposalKind`` instance + * subclass ``ProposalBase`` and add the fields you want + * define a Django ``ModelForm`` for proposals of that kind + * make sure your settings file has a ``PROPOSAL_FORMS`` dictionary + that maps the slug of your ``ProposalKind`` to the fully-qualified + name of your ``ModelForm``. + +For example:: + + PROPOSAL_FORMS = { + "tutorial": "pycon.forms.PyConTutorialProposalForm", + "talk": "pycon.forms.PyConTalkProposalForm", + "poster": "pycon.forms.PyConPosterProposalForm", + } + diff --git a/docs/schedule.rst b/docs/schedule.rst new file mode 100644 index 0000000000000000000000000000000000000000..15d37fa1966ddb11afb842b9d1e9f31f4ac8159a --- /dev/null +++ b/docs/schedule.rst @@ -0,0 +1,49 @@ +Schedule App +=========== + +The ``schedule`` app allows staff members to create the schedule for the +conference's presentations, breaks, lunches, etc. + +The ```schedule``` app has a number of models that facilitate building the +structured schedule: + + * Schedule: A high level container that maps to each Conference Section. + * Day: A Day associated with a Schedule. + * Room: A Room associated with a Schedule. + * Slot Kind: A type of Slot associated with a Schedule. + * Slot: A discrete time period for a Schedule. + * Slot Room: A mapping of a Room and Slot for a given Schedule. + * Presentation: A mapping of a Slot to an approved Proposal from the ```proposals``` app. + +Schedule Builder Form +--------------------- + +It can be cumbersome to generate a schedule through the admin. With that in mind, +a generic schedule builder is available via a Schedule's edit view. For instance, +if a Conference site has a Talks Section and Schedule, the form would be +available for Staff at:: + +/schedule/talks/edit + +The form consumes a structured CSV file, from which it will build the schedule. +Sample CSV data is included below:: + +"date","time_start","time_end","kind"," room " +"12/12/2013","10:00 AM","11:00 AM","plenary","Room2" +"12/12/2013","10:00 AM","11:00 AM","plenary","Room1" +"12/12/2013","11:00 AM","12:00 PM","talk","Room1" +"12/12/2013","11:00 AM","12:00 PM","talk","Room2" +"12/12/2013","12:00 PM","12:45 PM","plenary","Room1" +"12/12/2013","12:00 PM","12:45 PM","plenary","Room2" +"12/13/2013","10:00 AM","11:00 AM","plenary","Room2" +"12/13/2013","10:00 AM","11:00 AM","plenary","Room1" +"12/13/2013","11:00 AM","12:00 PM","talk","Room1" +"12/13/2013","11:00 AM","12:00 PM","talk","Room2" +"12/13/2013","12:00 PM","12:45 PM","plenary","Room1" +"12/13/2013","12:00 PM","12:45 PM","plenary","Room2" + +It is worth noting that this generates the **structure** of the schedule. It +does not create Presentation objects. This will need to be done manually. + +One can also **delete** an existing schedule via the delete action. This is +irreversible (save for a database restore). diff --git a/docs/speakers.rst b/docs/speakers.rst new file mode 100644 index 0000000000000000000000000000000000000000..affaa198a07b91b7edfa20be75bae66b9e7942f0 --- /dev/null +++ b/docs/speakers.rst @@ -0,0 +1,22 @@ +Speaker App +=========== + +The ``speaker`` app allows speakers to set up their profile, prior to or as +part of the proposal submission phase. The **dashboard** is the means through +which speakers manage their own profiles. + +We are planning to make the Speaker model more pluggable so, if you have +particular fields you'd like your speakers to fill out, you'll be able to +customize things more easily. + +Additional Speakers +------------------- + +Because ``symposion`` supports additional speakers being attached to a +proposal or actual presentation, it has the notion of a ``Speaker`` that is +not yet a ``User`` on the site. For this reason, a ``Speaker`` may have a +NULL ``user`` field (hopefully temporarily) as well as an ``invite_email`` +and ``invite_token`` field for the invitation sent to the additional speaker +to join. + +.. todo:: perhaps explain the invitation flow diff --git a/docs/sponsorship.rst b/docs/sponsorship.rst new file mode 100644 index 0000000000000000000000000000000000000000..5907a1a3d618f4ce1a4c45a65bbb0ac82d74fd0a --- /dev/null +++ b/docs/sponsorship.rst @@ -0,0 +1,82 @@ +Sponsorship App +=============== + +Sponsorship is managed via the ``sponsorship`` app. + +Sponsorship levels and sponsors are added via the Django admin. + + +Models +------ + +Each sponsor level has a ``name`` (e.g. "Gold", "Silver") and an ``order`` +field which is an integer that is used to sort levels (lowest first). Each +level also has a ``description`` which is not currently exposed anywhere +but can be used for private annotation. + +Each sponsor has a ``name``, ``external_url`` (i.e. link to the sponsor's +website), ``contact_name`` and ``contact_email``, ``logo``, and ``level``. + +A sponsor may also have a private ``annotation`` that can be used by +organizers to take notes about the sponsor. + +A sponsor will not appear on the site until the ``active`` flag is set true. + + +Template Snippets +----------------- + +The easiest way to include sponsor logos, grouped by level, is to either:: + + {% include "sponsorship/_vertical_by_level.html" %} + +or:: + + {% include "sponsorship/_horizontal_by_level.html" %} + +You can get a wall of sponsors (without level designation) with:: + + {% include "sponsorship/_wall.html" %} + + +You can always tweak these templates or use them as the basis for your own. +This is often all you'll need to do to display sponsors on your site. + +If you want to display a specific sponsor logo you can use:: + + {% include "sponsorship/_sponsor_link.html" with sponsor=sponsor %} + +or:: + + {% include "sponsorship/_sponsor_link.html" with sponsor=sponsor dimensions="100x100" %} + +if you want different dimensions than the default 150 x 150. + + +Template Tags +------------- + +If you want to retrieve the sponsors and traverse them yourself, you can use +the provided template tags:: + + {% load sponsorship_tags %} + + {% sponsors as all_sponsors %} + +or:: + + {% load sponsorship_tags %} + + {% sponsors "Gold" as gold_sponsors %} + +if you want to just get a specific level. + + +You can get the levels with:: + + {% load sponsorship_tags %} + + {% sponsor_levels as levels %} + +and you can always iterate over those levels, calling ``level.sponsors`` to +get the sponsors at that level.