HomeTipps & TricksVerwenden Sie standardisierte QuelltexteSchreiben Sie Ihre eigenen Kommandos
Handbuch UDO > Praktische Arbeit mit UDO > Tipps & Tricks Index

Verwenden Sie standardisierte Dateinamen

UDO ist es zwar völlig egal, wie die Dateien heißen, aus denen Sie Ihr UDO-Quelltext-Dokument erzeugen. Es kann aber für strukturiertes Arbeiten sehr nützlich sein, sich eigene Standards zuzulegen. Vor allem im Austausch mit anderen Menschen ist es sinnvoll, wenn Sie auch bei den Dateinamen eindeutige Standards verwenden.

Sobald Sie Dokumentationen für mehrere Sprachen entwickeln, empfiehlt es sich zudem, die Dateinamen englisch festzulegen, es sei denn, Sie wissen genau, dass sämtliche Mit-Autorinnen und Kollegen wirklich gut Deutsch können und die Dateisysteme, auf denen sie arbeiten, keine Probleme mit deutschen Umlauten haben.

Hier unser Vorschlag:

.u Eselsbrücke: .u wie UDO. Die Haupt-Datei für das Dokument, z.B. manual.u.
.ui Eselsbrücke: .ui wie UDO-Include. Dateien, die von der .u-Datei inkludiert werden. Diese Dateien sollten nur weitere Steuerkommandos enthalten, nicht aber Text, der ggf. übersetzt werden muss.
.uli Eselsbrücke: .uli wie UDO-Library-Include. Dateien, die aus einer Bibliothek (engl. Library) für verschiedene Projekte gleichzeitig genutzt werden können, z.B. Makros, Silbentrennungslisten usw.
.de Alle Dateien mit deutschen Texten.
.en Alle Dateien mit englischen Texten.
.sv Alle Dateien mit schwedischen Texten. (Falls Sie sich wundern, warum wir hier nicht .se vorschlagen, hier die Erklärung: sv ist der ISO-Bezeichner für die Sprache Schwedisch, während SE der ISO-Bezeichner für das Land Schweden ist. Das wird oft verwechselt, auch z.B. bei Tschechisch (cs) und Tschechien (CZ).
.fr_CA Jetzt ahnen Sie es schon, oder? Diese Datei-Endung würde festlegen, dass der darin enthaltene Dokument-Text Französisch für Kanadier ist. So einfach ist das mit den ISO-Bezeichnern für Sprachen und Länder. – Wenn Sie bei Französisch nicht weiter differenzieren müssen, reicht natürlich .fr völlig aus.

Wenn Sie so vorgehen, müssen Sie beim Hinzufügen einer neuen Sprache nur die !include-Befehle in den .ui-Dateien erweitern und z.B. die .en-Dateien kopieren und den Kopien die gewünschten Sprach-Endungen für die neue Übersetzung geben.

# manual.u
# --------
!include praeamble.ui

!begin_document
!include intro.ui
!include ref.ui
!include appendix.ui
!end_document

# intro.ui
# --------
!ifset [de]
!include intro.de
!endif
!ifset [en]
!include intro.en
!endif

Copyright © www.udo-open-source.org (Kontakt)
Letzte Aktualisierung am 19. Mai 2014

HomeTipps & TricksVerwenden Sie standardisierte QuelltexteSchreiben Sie Ihre eigenen Kommandos