You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> Tekst is still in development. We're currently testing Tekst internally and implementing the last missing bits. As soon as we're ready for it, the new [VedaWeb platform](https://vedaweb.uni-koeln.de) will become the first public instance of Tekst. Until then, you are welcome to follow the development in this very repository.
12
+
> Tekst is currently in an open beta phase. We're test-driving it as the technical basis of the new [VedaWeb platform](https://vedaweb.uni-koeln.de), the first public instance of Tekst. You are welcome to follow further development in this very repository, leave a star to signal you interest in our work or [get in touch](https://github.com/VedaWebProject/Tekst/issues) if you find any errors.
13
13
14
-
Tekst is developed within the scope of the [VedaWeb 2.0](https://vedaweb.uni-koeln.de/) research project on Old Indic texts, where it constitutes the technical basis of the research platform "VedaWeb", which will be launched in its new form as part of the project's efforts.
14
+
Tekst has been initially developed within the scope of the [VedaWeb 2.0](https://vedaweb.uni-koeln.de/) research project on Old Indic texts, where it constitutes the technical basis of the research platform "VedaWeb", which was created in its new form as part of the project's efforts.
15
15
16
16
17
17
## Manual
18
18
19
19
You are looking for information on concepts, use cases, features, setup, deployment or administration of the Tekst platform?
20
20
21
-
<!-- I know this is a sin – and it hurts me, too. But I need the bigger font on this. -->
21
+
<!-- I know this is a sin – and it hurts me, too. But I need the bigger font on this and want to avoid more HTML in this README. -->
22
22
23
23
### Click here for the [📖 _Tekst_ manual](https://vedawebproject.github.io/Tekst)!
The Tekst platform as well as this documentation are still work-in-progress.
5
-
Very soon, the first public instance will go online and replace the current [VedaWeb](https://vedaweb.uni-koeln.de) platform.
4
+
While the Tekst platform is already in its open beta phase, this manual is still very much work-in-progress. We'll try to keep it up-to-date and complete it as soon as possible, but please bear with us if you encounter any incomplete or outdated information.
6
5
7
6
Tekst is a collaborative, web-based research platform for aligning, displaying, linking, exploring, and enriching resources on natural language texts ([and more](#alternative-use-cases)). It is developed within the scope of the [VedaWeb 2.0](https://vedaweb.uni-koeln.de/) research project, where it constitutes the technical basis of the *VedaWeb* research platform.
8
7
9
8
## Use cases
10
9
11
-
### Philological research projects
12
-
13
-
The original intent for the development of Tekst was to create the technical basis for the online research platform [VedaWeb](https://vedaweb.uni-koeln.de/), where numerous resources on multiple Old Indic Sanskrit texts can be browsed, compared and searched. These include text versions, translations, annotations, audio recordings of recitations and references to external sources, which are all aligned to the structure of their respective reference texts.
10
+
Tekst is primarily meant as a platform software for philological research projects. The original intent for the development of Tekst was to create the technical basis for the online research platform [VedaWeb](https://vedaweb.uni-koeln.de/), where numerous resources on multiple Old Indic Sanskrit texts can be browsed, compared and searched. These include text versions, translations, annotations, audio recordings of recitations and references to external sources, which are all aligned to the structure of their respective reference texts.
14
11
15
12
Therefore, the main use cases for Tekst are comparable research projects that either want to publish and showcase their research data, simply curate a set of established resources on certain reference texts, or even encourage the research community to participate and contribute to a central platform dedicated to provide relevant resources.
16
13
17
-
### Alternative use cases
18
-
19
-
The above being said, nothing is stopping you from using Tekst in different contexts. Tekst might be a viable option for you as long as the following conditions are met:
20
-
21
-
1. Your data revolves around a somewhat structured work or other phenomenon (e.g. book, movie, theatre play or even a simple sequence of years).
22
-
2. The [types of resources](concepts.md#resources) Tekst offers are sufficiently able to represent the data you want to work with.
23
-
24
14
In the end, giving it a try on your local machine [is relatively easy](setup/installation.md#docker-based-deployment-recommended).
25
15
26
-
!!! info "Please note"
27
-
Despite the alternative use cases mentioned, "texts" are used exemplary throughout this documentation and in the internal user interface of Tekst, as they are still the main use case.
28
-
29
-
30
16
## Features
31
17
32
18
This list is far from exhaustive, but includes some features that might be decisive in certain scenarios:
@@ -44,10 +30,9 @@ This list is far from exhaustive, but includes some features that might be decis
44
30
- Extensively typed and documented server API (via [OpenAPI](https://spec.openapis.org/oas/v3.0.2) specification) and built-in interactive API documentation (via [Swagger UI](https://github.com/swagger-api/swagger-ui) and/or [ReDoc](https://github.com/Redocly/redoc)), all thanks to [FastAPI](https://github.com/tiangolo/fastapi)
45
31
- ...
46
32
47
-
48
-
## Caveats
33
+
## Conceptual Caveats
49
34
50
35
Depending on your requirements, you might want to consider the following list of potential shortcomings:
51
36
52
-
- SEO: The (web-) client is a [SPA](https://en.wikipedia.org/wiki/Single-page_application) that is rendered in the browser (so no SSR). As a result, visibility to search engines is somewhat limited.
53
-
- ...?
37
+
- SEO: The web client is a [SPA](https://en.wikipedia.org/wiki/Single-page_application) that is rendered in the browser (no SSR). As a result, visibility to search engines is somewhat limited.
38
+
- ..._(get in touch if you find anything that should be added to this list, we mean it!)_
0 commit comments