======= Wiki Help ======= --- //[[alexander.haumann@usys.ethz.ch|Alexander Haumann]] 2014/03/05// Here you can find some basic help for creating and editing of Wiki pages.\\ For any other questions please contact the assistant of the lecture.\\ ==== 1. Create a new page ==== Some of the [[:|topics]] only exist as a link to a [[:link|page]] that does not exist yet (red dashed underline). Such a link to a new page can be created by opening the editor of the current page ("//Edit//" in the upper right corner) and creating a new link: [[:link|Page name]] This has been done already for all [[:|topics]] available. In order to create that page, click on the link and on "//create//" (upper right corner).\\ For each topic in the [[:|OceanWiki]] there should only be one page. So, please first check with the assistant before you create new pages (besides the listed [[:|topics]]). If you want to sign-up for a topic, please write down your name under "//Author//" on the respective page.\\ ==== 2. Structure & Style ==== Each Wiki page should be clearly structured and nicely designed. For this reason you should make use of [[#headings_tables_of_content|headings, tables of content]], [[#links|links]], [[#references|references]], clearly visible [[#adding_figures|figures]], readable [[#adding_equations|equations]], and [[#adding_tables_lists|tables and item lists]]. The syntax for different text styles such as **bold** or //italic// is described in detail on the [[wiki:syntax|Syntax Wiki Page]].\\ Each Wiki page should consist of the most important information of the corresponding topic in a as short as possible and to the point manner. Since these pages are made by students and for students and serve also as a preparation for the exam or help with solving the exercises, it is good to keep them not too long but still with the most important points. Please also check already existing topics as an orientation.\\ == 2.1. Headings & Tables of Content == In this Wiki there are 5 levels of headings. You can create them by putting equal-signs on either side of the heading: ====== Level 1 Heading ====== ... == Level 5 Heading == Numbering, if desired, needs to be added manually. A table of content is created automatically, if the following criteria are fulfilled: At least 3 headings of level 1 to 3. Level 4 and 5 will not be displayed in the table of contents.\\ == 2.2. Links == [[#additional_helpful_links|Additional helpful links]] can be very useful or serve as a [[#references|reference]]. They are created by putting them between double squared brackets. The link address and the link name should be separated by a vertical line.\\ Link to an existing section of this page (heading):\\ [[#additional_helpful_links | Additional helpful links]] Link to another existing page in this Wiki:\\ [[: | main page]] [[:wiki_help | Wiki Help]] Link to an external page:\\ [[https://www.dokuwiki.org/manual | Wiki Manual]] [[:help | Wiki Help]]\\ == 2.3. References == Das Verfassen von wissenschaftlichen Artikeln beinhaltet **immer** die Angabe von Quellen. Dies gilt auch für dieses Wiki. Allerdings gibt es keine speziellen formalen Vorgaben. Generell gilt: Direkt kopierter Text muss durch //kursive Schrift// und/oder "Anführungszeichen" gekennzeichnet werden, gefolgt von einer Quellenangabe. Umformuliertes Wissen, Abbildungen, oder der Verweis auf die Arbeit anderer Autoren zieht zwingend eine Quellenangabe nach sich. Quellenangaben können direkt im Text [Quelle: http://de.wikipedia.org/wiki/Quellenangabe] gemacht werden oder durch eine Fussnote[[#referenzen|[1]]]/Autor-Jahr-Angabe [[#referenzen|[Wikipedia, 2013]]] eingefügt werden. Dies gilt gleichermassen für Internet, Bücher oder wissenschaftliche Artikel.\\ == 2.4. Adding Figures == Das Einfügen von Abbildungen kann sehr hilfreich sein. Abbildungen können entweder auf die Wiki-Seite geladen werden oder durch einen Link auf eine andere Seite eingebunden werden.\\ Um eine Abbildung auf die Wiki-Seite zu laden klicken Sie im Menü links auf //[[https://oceanwiki.ethz.ch/doku.php?id=start&do=media | Medien-Manager]]// und dort auf //bilder//. Dort können Sie Dateien hochladen. Die Einbindung erfolgt über einen Link zu dem Bild in doppelten geschweiften Klammern:\\ {{bilder:bild1.png|Dieser Text erscheint wenn man mit der Maus über das Bild fährt}} Das Bild kann ausgerichtet werden indem man innerhalb der Klammern vor oder nach dem Bild zwei Leerzeichen einfügt:\\ {{ bilder:bild1.png|Dieser Text erscheint wenn man mit der Maus über das Bild fährt}} Um das Bild zu Vergrössern oder Verkleinern kann hinter dem Link ein Fragezeichen gesetzt werden gefolgt von eine Grössenangabe (Breite x Länge in Pixeln):\\ {{ bilder:bild1.png?300x200|Dieser Text erscheint wenn man mit der Maus über das Bild fährt}} Bitte beachten Sie bei Abbildungen immer die Quelle anzugeben und dass die Auflösung hoch genug ist um etwas zu erkennen aber nicht so hoch, dass zu viel Speicherplatz gebraucht wird.\\ == 2.5. Adding Equations == Gleichungen oder mathematische Sonderzeichen sollten **nicht** in Form von Bildern oder im normalen Textformat eingefügt werden, sondern mit Hilfe einer [[https://www.dokuwiki.org/plugin:latex|LaTeX Syntax]]. [[http://web.ift.uib.no/Teori/KURS/WRK/TeX/symALL.html|Hier]] finden Sie eine Zusammenfassung von mathematischen Symbolen und Formeln im LaTeX-Format. Die Eingabe im LaTeX-Format wird zwischen zwei Dollarzeichen gesetzt:\\ $\rho$ ergibt "$\rho $". Dies funktioniert auch bei Gleichungen. Soll die Gleichung in einer separaten Zeile herausgestellt werden, kann man sie folgendermassen grösser ausdrucken lassen \begin{equation*} N^2 = -\frac{g}{\rho} \frac{\partial{\sigma_{\vartheta}}}{\partial{z}}, \end{equation*} was wie folgt aussieht: \begin{equation*} N^2 = -\frac{g}{\rho} \frac{\partial{\sigma_{\vartheta}}}{\partial{z}}, \end{equation*} oder bei mehreren Gleichungen, die aufeinander folgen: \begin{eqnarray*} & & \frac{3}{4 \pi} \sqrt{4 \cdot x^2 + 12},\\ & & e^{i \pi} + 1 = 0. \end{eqnarray*} ergibt: \begin{eqnarray*} & & \frac{3}{4 \pi} \sqrt{4 \cdot x^2 + 12}\\ & & e^{i \pi} + 1 = 0. \end{eqnarray*} Wenn man die Sterne ''*'' weglässt, werden die Gleichungen nummeriert. Generell sollten alle verwendeten Variablen deklariert werden und Konstanten angegeben werden. Bitte nur vorlesungsrelevanten Gleichungen verwenden.\\ == 2.6. Adding Tables & Lists == Manchmal eignet sich eine Tabelle oder Auflistung zur übersichtlichen Darstellung. Tabellen werden durch eine Titelleiste (getrennt durch "^") und den darauf folgenden Inhalt (getrennt durch "|") eingefügt: ^ Woche ^ Datum ^ Vorlesung ^ ^ 1 | 20.2. | Einführung und Motivation | Eine Auflistung erfolgt auf einer neuen Zeile durch zwei Leerzeichen, gefolgt von einem "*" oder "-", gefolgt von Leerzeichen und Text. ==== 3. Additional helpful links ==== * [[wiki:syntax|Wiki Syntax]] * [[https://www.dokuwiki.org/manual|Wiki Handbuch]] * [[https://www.dokuwiki.org/plugin:latex|LaTeX plugin]] für Gleichungen * [[http://web.ift.uib.no/Teori/KURS/WRK/TeX/symALL.html|Zusammenfassung von mathematischen LaTeX Symbolen]] ==== 4. References ==== (For example:)\\ [1] Page for „Quellenangabe“. In: Wikipedia, Die freie Enzyklopädie. Bearbeitungsstand: 1. Dezember 2012, 10:30 UTC. URL: http://de.wikipedia.org/w/index.php?title=Quellenangabe&oldid=111151941 (Abgerufen: 19. Februar 2013, 13:28 UTC)\\