Info: DE-Version

Quellen: Keine

Deutsch

Stand der Übersetzung

2023-03-04. Die Vollständigkeit ist in der Konkordanzseite zu sehen (siehe Handbuchseiten-Konkordanz der übersetzen Dokumentation)

Hintergrund

Änderungen zur offiziellen FOLIO-Dokumentation

  • Config-Dateien aus der Original-Version, die angepasst oder gelöscht/deaktiviert wurden, liegen mit der Dateierweiterung “.folio-official” nochmal in diesem Branch
  • Die deutsche Version setzt stärker auf Unterseiten (“Workflows”-Abschnitt unter jeder App), statt sehr langen Seiten zu einzelnen Apps.
  • In der englischen Dokumentation sind die Einstellungen aller Apps unter “Einstellungen” zu finden. Die deutsche Version hat diese Inhalt direkt unter die jeweilige App sortiert und nur Inhalte ohne eindeutige App-Zuordnung unter “Einstellungen” behalten
  • Apps haben ggf. noch “Best Practice” und “Worfklows von Anwendern” als Unterabschnitte (siehe Abschnitt Struktur weiter unten)
  • Jede Seite linkt zur englischen Originalquelle (“Quellen: Folio” am Seitenanfang)
  • Seiten zu Apps wurde ein 📱-Icon vorangestellt
  • Letzte/Nächste Seite über TOC verlinkt (sofern vorhanden)
  • Es wurden Tags vergeben

Im ersten Schritt (und wahrscheinlich zugleich letzten) ging es nicht um Perfektion, d.h. es wurde nur wenig Zeit auf grammatikalisch “schönere” Sätze gelegt. Zum Teil klingt es etwas steif, da die englische Version sowohl in Folio selbst als auch in der Dokumentation aktive Anrede verwendet, währen die die Folio-Fachgruppe D-Übersetzung sich auf passive Formulierungen festgelegt hat (“Wenn Sie einen weiteren Typ anlegen wollen, dann klicken Sie auf den Button” wird “Soll einer neuer Typ angelegt wird, dann auf den Button klicken”). Gendern ist weitgehend schon durch die Übersetzungen der AG Übersetzung abgedeckt, An wenigen Stellen kann das aber noch unzureichend übersetzt sein.

Lizenz und Version

Diese Übersetzung ist ein Fork des FOLIO-Doc-Repositorys. Dort zu entnehmen: “This software is distributed under the terms of the Apache License, Version 2.0. See the file ‘LICENSE’ for more information.”.

Der Copyright-Hinweis im Footer der offiziellen Dokumentation wurde am 2023-02-20 mit dem Commit Use CC-By 4.0 license and FOLIO project geändert.

Quellen

Bedeutsame Quellen sind

Struktur

Die Struktur der Dokumentation orientiert sich an der Struktur der offiziellen Doku (siehe auch FOLIO Wiki: About Documentation> Content standards). Sie hat also Einleitung, Anhang und Hauptblöcke zu den großen Themen-/Aufgabenbereichen in Bibliotheken, wie Bestandszugang (Leihverkehr), Bestandmanagement (Erwerbung), Metadatenmanagement (Katalogisierung) und Electronic Resource Management (ERM). Die einzelnen FOLIO-Apps sind darunter zusammengefasst und beschrieben.

An vielen Stelle des Handbuchs, insbesondere unter den App-Seiten, gibt es eine Unterseite “Best Practises” und/oder “Workflows” und “Workflows von Anwendern”. Diese Seiten haben jeweils Unterseiten. Bei “Workflows von Anwendern” nach dem Schema “Einstellende Einrichtung: App/Thema + Aktion” (Beispiel: “TUB HH: Lizenzverträge Ersterfassung”). Die Workflows aus dem Original-Foliohandbuch sind alle unter " Workflows" mit der Reihenfolge der Originaldokumentation.

Zusätzlich werden den Seiten (ehemals Confluence-)Labels vergeben, womit sich dann Übersichten und Filterungen generieren lassen, die auch unabhängig von der (primären) hierarchischen Dokumentationsstruktur. Siehe dazu insbesondere die Übersichtslisten aus Tags im Index. Dort ist jeweils auch die Verwendung eines einzelnen Tags nochmal näher erläutert.

Beispiel folgen hier drunter, solange es nur Vorschlagscharakter hat und es noch keine Extraseite gibt. Die Labels könnten ggf. noch spezifischer gewählt werden, lassen sich aber später auch noch (relativ) leicht anpassen. Es gibt folgende Labelkategorien, die bei den meisten Beitrag (fast) alle vergeben werden sollten

  • by-
  • for-
    • Für welche Zielgruppe ist der Beitrag? Derzeit for-anwender für z.B. Workflows in den Apps selbst und for-admin für Workflows bei den App-Einstellungen.
    • In Testphase: for-entwickler (sinngemäß auch für SIGs).
  • cat-
    • Typ des Beitrag. Zum Beispiel cat-bestpractises (von Anwendern), cat-workflows (von Folio und von Anwendern), cat-einstellungen (von Folio), sowie cat-berechtigungen (meist zugleich Beschreibung der app selbst)
    • cat- meint eher starre, wiederkehrende Strukturelement der Dokumentation. Topic- (siehe unten) hingegen können mehr und freier gewählt werden
  • app-
    • Name der beteiligten Folio-App(s). Zum Beispiel app-personen, app-organisationen
    • Sonderfall “app-einstellungen”. Da Einstellungen zu spezifischen Apps werden mit app-NAME und cat-einstellung gettagt. Globale Einstellungen werden mit app-einstellungen getaggt. Das ist nicht unbedingt logisch oder am sinnvollsten, aber Konvention für den Moment. Um weiterhin Filterungen zu erlauben, gibt es zusätzlich auch cat-eisntellungen.
    • In Testphase (Sonderfall): app-gokb und app-laser, weil es sich gut ins Schema (by-x und for-x und app-x und cat-x) einfügt. Wird aber eventuell noch geändert.
  • topic-
  • meta-
    • Tags, die die Bearbeitung dieser Dokumentation unterstützen. Zum Beispiel meta-Dokumentation (Alles Festlegungen etc. rund um die Dokumentation) und meta-Entwurf (unfertige aber ggf. veröffentlichte Seiten)
    • dev-bug (wurde übersprünglich benutzt, soll aber durch ein meta-fehler o.ä. abgelöst werden ggf.)
      • Gelegentlich fallen beim Schreiben/Übersetzen Fehler auf, die aber nicht sofort gemeldet werden können oder ggf. nochmal geprüft werden müssen. Um die wiederzufinden, ist dieser spezielle Tag vergeben.

Todo

Der erste Lauf zielt auf Vollständigkeit. Einige Dinge, die für zukünftige Verbesserungen zu bedenken sind, sind hier notiert.

English

Status of translation

2023-03-04. completeness can be seen in the concordance page (see manual page concordance of translated documentation). As of march 2023 only the pages “Single server or PC: fresh install”, " Single server with containers", “quickMARC”, “eHoldings” and “GOBI integration” are not translated.

Background

Changes to the official FOLIO documentation

  • Config files from the original version, which were adapted or deleted/deactivated, are again in this branch with the file extension “.folio-official”.
  • The German version relies more on subpages (“Workflows” section fo each app) instead of very long pages for single apps.
  • In the English documentation, the settings of all apps can be found under “Settings” (Einstellungen). The German version has this content sorted directly under the respective app and only keeps content without a clear app relationship under “Settings” (Einstellungen).
  • Apps may have “Best Practice” and “Worfklows from Users” as subsections (see section “Structure” further down).
  • Each page links to the original English source (“Quelle: Folio” at the top of the page)
  • Pages to apps have been prefixed with a 📱 icon.
  • Last/next page linked via TOC (if available)
  • Tags were assigned

The first step (and probably at the same time last) was not about perfection, i.e. little time was spent on grammatically “nicer” sentences. In part it sounds a bit stiff, since the English version uses active forms of address both in Folio itself and in the documentation, while the DACH-SIG D-Übersetzung (DE-Translation) has settled on passive formulations (“A license explains what you can do with the content your library can access.” becomes “A license explains what can be done with the content that the library can access."). Gendering is largely already covered by the translations of D-Übersetzung, but in a few places it may still be insufficiently translated.

License and version

This translation is a fork of the FOLIO doc repository. According to it: “This software is distributed under the terms of the Apache License, Version 2.0. See the file ‘LICENSE’ for more information.”

The copyright notice in the footer of the official documentation was changed on 2023-02-20 with the commit Use CC-By 4.0 license and FOLIO project.

Sources

Significant sources are

Structure

The structure of the documentation is based on the structure of the official documentation (see also FOLIO Wiki: About Documentation> Content standards). Thus, it has introduction, appendix, and main blocks on the major topic/task areas in libraries, such as collection access (circulation), collection management (acquisitions), metadata management (cataloging), and electronic resource management (ERM). The individual FOLIO apps are summarized and described below.

In many places in the manual, especially under the app pages, there is a “Best Practices” and/or “Workflows” and “User Workflows” subpage. These pages each have subpages. In the case of “Workflows from users” according to the scheme “Contributing institution: App/Topic + Action” (example: “TUB HH: License agreements initial entry”). The workflows from the original folio manual are all under " Workflows” with the order of the original documentation.

In addition, (formerly Confluence) labels are assigned to the pages, which can then be used to generate overviews and filters that are also independent of the (primary) hierarchical documentation structure. See in particular the overview lists from tags in the Index. There the use of a single tag is explained in more detail.

Example follow hereunder, as long as it has only suggestion character and there is no extra page yet. The labels could be chosen more specific if necessary, but can be adapted (relatively) easily later. There are the following label categories, which should be assigned (almost) all for most contributions

  • by-
  • for-
    • What is the target audience for the contribution? Currently for-users for e.g. workflows in the apps themselves and for-admin for workflows in app settings.
    • In test phase: for-developer (analogously also for SIGs).
  • cat-
    • Type of contribution. For example, cat-bestpractises (from users), cat-workflows (from Folio and from users), cat-settings (from Folio), and cat-permissions (usually also description of the app itself).
    • cat- means rather rigid, recurring structural elements of the documentation. Topic- (see below) on the other hand can be chosen more and more freely
  • app-
    • Name of the folio app(s) involved. For example, app-persons, app-organizations.
    • Special case “app-settings”. Since settings to specific apps are tagged with app-NAME and cat-setting. Global settings are tagged with app-settings. This is not necessarily logical or most useful, but convention for now. To still allow filtering, there is also cat-settings.
    • In testing (special case): app-gokb and app-laser, because it fits well into the scheme (by-x and for-x and app-x and cat-x). But will be changed eventually.
  • topic-
  • meta-
    • Tags that support editing this documentation. For example, meta-documentation (All specifications etc. around the documentation) and meta-draft (unfinished but possibly published pages).
    • dev-bug (was originally used, but should be replaced by a meta-bug or similar if necessary)
      • Occasionally errors are found while writing/translating, but cannot be reported immediately or may need to be rechecked. To find them again, this special tag is assigned.

Todo

The first run aims at completeness. Some things to consider for future improvements are noted here.

  • Reconsider file names
  • Reorder images from _moved_from_wrong_pasting again nicely if necessary.
  • Hugo/Docsy has trimmed the original doc quite a bit. So to make the DE structure work, many times the Docsy defaults were taken again. Check.
  • Remove date: 2023-02-01T00:00:00-00:00 if necessary? Autogenerate from Git(hub) as in layouts\partials\page-meta-lastmod.html ?
  • C:\ProgramsPortable__NoSync\Seafile\Filesafe\Programs\UniServerZ\www_gitRep\tub_dd_folio\folio-docs\docs.folio. org_en-branched\content\de\docs\110 Dashboard\030 Workflows\080 TUB HH [Dashboard] - Creating Widgets (Quick Start Guide).md
    • pane
  • “pane” translates to “view”. Could also be “column with the title” or similar.
Zuletzt geändert 23.03.2023