Hilfe:Todo-Listen

Aus Wikibooks

Wozu dient die Todo-Liste[Bearbeiten]

Bei einigen großen Buchprojekten wünscht man sich vielleicht eine Erinnerungsstütze auf Textabschnitte, die später noch einmal nachbearbeitet oder ergänzt werden müssen.

Vielleicht möchte man aber auch einem Co-Autor (sowohl einem Hauptautoren als vielleicht auch potenziellen Neuautoren) einen Hinweis geben, wo etwas nachzuarbeiten ist.

Das Problem ist, dass man diese Einträge manchmal aus den Augen verliert oder gar übersieht.

Damit man nicht noch einmal das ganze Buch nach Todo-Einträgen durchforsten muss, wurde die Todo-Listen-Vorlage angelegt.

Der große Vorteil ist, dass sich die Todo-Liste praktisch von selbst verwaltet. Man braucht nach erledigter Aufgabe nur den Eintrag entfernen.

Wie legt man eine Todo-Liste an?[Bearbeiten]

Möchtest du selbst eine Todo-Liste anlegen? Dann verwende auf der entsprechenden Buchseite die Vorlage:Todo.

Sie kann praktisch überall auf der Seite platziert werden (sinnvollerweise aber nur an einer Stelle).

{{todo|Text, der auf der Seite erscheinen soll|Benutzername}}
{{todo|Text, der auf der Seite erscheinen soll|Buchname}}
{{todo|Text, der auf der Seite erscheinen soll|Benutzer1|Benutzer2|Benutzer3|Unterprojekt}}
  • Die Vorlage benötigt mindestens zwei Parameter:
    1. Nach dem {{todo| erfolgt der Ausgabetext, der auf der entsprechenden Seite erscheinen soll.
    2. danach folgt ein Benutzername oder der Titel des Buches.
  • Danach können weitere Parameter folgen (derzeit maximal 10 Einträge).
    • Dieses kann dein Benutzername sein
    • oder der Buchtitel oder
    • gegebenenfalls ein spezielles Unterprojekt. (Z.B. "Lagerfeuerdiplom" im Buchprojekt "Gitarre")
    • Bei langen Buchtiteln kann eine Abkürzung sinnvoll sein. (z.B. "Mathe" statt "Mathe für Nicht-Freaks")
  • Der Todo-Eintrag wird nicht gedruckt.
  • Wenn ein Buch fertig ist (oder kurz davor), so macht ein "Todo-Eintrag" natürlich den Eindruck zunichte. Möchte man dennoch immer mal wieder etwas nachtragen, so kann man den Todo-Eintrag auch auf die Diskussionsseite des entsprechenden Kapitels verschieben.
  • Kurz vor der Fertigstellung sollte man alle verbleibenden Todo-Einträge auf die entsprechenden Diskussionsseiten verschieben.

Was macht dieser Todo-Eintrag?[Bearbeiten]

Neben dem dem eigentlichen Ausgabetext werden weitere Kategorien angelegt, und zwar die, welche man in die Parameter eingetragen hat. Jedem Eintrag wird automatisch ein "todo_" vorangestellt, und er wird in eine Kategorie umgewandelt: Aus dem Parameter "Benutzername" wird der Kategoriename "todo_Benutzername". Existiert diese Kategorie noch nicht, so wird sie neu angelegt.

Als Parameter solltest du jedoch nur Benutzernamen und/oder den Titel des Buches eintragen.

Beispiel
{{todo|Dieses ist nur ein Test|Buchtitel|Benutzername}}
daraus wird
todo
Dies ist nur ein Test

Der große Vorteil der Todo-Listen ist, dass sie nichts anderes als eine Kategorie sind. Auf der Kategorie-Seite kann man Informationen zum Buchprojekt hinterlassen, so dass andere Autoren genau wissen, was man in einem Buchprojekt erwartet. Es bietet weiterhin die Möglichkeit, Informationen zum Stand der Dinge zu hinterlassen (insbesondere wenn Bücher kurz vor der Fertigstellung sind).

Hier sind alle aktuellen Todo-Listen zu finden:

Todo(44 K, 101 S)

Achte auf die Kategorien am Fußende[Bearbeiten]

Wenn außer "Todo" mehr Kategorien am Seitenende mit "todo_" am Anfang erscheinen, dann schau noch einmal, ob du die Groß- und Kleinschreibung beachtet hast; wenn die stimmt, dann gehe bitte auf die übrigen Todo-Kategorie-Einträge und trage dort Folgendes ein:

__VERSTECKTE_KATEGORIE__
[[Kategorie:todo|meinBuchOderBenutzername]]

Das VERSTECKTE_KATEGORIE verhindert, dass diese Kategorie mit unten erscheint und die Seite mit Todo-Kategorien zugemüllt wird. Das kann schnell passieren, wenn man in einem Unterprojekt mit vielen Benutzern arbeitet.

Über die Kategorie "Todo" erreicht man mit einem einfachen Klick alle weiteren Todo-Listen.

Nur dort, wo es wirklich sinnvoll ist (wenn beispielsweise ein Buchprojekt aus mehreren Bänden besteht), kann es sinnvoll sein, evtl. auch für die Unterprojekte eine eigene Todo-Liste anzulegen. Sollten zu viele Todo-Listen eröffnet werden, kann es leicht passieren, dass man sich verzettelt.

Beachte[Bearbeiten]

Man muss bei der Todo-Liste auf Groß- und Kleinschreibung achten. Daher gilt für Todo-Listen die gemischte Schreibweise als Standard (jedes Wort beginnt mit einem Großbuchstaben, alles andere wird klein geschrieben)!

Also
{{ todo|Spielwiese}} oder {{todolink|Spielwiese|Spielwiese}}
und nicht
{{todo|spielwiese}} oder {{todolink|spielwiese|spielwiese}}
Vorsicht bei Aufzählungen
Vor einer Todo-Vorlage darf kein Aufzählungszeichen (* oder #) stehen, da dieses das Design zerschießt.
* {{todo|...      so nicht!
Vorsicht, wenn das Vormat zerschossen werden.

Gleichheitszeichen können ggf. durch {{=}} ersetzt, Pipes durch {{|}}. Setze Todo-Einträge außerhalb anderer Vorlagen und Tabellen. Verschachtelte Vorlagen sind schwer zu bearbeiten und zu warten, und mitunter beeinflussen sie sich gegenseitig. Da ist es besser, die Todo-Vorlage auf die Diskussionsseite zu verlegen, und dort die anderen Vorlagen und Tabellen getrennt aufzuführen.

{{todo| folgende Punkte abarbeiten |MeinBuch}}
...

Wie verweise ich auf eine Todo-Liste[Bearbeiten]

Möchte man auf eine Todo-Liste verweisen, dann kann man die Todolink-Vorlage verwenden. Es wird mindestens ein Parameter benötigt. Dies ist der Name der Todo-Liste (d.h. der Benutzername oder der Buchtitel). Mit einem weiteren optionalen Parameter kann man den Ausgabetext des Link anpassen.

Beispiel
  • Todo-Liste für {{todolink|Benutzername}}

daraus entsteht:

  • Todo-Liste für Benutzername


  • Todo-Liste für {{todolink|Benutzername|meine Projekte}}

daraus entsteht:

  • Todo-Liste für meine Projekte

Derzeit ist es üblich, auf der Diskussionsseite der Hauptseite eines Buches und/oder auf der Diskussionsseite der ersten Seite der Inhaltsübersicht jeweils an der obersten Stelle der Seite einen Todo-Link zu hinterlegen. Ob man dieses auch auf der Diskussionsseite der Benutzer so handhabt oder es für den Link eine eigene "Werkstatt-Seite" gibt, bleibt den Benutzern überlassen.