DE/In der Dokumentation verwendete Konventionen
⇐ DE/Inhaltsverzeichnis{{#if: | | [[{{{2}}}]] }}{{#if: | | [[{{{3}}}]] }}{{#if: | | [[{{{4}}}]] }}{{#if: | | [[{{{5}}}]] }} | DE/In der Dokumentation verwendete Konventionen{{#if: Sources of Other Information| | Sources of Other Information }} ⇒
Die ADempiere - Dokumentation ist ein gemeinsam produziertes Werk mit Beiträgen von Menschen auf der ganzen Welt. All diesem Menschen haben das Bestreben Ihnen zu helfen. Die Durchsetzung eines gemeinsamen Schreibstils in einer so großen Gruppe ist sehr schwierig. In diesem Artikel werden einige Ziel zur Erstellung und dem lesen der Dokumentation beschrieben.
Im Allgemeinen werden die Standard-Wiki-mark-up Styles verwendet um Informationen darzustellen.
Code-Beispiele werden als vorformatierten Text vorgestellt werden.
Die Seite kann durch Eingabe des Titels in der Suchfunktion in der linken Seitenleiste und einem Klick auf GO bzw. suchen wiedergefunden werden.
Bei der Suche wird zwischen Groß- und Kleinschreibung unterschieden.
Seiten können auch Kategorien am unteren Rand anzeigen.
Sie können auf die Kategorie klicken, um eine Liste von Seiten dieser Kategorie anzuzeigen.
Die folgenden Vorlagen werden verwendet, um spezifische Informationen zu präsentieren:
Note: Ein Hinweis enthält zusätzliche Informationen oder Highlights ein wichtiger Punkt in dem Text.
Caution! weist auf ein potentielles Problem hin das schwer zu beheben ist wenn es auftritt..
Code-Beispiele werden als vorformatierten Text vorgestellt werden.
Bereitgestellte Beispiel und Einträge, die vom Benutzer ersetzt werden, werden in spitze Klammern eingeschlossen <so wie hier>
Zum Beispiel, "<Geben Ihren Namen hier ein> ist ein prima Mitarbeiter!".
Hinweise auf Anwendung Menüauswahl (Datei, Bearbeiten, Ansehen, Go, Tools, Fenster, Hilfe...)
wird als Folge von Menüoptionen in fetter Schrift dargestellt. Zum Beispiel Tools{{#if: Preferences | →Preferences }}{{#if: | → }}{{#if: | → }}.
Bezugnahmen auf den ADempiere Standard Menübaum werden in fett und kursiv durch doppelten spitzen Klammern getrennt.
Zum Beispiel: System Admin{{#if: Data | » Data }}{{#if: Data Import | » Data Import }}{{#if: Import Loader Format | » Import Loader Format }}{{#if: | » }}
Fenster werden mit dem Begriff Window bezeichnet und ein Link zu den zugehörigen Manual-Seite gesetzt. Zum Beispiel: {{#if: Business Partner|Business Partner|BusinessPartner }} Window
Tabs innerhalb eines Fensters werden mit dem Begriff Tab und einen Link zu den zugehörigen Manual-Seite gesetzt. Zum Beispiel: {{#if: Customer|Customer|Customer }} Tab.
Spezielle Anleitungen werden als manpage * Name where * Buchstaben-Code für die Art der Fensters versehen. Siehe auch: Category:Manual für Einzelheiten.
Die Begriffe "Benutzer - user", "System-Administrator" und "Entwickler - developer" sollte nicht allzu literarisch genommen werden, da die Unterschiede verwischen. Sie dienen dazu zu kategorisieren und zu gruppieren.
Originalseite: http://www.adempiere.com/Conventions_Used_in_the_Documentation
