## page was renamed from Wiki/Konvention <> = Informationen zur Benutzung und Verwaltung von diesem Computer-Wiki = = Zweck = Die Konvention soll eine Richtschnur sein, welche Konstrukte für welche Anwendung verwendet werden sollen. Je nach Nutzungsart und Konfiguration eines Wikis können diese Konventionen unterschiedlich ausfallen. Dementsprechend ist auf dieser Seite die Anwendung für dieses Wiki (http://wiki.asta.uni-ulm.de/computer) zu finde. Unter [[Wiki/Möglichkeiten_für_Konventionen]] werden in groben Zügen die erdenklichen Variantionsmöglichkeiten gesammelt. Die konkrete Regelung muss von den Nutzern jedes einzelnen Wikis selbst fest gelegt werden. = Sprache = Die "Amtssprache" hier ist Deutsch. Bitte versucht für erklärungsbedürftige Begriffe, die noch nicht allgemein im Deutschen verwendet werden, eine gute deutsche Formulierung / beschreibung zu finden. Das erleichtert es dem unbedarften Benutzer sehr die Dokumentation zu nutzen. Zum Beispiel: * Internet bleibt Internet, da es allgemein verwendet wird. * Monitoring wird Überwachung, da es nicht allgemein verwendet wird. * Siehe auch: http://ikhaya.ubuntuusers.de/2010/02/24/wiki-eindeutschen/ = Allgemeines = * Mitarbeit ist erwünscht! Das heist insbesondere: * Wer (Rechtschreib-)Fehler findet oder die Formatierung eines Inhaltes zu undeutlich findet, sollte dies verbessern. * Ein Wiki dient im Allgemeinen der Zusammenarbeit an Themen, also darf mitdiskutiert werden; dies geschieht meist in einem gekennzeichneten Abschnitt einer Seite oder einer extra Unterseite. * Denken hilft! :-) Und hier insbesondere: Erstmal Lesen hilft wahrscheinlich auch schon weiter! * Die Abkürzung {{{tbd}}} irgendwo im Text ist dafür reserviert, eine noch zu bearbeitende Stelle zu markieren. So können solche zur Bearbeitung ausstehenden Stellen noch durch die Text-Suche gefunden werden und es kann als Marker verwendet werden, dass die aktuelle Seite noch nicht alle erforderlichen Inhalte enthält. {{{tbd}}} steht für "to be done". * Außerdem kann die ebenfalls nur für diesen Zweck reservierte Abkürzung {{{tba}}} (für "to be announced") verwendet werden, anzuzeigen, dass der erforderliche Inhalt schon in Vorbereitung ist und nur noch nicht veröffentlicht werden soll. Es empfiehlt sich dabei Namen des Bearbeiters und Datum der Bearbeitung zu hinterlassen. * Links auf andere Wikiseiten sind '''immer''' in zweifache eckige Klammern {{{[[ ]]}}} zu setzen. * Benutze '''Vorschau anzeigen''' vor '''Änderung speichern'''. Jede Version einer Seite bleibt erhalten. Das ist zwar vom Speicherplatzbedarf her nicht so wesentlich, aber es erhöht z.B. auch nicht gerade die Übersichtlichkeit der Versionshistorie. = Benennung von Seiten = * '''Umlaute''' in Seitentiteln sind erlaubt und erwünscht. * '''Leerzeichen''' sind nicht erlaubt. Ersetzt sie bitte mit einem Unterstrich {{{_}}}. * '''Doppelpunkte''' in Seitentiteln haben erzeugen InterWiki Links und sind daher nicht erlaubt. == Umbenennen von Seiten == Beim Umbenennem von Seiten muss man berücksichtigen das alte Verweise dann nicht mehr auf die Seite mit dem neuen Titel zeigen. MoinMoin versucht zwar umgezogene Seiten wieder zu finden und bietet Seiten mit ähnlichem namen an, das ist aber keine perfekte Lösung. Um zumindest alle Verweise innerhalb eines Wikis zu finden ist folgendes Vorgehen hilfreich: * !SeiteBeispiel soll umbenannt werden in !SeiteBeispielNeu * umzubenennende !SeiteBeispiel besuchen * Seiten die darauf verweisen suchen * auf den Titel im oberen Bereich klicken . -oder - * Suchen nach linkto:"!SeiteBeispiel" * alle Seiten die aufgelistet werden editieren und den Verweis auf den neuen Namen !SeiteBeispielNeu abändern = Hierachie / Seitenstruktur = Eine geschachtelte Struktur von Seiten darf nur verwendet werden, wenn es von der Bennenung her nötig bzw. sinnvoll ist. Dazu ein Beispiel: Im AStA-Wiki gibt es eine eigene Seite für das BAföG-Referat und das Wohnreferat, beide Referate sind allerdings Teil des Sozialreferats. Dementsprechend gibt es zu den Themen der Referate '''nicht''' die Seite {{{ Sozial }}} mit den Unterseiten {{{ Sozial/BAföG Sozial/Wohnen }}} '''sondern''' {{{ BAföG Wohnen }}} sind eigene Seiten in der obersten Hierarchie Ebene, genau so wie {{{Sozial}}} wobei von dort aus natürlich auf die beiden zugehörigen Seiten verwiesen wird. Die Unterseiten werden nur dazu genutzt allgemeine Seitennamen in der oberen Ebene zu vermeiden, die für mehrere Themen verwendet werden könnten. Wieder am Beispiel: Das o.g. Wohnreferat möchte eine Seite für seine ToDo Liste und seine Rechenschaftsberichte haben. Es verwendet dafür '''nicht''' die Seiten mit den folgenden Namen in der obersten Hirarchie {{{ Rechenschaftsberichte ToDo }}} '''sondern''' fügt diese Seiten in die eigene Hierarchie ein, weil auch andere Bereiche "Rechenschaftsberichte" oder !ToDos haben werden: {{{ Wohnen/Rechenschaftsberichte Wohnen/ToDo }}} Dies soll unter anderem auch wilde Konstruktionen und Lange Seitennamen unnötig machen, wie {{{Rechenschaftsbericht_des_Wohnreferats_aus_2009}}}; diese Seite sollte eher so verlinkt sein: {{{Wohnreferat/Rechenschaftsbericht/2009}}} == Standardisierte Unterseiten == {{{ /ToDo /Diskussion /Kalender }}} Diese Seitennamen sollten für die entsprechende Anwendung genutzt werden, um die Kollaboration zu vereinfachen, indem jeder der an dem Thema mitarbeiten will z.B. einfach die ToDo-Liste findet und nicht erst über den Link zur Unterseite {{{/was es hier noch zu tun gibt}}} stolpern muss. Natürlich muss man für die o.g. Anwendungen nicht immer eine Unterseite erstellen, sondern kann auch getrost nur einen eigenen Abschnitt auf der entsprechenden Seite erstellen. == Benutzerseite == Auf der eigenen Seite und den Unterseiten kann man tun und lassen, was man will. Auch kann man hier Rechte selbsständig vergeben; siehe hier [[Wiki/AdminDoku]] und hier [[HelpOnAutoAdmin]]. = Seitenquelltext = Der Quelltext einer Seite ist sauber und übersichtlich zu halten und die Leserlichkeit dieses "unformatierten" Textes hat Vorrang. Siehe auch Überschrift "GUI Editor" weiter unten. = Kalender = tbd: die Verwendung von Kalendern. = Include = tbd: Verwenden des Include-Makros zum Einbinden von anderen Seiten; Kenntlich machen, wo editiert werden muss. = GUI Editor = Editieren mit dem GUI-Editor erfolgt auf eigenen Gefahr. Es kann beim Verwenden des GUI-Editors dazu kommen, dass der Quelltext für das Editieren in diesem praktisch unlesbar wird. Der Quelltext ist aber der kleinste gemeinsame Nenner für die Editierung im Wiki und hat somit Vorrang vor dem Editieren in der GUI.