Skip to content

Kollokiertes übersetztes SVG (doc-system)

Verwenden Sie dies für Doc-System-Sites, bei denen übersetzte SVG-Illustrationen zusammen mit übersetzten Dokumenten im Inhaltsverzeichnis jeder Region angezeigt werden müssen – am selben Speicherort wie nebeneinanderliegende Screenshots. Das Docusaurus-Preset ist das primäre Beispiel.

Konfiguration

json
"features": {
  "translateSVG": true
},
"svg": {
  "sourcePath": [
    "documentation/static/assets/diagram.svg"
  ],
  "outputDir": "documentation/i18n",
  "style": "nested",
  "pathTemplate": "{outputDir}/{locale}/docusaurus-plugin-content-docs/current/assets/{basename}",
  "forceLowercase": true
}

translate-svg schreibt eine SVG-Datei pro Gebietsschema in dasselbe current/assets/-Verzeichnis, das nebeneinanderliegende Screenshots für PNGs verwenden:

documentation/i18n/de/docusaurus-plugin-content-docs/current/assets/diagram.svg
documentation/i18n/fr/docusaurus-plugin-content-docs/current/assets/diagram.svg

Quell-Markdown

Alle Dokumente in allen Sprachvarianten verwenden denselben relativen Pfad:

markdown
![Diagram](../assets/diagram.svg)

Für die englische Sprachvariante löst der symbolische Link docs/assets → ../static/assets dies auf. Für übersetzte Sprachvarianten verweist er direkt auf current/assets/.

Keine regexAdjustments-Regel ist erforderlich, da die Quelldokumente in Englisch und die übersetzten Ausgabedokumente identische Pfade verwenden.

Speicherort der SVG-Quelldateien

Empfohlen: Quell-SVGs gemeinsam mit den en-GB-PNGs im documentation/static/assets/-Verzeichnis ablegen. Dadurch verbleiben alle Dokumentationsressourcen an einem Ort, und derselbe docs/assets-symbolische Link deckt beide ab. Die svg.sourcePath-Einträge verweisen dann auf documentation/static/assets/name.svg.

pathTemplate-Platzhalter

PlatzhalterWert
{outputDir}Absoluter aufgelöster Pfad von svg.outputDir
{locale}Ziel-Sprachvariantencode
{LOCALE}Sprachvariantencode in Großbuchstaben
{relPath}Relativer Pfad von der sourcePath-Stammverzeichnisses zum Quell-SVG
{stem}Dateiname ohne Erweiterung
{basename}Dateiname mit Erweiterung
{extension}Erweiterung inklusive Punkt
{relativeToSourceRoot}Relativer Pfad vom nächstgelegenen sourcePath-Stammverzeichnis

Vollständige Referenz in der SVG-Konfigurationstabelle.

Implementierungsbeispiel

duplistatus – verschachtelter svg-Block mit pathTemplate in ai-i18n-tools.config.json; Quell-SVGs in documentation/static/assets/ (z. B. duplistatus_toolbar.svg); translate-svg schreibt sprachspezifische Dateien in documentation/i18n/<locale>/…/current/assets/ neben kollozierten PNGs; Dokumente betten sie über ../assets/-Pfade (z. B. overview.md) ein, ohne dass eine regexAdjustments-Brücke erforderlich ist.


Veröffentlicht unter der MIT-Lizenz.