K (→Aufbau: Artikelbenennung) |
|||
| (10 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
== Vorwort == | == Vorwort == | ||
Diese Richtlinien erklären, wie im Knuddels-Wiki | Diese Richtlinien erklären, wie im Knuddels-Wiki Funktionsartikel auszusehen haben. Ein einheitliches Auftreten fördert neben dem seriösen Erscheinen auch ein effizienteres, auf Gewohnheit basierendes Suchen nach gezielten Informationen. Eine Übersicht aller Funktionen ist übrigens [[Funktionsübersicht|hier]] zu finden. | ||
Der Artikel zur fiktiven Funktion [[:/beispiel]] demonstriert das ganze. | Der Artikel zur fiktiven Funktion [[:/beispiel]] demonstriert das ganze. | ||
== Aufbau == | == Aufbau == | ||
Im Folgenden werden die einzelnen Abschnitte der Funktionsartikel erklärt. | Die Seite ist grundsätzlich immer nach dem Namen der Funktion ohne Parameter benannt (z.B. "/beispiel" statt "/beispiel test"). Eine Ausnahme bilden hier ausschließlich die Artikel der Funktion [[:/h]], welche mit Parameter im Seitennamen benannt werden. Im Folgenden werden die einzelnen Abschnitte der Funktionsartikel erklärt. | ||
=== Allgemeines === | === Allgemeines === | ||
Im Abschnitt <nowiki>== Allgemeines ==</nowiki> sollten die Grundzüge der Funktion erklärt werden. Mit anderen Worten sollte hier enthalten sein, auf was sich die Funktion bezieht und wie/wann sie anzuwenden ist. Der Abschnitt sollte möglichst genau beschreiben, was die Funktion bewirkt und wie sie sich äußert. | Im Abschnitt <nowiki>== Allgemeines ==</nowiki> sollten die Grundzüge der Funktion erklärt werden. Mit anderen Worten sollte hier enthalten sein, auf was sich die Funktion bezieht und wie/wann sie anzuwenden ist. Der Abschnitt sollte möglichst genau beschreiben, was die Funktion bewirkt und wie sie sich äußert. Bei einigen Funktionen macht es auch Sinn ein Bild anzufügen. | ||
=== | === Voraussetzungen === | ||
Der Abschnitt <nowiki>== | Der Abschnitt <nowiki>== Voraussetzungen ==</nowiki> sollte aufführen was nötig ist um die Funktion auszuführen. In den meisten Fällen wird dies ein Mindeststatus oder ein Smiley sein, es kann jedoch auch sein, dass man sich in einem bestimmten Channel aufhalten muss, oder dass eine betroffene Person eine bestimmte Eigenschaft aufweist oder ähnliches. Ebenfalls zu beachten ist, dass es negierte Voraussetzungen gibt, wie bspw. '''Channel darf nicht moderiert sein''' oder ähnliches. Ein einleitender Fließtext sollte hier im Regelfalle vorhanden sein, allerdings ist es bei mehreren Voraussetzungen auch in Ordnung eine Liste anzulegen. Ebenfalls sollte darauf eingegangen werden, wenn verschiedene Parameter unterschiedliche Anforderungen haben. (Bsp: /cm stat kann jeder LCler eines Channels machen, alle anderen /cm Funktionen nur CMs) | ||
=== Syntax === | === Syntax === | ||
Unter <nowiki>== Syntax==</nowiki> werden mit <nowiki> === Unterpunkten ===</nowiki>alle | Unter <nowiki>== Syntax==</nowiki> werden mit <nowiki> === Unterpunkten ===</nowiki> alle Möglichkeiten die Funktion anzuwenden aufgeführt. Hierbei stehen großgeschriebene Wörter für zwingend notwendige Parameter, wie zB. /kiss NICK, während großgeschriebene Parameter in eckigen Klammern für optionale Parameter stehen. (Bsp: /dice [ZAHL]). Das ganze lässt sich auch auf komplexe Funktionen anwenden, wobei sich ab und an anbietet ein Beispiel dazu zu schreiben. | ||
=== (Mögliche Sätze) === | |||
Im Falle von Chatmakros (/freu, /welcome usw.) soll hier noch ein zusätzlicher Abschnitt hin in welchem eine Liste aller möglichen Ausgaben des Makros enthalten sein soll. | |||
=== Weiterführende Informationen === | === Weiterführende Informationen === | ||
Abschließend werden unter der Überschrift <nowiki>== Weiterführende Informationen==</nowiki> in Stichpunkten wie es bei vielen Artikeln geläufig ist verwandte Artikel aufgezählt. Dies können andere Funktionen sein, | Abschließend werden unter der Überschrift <nowiki>== Weiterführende Informationen==</nowiki> in Stichpunkten wie es bei vielen Artikeln geläufig ist verwandte Artikel aufgezählt. Dies können andere Funktionen sein, teilweise sogar Funktionen mit inhaltlicher Überschneidung (/afk <=> /away) oder auch ganz andere Artikel (zB. MyChannel bei der /mychannel Funktion). | ||
Ebenfalls muss hier mittels <code><nowiki>[[Kategorie:Chatfunktion|SORTIERUNG]]</nowiki></code> die Funktion kategorisiert werden. Für SORTIERUNG muss der Name der Funktion ohne führenden Slash ( / ) eingesetzt werden, also bspw. <nowiki>[[Kategorie:Chatfunktion|away]]</nowiki>. | |||
Aktuelle Version vom 5. November 2022, 12:28 Uhr
Vorwort
Diese Richtlinien erklären, wie im Knuddels-Wiki Funktionsartikel auszusehen haben. Ein einheitliches Auftreten fördert neben dem seriösen Erscheinen auch ein effizienteres, auf Gewohnheit basierendes Suchen nach gezielten Informationen. Eine Übersicht aller Funktionen ist übrigens hier zu finden.
Der Artikel zur fiktiven Funktion /beispiel demonstriert das ganze.
Aufbau
Die Seite ist grundsätzlich immer nach dem Namen der Funktion ohne Parameter benannt (z.B. "/beispiel" statt "/beispiel test"). Eine Ausnahme bilden hier ausschließlich die Artikel der Funktion /h, welche mit Parameter im Seitennamen benannt werden. Im Folgenden werden die einzelnen Abschnitte der Funktionsartikel erklärt.
Allgemeines
Im Abschnitt == Allgemeines == sollten die Grundzüge der Funktion erklärt werden. Mit anderen Worten sollte hier enthalten sein, auf was sich die Funktion bezieht und wie/wann sie anzuwenden ist. Der Abschnitt sollte möglichst genau beschreiben, was die Funktion bewirkt und wie sie sich äußert. Bei einigen Funktionen macht es auch Sinn ein Bild anzufügen.
Voraussetzungen
Der Abschnitt == Voraussetzungen == sollte aufführen was nötig ist um die Funktion auszuführen. In den meisten Fällen wird dies ein Mindeststatus oder ein Smiley sein, es kann jedoch auch sein, dass man sich in einem bestimmten Channel aufhalten muss, oder dass eine betroffene Person eine bestimmte Eigenschaft aufweist oder ähnliches. Ebenfalls zu beachten ist, dass es negierte Voraussetzungen gibt, wie bspw. Channel darf nicht moderiert sein oder ähnliches. Ein einleitender Fließtext sollte hier im Regelfalle vorhanden sein, allerdings ist es bei mehreren Voraussetzungen auch in Ordnung eine Liste anzulegen. Ebenfalls sollte darauf eingegangen werden, wenn verschiedene Parameter unterschiedliche Anforderungen haben. (Bsp: /cm stat kann jeder LCler eines Channels machen, alle anderen /cm Funktionen nur CMs)
Syntax
Unter == Syntax== werden mit === Unterpunkten === alle Möglichkeiten die Funktion anzuwenden aufgeführt. Hierbei stehen großgeschriebene Wörter für zwingend notwendige Parameter, wie zB. /kiss NICK, während großgeschriebene Parameter in eckigen Klammern für optionale Parameter stehen. (Bsp: /dice [ZAHL]). Das ganze lässt sich auch auf komplexe Funktionen anwenden, wobei sich ab und an anbietet ein Beispiel dazu zu schreiben.
(Mögliche Sätze)
Im Falle von Chatmakros (/freu, /welcome usw.) soll hier noch ein zusätzlicher Abschnitt hin in welchem eine Liste aller möglichen Ausgaben des Makros enthalten sein soll.
Weiterführende Informationen
Abschließend werden unter der Überschrift == Weiterführende Informationen== in Stichpunkten wie es bei vielen Artikeln geläufig ist verwandte Artikel aufgezählt. Dies können andere Funktionen sein, teilweise sogar Funktionen mit inhaltlicher Überschneidung (/afk <=> /away) oder auch ganz andere Artikel (zB. MyChannel bei der /mychannel Funktion).
Ebenfalls muss hier mittels [[Kategorie:Chatfunktion|SORTIERUNG]] die Funktion kategorisiert werden. Für SORTIERUNG muss der Name der Funktion ohne führenden Slash ( / ) eingesetzt werden, also bspw. [[Kategorie:Chatfunktion|away]].