Bearbeiten von „Vorlage:Item/Dokumentation“

<noinclude>{{Dokumentationsseite|Vorlage:Item}}</noinclude>

Diese Vorlage wird für jedes Item, das im Wiki dokumentiert ist, genutzt und sorgt für ein einheitliches Layout.

== Verwendung ==
Diese Vorlage wird mit '''<tt><nowiki>{{subst:</nowiki>{{ucfirst:{{#titleparts:{{BASEPAGENAME}}|1}}}}<nowiki>}}</nowiki></tt>''' eingebunden.


=== Zur Verwendung der Dokumentation ===
Parmeter sind '''fett gedruckt'''. Paremeter-Werte in <code>Code-Schriftart</code>. Hat ein Paremeter den Standardwert <code>none</code> erzeugt er keine Ausgabe, wenn der nicht gesetzt ist oder den Wert <code>none</code> hat. Hat der Parameter keinen Standardwert erzeugt er zwingend eine Ausgabe, außer die Dokumentation sagt explizit etwas anderes. Der Parameterwert <code>ja</code> ist Konvention für Boolesche Parameter.

== Parameter ==
* 1 : Typ des Items (AWaffe, VWaffe, Halsschmuck, Schusswaffe, Zauber, Buch, Gericht, Pflanze, Item). ''Groß- und Kleinschreibung ist irrelevant.'' ''Standard:'' <code>item</code>
* 2 : Den Wert auf 'RP' setzen, damit die Vorlage <nowiki>Erst in RP</nowiki> statt <nowiki>Erst in W1</nowiki> einbindet. '''Standard:''' <code>W1</code>
* '''Bild:''' Bildlink des Items (welt1 als Server nutzen). ''Standard:'' keiner (Bücher: http://welt1.freewar.de/freewar/images/items/buch.gif, Gerichte: [[Datei:Gericht.gif]])
* '''Beschreibung:''' Die Beschreibung, die das Item trägt. ''Standard:'' keiner
* '''Einbaudatum:''' in einem maschinenlesbaren Format (z.B. ''d.m.Y (Tag.Monat.Jahr)'') ''Achtung:'' Entspricht das Datum dem heutigen wird die Vorlage als unformatiert gekennzeichnet. Dies löst sich automatisch am nächsten Tag. ''Standard:'' keiner
* '''Name:''' Falls das Item in Freewar anders geschrieben werden sollte als der Artikeltitel, den richtigen Namen angeben. ''Standard:'' keiner
{{EnglischEinblendung/Dokumentationsbaustein}}
* '''EinkPreis:''' Falls das Item in einem [[Shop]] gekauft werden kann, den Einkaufs-[[Standardpreis]] angeben, sonst <tt>none</tt>. ''Standard:'' <code>none</code>
* '''VerkPreis:''' Der Verkaufs-[[Standardpreis]] in einem [[Shop]]. ''Standard:'' keiner
* '''NatlaPreis:''' Der Preis des Items im Shop der Natla. Erzeugt automatisch einen Eintrag unter Herkunft. ''Standard:'' <code>none</code>
* '''CP:''' Der Preis des Items im Haus der Clan-Kriege. ''Standard:'' <code>none</code>
* '''RepPreis:''' Die Standard-Reparaturkosten. ''Standard:'' <code>none</code>
* '''MarktWert:''' Sollte ein Marktwert bekannt sein, lässt sich dieser hiermit ergänzen. ''Standard:'' <code>none</code>
* '''MarktPreisSeite:''' Sollte der Marktwert vom Verkaufspreis abweichen, lässt sich mit <code>ja</code> ein Link auf eine entsprechende Marktpreisseite erstellen. ''Standard:'' <code>none</code>
* '''Versionen:''' Hier frühere Versionen des Items eintragen, die noch ''existieren''! Eventuell Verweise auf den zugehörigen Antiqitäten-Artikel, sollten die Änderung einen extra Artikel rechtfertigen. ''Standard:'' <code>none</code>
* '''Geschichte:''' Wurden Veränderungen an dem Item durchgeführt, die nicht frühere Versionen erzeugt haben. ''Standard:'' <code>none</code>

=== Parameter, die hauptsächlich für Anforderungen relevant sind ===
* '''Rasse''': Der Name der Rasse, die das Item nur anwenden kann. ''Standard:'' <code>none</code>
* '''Mindestintelligenz''': Benötgte Intelligenz, die in der Beschreibung aufgeführt wird. Zahl wird automatisch formatiert. ''Standard:'' <code>none</code>
* '''Mindeststärke''': Benötgte Stärke, die in der Beschreibung aufgeführt wird. Zahl wird automatisch formatiert. ''Standard:'' <code>none</code>
* '''Mindestakademielimit''': Benötgtes Akademielimit, die in der Beschreibung aufgeführt wird. Zahl wird automatisch formatiert. ''Standard:'' <code>none</code>
* '''Phasenenergie''': Benötigte/Verbrauchte Phasenenergie bei Benutzung des Items. Zahl wird automatisch formatiert. Ereugt automatisch eine Ausgabe unter Sonstiges. ''Standard:'' <code>none</code>
* '''Verräter''': <code>ja</code> wenn das Item nur von Verrätern angewendet werden kann. Zeigt automatisch eine entsprechende Kategorie an. ''Standard:'' <code>none</code>

=== Parameter, die unter Funktion auftauchen ===
* '''Funktion:''' Für jede Funktion, die nicht von der Vorlage angezeigt wird. Die Vorlage erzeugt automatisch den Eintrag ''keine''. ''Standard:'' keiner
* '''Quest:''' Sollte das Item zu einer Quest gehören, muss hier der Name der Quest eingetragen werden. ''Standard:'' <code>none</code>
* '''ZutatGericht:''' Namen der Gerichte, für die dieses item an der Feuerstelle benötigt wird als Wiki-Liste. Trägt den Artikel automatisch in eine entsprechende Kategorie ein. ''Standard:'' <code>none</code>
* '''ZutatZb:''' Namen der Zauber, für die dieses Item am Zauberlabor benötigt wird als Wiki-Liste. Trägt den Artikel automatisch in eine entsprechende Kategorie ein. ''Standard:'' <code>none</code>
* '''ZutatHwh:''' Namen der Items, für die dieses Item an der Handwerkshalle benötigt wird als Wiki-Liste. Trägt den Artikel automatisch in ein entsprechende Kategorie ein. ''Standard:'' <code>none</code>
* '''ZutatChaoslabor:''' <code>ja</code>, falls das Item am Chaoslabor benötigt wird. Trägt den Artikel automatisch in eine entsprechende Kategorie ein. ''Standard:'' <code>none</code>
* '''ZutatWerkstatt:''' Namen der Items, für die dieses Item in der Werkstatt benötigt wird als Wiki-Liste. Trägt den Artikel automatisch in eine entsprechende Kategorie ein. ''Standard:'' <code>none</code>
* '''ZutatLuxusmanufaktur:''' <code>ja</code>, falls das Item in der Luxusmanufaktur benötigt wird. Trägt den Artikel automatisch in eine entsprechende Kategorie ein. ''Standard:'' <code>none</code>

=== Parameter, die hauptsächlich für Sonstiges relevant sind ===
* '''Sonstiges:''' Für sonstige Daten, die nicht über die Vorlage angezeigt werden. Die Vorlage rzeugt automatisch den Eintrag ''nichts''. ''Standard:'' keiner
* '''Haltbarkeit:''' Die Haltbarkeit des magischen Items. Der sollte grammatikalisch in den Satz <code>Das magische Item zerfällt nach {{{Haltbarkeit}}}.</code> passen. Der Parameter erzeugt automatisch einen Hinweis unter Beschreibung und eine entsprechende Kategorie. ''Standard:'' <code>none</code>
* '''Verlaengert: ''' <code>ja</code>, falls das Item schon magisch verlängert ist, wenn es entsteht. ''Standard:'' <code>none</code>
* '''Zauberlabor:''' Namen der Items, aus denen dieses Item am Zauberlabor hergestellt wird als Wiki-Liste. Trägt den Artikel automatisch in eine entsprechende Kategorie ein und erzeugt eine Ausgabe unter Herkunft. ''Standard:'' <code>none</code>
* '''LaborXP:''' Anzahl der benötigten XP für die Herstellung dieses Items im Zauberlabor. Keine Anzeige wenn '''Zauberlabor''' nicht gesetzt ist. ''Standard:'' keiner
* '''LaborSt:''' benötigte Stufe in Labortechnik für die Herstellung dieses Items im Zauberlabor. Keine Anzeige wenn '''Zauberlabor''' nicht gesetzt ist. ''Standard:'' keiner
* '''Handwerk:''' Namen der Items, aus denen dieses Item an der Handwerkshalle hergestellt wird als Wiki-Liste. Trägt den Artikel automatisch in eine entsprechende Kategorie ein und erzeugt eine Ausgabe unter Herkunft. ''Standard:'' <code>none</code>
* '''HandwerkPE:''' Anzahl der benötigten Phasenenergiepunkte für die Herstellung dieses Items an der Handwerkshalle. Keine Anzeige wenn '''Handwerk''' nicht gesetzt ist. ''Standard:'' keiner
* '''HandwerkSt:''' Benötigte Stufe in Labortechnik für die Herstellung dieses Items an der Handwerkshalle (benötigte XP werden daraus automatisch berechnet). Keine Anzeige wenn '''Handwerk''' nicht gesetzt ist. ''Standard:'' keiner
* '''Werkstatt:''' Namen der Rohstoffe/Materialien etc, aus dem dieses Item in der Werkstatt hergestellt wird als Wiki-Liste. Trägt den Artikel automatisch in eine entsprechende Kategorie ein und erzeugt eine Ausgabe unter Herkunft. ''Standard:'' <code>none</code>
* '''Luxusmanufaktur:''' Namen der Items, aus denen dieses Item in der Luxusmanufaktur hergestellt wird als Wiki-Liste. Trägt den Artikel automatisch in eine entsprechende Kategorie ein und erzeugt eine Ausgabe unter Herkunft.  ''Standard:'' <code>none</code>

=== Parameter, die hauptsächlich für Herkunft relevant sind ===
* '''AP:''' Wenn man das Item im [[Haus der Aufträge]] kaufen kann gehört hier ein <code>ja</code> hin, die Anzahl Auftragspunkte kommen wie gewohnt in den Parameter '''EinkPreis'''. Erzeugt Eintrag bei Herkunft und den entsprechenden Kategorie-Link. ''Standard:'' <code>none</code>
* '''Auktion:''' Sollte das Item über die [[Auktionshalle]] zu kaufen sein, muss hier <code>ja</code> eingetragen werden. ''Standard:'' <code>none</code>
* '''Ausgrabung:''' Sollte das Item automatisch vergraben werden, muss hier <code>ja</code> eingetragen werden. ''Standard:'' <code>none</code>
* '''Chaoslabor:''' Sollte das Item im Chaoslabor hergestellt werden können, muss hier <code>ja</code> eingetragen werden. Erzeugt automatisch einen Eintrag in Sonstiges. ''Standard:'' <code>none</code>

=== Für bestimmte Itemtypen relevante Parameter ===
* '''Stärke:''' Die Stärke des Items wird in der Beschreibung mit der Bezeichnung des Itemtyps angzeigt. Bei Waffen erzeugt der Parameter ''immer'' eine Ausgabe unter Funktion. ''Standard:'' <code>none</code>
* '''Stufe:''' Die Stufe des Items wird in der Bezeichnung bei Zaubern und Halsschmuck angezeigt. ''Standard:'' <code>none</code> (Bücher, Gericht, Schusswaffe: <code>0</code>)
* '''HideNav:''' <code>true</code> oder <code>True</code>, wenn die Navigationsleiste (bei Waffen) ausgeblendet werden soll. ''Standard:'' keiner

==== Bücher ====
Bei Büchern werden automatisch die Beschreibungszusätze bezüglich der erlernten Fähigkeit und der Auflösung des Buches hinzugefügt. 
Die folgenden Parameter erzeugen nur eine korrekte Ausgabe, wenn das Item (implizit oder explizit) als Buch zählt. 
* '''Fähigkeit''': Der Artikelname der erlernten Charakterfähigkeit. Erzeugt automatisch einen Eintrag unter Anforderungen, Funktion und Beschreibung. ''Standard:'' keiner
* '''FähigkeitName''': Name der erlernten Fähgikeit. ''Standard:'' Wert von Parameter <code>Fähigkeit</code>
* '''Max:''' Maximalstufe der erlernten Charakterfähigkeit. ''Standard:'' keiner

==== Pflanze ====
* '''Vorkommen:''' Alias für '''Herkunft'''. ''Standard:'' leer 
Die folgenden Parameter erzeugen nur eine korrekte Ausgabe, wenn das Item (implizit oder explizit) als Pflanze zählt.
* '''min-Pflanzenkunde:''' Die Mindeststufe in Pflanzenkunde, um die Pflanze zu ernten. ''Standard:'' keiner
* '''max-Pflanzenkunde:''' Die Maximalstufe in Pflanzenkunde, um die Pflanze zu ernten. ''Standard:'' <code>none</code>
* '''Zeit:''' Die Zeit bis die Pflanze verwelkt ist, sollte sie nicht geerntet werden. ''Standard:'' <code>24 Stunden</code>

==== Schusswaffe ====
Die folgenden Parameter erzeugen nur eine korrekte Ausgabe, wenn das Item (implizit oder explizit) als Schusswaffe zählt.
* '''kein_pfeil:''' <code>ja</code>, wenn kein Pfeil benötigt/verbraucht wird. ''Standard:'' <code>none</code>
* '''kein_npc:''' <code>ja</code>, wenn man mit dieser Schusswaffe NPC keine Lebenspunkte abziehen kann. ''Standard:'' <code>none</code>
* '''Charf:''' Die benötigte Stufe in Schusswaffen, um das Item zu verwenden. ''Standard:'' keiner

==== Gericht ====
Die folgenden Parameter erzeugen nur eine korrekte Ausgabe, wenn das Item (implizit oder explizit) als Gericht zählt.
* '''Anzahl der geheilten Lebenspunkte:''' Erzeugt den entsprechenden Eintrag unter Funktion (mit Chattext) nur wenn es sich explizit um ein Gericht handelt. ''Standard:'' keiner
* '''InvariableHeilung:''' Setzen falls die Anzahl der geheilten Lebenspunkte unabhängig von der Stufe der Charakterfähigkeit Kochkunst ist. ''Standard:'' <code>none</code>
* '''Minimalpreis:''' Der Minimalpreis des Items, den das seltsame Gasthaus zahlt. ''Standard:'' <code>none</code>
* '''Maximalpreis:''' Der Minimalpreis des Items, den das seltsame Gasthaus zahlt. Angezeigt nur wenn '''Minimalpreis''' gesetzt ist. ''Standard:'' keiner
* '''Benötigte Items:''' Die für die Herstellung an der Feuerstelle benötigten Items als Wiki-Liste. ''Standard:'' keiner

==== Zauber ====
* '''Logout:''' <code>ja</code>, wenn der Zauber nach dem Logout seine Wirkung verliert. ''Standard:'' <code>none</code>

=== für Unique-Items relevante Parameter ===
* '''Unique:''' Steuert explizit ob das Item als Unique oder nicht behandelt wird (<code>true</code> eintragen). Implizit wird das über den Namespace erkannt (''Unique:''). Erzeugt automatisch einen Eintrag unter Beschreibung. ''Standard:'' <code>none</code>
Die folgenden Parameter erzeugen nur eine korrekte Ausgabe, wenn das Item (implizit oder explizit) als Unique zählt.
* '''Welt:''' Die Welt in der das Item existiert. Ist nur eine Welt verlinkt, sollte der Artikel automatisch in die passende Unique-Kategorie eingetragen werden. ''Standard:'' keiner
* '''Beisitzer:''' Besitzer des Items. ''Standard:'' <code>''unbekannt''</code>
* '''Auftraggeber:''' Der Auftraggeber des Uniques. ''Standard:'' <code>none</code>
* '''Admin:''' Der Ersteller des Uniques. ''Standard:'' <code>none</code>
* '''Basis:''' Das Basisitem. ''Standard:'' <code>none</code>
* '''Datum:''' Das Erstellungsdatum des Items. ''Standard:'' <code>none</code>
=== für Antiquitäten relevante Parameter ===
* '''Antiquität:''' Steuert explizit ob das Item als Antiquität oder nicht behandelt wird (<code>true</code> eintragen). Implizit wird das über den Namespace erkannt (''Antiquität:''). Erzeugt automatisch einen Eintrag unter Beschreibung. ''Standard:'' <code>none</code>
Die folgenden Parameter erzeugen nur eine korrekte Ausgabe, wenn das Item (implizit oder explizit) als Anitquität zählt.
* '''Beisitzer:''' Besitzer der alten Version. ''Standard:'' keiner
* '''Nachfolger:''' Nachfolger des Items. ''Standard:'' keiner
* '''Unterschied:''' Unterschiede zur aktuellen Version. ''Standard:'' keiner