Difference between revisions of "DE/Vorlagenpakete"
From Apache OpenOffice Wiki
< DE
Plutonium244 (Talk | contribs) |
|||
| (9 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[Category: | + | [[Category:DE|Vorlagenpakete]] |
Diese Seite soll eine Kurzdokumentation zu den bei de.openoffice.org gesammelten Vorlagenpaketen sein. | Diese Seite soll eine Kurzdokumentation zu den bei de.openoffice.org gesammelten Vorlagenpaketen sein. | ||
| Line 7: | Line 7: | ||
* Die Vorlagensammlung soll ein Basis-Set von Vorlagen bereitstellen, die von vielen OOo-Anwendern verwendet werden können. | * 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 soll als einfacher Download angeboten werden können (als zip-Archiv bzw. .oxt-Extension verpackt) |
| − | * Die Sammlung muss möglichst einfach vom Anwender eingebunden | + | * 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 Ganzes soll in der Vorlagenverwaltung von OOo verwendet werden können. |
| − | + | ||
=== Inhalte (Dateiarten, Komplexität ...) === | === Inhalte (Dateiarten, Komplexität ...) === | ||
| Line 16: | Line 16: | ||
* es werden nur Vorlagen (Templates) 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. | * 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 | + | * die Vorlagen sollten möglichst einfach bedienbar sein, um lange Einarbeitungszeiten oder zusätzliche Dokumentationen zu vermeiden |
=== Rechtliche Anforderungen === | === Rechtliche Anforderungen === | ||
* alle Vorlagen müssen unter einer einheitlichen Freien Lizenz stehen. | * alle Vorlagen müssen unter einer einheitlichen Freien Lizenz stehen. | ||
| − | * diese | + | * diese Lizenz muss insofern frei sein, dass sie von verschiedenen Projekten und Distributoren akzeptiert wird |
* die LGPL erfüllt diese Anforderung | * die LGPL erfüllt diese Anforderung | ||
| Line 27: | Line 27: | ||
=== technische Anforderungen === | === technische Anforderungen === | ||
| − | * Dateien werden im | + | * Dateien werden im CVS von OOo verwaltet -> auf Besonderheiten des CVS (Gross- / Kleinschreibung, leere Verzeichnisse) achten |
* OpenDocument Dateiformat | * OpenDocument Dateiformat | ||
* keine übergrossen Dateien (Downloadpakete) | * keine übergrossen Dateien (Downloadpakete) | ||
| − | * keine Umlaute im Dateinamen (verursachen evtl. Probleme in verschiedenen Systemumgebungen) | + | * keine Umlaute, Sonderzeichen oder Freiräume im Dateinamen (verursachen evtl. Probleme in verschiedenen Systemumgebungen und mit entsprechender URL auch in verschiedenen Browsern) |
| − | + | ||
== Umsetzung == | == Umsetzung == | ||
| Line 45: | Line 44: | ||
=== Konventionen für Verzeichnis- und Dateinamen === | === Konventionen für Verzeichnis- und Dateinamen === | ||
| − | * kurze und | + | * kurze und aussagekräftige Verzeichnisnamen (diese werden im Vorlagendialog von OOo angezeigt) |
| − | * | + | * Dateinamen in Kleinbuchstaben, ohne Leerzeichen (stattdessen "_" verwenden) |
| Line 53: | Line 52: | ||
* Copyright und Quellhinweise in die Dateigenschaften schreiben | * Copyright und Quellhinweise in die Dateigenschaften schreiben | ||
* Hinweis zur LGPL in die Dateieigenschaften schreiben | * Hinweis zur LGPL in die Dateieigenschaften schreiben | ||
| − | * Textvorlage für den LGPL-Hinweis liegt im OOo | + | * Textvorlage für den LGPL-Hinweis liegt im OOo CVS |
| − | * weichen die original Lizenz- / Nutzungshinweise von der LGPL ab unbedingt beim Autor rückfragen! | + | * weichen die original Lizenz- / Nutzungshinweise von der LGPL ab, unbedingt beim Autor rückfragen! |
=== Ablegen von Dokumentationen / weiteren Informationen zu den Vorlagen === | === Ablegen von Dokumentationen / weiteren Informationen zu den Vorlagen === | ||
| − | * kurze Hinweise zur Verwendung können in die Dateieigenschaften geschrieben werden (werden dann im OOo | + | * kurze Hinweise zur Verwendung können in die Dateieigenschaften geschrieben werden (werden dann im OOo Vorlagendialog und z.B. auch im Windows-Explorer angezeigt) |
| − | * Für umfangreichere Anleitungen (in | + | * Für umfangreichere Anleitungen (in separaten Dateien) muss noch eine Lösung gefunden werden |
| + | |||
| + | |||
| + | == Arbeitsschritte == | ||
| + | |||
| + | * Vorlage prüfen und in eine Kategorie einordnen | ||
| + | * Vorlage im entsprechenden Ordner ablegen (ggf. Ordner für neue Kategorie vorher anlegen) | ||
| + | * Dateiname korrigieren (Kleinbuchstaben, keine Umlaute und Sonderzeichen) | ||
| + | |||
| + | |||
| + | * Vorlage öffnen (Achtung - nicht "neues Dokument aus Vorlage erstellen") | ||
| + | * In die Dateieigenschaften [http://de.openoffice.org/unbranded-source/browse/*checkout*/de/documentation/vorlagen/vorlage_lizenznotiz_lgpl.txt Lizenzhinweis] einfügen - originale Autoren / Copyright-Hinweise müssen erhalten bleiben | ||
| + | * In den Dateieigenschaften "Nutzerdaten verwenden" abschalten | ||
| + | * Vorlage speichern | ||
| + | * Vorlage normal öffnen (neues Dokument aus Vorlage) und auf Grundfunktionalität prüfen | ||
| + | |||
| + | |||
| + | * Vorlage in das cvs-Repository einfügen (unbedingt als Binary! - ggf. vorher neuen Ordner für Kategorie einfügen) | ||
| + | * script make_zips.sh ausführen | ||
| + | * zip-Archiv und Extension kontrollieren | ||
| + | * Vorlage, zip-Archiv und Extension commiten | ||
| + | |||
| + | |||
| + | |||
| + | == Verbesserungsmöglichkeiten == | ||
| + | |||
| + | === Vorlagenkategorien === | ||
| + | |||
| + | Die Vorlagenkategorien sollten neu strukturiert werden (z.B. enthält die Kategorie "Präsentationen" zu viele Vorlagen, viele davon sind eher nur Hintergründe). | ||
| + | Randbedingungn / Hinweise: | ||
| + | * Die angezeigten Kategorien können unabhängig vom Verzeichnisnamen sein ( [[Non-code extensions#Localization of templates and template categories]] ) | ||
| + | * bei einer Neustrukturierung sollten die im Programm vorgegebenen Kategorien verwendet werden ( [http://blogs.linux.ie/caolan/2006/01/31/basic-notes-on-ooo-templates/ Infos zu vorgegebenen Kategorien]) | ||
| + | |||
| + | === Extension === | ||
| + | |||
| + | Da ab OpenOffice.org 2.2 Extensions als Dateityp im System registriert sind, ist dieses Format zur Installation zu bevorzugen (einfache Installation / Update per Doppelklick). Erweiterungsmöglichkeiten: | ||
| + | * Anpassen der Scripte, so dass "kleinere" Extensions gebaut werden können (eine Extension pro Kategorie) | ||
| + | * saubere Versionierung (zur Zeit müsste die Version manuell gesetzt werden) | ||
| + | * Lizenzhinweise bei Installation der Extension einbinden | ||
| + | * evtl. Verzeichnisstruktur als deutschsprachige Vorlage aufbauen ( [[Non-code extensions#Multi language templates extensions]] ) | ||
| + | |||
| + | Generelle Informationen zu Extensions auf [[Category:Extensions]] | ||
| + | Aktuelle Specs zu Extensions: | ||
| + | * [http://specs.openoffice.org/appwide/packagemanager/extensiondependencies1.odt Minimal Support for Extension Dependencies] | ||
| + | * [http://specs.openoffice.org/appwide/packagemanager/simple_extension_license.odt Simple License for Extensions] | ||
| + | * [http://specs.openoffice.org/appwide/packagemanager/extensionversion.odt Extension Version Handling] | ||
| + | * [http://specs.openoffice.org/appwide/packagemanager/extension_system_integration.odt System integration for extensions] | ||
| + | * [http://specs.openoffice.org/appwide/packagemanager/online_update_for_extensions.odt Online update for extensions] | ||
| + | * [http://specs.openoffice.org/appwide/packagemanager/extensionidentifiers.odt Extension Identifiers] | ||
| + | Specs zu Extensions werden in der [http://specs.openoffice.org/appwide/index.html modulübergreifenden] Spezifikations-Kategorie gelistet. | ||
Latest revision as of 00:34, 22 October 2012
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.
Contents
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 bzw. .oxt-Extension 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 Ganzes soll in der Vorlagenverwaltung von OOo verwendet werden können.
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, Sonderzeichen oder Freiräume im Dateinamen (verursachen evtl. Probleme in verschiedenen Systemumgebungen und mit entsprechender URL auch in verschiedenen Browsern)
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 aussagekräftige 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 Vorlagendialog und z.B. auch im Windows-Explorer angezeigt)
- Für umfangreichere Anleitungen (in separaten Dateien) muss noch eine Lösung gefunden werden
Arbeitsschritte
- Vorlage prüfen und in eine Kategorie einordnen
- Vorlage im entsprechenden Ordner ablegen (ggf. Ordner für neue Kategorie vorher anlegen)
- Dateiname korrigieren (Kleinbuchstaben, keine Umlaute und Sonderzeichen)
- Vorlage öffnen (Achtung - nicht "neues Dokument aus Vorlage erstellen")
- In die Dateieigenschaften Lizenzhinweis einfügen - originale Autoren / Copyright-Hinweise müssen erhalten bleiben
- In den Dateieigenschaften "Nutzerdaten verwenden" abschalten
- Vorlage speichern
- Vorlage normal öffnen (neues Dokument aus Vorlage) und auf Grundfunktionalität prüfen
- Vorlage in das cvs-Repository einfügen (unbedingt als Binary! - ggf. vorher neuen Ordner für Kategorie einfügen)
- script make_zips.sh ausführen
- zip-Archiv und Extension kontrollieren
- Vorlage, zip-Archiv und Extension commiten
Verbesserungsmöglichkeiten
Vorlagenkategorien
Die Vorlagenkategorien sollten neu strukturiert werden (z.B. enthält die Kategorie "Präsentationen" zu viele Vorlagen, viele davon sind eher nur Hintergründe). Randbedingungn / Hinweise:
- Die angezeigten Kategorien können unabhängig vom Verzeichnisnamen sein ( Non-code extensions#Localization of templates and template categories )
- bei einer Neustrukturierung sollten die im Programm vorgegebenen Kategorien verwendet werden ( Infos zu vorgegebenen Kategorien)
Extension
Da ab OpenOffice.org 2.2 Extensions als Dateityp im System registriert sind, ist dieses Format zur Installation zu bevorzugen (einfache Installation / Update per Doppelklick). Erweiterungsmöglichkeiten:
- Anpassen der Scripte, so dass "kleinere" Extensions gebaut werden können (eine Extension pro Kategorie)
- saubere Versionierung (zur Zeit müsste die Version manuell gesetzt werden)
- Lizenzhinweise bei Installation der Extension einbinden
- evtl. Verzeichnisstruktur als deutschsprachige Vorlage aufbauen ( Non-code extensions#Multi language templates extensions )
Generelle Informationen zu Extensions auf Aktuelle Specs zu Extensions:
- Minimal Support for Extension Dependencies
- Simple License for Extensions
- Extension Version Handling
- System integration for extensions
- Online update for extensions
- Extension Identifiers
Specs zu Extensions werden in der modulübergreifenden Spezifikations-Kategorie gelistet.
