# How-To

The [QuidEx-Wh Repository](https://scm.cms.hu-berlin.de/schluesselstellen/quidex-wh) contains a whitelabel version of
[QuidEx](https://hu.berlin/quidex) which can be used to create a custom website version for other use cases.
This creation is a multistep process. All steps are executed using the tool [Quid](https://scm.cms.hu-berlin.de/schluesselstellen/quid)
which can be installed with:

~~~
pip install Quid
~~~

## Quotation Identification

In this first step, Quid is used to find quotations between a source text, for example some literary work and one or
more target texts, for example scholarly works. The usage of Quid  is described [here](https://scm.cms.hu-berlin.de/schluesselstellen/quid).
To compare a source text with a number of target texts the target texts need to be in a single folder. The following
command can be used to run the comparison:

~~~
quid compare
"path_to_source_text.txt"
"path_to_target_text_folder"
--output-type json
--text
--output-folder-path
"path_to_output_folder"
~~~

## Passage Creation

In this second step, the `passage` command from Quid is used to create passages from the extracted quotations, with
the following command:

~~~
quid passage
"path_to_source_text.txt"
"path_to_target_text_folder"
"path_to_compare_output"
"path_to_output_folder"
~~~

`path_to_compare_output` is the path to the output of the `compare` step.

## Visualization

In this step, the `visualize` command from Quid is used to create the files needed for the website.

~~~
quid visualize
"path_to_source_text.txt"
"path_to_target_text_folder"
"path_to_passage_output"
"path_to_output_folder"
--title "Some title"
--author "Some author"
--year 1900
~~~

`path_to_passage_output` is the path to the output of the `passage` step.

The website skeleton is located in the [QuidEx-Wh Repository](https://scm.cms.hu-berlin.de/schluesselstellen/quidex-wh).

The output of the `visualize`command needs to be copied into a subfolder of the `content` folder of the website
skeleton. The files and datastructures are documented [here](https://scm.cms.hu-berlin.de/schluesselstellen/quid/-/blob/master/DATA_STRUCTURE_README.md).
Then values in `config.json` also need to be adjusted, for example:

~~~
{
    "title": "Some title for the website",
    "collections": [
        "Work1",
        "Work2"
    ]
}
~~~

The subfolders in `content` must match the items listed under `collections`.
The names of the files in `content/Work1/target` should have the following structure `year_author_title`.
This way the files will be properly sorted and displayed.