Konventionen für dieses Wiki
Ziele des iDempiere Wikis
Ziel diese Wikis ist es iDempiere für Anwender und Entwickler zu beschreiben und Hilfestellungen zu den verschiedensten Themengebieten zu geben.
Diese Wiki lädt alle dazu ein iDempiere, die Dokumentation für iDempiere und insbesondere dieses Wiki weiter zu entwickeln. Nur eine starke Gemeinschaft ist dazu in der Lage ein so großes Projekt zu realisieren.
Hinweise / Beiträge
Über Hinweise von Anwendern, Programmieren und allen anderen Personen würden wir uns sehr freuen. Diese Hinweise helfen uns das Programm iDempiere und die Dokumentation zu verbessern.
Hierzu können auf jeder WIKI-Seite im Bereich Beiträge oder im Diskussionsbereich jeder Seite , auch ohne Verwendung der Konventionen, die entsprechenden Hinweise und Beschreibungen eingetragen werden. Diese Hinweise werden ggf. durch uns, entsprechend den Konventionen, in das WIKI an entsprechender Stelle eingefügt. Somit erhöht sich die Qualität und der Informationsgehalt des WIKIś
Offene Fragen können auf den Diskussionsseiten bei SourceForge oder im IRC FreeNode #idempiere gestellt werden.
Konventionen Einführung
Die Dokumentation für iDempiere wird von vielen Menschen in diversen Sprachen erstellt. Um ein einheitliches Erscheinungsbild, Suchmöglichkeiten usw. zu gewährleisten sind bestimmte Konventionen in der Dokumentation erforderlich.
Doppelte Artikel vermeiden
Vor dem Schreiben eines Artikels sind einige Vorarbeiten ratsam. Damit Artikel nicht mehrfach angelegt werden sollte überprüft werden, ob es nicht schon einen Artikel, evtl. unter einem anderen Namen, zu diesem Thema gibt. Dieser könnte ggf. ergänzt oder verbessert werden. Vorhandene Artikel können über die Suchfunktion oben rechts gefunden werden.
Oft existiert ein Artikel zu dem Themengebiet in einer anderen Sprache. Viele Artikel werden zuerst in englischer Sprache angelegt.
Namensgebung
Referenzseiten sind reine Kurzbeschreibungen der Fenster, Unterfenster und dessen Inhalt. Es wird meistens jedes einzelne Feld tabellarisch aufgezählt und mit einer „Standard“ Kurzerklärung versehen. Hierbei handelt es sich um sogenannte „Manpages“. Die Wiki-Seite trägt immer den Namen des Fensters in iDempiere und die Menü ID "Menü (ID-105)", "Baum (ID-163)". Ausnahmen bilden hier nur die wenig vorhandenen doppelt benannten Fenster.
Für Bilder der "Manpages" ist folgende Namensgebung vorgesehen:
- Fenstername
- Tabulatorname
- - Window im deutschen Wiki: Fenster
- - Process im deutschen Wiki: Prozess
- - Report im deutschen Wiki: Report
- - Tools im deutschen Wiki: Tools
- - Workflow im deutschen Wiki: Workflow
- (iDempiere 1.0.0).png (Versionsstand)
Business Partner - Customer - Window (iDempiere 1.0.0).png Geschäftspartner - Kunde - Fenster (iDempiere 1.0.0).png
Außer im deutschen Wiki wird grundsätzlich die englische Bezeichnung verwendet. Wenn gewünscht, und wenn Personen dazu bereit sind es entsprechend zu pflegen, kann natürlich auch die lokale Sprache verwendet werden.
Besonderheiten:
- Verwendete, aber verbotene Zeichen, im Dateisystem werden durch einen Unterstrich ausgetauscht z.B. "/ -> _"
- Wenn ein Fenster kein Tab hat wird diese Stelle nicht verwendet
- Bei einem zweiteiligen Fenster (für einen Schnappschuss zu groß) wird hinter den Dateinamen z.B. "-2 usw. " gesetzt. So bleibt der Zusammenhang zwischen den Fenstern erhalten.
Geschäftspartner - Kunde - Fenster (iDempiere 1.0.0)-2.png
- Bei einigen Fenstern verändern sich durch die Auswahl in einem Auswahlfeld oder eine bestimmte Eingabe in einem Feld die Eigenschaften des Fensters bzw. die Anzahl und Art der Eingabefelder. In diesem Fall kann die Auswahl in einem Auswahlfeld zum Dateinamen hinzugefügt werden:
Pack Out - Package Details - Data - Window (iDempiere 1.0.0).png PackOut - Erweiterungs-Details - Daten - Fenster (iDempiere 1.0.0).png
- Für den seltenen Fall einer Namensgleichheit wird hinter den Dateinamen, wie bei mehreren Fenstern, eine Nummer vergeben
Access Audit - Access Audit - Window (iDempiere 1.0.0)-2.png In der deutschen Übersetzung unterschiedlich benannt....
Spezielle Begriffe
Spezielle Begriffe und Abkürzungen sollten sparsam eingesetzt und gesondert erklärt werden. Ein allgemeines Verständnis kann nicht bei allen Lesern vorausgesetzt werden.
Einleitung
Ein Artikel sollte mit einer Einleitung bzw. einer kurzen Beschreibung (Ziel bzw. Zweck) des Themas beginnen. Dieser Text wird üblicherweise zuerst gelesen. Anhand dieses Textes entscheiden viele Personen ob es sich lohnt den gesamten Beitrag zu lesen, oder es besser zu lassen.
Der Leser sollte die Einleitung schnell erfassen können. Kurze und einfache Erklärungen sind in der Einleitung besser geeignet als lange verschachtelte Sätze.
Hauptteil des Artikels
Im Hauptteil des Artikels können durch Überschriften Absätze gebildet werden. Die Überschriften und Zwischenüberschriften erhöhen die Lesbarkeit des Artikels. Ab vier Überschriften wird oben auf der WIKI-Seite automatisch ein Inhaltsverzeichnis angelegt.
Zu lange Artikel können in weiterführende Artikel ausgelagert werden. Auf diesen Artikel kann per Link verwiesen werden.
Artikeltext
Ein Artikel soll Abläufe, Fakten und geprüfte Informationen enthalten. Wünsche und Verbesserungsvorschläge zu iDempiere gehören nicht ins Wiki. Diese Informationen werden z.B. bei SourceForge oder im IRC „FreeNode #idempiere ausgetauscht.
Formatierungen
In dem iDempiere Wiki können diverse Formatierungen verwendet werden. Hierzu empfiehlt es sich die Seite für Formatierungen bei Mediawiki zu besuchen.
Tabellenerstellung, Bilder und viele weitere allgemeine Hilfestellungen beim Umgang mit diesem Wiki stehen zur Verfügung.
Hier befinden sich ganz allgemeine Hilfen zum Mediawiki
Verwendete Formatierungen
Menüaufruf:
'''Menü → Systemadministration → Einstellungen allgemein → Einstellungen System → Menü'''
Menü → Systemadministration → Einstellungen allgemein → Einstellungen System → Menü
Verlinkung auf andere Seiten:
'''[[Deutsche_Sprache_installieren|Sprachversion installieren]]'''
Verlinkung auf Manpages:
'''''[[Baum_(Fenster_ID-163)|Manpage: Baum]]'''''
Eingabefelder <Eingabe>:
* Benutzer: <'''SuperUser'''> * Passwort: <'''System'''>
- Benutzer: <SuperUser>
- Passwort: <System>
Strukturierung des Wikis
An die Strukturierung des Wiki's werden bestimmte Anforderungen gestellt. Diese sind z.B.:
- Aufgaben orientierte Artikeltexte
- Ordnung nach Benutzerzielen und nicht nach Funktionen
- Beispiele mit Erklärungen
- In sich abgeschlossenen Vorgänge (Beispiele)
- Kurz und bündig beschreiben, zum eigenen Ausprobieren anregen.
- Fehlererkennung und Fehlerlösung direkt im Artikel platzieren.
- Auf Vorkenntnisse aufbauen, ggf. auf entsprechende Seiten verlinken
Verlinkungen
Links sollen deutlich sein und deutlich auf sein Ziel hinweisen.
Kategorien
Jeder Artikel sollte einer oder mehreren Kategorien zugeordnet werden. Bei Kategorien gibt es einige Dinge zu beachten. Um einen besser Übersichtlichkeit zu gewährleisten befindet sich eine Beschreibung auf der Seiten Kategorien einrichten
Vorlagen / Templates
Für wiederkehrende Texte und Formatierungen können die sehr praktischen Vorlagen eingesetzt werden. Auch zu diesem Thema können weitere Informationen auf der Seite Vorlagen verwenden abgerufen werden.
Hinweise und Bezugsquellen
Im unteren Teil der Seite sollten sich Links auf weitere Hinweise oder Bezugsquellen befinden.
Weitere Sprachen
Für jede eigenständige Sprache im iDempiere Wiki wird ein weiteres WIKI angelegt. Alle Wikis sind untereinander verbunden und können Verlinkungen zu Seiten in einer anderen Sprache enthalten. Ziel soll es sein die Informationen, wie auch bei WIKIPEDIA, in diversen Sprachen zur Verfügung zu stellen.
Hierzu würden wir uns über eine Unterstützung bei der Übersetzung in diverse Sprachen sehr freuen und bedanken uns bereits an dieser Stelle für die Hilfe.
Auf jeder Seite werden, wenn vorgegeben, auf der linken Seite die weiteren Sprachen zur Auswahl angeboten.
Im Quelltext des WIKI's wird meistens ganz oben die Sprache und aufzurufende Seite eingetragen:
[[en:Main Page]] [[de:Hauptseite]] [[fr:Accueil]] [[pl:Strona główna]] [[zh:首页]] [[ja:メインページ]]
Im Stammwiki befinden sich keine Beiträge zu iDempiere. Es werden im Stammwiki hauptsächlich grundlegende Einstellungen durchgeführt und die Benutzerverwaltung realisiert.
Verhaltensregeln im WIKI
Bitte beachten Sie die Verhaltensregeln im Wiki.
Zur Dokumentation anregen
Dokumentation, insbesondere Entwickler-Dokumentation, ist einer der größte Schwäche von Compiere und ADempiere. Auch an diesem Punkt möchte iDempiere ansetzen und zusätzlich zu den System- und Programmerweiterungen, eine umfangreiche Dokumentation, Tipps und Tricks, Tutorials und Howtos anbieten. Lesen Sie hierzu bitte auch den gesonderten Beitrag.
