Skip to content

Commit

Permalink
Update documentation and related links
Browse files Browse the repository at this point in the history
To keep things simple and with translation tools widely available, all documentation is only provided in English.
  • Loading branch information
t11r committed Jan 9, 2025
1 parent 32d7089 commit e4f7e06
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 76 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 3 additions & 0 deletions doc/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# TIFY Introduction

See [readme](../README.md).
57 changes: 0 additions & 57 deletions doc/user-guide.de.md

This file was deleted.

2 changes: 0 additions & 2 deletions doc/user-guide.en.md → doc/user-guide.md
Original file line number Diff line number Diff line change
@@ -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 <acronym title="application programming interface">API</acronym>s 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/)
Expand Down
12 changes: 3 additions & 9 deletions src/components/ViewHelp.vue
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,6 @@ export default {
return 'TIFY is a slim and mobile-friendly IIIF document viewer, released under the'
+ ' <a href="https://www.gnu.org/licenses/agpl-3.0.html.en">GNU Affero General Public License 3.0</a>.';
},
userGuideUrl() {
const lang = this.env.docsLanguages.includes(this.$store.options.language)
? this.$store.options.language
: 'en';
return `${this.env.docsUrl}/user-guide.${lang}.md`;
},
},
};
</script>
Expand All @@ -40,13 +34,13 @@ export default {

<ul class="tify-list">
<li>
<a :href="userGuideUrl">{{ $translate('User guide') }}</a>
<a :href="env.repositoryUrl">{{ $translate('Source code') }}</a>
</li>
<li>
<a :href="env.repositoryUrl">{{ $translate('Source code') }}</a>
<a :href="`${env.blobBaseUrl}/doc`">{{ $translate('Documentation') }}</a>
</li>
<li>
<a :href="env.contributorsUrl">{{ $translate('Contributors') }}</a>
<a :href="`${env.blobBaseUrl}/CONTRIBUTORS.md`">{{ $translate('Contributors') }}</a>
</li>
<li>
<a :href="env.bugsUrl">{{ $translate('Report a bug') }}</a>
Expand Down
10 changes: 3 additions & 7 deletions vite.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,11 @@ export default defineConfig({
// https://vitejs.dev/config/#environment-variables
define: {
ENV: {
version: pkg.version,
license: pkg.license,
blobBaseUrl: `${pkg.repository.url}/blob/v${pkg.version}`,
bugsUrl: pkg.bugs.url,
contributorsUrl: `${pkg.repository.url}/blob/v${pkg.version}/CONTRIBUTORS.md`,
docsUrl: `${pkg.repository.url}/blob/v${pkg.version}/doc`,
docsLanguages: [
...new Set(readdirSync('./doc').map((file) => file.split('.')[1])),
],
license: pkg.license,
repositoryUrl: pkg.repository.url,
version: pkg.version,
},
},
plugins: [
Expand Down

0 comments on commit e4f7e06

Please sign in to comment.