Hilfe:Wiki-Syntax

aus CommerceWiki, dem Wiki zum S2I-Commerce-Framework und der S2I-Software-Standardisierung

Hier findest du eine Kurzanleitung zur Syntax in diesem Wiki.

Bild:note.png

Hinweis: Da dieses Wiki ein MediaWiki wie die Wikipedia ist, kannst du auch nahezu alle Kenntnisse im Schreiben von Wikipedia-Artikeln auf dieses Wiki übertragen.

[bearbeiten]

Einfaches Beispiel

So kann ein einfacher Artikel aussehen: 

Auf dieser Seite findest du Neuigkeiten über das Commerce-Framework,
welche Features und Fixes demnächst geplant sind,
und was vor kurzer Zeit bereits umgesetzt worden ist.
 
== Neue Funktionen ==
 
Die folgenden Features und Fixes sind in letzter Zeit durchgeführt worden
und können in der neuesten Version des Frameworks gefunden werden.
Die Arbeiten sind sortiert nach Fertigstellungsdatum, die neueste Änderung steht oben.
 
Alle Änderungen, sowie Information darüber, in welcher Version welche Änderung
umgesetzt wurde und welche Migrationsarbeiten notwendig sind,
findest du in der [[Versionshistorie]].
 
* Das Commerce-Framework buildet jetzt mit [[Glossar:Maven|Maven]].
* Die reflektiveren [[Glossar:Attribut|Attribute]] sind komplett überarbeitet worden.
 
== Geplante Arbeiten ==
 
Die folgenden Features und Fixes sind geplant, demnächst umgesetzt zu werden.
Die Arbeiten sind sortiert in der Reihenfolge, in der sie bearbeitet werden sollen,
die dringende Neuigkeit steht oben.
 
Weitere geplante Tasks findet ihr in [https://webperfect.s2neueinformatik.de Jira].
 
* Gliederung der Commerce-Frameworks in verschiedene Komponenten.

So würde es erscheinen:

Auf dieser Seite findest du Neuigkeiten über das Commerce-Framework, welche Features und Fixes demnächst geplant sind, und was vor kurzer Zeit bereits umgesetzt worden ist.

[bearbeiten]

Neue Funktionen

Die folgenden Features und Fixes sind in letzter Zeit durchgeführt worden und können in der neuesten Version des Frameworks gefunden werden. Die Arbeiten sind sortiert nach Fertigstellungsdatum, die neueste Änderung steht oben.

Alle Änderungen, sowie Information darüber, in welcher Version welche Änderung umgesetzt wurde und welche Migrationsarbeiten notwendig sind, findest du in der Versionshistorie.

  • Das Commerce-Framework buildet jetzt mit Maven.
  • Die reflektiveren Attribute sind komplett überarbeitet worden.
[bearbeiten]

Geplante Arbeiten

Die folgenden Features und Fixes sind geplant, demnächst umgesetzt zu werden. Die Arbeiten sind sortiert in der Reihenfolge, in der sie bearbeitet werden sollen, die dringende Neuigkeit steht oben.

Weitere geplante Tasks findet ihr in Jira.

  • Gliederung der Commerce-Frameworks in verschiedene Komponenten.
[bearbeiten]

Kurzreferenz

Kleiner- und größergeschriebenen Text, harte Zeilenumbrüche mit <br/>-Tags, Absätze durch doppelte oder mehrfache Leerzeilen, Farben und ähnliche Spezialformatierungen solltest du nicht verwenden.

Alternativ bietet MediaWiki hierfür u.a. die folgenden Notationen. Weitere Hilfe findest du auf den Hilfeseiten der Wikipedia zum Thema Formatierungen und Listen und Tabellen

Was du schreibst Wie es erscheint

Normaler Text wird so dargestellt, wie du ihn eingibst. Mit einer Leerzeile

erzeugst du einen Absatz.

Normaler Text wird so dargestellt, wie du ihn eingibst. Mit einer Leerzeile

erzeugst du einen Absatz.

Um auf ein anderes Dokument wie die [[Hauptseite]] zu verlinken, setzt du es in doppelte eckige Klammern.

Wenn der Name des Artikels syntaktisch oder logisch nicht in den Satz passt, kannst du den Text, der erscheinen soll, nach einem senkrechten Strich dahinter setzen:

[[Hauptseite|Inhaltsverzeichnis]]

Um auf ein anderes Dokument wie die Hauptseite zu verlinken, setzt du es in doppelte eckige Klammern.

Wenn der Name des Artikels syntaktisch oder logisch nicht in den Satz passt, kannst du den Text, der erscheinen soll, nach einem senkrechten Strich dahinter setzen:

Inhaltsverzeichnis

Externe Dokumente oder andere Wikis referenzierst du mit einfachen eckigen Klammern und dem Klarnamen, mit Leerzeichen getrennt, dahinter:

[http://www.google.de Google] bzw. [http://dev Dev-Site]]

Externe Dokumente oder andere Wikis referenzierst du mit einfachen eckigen Klammern und dem Klarnamen, mit Leerzeichen getrennt, dahinter:

Google bzw. CommerceWiki

Wenn du 'internal' dahinter schreibst, wird kein neues Fenster geöffnet:

[http://www.google.de Google|internal] bzw. [http://dev Dev-Site|internal]]

Wenn du 'internal' dahinter schreibst, wird kein neues Fenster geöffnet:

Google bzw. CommerceWiki

== Überschrift ==

==== Überschrift 2 ====

[bearbeiten]

Überschrift

[bearbeiten]

Überschrift 2

'''fett'''

fett

* eins
* zwei
** zwei-eins
** zwei-zwei
* drei

  • eins
  • zwei
    • zwei-eins
    • zwei-zwei
  • drei

# eins
# zwei
## zwei-eins
## zwei-zwei
# drei

  1. eins
  2. zwei
    1. zwei-eins
    2. zwei-zwei
  3. drei

Vom normalen Text
: eingerückt
:: doppelt eingerückt
# In Kombination
#: mit Listen
#:* verschachtelt

Vom normalen Text

eingerückt
doppelt eingerückt
  1. In Kombination
    mit Listen
    • verschachtelt

; Definitionsliste
: Eine Definition
: Eine andere Definition

; Begriff
: Definition des Begriffs

Definitionsliste
Eine Definition
Eine andere Definition
Begriff
Definition des Begriffs

 Maschinenschrift (z.B. Source-Code)
 beginnt mit einem Leerzeichen
   oder mehreren Leerzeichen
 am jedem Zeilenanfang 

Maschinenschrift (z.B. Source-Code)
beginnt mit einem Leerzeichen 
  oder mehreren Leerzeichen
an jedem Zeilenanfang

Bild-Thumbnails rechts neben den nachfolgenden Text, mit Titel:

[[Bild:sunset.jpg|thumb|Sonnenuntergang]]

Dies ist ein bisschen Text, der daneben stehen soll. Er fließt automatisch um das Bild, und wenn das Bild zu Ende ist, geht es ganz normal weiter.

Man kann aber auch mit "clear" Platz lassen, bis das Bild zu Ende ist, wenn der Text thematisch nicht mehr zu dem Bild passt:
{{clear}}

Hier geht's weiter mit Text, der nicht mehr neben dem Bild steht.

Bild-Thumbnails rechts neben den nachfolgenden Text, mit Titel:
Sonnenuntergang
vergrößern
Sonnenuntergang (Anklicken zum Vergrößern)

Dies ist ein bisschen Text, der daneben stehen soll. Er fließt automatisch um das Bild, und wenn das Bild zu Ende ist, geht es ganz normal weiter.

Man kann aber auch mit "clear" Platz lassen, bis das Bild zu Ende ist, wenn der Text thematisch nicht mehr zu dem Bild passt:

Hier geht's weiter mit Text, der nicht mehr neben dem Bild steht.

Vollflächige Bilder ohne Text daneben:

[[Bild:sunset.jpg|framed|left|Sonnenuntergang]] {{clear}}

Hier geht's weiter.

Vollflächige Bilder ohne Text daneben:
Sonnenuntergang
Sonnenuntergang (Anklicken zum Vergrößern)

Hier geht's weiter.

Maschinenschrift innerhalb einer Zeile mit Code-Tags: <code>MyProgram.java</code>

Maschinenschrift innerhalb einer Zeile mit Code-Tags: MyProgram.java

Maschinenschrift innerhalb einer Zeile mit Code-Tags: <code>MyProgram.java</code>

Maschinenschrift innerhalb einer Zeile mit Code-Tags: MyProgram.java
Tabellen:

{|
!Überschrift 1
!Überschrift 2
|-
|Zeile 1, Spalte 1
|Zelle 1, Spalte 2
|-
|Zeile 2, Spalte 1
|Zelle 2, Spalte 2
|-
|Zeile 3, Spalte 1
|Zelle 3, Spalte 2
|}
Überschrift 1 Überschrift 2
Zeile 1, Spalte 1 Zelle 1, Spalte 2
Zeile 2, Spalte 1 Zelle 2, Spalte 2
Zeile 3, Spalte 1 Zelle 3, Spalte 2

<!-- unsichtbarer Kommentar-->

[bearbeiten]

Wiki-Updater

Im Handbuch erfolgt die Kapitelnavigation und die Verlinkung zwischen den Abschnitten automatisch. Hierzu ruft ihr das Tool Commerce-Wikiupdater auf. Es analysiert das Inhaltsverzeichnis und sortiert alle dort erwähnten Kapitel und Abschnitte anhand der Listenaufzählung.

Den Wiki-Updater ruft ihr über das Ant-Target 'update-dev-toc' im Commerce-Framework-Projekt auf.

Von "http://dev.sinnerschrader.de/CommerceWiki/index.php/Hilfe:Wiki-Syntax"
'Persönliche Werkzeuge
Seitenfunktionen