Arbeiten mit .NET/ Gestaltung

Aus Wikibooks
Zur Navigation springen Zur Suche springen

Für ein einheitliches Erscheinungsbild der Bücher sollten die folgenden Regeln beachtet werden. Es ist klar, dass das schwierig wird, wenn ein Projekt schon weit fortgeschritten ist; aber vielleicht lässt es sich trotzdem verwirklichen.

Attention green.svg

Hinweis
Die folgenden Angaben sind Vorschläge, die auf Erfahrungen aus anderen Büchern gewonnen wurden. Sie könnten noch diskutiert werden; inzwischen sind die Vorarbeiten aber soweit gediehen, dass eine Änderung nur noch in dringenden Fällen sinnvoll ist.


Arbeitsanleitung für Autoren[Bearbeiten]

Zur Arbeitserleichterung gibt es eine Reihe von Vorlagen. Bitte geht nach den folgenden Anleitungen vor.

Empfehlung: Öffne alle neuen Seiten mit Rechtsklick in einem neuen Tab des Browsers (oder in einem neuen Fenster). Dann können diese Anleitung und die neuen Angaben nebeneinander gelesen und bearbeitet werden. Texte im Kasten können einfach an die entsprechende Stelle kopiert und angepasst werden.

Ein neues Buch[Bearbeiten]

Für ein neues Buch innerhalb der Reihe sind mehrere kleine Schritte vorgesehen.

Registrieren

Öffne die Liste der Buchnamen.

Füge dort eine neue Zeile ein mit dem vollständigen Namen des gewünschten Buches und dem Kurznamen nach dem folgenden Muster. Die Bezeichnung innerhalb der geschweiften Klammern entspricht dem Seitennamen; die Bezeichnung hinter dem Gleichheitszeichen kann davon abweichen. Speichere danach die Liste.

|{{subst:urlencode:Arbeiten mit .NET: NeuesBuch|WIKI}}=NeuesBuch
Übersicht zur Reihe

Öffne Arbeiten mit .NET/ Vorlage:Startseite zum Bearbeiten und trage das neue Buch am Ende in der Übersicht Die .NET-Bücher ein, und zwar mit Link auf das Inhaltsverzeichnis.

Im Inhaltsverzeichnis eintragen

Gehe nun zum Inhaltsverzeichnis der Reihe. Öffne es zum Bearbeiten und füge das Buch an zwei Stellen ein:

Am Anfang in der Übersicht

Notiere das Buch an einer geeigneten Stelle und passe die Nummerierung an, etwa nach dem folgenden Muster. An beiden Stellen wird üblicherweise der gewünschte Kurzname eingetragen.

[[#NeuesBuch|3.n NeuesBuch]]<br />
An der richtigen Stelle

Notiere innerhalb des Inhaltsverzeichnisses das Buch:

== NeuesBuch ==
Eine kurze Inhaltsangabe zum Buch ...
{{:Arbeiten mit .NET/ Vorlage:Inhalt Klappbox|Arbeiten mit .NET: NeuesBuch}}

Als Überschrift ist genau die Formulierung zu übernehmen, die in der Übersicht an der ersten Stelle eingetragen wurde. In die letzte Zeile gehört der korrekte Seitenname. Speichere die Änderung und gehe an die „richtige Stelle“. Wenn nun die Klappbox des neuen Buches geöffnet wird, können die wichtigsten Seiten angelegt werden.

Die Startseite des neuen Buchs

Durch Klick auf „Startseite anlegen“ wird mit [[Arbeiten mit .NET/ Preload:Startseite]] die Hauptseite des neuen Buches vorbereitet. Die Grafik kann aus Datei:DotNET-Titelbild Allgemeines.png abgeleitet werden.

  • Passe diese Seite an die Inhalte des neuen Buchs an, wie dort beschrieben ist.
  • Lösche die Arbeitsanleitung und das Ende der Vorlage.
  • Nach Kontrolle durch die Vorschau kann die Seite gespeichert werden.
Die Projektorganisation

Durch Klick auf „Projektorganisation anlegen“ wird mit [[Arbeiten mit .NET/ Preload:Projektorganisation]] die entsprechende Übersicht vorbereitet.

  • Passe diese Seite an die Inhalte des neuen Buchs an, wie dort beschrieben ist.
  • Lösche die Arbeitsanleitung und das Ende der Vorlage.
  • Nach Kontrolle durch die Vorschau kann die Seite gespeichert werden.
Die Themenaufteilung

Diese Seite ist als Diskussionsseite über die Inhalte gedacht und sollte standardmäßig bereitgestellt werden. Sie wird durch Klick auf „Projektorganisation anlegen“ mit [[Arbeiten mit .NET/ Preload:Themenaufteilung]] vorbereitet.

  • Lösche am Ende alles ab <noinclude>.
  • Bei Bedarf können bereits ein paar Hinweise eingetragen werden.
  • Nach Kontrolle durch die Vorschau kann die Seite sofort gespeichert werden.

Das Inhaltsverzeichnis[Bearbeiten]

Durch Klick auf „Inhaltsverzeichnis anlegen“ wird mit [[Arbeiten mit .NET/ Preload:Inhaltsverzeichnis]] die Übersicht vorbereitet.

  • Ändere den Verweis auf eine geeignete Wikipedia-Seite und lösche am Ende alles ab <noinclude>.
  • Füge am Anfang eine kurze Inhaltsangabe zum Buch ein. Es bietet sich an, den Text aus dem Inhaltsverzeichnis der Reihe zu kopieren.
  • Nach Kontrolle durch die Vorschau kann die Seite sofort gespeichert werden.

Das Inhaltsverzeichnis und die Navigation zwischen den Kapiteln benutzen die automatischen Vorlagen. Dazu sind die Buchdaten und Teildaten anzulegen.

Für Teile, Bereiche und Kapitel sind möglichst kurze Namen zu empfehlen, damit die Wikibooks-Kopfzeile und Links (vor allem in der Navigation) noch „lesbar“ sind. Umlaute sind zulässig, Sonderzeichen grundsätzlich ebenfalls. Aber Doppelpunkt und Schrägstrich sind verboten! Auch & und # können Nebenwirkungen haben und sollten vermieden werden. Beachte dazu auch die Hinweise in der Projektorganisation.

Die Buchdaten

Die Seite Buchdaten erhält die Liste der Teile des Buches und einige Standardangaben. Sie wird durch Klick auf den Link vorbereitet.

Nach dem Speichern der Buchdaten ist das neue Inhaltsverzeichnis des Buches zu aktualisieren. Anschließend können für jeden Teil die Kapitel eingetragen werden.

Die Teildaten

Nach einem Klick auf diese Links werden die Bereiche und Kapitel für einen Teil des Buches eingetragen.

Nach dem Speichern der Teildaten ist das Inhaltsverzeichnis des Buches zu aktualisieren.

Gönne dir Bedenkzeit

Eine gute Gliederung ist für ein zielgerichtetes Arbeiten an einem neuen Buch besonders wichtig. Warte ein paar Tage, bevor du mit dem Schreiben der Kapitel anfängst, und überprüfe das Inhaltsverzeichnis etwa zweimal am Tag:

  • Fehlen wichtige oder sinnvolle Teile noch?
  • Ist die Reihenfolge der Kapitel sinnvoll?
  • Passen die Überschriften und Zwischenüberschriften?
  • Sollten einzelne Kapitel aufgeteilt oder zusammengezogen werden?
  • An welchen Stellen (Teile, Bereiche, Kapitel) sind ergänzende Hinweise sinnvoll?

Alles, was du dir jetzt überlegst und berücksichtigst, erspart dir später viel Korrekturarbeit. Also nimm dir die Zeit und denke nach, was an der Gliederung noch verbessert werden könnte.

Nachträgliche Änderungen

Kapitel und Bereiche, die es noch nicht gibt („rote Links“), können problemlos in den Teildaten geändert werden: löschen, einfügen, umbenennen, Position ändern.

Teile können in den Buchdaten ebenfalls gelöscht, eingefügt oder neu positioniert werden. Bei einer Umbenennung oder Löschung ist auch die betreffende Seite anzupassen.

Kapitel, die es bereits gibt (blaue Links), müssen bei solchen Änderungen verschoben werden. Dann ist bei allen Aktionen sehr genau aufzupassen.

Ein Kapitel bearbeiten[Bearbeiten]

Ein neues Kapitel wird wie üblich durch Klick auf einen roten Link erstellt. Übernimm als erstes das folgende Gerüst für die neue Seite:

<noinclude>{{AutoNavigation}} {{TOCright}}</noinclude>

Ein einführender Satz oder Absatz über den Inhalt dieses Kapitels...
== Allgemeine Hinweise ==
== Themen... ==
== Zusammenfassung ==
== Übungen ==
== Siehe auch ==
Bei Wikipedia gibt es folgende Artikel als Überblick:
* [[w:.NET|.NET]]
In folgenden Kapiteln der Buchreihe gibt es weitere Erläuterungen:

<noinclude>{{AutoNavigation}}</noinclude>

Dabei sollten folgende Regeln gelten:

  1. Jedes Kapitel beginnt und endet mit {{AutoNavigation}}, eingeschlossen in <noinclude>.
  2. {{TOCright}} ist dem üblichen __TOC__ vorzuziehen: Es ist dezenter, und der Text des Kapitels ist sofort zu sehen. Schwierigkeiten gibt es nur, wenn gleich am Anfang ein Kasten oder ein Code-Abschnitt stehen sollen.
  3. Das Kapitel beginnt mit einer Einführung von ein bis drei Sätzen, erst danach kommen die Einzelteile. Der Name des Kapitels darf hier genannt werden (auch im Fettdruck), er darf aber nicht als Überschrift wiederholt werden.
  4. Dann kommt der erste Abschnitt des Textes mit der dazugehörigen Überschrift.
  5. Jedes Kapitel wird durch Überschriften in Abschnitte und Teilabschnitte gegliedert. Die Überschriften benutzen 2, 3 oder 4 Gleichheitszeichen, aber nicht die Ebene 1.
  6. Weitere Zwischenüberschriften können mit Semikolon gesetzt werden.
  7. Im laufenden Text werden Links allenfalls durch Kursivschrift angedeutet.
  8. Jedes Kapitel endet möglichst mit einer kurzen Zusammenfassung sowie
  9. Übungen, die auf dem Inhalt des Kapitels basieren.
  10. Links stehen gesammelt am Schluss unter „Siehe auch“. Die Hinweise auf die Namenskonventionen und die .NET-Hilfe kommen zu oft vor und werden nicht aufgeführt. Hier werden genannt:
    • allgemeine Erläuterungen in der Wikipedia,
    • Querverweise in der Buchreihe
    • bei Bedarf die .NET-Dokumentation in der MSDN
  11. Die Warnung, dass eine Seite nicht größer als 32 kB werden sollte, wird beachtet; wenn es soweit ist, sollte das Kapitel geteilt werden. Das ist bei den heutigen Browsern nicht unbedingt erforderlich, verbessert aber die Lesbarkeit.

Kapitel, die aus früheren Büchern übernommen wurden, sollten möglichst an dieses Schema angepasst werden.

Ein Kapitel wiederholt verwenden[Bearbeiten]

Es kommt vor, dass ein Kapitel für mehrere Bücher nützlich ist. In diesem Fall wird der "zentrale" Teil dieses Kapitels als eigene Seite gespeichert, in den betreffenden Büchern wird jeweils eine eigene Seite dafür vorbereitet und die "zentrale" Seite eingebunden:

Die zentrale Seite

Sinnvollerweise ist der allgemeine Inhalt zuerst zu schreiben und dieser dann in die verschiedenen Bücher einzubinden.

  • Öffne das Reihen-Inhaltsverzeichnis im Abschnitt Mehrfach verwendete Kapitel zum "Bearbeiten".
  • Trage dort die "zentrale" Seite mit einem passenden Namen ein, z.B.:
    [[Arbeiten mit .NET: Grundlagen: Datentypen/ Numerische Typen]]
  • Kontrolle durch die Vorschau, Speichern.
  • Erstellen der neuen Seite durch einfachen Aufruf, Bearbeiten, Vorschau, Speichern.

Auf jegliche Seiten-Navigation ist zu verzichten. Übungen können je nach Situation allgemein eingebaut oder weggelassen werden.

Benutzung der zentralen Seite

Ein Kapitel, das eine solche zentrale Seite benutzt, kann sich auf die folgenden Zeilen beschränken:

<noinclude>{{AutoNavigation}} {{TOCright}}</noinclude>

{{:Arbeiten mit .NET: Grundlagen: Datentypen/ Numerische Typen}}

<noinclude>{{AutoNavigation}}</noinclude>

Je nach Situation können die Übungen Teil der zentralen Seite oder Teil der Einzelseite sein oder in beiden Teilen eingebunden sein.

Es ist auch möglich, nachträglich eine vorhandene Seite für mehrere Bücher zu verwenden:

  1. Verschiebe die vorhandene Seite und speichere sie unter einem zentralen Namen.
  2. Registriere sie als zentrale Seite.
  3. Passe den Inhalt so an, dass "spezielle" Angaben entfernt und allgemeine Erläuterungen eingefügt werden.

Danach kann sie in mehreren Seiten eingebunden werden.

Diskussion bei Unklarheiten, Problemen usw.[Bearbeiten]

Bitte beachte die allgemeinen Hinweise dazu:

  • Fragen, die ein bestimmtes Buch betreffen, sind auf dessen Projektorganisation bzw. Diskussionen zu besprechen.
  • Fragen, die ein bestimmtes Kapitel betreffen, sind auf der speziellen Diskussionsseite zu besprechen.
  • Fragen, die mehrere Kapitel betreffen, sind keinesfalls auf mehreren Diskussionsseiten zu besprechen, sondern zentral zu behandeln:

Vorlagen[Bearbeiten]

Für ein einheitliches Erscheinungsbild werden – von Anfang an – Vorlagen genutzt, und zwar je nach Situation

Erläuterungen und Beispiele zu allen Vorlagen (vor allem zu den bucheigenen Vorlagen) stehen im separaten Kapitel zu Vorlagen.

Vorlagen zur Gliederung[Bearbeiten]

Dazu werden ausschließlich Standardvorlagen genutzt.

Vorlagen zur Code-Darstellung[Bearbeiten]

Sonstiges[Bearbeiten]

  • Tabellen wie unter  Hilfe:Tabellen beschrieben (mit oder ohne Verweis auf "wikitable")
  • Für Übungen werden Vorlage:Übung4 und im Abschnitt "Lösungen" Vorlage:Übung4 Lösung verwendet.
  • Für Tasten und Tab-Reiter gibt es eine einfache Art der Darstellung:
    • ESC wird erzeugt durch {{Taste|ESC}}; es gibt auch Varianten mit Festlegung von Farben u.a. – siehe Vorlage:Taste.
    • Strg+C oder auch Strg+C bezeichnet zwei Tasten, die gleichzeitig zu drücken sind.
    • Strg+K, I oder auch Strg+K-I bezeichnet eine Tastenkombination, bei der "I" getrennt zu drücken ist.
    •    Bearbeiten    wird erzeugt durch {{Register|Bearbeiten}} – siehe Vorlage:Register.
  • Mit Arbeiten mit .NET/ Vorlage:Baustelle und Arbeiten mit .NET/ Vorlage:Spezielle IDE können einzelne Kapitel oder Bücher gekennzeichnet werden.

Formatierung[Bearbeiten]

Bezeichner (Klassen, Member, Variable) werden mit <tt>Teletyper Text</tt> gekennzeichnet, z.B.:

Mit myDataSet bezeichnen wir eine Instanz der DataSet-Klasse.

Ausnahmen sind Begriffe wie String in einem fortlaufenden Text, wenn es als Synonym für "Zeichenkette" verwendet wird.

Es werden die .NET-Namenskonventionen beachtet.

Namespaces: Die eigenen Projekte (für Beispielanwendungen usw.) sollten einheitlich benannt werden. Zurzeit werden verwendet:

Wikibooks.(Sprache).ConsoleApp

"(Sprache)" wird ersetzt durch "CSharp" oder "VBNet" oder "CPP" oder "Prism". Bei umfangreicheren Anwendungen kann die Anwendung (Applikation) auch genauer bezeichnet und nach Themen unterschieden werden.

Kapitel u.ä. werden im fortlaufenden Text nicht mit einem Link versehen, sondern nur in Kursivschrift dargestellt. Die Links stehen am Ende des Kapitels im Abschnitt „Siehe auch“.

➤ Das Zeichen &#x27a4; soll auf einen bestimmten Sachverhalt hinweisen.

Beispielprogramme[Bearbeiten]

Folgende Programme sind sinnvoll und können bei mehreren Themenbereichen bearbeitet werden:

  • Taschenrechner für Konsolenprogramme
  • Taschenrechner für WinForms
  • Terminkalender für WinForms, kann später auch für ADO.NET erweitert werden
  • Haushaltsbuch für WinForms und ADO.NET

Projekte für WinForms können entsprechend auch für WPF entwickelt werden.