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
🏗 Just like Tekst itself, this manual/documentation is still very incomplete and "work in progress".
3
+
<imgsrc="assets/home_header.jpg"width="100%"title="We couldn't pay a designer for this, sorry."alt="An unpleasing AI slop showing a stack of books transitioning into what is supposed to graphically represent something like digital data flow but does an unfortunate job and looks like a public transport network plan instead" />
6
4
7
-
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 on Old Indic texts, where it constitutes the technical basis of the *VedaWeb* research platform.
8
-
9
-
!!! info
5
+
!!! warning
10
6
11
-
At the moment, the VedaWeb platform is still a custom made application that was developed in an earlier phase of the VedaWeb project. Many of its concepts will find their way into Tekst, but it lacks core features like user management, collaboration and the possibility to work with multiple arbitrarily structured texts. As soon as Tekst is ready, the VedaWeb platform will become the first public instance of Tekst.
7
+
🏗 The Tekst platform as well as this documentation are still work-in-progress.
12
8
9
+
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.
13
10
14
11
## Use cases
15
12
16
13
### Philological research projects
17
14
18
-
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 and references to external sources, which are all aligned to the structure of their respective reference texts.
15
+
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.
19
16
20
-
Therefore, the main use case 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.
17
+
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.
21
18
22
19
### Alternative use cases
23
20
24
-
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
21
+
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:
25
22
26
-
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)
27
-
2.the types of [resources](concepts.md#resources) Tekst offers are sufficiently able to represent the data you want to work with
23
+
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).
24
+
2.The [types of resources](concepts.md#resources) Tekst offers are sufficiently able to represent the data you want to work with.
28
25
29
26
In the end, giving it a try on your local machine [is relatively easy](setup/installation.md#docker-based-deployment-recommended).
30
27
31
28
!!! info "Please note"
32
-
Despite the alternative use cases mentioned, "texts" are used exemplary throughout this documentation and in the internal user interface of Tekst, as this is still the main use case.
29
+
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.
33
30
34
31
35
32
## Features
36
33
37
-
This list is far from exhaustive, but includes some features that might be decisive for certain use cases:
34
+
This list is far from exhaustive, but includes some features that might be decisive in certain scenarios:
38
35
39
36
- Manage multiple independent, potentially differently structured texts and arbitrary related resources in a single platform instance
40
37
- One common user base for the whole platform
41
-
- UI colors will adapt to the currently selected working text for visual unambiguity
42
-
- Built-in [i18n](https://en.wikipedia.org/wiki/Internationalization_and_localization) with an extensible set of languages
43
-
- Integrated user management with authentication and role-based as well as owner-based authorization
44
-
-*Closed Mode* to run the platform purely administrator-driven, turning off registration for arbitrary users
38
+
- Built-in [i18n](https://en.wikipedia.org/wiki/Internationalization_and_localization) with an extensible set of languages (contributions welcome!)
39
+
- Integrated user management with authentication and a combination of role-based and ownership-based authorization
40
+
- Optional *Closed Mode* to disable public registrations (or applications) for an internally curated platform without user contributions
45
41
- Customization of
46
42
- Content fonts
47
43
- On-screen keyboard character sets
44
+
- UI Colors
45
+
- ...
48
46
- 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)
49
47
- ...
50
48
@@ -54,4 +52,4 @@ This list is far from exhaustive, but includes some features that might be decis
54
52
Depending on your requirements, you might want to consider the following list of potential shortcomings:
55
53
56
54
- 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.
57
-
-UI responsiveness: The user interface – especially the public-facing part – is responsive to the use on hand-held mobile devices. That being said, it was primarily developed for desktop-based usage. This might show in places.
0 commit comments