Difference between revisions of "DE/Vorlagenpakete"

Revision as of 19:48, 29 March 2006

Diese Seite soll eine Kurzdokumentation zu den bei de.openoffice.org gesammelten Vorlagenpaketen sein. Für den Anfang handelt es sich nur um eine grobe Sammlung von Stichpunkten, die noch weiter verfeinert und strukturiert werden müssen.

Zweck der Vorlagensammlung und daraus resultierende Anforderungen

• Die Vorlagensammlung soll ein Basis-Set von Vorlagen bereitstellen, die von vielen OOo-Anwendern verwendet werden können.
• Die Sammlung soll als einfacher Download angeboten werden können (als zip-Archiv verpackt)
• Die Sammlung muss möglichst einfach vom Anwender eingebunden Werden können. D.h. Einzelne vorlagen müssen problemlos für neue Dokumente verwendet werden können. Die Sammlung als Ganzen soll in der Vorlagenverwaltung von OOo verwendet werden können.
• Die Vorlagen werden inzwischen auch innerhalb Distributionen benutzt (z.B. PrOOo-Box oder debian)

Inhalte (Dateiarten, Komplexität ...)

• es wird das OpenDocument Format verwendet
• es werden nur Vorlagen (Templates) verwendet
• eine Vorlage sollte aus nur einer Datei bestehen, da sonst die Verwendung aus der Vorlagenverwaltung von OOo heraus nur schwer möglich ist.
• die Vorlagen sollten möglichst einfach bedienbar sein, um lange einarbeitungszeiten oder zusätzliche Dokumentationen zu vermeiden

Rechtliche Anforderungen

• alle Vorlagen müssen unter einer einheitlichen Freien Lizenz stehen.
• diese lizenz muss insofern frei sein, dass sie von verschiedenen Projekten und Distributoren akzeptiert wird
• die LGPL erfüllt diese Anforderung

technische Anforderungen

• Dateien werden im cvs von OOo verwaltet -> auf Besonderheiten des cvs (Gross- / Kleinschreibung, leere Verzeichnisse) achten
• OpenDocument Dateiformat
• keine übergrossen Dateien (Downloadpakete)
• keine Umlaute im Dateinamen (verursachen evtl. Probleme in verschiedenen Systemumgebungen)

Umsetzung

Ablagestruktur

• Verzeichnisstruktur entspricht den Vorlagenkategorien im Vorlagendialog von OOo
• -> Sprechende Verzeichnisnamen für Kategorien
• -> nur eine Ebene von Unterverzeichnissen
• Kategorien sollten nach Thema, nicht nach Dateityp aufgebaut werden

Konventionen für Verzeichnis- und Dateinamen

• kurze und sprechende Verzeichnisnamen (diese werden im Vorlagendialog von OOo angezeigt)
• dateinamen in Kleinbuchstaben, ohne leerzeichen (stattdessen _ verwenden)

Konventionen für Lizenzhinweise

• Copyright und Quellhinweise in die Dateigenschaften schreiben
• Hinweis zur LGPL in die Dateieigenschaften schreiben
• Textvorlage für den LGPL-Hinweis liegt im OOo cvs
• weichen die original Lizenz- / Nutzungshinweise von der LGPL ab unbedingt beim Autor rückfragen!

Ablegen von Dokumentationen / weiteren Informationen zu den Vorlagen

• kurze Hinweise zur Verwendung können in die Dateieigenschaften geschrieben werden (werden dann im OOo Vorlagen Dialog und z.B. auch im Windows-Explorer angezeigt)
• Für umfangreichere Anleitungen (in extra Dateien) muss noch eine Lösung gefudnen werden