From e4f7e060eae306f4d48eda7388d356484a512f88 Mon Sep 17 00:00:00 2001 From: t11r <1674104+t11r@users.noreply.github.com> Date: Thu, 9 Jan 2025 12:08:07 +0100 Subject: [PATCH] Update documentation and related links To keep things simple and with translation tools widely available, all documentation is only provided in English. --- README.md | 2 +- doc/introduction.md | 3 ++ doc/user-guide.de.md | 57 ------------------------- doc/{user-guide.en.md => user-guide.md} | 2 - src/components/ViewHelp.vue | 12 ++---- vite.config.js | 10 ++--- 6 files changed, 10 insertions(+), 76 deletions(-) create mode 100644 doc/introduction.md delete mode 100644 doc/user-guide.de.md rename doc/{user-guide.en.md => user-guide.md} (99%) diff --git a/README.md b/README.md index 2744a70a..a54efeff 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ TIFY is a slim and mobile-friendly [IIIF](https://iiif.io/) document viewer built with [Vue.js](https://vuejs.org/). It supports [IIIF Presentation API and Image API](https://iiif.io/api/) version 2 and 3. -Continue reading to learn how to integrate TIFY into your website or application and about its options and API, [check out the website for usage examples](https://tify.rocks/), or [have a look at the user guide](doc/user-guide.en.md). +Continue reading to learn how to integrate TIFY into your website or application and about its options and API, [check out the website for usage examples](https://tify.rocks/), or [have a look at the documentation](doc). ## Embedding TIFY diff --git a/doc/introduction.md b/doc/introduction.md new file mode 100644 index 00000000..ae72eddc --- /dev/null +++ b/doc/introduction.md @@ -0,0 +1,3 @@ +# TIFY Introduction + +See [readme](../README.md). diff --git a/doc/user-guide.de.md b/doc/user-guide.de.md deleted file mode 100644 index c3e516c2..00000000 --- a/doc/user-guide.de.md +++ /dev/null @@ -1,57 +0,0 @@ -# TIFY Kurzanleitung - -## Einführung - -TIFY ist ein schlanker IIIF-Dokumentenbetrachter, der für Mobilgeräte optimiert wurde und eine schnelle und leicht zu bedienende Oberfläche bietet. - -IIIF steht für »International Image Interoperability Framework« und definiert verschiedene APIs, mit denen Bilddateien zusammen mit Metadaten für Präsentation und Struktur beschrieben und verteilt werden können. Dadurch können Büchern, Zeitungen, Handschriften, Karten, Schriftrollen und Archivmaterial weltweit zwischen Intitutionen und Repositorien mit geringem Aufwand geteilt werden. Diese Bilder und Metadaten lassen sich mit jeder IIIF-kompatiblen Anwendung verarbeiten und anzeigen. [Erfahren Sie mehr über IIIF.](http://iiif.io/about/) - -## Anzeige mehrerer Seiten - -Beliebige Seiten können nebeneinander dargestellt werden. - -Öffnen Sie dazu die Ansicht »Seiten« und wählen Sie mehrere Seiten aus, indem Sie diese mit gedrückter Strg-Taste anklicken – oder länger berühren, wenn Sie einen Touchscreen verwenden. - -## Tastenbelegung - -TIFY kann vollständig mit der Tastatur bedient werden. - -### Ansicht - -| Aktion | Taste | -| --- | :---: | -| Volltext (wenn verfügbar) | 1 | -| Seiten | 2 | -| Inhalt (wenn verfügbar) | 3 | -| Info | 4 | -| Export | 5 | -| Sammlung (wenn verfügbar) | 6 | -| Hilfe | 7 | -| Scan | Rücktaste | -| Vollbild | F | - -### Blättern - -| Aktion | Taste | -| --- | :---: | -| Vorige Seite | Q oder , | -| Nächste Seite | E oder . | -| Erste Seite | ⇧Q | -| Letzte Seite | ⇧E | -| Zu Seite springen | X | -| Doppelseite umschalten | B | - -### Scan - -| Aktion | Taste | -| --- | :---: | -| Bewegen | W S A D | -| Vergrößern | ⇧W oder + | -| Verkleinern | ⇧S oder - | -| Drehen (90 Grad im Uhrzeigersinn) | R | -| Filter umschalten | I | -| Position und Vergrößerung zurücksetzen | 0 | -| Drehung zurücksetzen | ⇧ + R | -| Filter zurücksetzen| ⇧ + I | -| Alles zurücksetzen | ⇧ + 0 | -| Vollbildschirm umschalten | U | diff --git a/doc/user-guide.en.md b/doc/user-guide.md similarity index 99% rename from doc/user-guide.en.md rename to doc/user-guide.md index 3d5ddf04..24ad9c9b 100644 --- a/doc/user-guide.en.md +++ b/doc/user-guide.md @@ -1,7 +1,5 @@ # TIFY User Guide -## Introduction - TIFY is a slim and mobile-friendly IIIF document viewer, created with performance and usability in mind. IIIF, which stands for “International Image Interoperability Framework”, defines a set of standardized APIs for describing and delivering images along with presentational and structural metadata over the web. This allows digitized artworks, books, newspapers, manuscripts, maps, scrolls, and archival materials to be shared between institutions and repositories. Any IIIF-compliant application can consume and display those images and metadata. [Get more information about IIIF.](http://iiif.io/about/) diff --git a/src/components/ViewHelp.vue b/src/components/ViewHelp.vue index 7f657a31..db45fbca 100644 --- a/src/components/ViewHelp.vue +++ b/src/components/ViewHelp.vue @@ -15,12 +15,6 @@ export default { return 'TIFY is a slim and mobile-friendly IIIF document viewer, released under the' + ' GNU Affero General Public License 3.0.'; }, - userGuideUrl() { - const lang = this.env.docsLanguages.includes(this.$store.options.language) - ? this.$store.options.language - : 'en'; - return `${this.env.docsUrl}/user-guide.${lang}.md`; - }, }, }; @@ -40,13 +34,13 @@ export default {