Link to manual about export files, fix #133

spraakbanken · Jan 2, 2024 · bd4577f · bd4577f
1 parent 3b3001a
commit bd4577f
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,10 @@ As this project is a user-facing application, the places in the semantic version
 
 ## [Unreleased]
 
+### Added
+
+- Link to manual about exports files
+
 ### Changed
 
 - Rename "Dashboard" to "Library"

diff --git a/src/corpus/exports/CorpusResult.vue b/src/corpus/exports/CorpusResult.vue
@@ -3,6 +3,13 @@
     <Section :title="$t('result')">
       <HelpBox>
         <p>{{ $t("exports.help") }}</p>
+        <aside>
+          <a
+            href="https://spraakbanken.gu.se/en/tools/mink/manual#download-results"
+          >
+            {{ $t("exports.help.more.label") }}
+          </a>
+        </aside>
       </HelpBox>
 
       <div class="my-4">

diff --git a/src/i18n/locales/en.yaml b/src/i18n/locales/en.yaml
@@ -95,6 +95,7 @@ exports.tools.view: View
 exports.download.help: Results can be downloaded as machine-readable files for processing in scripts or other specialized software.
 exports.downloading: Downloading results
 exports.help: The annotation process yields export files for each input file. You can download each single export file or all of them in a bundle. The exact structure of the files depends on the input files as well as the configuration. They are stored on the server indefinitely, but re-running the annotation will replace them with new ones.
+exports.help.more.label: Read more about export files in the user manual
 user.settings: Settings
 user.settings.admin_mode: Enable administration mode
 user.admin_mode.warning: Administration mode is enabled. Please be careful!

diff --git a/src/i18n/locales/sv.yaml b/src/i18n/locales/sv.yaml
@@ -96,6 +96,7 @@ exports.tools.view: Visa
 exports.download.help: Resultatet kan laddas ner som maskinläsbara filer för bearbetning i script eller speciella program.
 exports.downloading: Laddar ner analysresultat
 exports.help: Annoteringsprocessen skapar exportfiler för varje källfil, och de kan laddas ner enskilt eller som arkiv. Filernas struktur beror både på källfilerna och konfigurationen. De lagras på servern tillsvidare, men ersätts med nya om du kör om annoteringen på nytt.
+exports.help.more.label: Läs mer om exportfiler i användarhandledningen
 user.settings: Inställningar
 user.settings.admin_mode: Aktivera administratörsläget
 user.admin_mode.warning: Administratörsläget är aktiverat. Var försiktig!