From b9a5d1d803279eeb3c3415013063cb1cb281ffe0 Mon Sep 17 00:00:00 2001
From: Mike Bader <michaeldmbader@gmail.com>
Date: Thu, 20 Sep 2018 12:09:13 -0400
Subject: [PATCH] added documentation for reports

---
 docs/source/topics/publications.rst | 80 ++++++++++++++++++++++++++---
 1 file changed, 74 insertions(+), 6 deletions(-)

diff --git a/docs/source/topics/publications.rst b/docs/source/topics/publications.rst
index 0745c96..b62f7be 100644
--- a/docs/source/topics/publications.rst
+++ b/docs/source/topics/publications.rst
@@ -327,15 +327,15 @@ Book Views
 
    ``total_books``
       Integer of total number of books from all three managers:
-   ``books_published_list``
+   ``book_published_list``
       :class:`~django.db.models.query.QuerySet` of all published books (uses the 
       `published manager <topics-pubs-published-manager>`)
    
-   ``books_revise_list``
+   ``book_revise_list``
       queryset of all books in the revision process (uses the `revise manager 
       <topics-pubs-revise-manager>`)
    
-   ``books_inprep_list`` 
+   ``book_inprep_list`` 
       queryset of all books in preparation for submission (uses the `inprep manager 
       <topics-pubs-published-manager>`)
 
@@ -420,6 +420,9 @@ Model field reference                           :class:`cv.models.Chapter`
 Authorship set                                  :class:`cv.models.ChapterAuthorship`
 =======================                         ========================================
 
+Chapter Views
+"""""""""""""
+
 **Chapter List** : :class:`cv.views.ChapterListView`
 
    ===============  ================================================================   
@@ -435,15 +438,15 @@ Authorship set                                  :class:`cv.models.ChapterAuthors
    ``total_chapters``
       Integer of total number of chapters from all three managers:
    
-   ``chapters_published_list``
+   ``chapter_published_list``
       :class:`~django.db.models.query.QuerySet` of all published chapters (uses the 
       `published manager <topics-pubs-published-manager>`)
    
-   ``chapters_revise_list``
+   ``chapter_revise_list``
       :class:`~django.db.models.query.QuerySet` of all chapters in the 
       revision process (uses the `revise manager <topics-pubs-revise-manager>`)
    
-   ``chapters_inprep_list`` 
+   ``chapter_inprep_list`` 
       :class:`~django.db.models.query.QuerySet` of all chapters in 
       preparation for submission (uses the `inprep manager 
       <topics-pubs-published-manager>`)
@@ -489,6 +492,71 @@ Authorship set                                  :class:`cv.models.ChapterAuthors
 Reports
 ^^^^^^^
 
+The :class:`~cv.models.Report` class stores instances of reports that can also be used for other non-article publications. The :attr:`abstract` field
+takes Markdown_ input and saves the converted HTML to the non-editable 
+:attr:`abstract_html` field. 
+
+.. _Markdown: https://daringfireball.net/projects/markdown/syntax
+
+
+=======================                         ========================================
+Model field reference                           :class:`cv.models.Report`
+Authorship set                                  :class:`cv.models.ReportAuthorship`
+=======================                         ========================================
+
+Report Views
+""""""""""""
+**Report List** : :class:`cv.views.ReportListView`
+
+   ===============  ================================================================   
+   Context object   ``{{report_objects}}``
+   Template         ``'cv/lists/report_list.html'``
+   URL              ``'reports/'``
+   URL name         ``'report_object_list'``
+   MIME type        ``text/html``
+   ===============  ================================================================   
+
+   Returns context ``{{report_objects}}`` with four objects on the dot path: 
+
+   ``total_reports``
+      Integer of total number of books from all three managers:
+   
+   ``report_published_list``
+      :class:`~django.db.models.query.QuerySet` of all published books (uses the 
+      `published manager <topics-pubs-published-manager>`)
+   
+   ``report_revise_list``
+      queryset of all books in the revision process (uses the `revise manager 
+      <topics-pubs-revise-manager>`)
+   
+   ``report_inprep_list`` 
+      queryset of all books in preparation for submission (uses the `inprep manager 
+      <topics-pubs-published-manager>`)
+
+**Report Detail**: :class:`cv.views.ReportDetailView`
+
+   ===============  ================================================================   
+   Context object   ``{{report}}``
+   Template         ``'cv/details/report_detail.html'``
+   URL              ``'reports/<slug:slug>/'``
+   URL name         ``'report_object_detail'``
+   MIME type        ``text/html``
+   ===============  ================================================================
+   
+   Returns context ``{{report}}`` that represents a single 
+   :class:`~cv.models.Report` instance.
+
+**Report Citation**: :func:`cv.views.report_citation_view`
+
+   ===============  ================================================================   
+   Context object   ``{{report}}``
+   Templates        ``'cv/citations/report.ris'``
+                    ``'cv/citations/report.bib'``
+   URL              ``'reports/<slug:slug>/citation/<str:format>/'``
+   URL name         ``'report_citation'``
+   MIME types       ``application/x-research-info-systems``
+                    ``application/x-bibtex``
+   ===============  ================================================================