.. CIVET documentation master file, created by
   sphinx-quickstart on Fri Aug  7 12:02:41 2015.

   

.. only:: html

    *******
    Welcome
    *******

.. raw:: latex

    \section*{Preface}


This is the documentation for the CIVET—Contentious Incident Variable Entry Template—data entry system. 
CIVET was developed under the NSF-sponsored project titled “A Method for Leveraging Public Information 
Sources for Social Science Research” which is creating tools to improve the efficiency of data generation 
in the social sciences, with an initial focus on coding event data in the domain of contentious politics.

The system is deployed as a `Django <https://www.djangoproject.com/start/overview/>`_ application; 
it should be possible to get this working by installing Django on a local machine and copying the directory ``djcivet_site``.  

We are very interested in feedback on this system, including any bugs
you encounter (please let us know what operating system (e.g. Windows,
OS-X) and browser (e.g. FireFox, Explorer, Chrome) you were using),
aspects of the manual that are unclear (and features that appear too
complex), and additional features that would be useful. Please send any
suggestions to `schrodt735@gmail.com <schrodt735@gmail.com>`__.

`Link to <https://github.com/civet-software>`_ the software on GitHub

.. Download documentation (PDF)<h3> <a href="documents/CIVET.Documentation.pdf"></a></h3>

.. Solved this problem!

    .. raw:: latex

    \subsection*{Note on the PDF version of the documentation}
    
    .. only:: latex

    The PDF is generated by the Sphinx system from the same files used to produce the
    in-line documentation and some aspects of the formatting, most notably the insertion
    of a myriad of superfluous blank pages, presumably at the behest of the Koch brothers
    paper companies, and the identification of ``Parts``, rather suck compared to what
    the author would do (or rather, originally did) with a LaTeX-native version. That 
    said, the in-line version of the documentation is clearly far more important, and
    most efforts will be devoted to that.
    
    .. only:: latex

    Having said this, if anyone can advise me on getting the files to be recognized
    as chapter without using ``latex_use_parts = True`` in ``conf.py``, I would 
    appreciate learning about that.
 

.. only:: html

    Acknowledgements
    ================

.. raw:: latex

    \section*{Acknowledgements}


The development of CIVET is funded by the U.S. National Science Foundation Office of Multidisciplinary Activities
in the Directorate for Social, Behavioral & Economic Sciences, Award 1338470 and the `Odum Institute <http://www.odum.unc.edu/odum/home2.jsp>`_ at the University of North Carolina at Chapel Hill with additional assistance from `Parus Analytics <http://parusanalytics.com/>`_. This documentation is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License; CIVET is open source and under the MIT license.
Any opinions, findings, and conclusions or recommendations expressed in this material are those of the authors 
and do not necessarily reflect the views of the National Science Foundation.

.. only:: html

    Contents
    ========

.. only:: latex

    *********
    Contents
    *********


..  toctree::
    :maxdepth: 2
   
    intro
    installing
    authentication
    homepage
    forms
    workspaces
    annotation
    extraction
    preferences
    future
    appendix1
    appendix2
    appendix3
    appendix4


.. Indices and tables

.. * :ref:`genindex`

.. * :ref:`modindex`
.. * :ref:`search`