My wiki:Hilfe

Mitarbeit bei OptiYummy

Bis auf Weiteres ist das Bearbeiten von Beiträgen nur eingetragenen Nutzern möglich. Damit soll ein qualitativ hohes Niveau der zur Verfügung gestellten Informationen gewährleistet werden. Die Autoren bürgen mit ihrem Namen für fachliche und urheberechtliche Korrektheit ihrer Beiträge. Interessenten können sich für eine Mitarbeit beim Betreiber dieses Wiki-Systems bewerben (Siehe OptiYummy:Impressum).

Anlegen neuer Seiten

Bevor man eine neue Seite anlegen kann, muss man in einer vorhandenen Seite einen "internen Link" zu dieser neuen Seite eintragen. Dabei sollte man die Wahl des Seiten-Namens anhand ihrer Stellung in der hierarchischen Struktur der Inhalte orientieren.

Beiträge zur Nutzung folgender Simulationsprogramme sind in nächster Zeit geplant bzw. in Bearbeitung:
* [[Software: System-Simulation - SimulationX|'''SimulationX''']] (vorhandener Inhalt)
* [[Software: System-Simulation - NewSoft|'''NeuSim''']] (neuer Link)
* Dymola
* MATLAB
* :

Das anschließende Aufrufen des neuen Links öffnet den Editor für die neue Seite, welche erst nach dem Speichern der Editor-Inhalte angelegt wird (Bitte "NewSoft" nicht speichern!):

• SimulationX (vorhandener Inhalt)
• NeuSim (neuer Link)
• Dymola
• MATLAB
• :

Achtung: keine Umlaute und Sonderzeichen für Seiten-Namen!

Umlaute, "ß" und Sonderzeichen sollten nicht für die Namen neuer Seiten verwendet werden. Es besteht die Gefahr, dass bei einer irgendwann erforderlichen Portierung der Datenbank auf ein neues Wiki-System Probleme mit unterschiedlichen Zeichensätzen entstehen. Je nach Zeichensatz werden Sonderzeichen unterschiedlich interpretiert. Damit würde die gesamte Link-Struktur des Wiki-Systems zerstört!

Dieses Problem trat bei einer versuchsweisen Portierung der Datenbank auf ein anderes Wiki-System bereits auf. Es wurde dafür im Spezialfall noch keine andere Lösung gefunden, als Sonderzeichen in Links grundsätzlich zu vermeiden. Das es sich hier um ein grundsätliches Problem handelt, zeigen tausende Hilferufe von ebenfalls davon betroffenen Nutzern im Internet. Eine eindeutige Lösung dieses Problems war dabei nicht zu erkennen.

Editor-Funktionen

OptiYummy wird auf der Basis von MediaWiki betrieben. Wie man in solch einem Wiki-System neue Seiten anlegt und bearbeitet, wird z.B. im Hilfesystem der Wikipedia ausführlichst beschrieben. Damit sollte auch der unerfahrene Wiki-Autor sehr schnell zumindest seine Texte ansprechend formatieren können:

Einstieg in die Textgestaltung (Wikipedia)

Tabellen-Text

In der Wikipedia findet man eine ausführliche Hilfe zur Tabellengestaltung.

Achtung:

Leider ist die class="wikitable", deren Anwendung in der Wikipedia beschrieben wird, in unserem Wiki-System nicht nutzbar!. Möglich ist jedoch die Benutzung der MediaWiki-Tabellensyntax.

Hinweis:

Für ganz einfache Tabellen sollte man den Schreibmaschinenstil ohne Formatierungen benutzen. Dazu stellt man jeder Tabellenzeile ein Leerzeichen voran. Spalten und Layout werden visuell im Bearbeitungsmodus angepasst. Das Ergebnis entspricht anschließend genau der Ansicht im Bearbeitungsmodus. Hervorhebungen von Text (z.B. Fett) sollte man erst an der fertigen Tabellenstruktur vornehmen. Im Folgenden ein Beispiel:

Name      | Kommentar        | Wert     | Einheit
-------------------------------------------------
my0       | Magn. Feldkonst. | 1.256E-6 | H/m
Bmax_zul  | Max. Flussdichte | 1.2      | T
d_Anker   | Ankerdurchmesser | 10       | mm
L_Faktor  | L_Anker/d_Anker  | 2        | -
rho_Eisen | Massedichte      | 7.8      | g/cm³

Mathematische Formeln einfügen (LaTeX)

Der MediaWiki-Editor enthält einen Button für das Einfügen von Formeln. Allerdings muss man die Formel als TeX-Quelltext schreiben, was zumindest für den Einsteiger etwas gewöhnungsbedürftig ist.

Im Hilfesystem der Wikipedia findet man eine sehr gute Übersicht zur Formel-Notation:

Einstieg in die Formelgestaltung (Wikipedia)

Über die Vorschau-Funktion des Editors kann man sich das Resultat anzeigen lassen, falls die Formel syntaktisch richtig ist. Ansonsten erhält man nur eine allgemeine Fehlermeldung.

Es ist bedeutend einfacher, sich für das Erstellen und Modifizieren von Formeln separat z.B. das Programm LyX auf dem PC zu installieren:

• Download der Software von http://www.lyx.org
• Bei der Installation lädt LyX alle erforderlichen TeX-Komponenten aus dem Internet nach und installiert sie.
• Nach dem Start von LyX aktiviert man die Ansicht der Quelle.
• Die Formel kann man mit Hilfe der zugehörigen Werkzeugleisten im Grafik-Modus editieren. Man sieht also sofort den Erfolg.
• Der zugehörige Quelltext erscheint im Quelltext-Fenster.
• Ist die Formel fertig, kopiert man den Quelltext über die Zwischenablage in den MediaWiki-Editor.
• Umgekehrt kann man eine vorhandene Formel aus dem MediaWiki-Editor über die Zwischenablage als TeX-Code in ein Formel-Objekt des LyX-Dokuments einfügen und ändern.

Bilder hochladen

Die hochzuladenden Bilder kann man über "Spezialseite Hochladen" vom eigenen Rechner in die Datenbank von OptiYummy kopieren.

Da dort alle Bilder in einem gemeinsamen Ordner gespeichert werden, dürfen keine doppelten Namen für Bilder vergeben werden. Als Präfix für den Bildnamen soll der Seiten-Name benutzt wird. Damit ist auch eine einfache Zuordnung zur richtigen Textseite möglich.

Die Namen der Bilder sollten den Inhalt beschreiben. Es stört nicht, wenn Bildnamen dadurch sehr lang werden!

Beispiel: Das jpg-Bild eines Messplatzes auf der Seite "Parameteridentifikation" sollte den folgenden Namen erhalten:

Parameteridentifikation-Messplatz.jpg

Welche Bilder sich bereits in der Datenbank von OptiYummy befinden, erfährt man über "Spezialseiten Dateien".

Größe der Bild-Dateien:

• Der Speicherplatz für das Archivieren von Bildern ist praktisch nicht beschränkt.
• Da der Zugriff über das Internet erfolgt, sollte beim derzeitigen Stand der Technik eine Bild-Datei maximal 1-2 MByte groß werden.
• Die Qualität der Bilder muss im Rahmen dieser Größen-Beschränkung möglichst gut sein:
  • Die Pixel-Auflösung einer durch Scannen gewonnenen Digitalkopie sollte so groß gewählt werden, dass die Details des Originalbildes erhalten bleiben.
  • Ein Digitalbild sollte in der Pixel-Auflösung soweit reduziert werden, dass die Details noch nicht verloren gehen. So müssen z.B. unscharfe Digitalfotos nicht mit ihrer Originalauflösung gespeichert werden.
  • Im Normalfall wird die verlustbehaftete JPG-Kompression eingesetzt. Hier sollte man den Kompressionsfaktor so groß wählen, dass gerade noch keine sichtbaren Kompressionsartefakte auftreten.
• Die Bild-Dateien sollen bei Erhalt der Qualität möglichst klein werden. Der erforderliche Kompromiss sollte im Zweifelsfall zugunsten der Qualität gewählt werden!

Vorschau- und Original-Bild:

• Die kleinformatigen sogenannten "Thumbnails" können beim Laden der Seite vom Wiki-System aus den großen Original-Dateien erzeugt werden.
• Dazu muss man im Bild-Link das Schlüsselwort "thumb" verwenden. Standardmäßig werden diese Vorschau-Bilder dann mit einer maximalen Ausdehnung von 200 Pixel generiert.
• Die Größe der Vorschau-Bilder kann man über die Syntax beim Einbinden der Bilder in den Text beeinflussen.
• Insgesamt sollten alle Bilder für den Nutzer in 3 Größen bereitgestellt werden:
  • Vorschaubild im Text (ca. 200 Pixel)
  • An die Bildschirmauflösung angepasste Qualität (ca. 800 Pixel)
  • Original-Bild in maximaler Auflösung (z.B. 3000 Pixel)
• Falls man die reduzierten Bilder nicht über die thumb-Funktion des Wiki-Systems generieren möchte, so muss man diese reduzierten Bilder selbst erzeugen und hochladen. Die reduzierten Bilder sollen den gleichen Datei-Namen besitzen wie das Original, jedoch gekennzeichnet werden durch einen Nachspann "_v" für Vorschau (klein) und "_" für die mittlere Größe. Am Beispiel des "Messplatzes" ergäben sich also folgende Datei-Namen:

Parameteridentifikation-Messplatz.jpg
Parameteridentifikation-Messplatz_.jpg
Parameteridentifikation-Messplatz_v.jpg

• Achtung: Wahrscheinlich ist die individuelle Erzeugung der reduzierten Bilder nur noch im Einzelfall von Bedeutung. Die vom Wiki-System generierten Bilder haben eine sehr gute Qualität. Die erzeugten Bilder sind maximal doppelt so groß, wie manuell optimierte Bilder. Allerdings spielt das zukünftig mit der Verbesserung der Internet-Anbindung keine Rolle mehr. Man spart jedoch sehr viel Zeit und Verwaltungsaufwand!

Bilder in Text einfügen

Leider funktionieren in diesem Wiki-System (noch) nicht alle Möglichkeiten zum Einfügen von Bildern, welche in der Hilfe zur Wikipedia beschrieben werden. So konnte trotz einiger Anstrengungen die ImageMap-Funktion nicht installiert werden. Damit entfällt die Möglichkeit, Bilder direkt mit einem Link auf eine andere Seite zu hinterlegen.

Als Schlüsselwörter für die Positionierung des Bildes wurden getestet:

• Horizontal

1. left
2. center (Druck links im Internet-Explorer!)
3. right

• Vertikal (in Bezug auf Zeile)

1. top
2. middle
3. baseline

Hier nun beispielhaft einige Möglichkeiten für das Einfügen von Bildern:

Rahmenloses Vorschaubild mit Link auf das Originalbild:

Hier wurde eine Größe von 100 Pixeln gewählt. Für den Einsatz im richtigen Text sollte man 200 Pixel benutzen:

[[Bild:Testbild.jpg|100px|Bildinfo]] 

Standard-Position des Bildes ist in Textzeile (nur für kleinste Bilder nutzbar!)

[[Bild:Testbild.jpg|100px|left||Bildinfo]]

Bild links im Absatz

• .
• .
• .
• .

[[Bild:Testbild.jpg|100px|right|Bildinfo]]

Bild rechts vom Absatz

• .
• .
• .
• .

[[Bild:Testbild.jpg|100px|center|Bildinfo]]

Bild allein auf einer neuen Zeile mittig - Leider erfolgt die Bild-Darstellung auf einer Druckseite zumindest im IE7+8 links! Deshalb wird folgende Zentrierung vorgeschlagen:

<div align="center">[[Bild:Testbild.jpg|100px|Bildinfo]]</div>

Bild allein auf einer horizontal zentrierten Zeile

Standard-Vorschaubild mit Link auf das Originalbild, Zusatztext und Links:

[[Bild:Testbild.jpg|thumb|Bildinfo]]

Bildinfo

Standard-Position ist rechts vom Absatz, Zusatztext im Rahmen:

• .
• .
• .
• .
• .
• .
• .
• .

[[Bild:Testbild.jpg|thumb|center|Bei Interesse:[[Simulation]]]]

Die zentrierte Anordnung enthält Zusatztext und einen internen Link. Da das Symbol für die Bildvergrößerung unten im Rahmen auch zentriert wird, benötigen Text und Link eine weitere Zeile im Rahmen. Von Nachteil ist, dass der Text, der unten im Rahmen steht, auch als Quickinfo für das Bild angezeigt wird, wenn man sich mit dem Cursor darüber befindet:

Bei Interesse:Simulation

[[Bild:Testbild.jpg|thumb|left|Bei Interesse:[[Simulation]]]]

Bei Interesse:Simulation

Anordnung links mit Text und internem Link

• .
• .
• .
• .
• .
• .
• .
• .
• .

Eigenes Vorschaubild mit Rahmen, Text und Links:

• Anstatt der automatisch generierten Vorschaubilder, kann man auch ein eigenes Vorschaubild verwenden. Dessen Form und Inhalt muss nicht mit dem damit verknüpften großen Bild übereinstimmen. Nur mit einem eigenem Vorschaubild unter Verwendung von |frame| gelingen auch zentriert platzsparende Varianten:

[[Bild:Testbild.jpg|thumb=Testbild_v.jpg|frame|center]]

frame

• oder mit zusätzlichem Text. Der Text sollte das Bild beschreiben:

[[Bild:Testbild.jpg|thumb=Testbild_v.jpg|frame|center|Ansicht des Motors]]

Ansicht des Motors

• oder mit zusätzlichem Text und Link:

[[Bild:Testbild.jpg|frame|thumb=Testbild_v.jpg|center|Siehe auch:[[Simulation]]]]

Siehe auch:Simulation

• externe Links gehen analog:

[[Bild:Testbild.jpg|frame|thumb=Testbild_v.jpg|center|Quelle: [http://www.ifte.de IFTE-TUD]]]

Quelle: IFTE-TUD

• Anstatt |center| kann man natürlich auch |left| bzw. |right| verwenden. Die Form der Darstellung ist dabei identisch.

Ergänzende Informationen zu einem Bild

Häufig soll ein Bild den Einstieg in eine weitere Seite bieten, in dem das Thema behandelt wird, welches durch das Bild repräsentiert wird. Ein Link zu einer anderen Text-Seite gelingt durch das Fehlen der ImageMap-Funktion nur über einen Link im Rahmen des Vorschaubildes, wie es zuvor beschrieben wurde.

Eine unkonventionelle Lösung innerhalb des Wiki-Systems besteht in der Nutzung der automatisch generierten Bildseite. Ein Klick auf das Vorschaubild führt direkt zu dieser Bildseite. Bildseiten kann man normal bearbeiten, wie jede andere Seite auch im Wiki-System. Die automatisch generierten Zusatz-Informationen vor und nach dem manuell ergänzten Inhalt stören nicht bzw. sind sogar sinnvoll!

Diese Möglichkeit ist sicher sinnvoll für die detaillierte Erläuterung von Experimentier-Aufbauten bzw. grafisch vorliegenden Experiment-Ergebnissen.

Beispielhaft wurde dies für das verwendete Testbild angedeutet. Zu der Seite Bild:Testbild.jpg gelangt man durch Klicken auf das Vorschaubild.

Einbinden von PDF-Dateien und ZIP-Archiven

Solche Dateien kann man genauso hochladen wie Bild-Dateien. Sie werden vom Wiki-System ebenfalls im Ordner /images gespeichert. Allerdings kann man PDF-Dateien und ZIP-Archive nur als externen Link in den Text einbinden, z.B.:

[http://www.optiyummy.de/images/dateiname.zip Dateien]
[http://www.optiyummy.de/images/dateiname.pdf Dokument]

Vor dem Dateinamen muss also der Name der Wiki-Domäne mit dem Ordner /images ergänzt werden.