|
Größe: 614
Kommentar:
|
Größe: 4887
Kommentar:
|
| Gelöschter Text ist auf diese Art markiert. | Hinzugefügter Text ist auf diese Art markiert. |
| Zeile 1: | Zeile 1: |
| = Konventionen bei der Nutzung von Wikis = | Eine Diskussion über die Konventionen hier ist leider nicht mehr sinnvoll, da das Wiki nun schon begonnen wurde. Es gelten die unten aufgeführten Vereinbarungen. Bei Unklarheiten und noch offenen Fragen, sollte natürlich auf jeden Fall nachgebessert werden; wendet euch dazu bitte kurz per Mail an stuve.computer@uni-ulm.de. Die unten stehende Konvention ist sicher nicht für jeden Einzelfall der Königsweg, aber aktuell der beste Kompromiss. -- SimonLüke <<DateTime(2009-08-21T18:28:43Z)>> |
| Zeile 3: | Zeile 3: |
| == Zweck == Die Konventionen sollen eine grobe Anleitung sein, welche Konstrukte für welche Anwendung "normal" verwendet werden. Je nach Nutzungsart und Konfiguration eines Wikis können diese Konventionen unterschiedlich ausfallen. Dementsprechend sollen hier nur Anwendungen und alle möglichen Konventionen vorgestellt werden. Eine feste Lösung muss von den Nutzern jedes einzelnen Wikis selbst fest gelegt werden. |
<<TableOfContents>> |
| Zeile 9: | Zeile 5: |
| == Benennung von Seiten == * Umlaute in Seitentiteln |
= Kurzfassung der Konvention = |
| Zeile 12: | Zeile 7: |
| == Struktur / Hierachie == | tbd |
| Zeile 14: | Zeile 9: |
| == Seitenquelltext == * Farbe |
|
| Zeile 17: | Zeile 10: |
| == GUI Editor == | = 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. = 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. = Benennung von Seiten = * Umlaute in Seitentiteln sind erlaubt und erwünscht. * Leerzeichen sind nicht erlaubt. Ersetzt sie bitte mit einem Unterstrich {{{_}}}. = Hierachie / Seitenstruktur = Hirachiesierung von Seiten darf nur verwendet, 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 Hierarchieebene, 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 Hirarchie ein, weil auch andere Bereiche "Rechenschaftsberichte" oder ToDos haben werden: {{{ Wohnen/Rechenschaftsberichte Wohnen/ToDo }}} == Standardisierte Unterseiten == {{{ /ToDo /Diskussion /Kalender }}} == 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. |
Eine Diskussion über die Konventionen hier ist leider nicht mehr sinnvoll, da das Wiki nun schon begonnen wurde. Es gelten die unten aufgeführten Vereinbarungen. Bei Unklarheiten und noch offenen Fragen, sollte natürlich auf jeden Fall nachgebessert werden; wendet euch dazu bitte kurz per Mail an stuve.computer@uni-ulm.de. Die unten stehende Konvention ist sicher nicht für jeden Einzelfall der Königsweg, aber aktuell der beste Kompromiss. -- SimonLüke 2009-08-21 20:28:43
Inhaltsverzeichnis
Kurzfassung der Konvention
tbd
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.
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.
Benennung von Seiten
- Umlaute in Seitentiteln sind erlaubt und erwünscht.
Leerzeichen sind nicht erlaubt. Ersetzt sie bitte mit einem Unterstrich _.
Hierachie / Seitenstruktur
Hirachiesierung von Seiten darf nur verwendet, 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 Hierarchieebene, 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 Hirarchie ein, weil auch andere Bereiche "Rechenschaftsberichte" oder ToDos haben werden:
Wohnen/Rechenschaftsberichte Wohnen/ToDo
Standardisierte Unterseiten
/ToDo /Diskussion /Kalender
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.