.. QuidEx documentation master file, created by
   sphinx-quickstart on Thu Mar  7 17:33:15 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

QuidEx Documentation
=================================

|name| was created as part of the project `What matters? Key passages in literary works
<https://www.projekte.hu-berlin.de/en/schluesselstellen/index.html>`_ [#fn1]_.
The project website describes the project as follows:

  *The goal of this exploratory project is to identify and characterize key passages in literary works. We understand
  key passages as passages that are particularly important to expert readers when interpreting texts. In a mixed-methods
  approach, we primarily want to investigate empirically which textual characteristics of literary genres can be revealed
  through patterns of citation and quotation.*

|name| is a tool to visualize and explore quotations between a source text, for example, a literary work, and one or
more target texts, for example, scholarly interpretations.
:doc:`General Usage <general_usage>` is the best entry point to a step-by-step introduction. Individual functionality
is described in in :doc:`Overview <functionality_overview>`. For an introduction to how passages are created from
quotations, see :doc:`Background <background>`.

Contact
=================================

`Frederik Arnold <mailto:frederik.arnold@hu-berlin.de>`_

Or open an issue in one of our repositories. For issues regarding QuidEx or this documentation, use
`QuidEx-Wh <https://scm.cms.hu-berlin.de/schluesselstellen/quidex-wh>`_. For issues regarding anything related to tooling
for extracting quotations, use `Quid <https://scm.cms.hu-berlin.de/schluesselstellen/quid>`_ or
`ProQuo <https://scm.cms.hu-berlin.de/schluesselstellen/proquo>`_.

Publications
=================================

.. include:: publications_body.md
   :parser: myst_parser.sphinx_

.. toctree::
   :maxdepth: 1
   :caption: Overview

   general_usage
   background
   publications

.. toctree::
   :maxdepth: 1
   :caption: Functionality

   functionality_overview
   settings
   segments_graph
   filter
   passage_graph
   quotations_over_time

.. toctree::
   :maxdepth: 1
   :caption: Build your own website

   build_your_own_website

.. rubric:: Footnotes

.. [#fn1] The first project phase ended in August 2023. The description of the first phase, can be found `here <https://www.projekte.hu-berlin.de/en/schluesselstellen/what-matters-key-passages-in-literary-works>`_.

.. |name| replace:: QuidEx