Formatierung im Forum

Aus der Mikrocontroller.net Artikelsammlung, mit Beiträgen verschiedener Autoren (siehe Versionsgeschichte)
Wechseln zu: Navigation, Suche

Das Forum bietet folgende Möglichkeiten zur Formatierung von Text in Beiträgen:

  • *hervorheben*hervorheben (Mobil) → hervorheben (Desktop)
  • _hervorheben_hervorheben (Mobil) → hervorheben (Desktop)
  • /hervorheben/ → /hervorheben/ (Mobil) → hervorheben (Desktop)
  • [c]C-Code[/c]
  • [avrasm]AVR-Assembler-Code[/avrasm]
  • [vhdl]VHDL-Code[/vhdl]
  • [pre]vorformatierter Text (z. B. Code in anderen Sprachen), ASCII-Zeichnungen[/pre]
  • [math]Formel in LaTeX-Syntax[/math][math]\displaystyle{ \LaTeX }[/math] (siehe unten)
  • [[Standardbauelemente]]Standardbauelemente (Link zu Wiki-Artikel)

Zitate

Zitate vorangegangener Beiträge kann man, in Anlehnung an die gängige Internet-Konvention für E-Mails, durch Voranstellen eines Größer-als-Zeichens (>) kennzeichnen. Bei ihnen wird der normale Zeilenumbruch nicht erneut durchgeführt (das war ja bereits zuvor im Originalartikel erfolgt), und das Zitat wird in der Darstellung farblich gekennzeichnet. Falls mehrere Zitatebenen existieren (verschieden viele >-Zeichen am Anfang), dann gibt es für die Ebenen verschiedene Farben.

Angemeldete Nutzer können sich für einen Beitrag, auf den sie antworten, über den Link Antwort mit Zitat (rechts unter dem Beitrag) eine Vorlage des Beitrags im Editorbereich erzeugen lassen, der um eine Zitatebene eingerückt worden ist.

Automatische Verlinkung

  • Im Text genannte ISBN-Nummern (z. B. „ISBN 123-4567-890“) werden automatisch in Links zu Amazon umgewandelt.
  • Artikelnummern von Conrad, Ebay und ELV werden automatisch in Links zum Artikel umgewandelt, wenn irgendwo im Text der Name des Anbieters vorkommt.
  • Manche Begriffe (z. B. „AVR“) werden automatisch in Links auf die entsprechenden Wiki-Artikel umgewandelt. Für welche Begriffe dies geschieht ist nicht genau bekannt. Daher hat diese Funktion für Verfasser von Foren-Beiträgen keinen echten Nutzen. Wer einen Link auf einen Artikel in einem Beitrag setzen möchte, sollte den Link manuell wie oben beschrieben setzen.
  • Einige Begriffe, wie zum Beispiel „Tietze-Schenk“, werden automatisch in Links auf Bezugsquellen umgewandelt.
  • Manche Bauteilebezeichnungen wie BC547 werden automatisch in Links auf zugehörige Bauteile-Seiten umgewandelt. Im Fall von „BC547“ zum Beispiel auf https://www.mikrocontroller.net/part/BC547. Eine Bauteil-Seite enthält wiederum Links auf Forumsbeiträge und Wiki-Artikel, in denen dieses Bauteil diskutiert wird. Ebenso Links zu Bezugsquellen und ein Datenblatt.

Soweit ein automatisch erzeugter Link direkt zu einem kommerziellen Angebot führt, wird der Link automatisch mit einer Fußnote „* Anzeige-Link“ versehen.

Formel-Beispiele

Da die TeX-Formelsyntax nicht jedem unbedingt geläufig ist, hier ein paar Beispiele.

→ Siehe auch: Wikipedia-Hilfe für TeX

Hoch- und Tiefstellungen

Hochstellungen (Potenzen, Superscript) erzeugt man mit einem Dach ^ (ASCII Caret, Zeichen 0x5E). Das unmittelbar folgende Zeichen wird dabei hochgestellt; falls man mehrere Zeichen hochstellen will, muss man diese in geschweifte Klammern einschließen.

Tiefstellungen (Indices, Subscript) funktionieren gleichermaßen, werden jedoch mit einem Unterstrich (ASCII 0x5F) eingeleitet.

Eine Hoch- und eine Tiefstellung lassen sich auch kombinieren.

[math] A^2 = l_1^2 \cdot l_2^2 [/math]

Darstellung: [math]\displaystyle{ A^2 = l_1^2 \cdot l_2^2 }[/math]

Gemeine Brüche: \frac

Einen gemeinen Bruch (Bruch mit Bruchstrich in der Mitte) stellt man durch \frac dar. Dieser Operator nimmt zwei Argumente für den Zähler und Nenner, die jeweils in einem Paar geschweiften Klammern stehen.

[math] P = \frac{U_\text{eff}^2}{R_L} [/math]

Darstellung: [math]\displaystyle{ P = \frac{U_\text{eff}^2}{R_L} }[/math]

Summen, Reihen, Integrale

Das Summenzeichen (großes Sigma) wird durch \sum bezeichnet. Die Grenzen der Summation werden dabei als normale Hoch- und Tiefstellungen angefügt. Die Summanden selbst bedürfen keiner weiteren Sonderbehandlung, sondern werden angehängt.

[math] \sin(x) = \sum_{i = 0}^{\infty} (-1)^i \cdot \frac{x^{2i+1}}{(2i+1)!} [/math]

Darstellung: [math]\displaystyle{ \sin(x) = \sum_{i = 0}^{\infty} (-1)^i \cdot \frac{x^{2i+1}}{(2i+1)!} }[/math]

Gleiches trifft auf Integrale zu; das Integralzeichen heißt dabei \int.

[math] W = \int_{t = 0}^{t_i}u(t) \cdot i(t) dt [/math]

Darstellung: [math]\displaystyle{ W = \int_{t = 0}^{t_i}u(t) \cdot i(t) dt }[/math]

Zeichenabstände und Text in Formeln

Manchmal möchte man in einer Formel einen zusätzlichen Abstand zwischen Zeichen einfügen. Da in Formeln jedoch Leerzeichen ignoriert werden, muss man hier ebenfalls spezielle Kommandos benutzen. Das einfachste ist ein „\ “ (ein Backslash gefolgt von einem Leerzeichen). Dadurch wird ein zusätzlicher normaler Zeichenabstand eingefügt.

Beispiel:

[math] 1 2 3 \ 1 \ 2 \ 3 [/math]

Darstellung: [math]\displaystyle{ 1 2 3 \ 1 \ 2 \ 3 }[/math]

Ein schmaler Abstand (z. B. zwischen Maßzahl und Einheit) wird mittels „\,“ erzeugt. Ein Komma in einer Zahl wird in geschweifte Klammern eingeschlossen, da TeX ansonsten einen Abstand nach dem Komma einfügt; Einheiten werden z. B. mittels \text{} aufrecht gesetzt.

Beispiel:

[math]U_\text{Batt} = 13{,}8\,\text{V}[/math]

Darstellung: [math]\displaystyle{ U_\text{Batt} = 13{,}8\,\text{V} }[/math]

Beliebiger Text kann mit dem Befehl \mbox{} eingebaut werden. Der Inhalt der geschweiften Klammern wird dann in Normalschrift gesetzt. Für den Inhalt einer mbox gelten die üblichen LaTeX-Regeln für den Textsatz. Z. B. werden bei mehreren aufeinanderfolgenden Leerzeichen alle bis auf eines ignoriert.

[math] normaler \ Formeltext \ \mbox{Dies     ist ein Text  mit    vielen     Leerzeichen} [/math]

Darstellung: [math]\displaystyle{ normaler \ Formeltext \ \mbox{Dies ist ein Text mit vielen Leerzeichen} }[/math]

Klammern

In der Größe angepasste Klammern und sonstige Symbole können mit \leftSYMBOL und \rightSYMBOL erzeugt werden. Für SYMBOL können z. B. ([ bzw. ]) oder auch | eingesetzt werden. Bei den geschweiften Klammern {}, die in LaTeX eine besondere Bedeutung haben, muss die entsprechende LaTeX-Befehlssequenz \{ bzw. \} für SYMBOL gesetzt werden.

Klammern müssen immer paarweise gesetzt werden. Wenn ein Begrenzer (Delimiter) nur öffnend oder nur schließend dargestellt werden soll (z. B. geschweifte Klammer vor Array-Darstellungen, Fallunterscheidung, Beispiel siehe weiter unten), dann muss ein entsprechendes "\left." oder "\right." gesetzt werden, um das Klammernpaar syntaktisch zu schließen. Der Punkt ersetzt dabei die Klammer, wird aber nicht angezeigt. Beispiel:

[math] \left. \left\{ \left( \left[ \frac{abc}{def} \right] \right) \right\} \right|_{\alpha = 0} [/math]

Darstellung: [math]\displaystyle{ \left. \left\{ \left( \left[ \frac{abc}{def} \right] \right) \right\} \right|_{\alpha = 0} }[/math]

Das "\left." am Anfang gehört zu dem "\right|" am Ende. Ohne das "\left." ergäbe sich ein Parser-Fehler.

Mit normalen Klammern (also ohne \left und \right) sähe das so aus: [math]\displaystyle{ ( [ \frac{abc}{def} ] ) |_{\alpha = 0} }[/math]

Ein Beispiel für die Verwendung einer einzelnen öffnenden Klammer für eine Fallunterscheidung:

[math] \mbox{Wert} = \left\{ \begin{array}{c} \mbox{Fall 1} \\ \mbox{Fall 2} \\ \mbox{Fall 3} \end{array} \right. [/math]

Darstellung: [math]\displaystyle{ \mbox{Wert} = \left\{ \begin{array}{c} \mbox{Fall 1} \\ \mbox{Fall 2} \\ \mbox{Fall 3} \end{array} \right. }[/math]

Mit \overbrace und \underbrace sind auch horizontale (geschweifte) Klammern möglich, z. B. zum Zusammenfassen und Beschriften von Teilausdrücken. \overbrace und \underbrace besitzen als Parameter den Ausdruck, der "überklammert" werden soll. Ein direkt anschließender hochgestellter bzw. tiefgestellter Ausdruck wird zentriert über bzw. unter der Klammer angeordnet.

Beispiel:

[math] \overbrace{a+b+c}^{\alpha} \geq \underbrace{d+e+f}_{\delta} [/math]

Darstellung: [math]\displaystyle{ \overbrace{a+b+c}^{\alpha} \geq \underbrace{d+e+f}_{\delta} }[/math]

Quadrat- und andere Wurzeln

Eine Quadratwurzel wird mit "\sqrt" erzeugt.

Beispiel:

[math]U_\text{eff}\cdot \sqrt{2} = \hat{u}[/math]

Darstellung: [math]\displaystyle{ U_\text{eff} \cdot \sqrt{2} = \hat{u} }[/math]

Das "\sqrt" kann dabei ein optionales Argument (in eckigen Klammern) erhalten, das den Grad der Wurzel anzeigt.

Beispiel:

[math] a = \sqrt[3]{V} [/math]

Darstellung: [math]\displaystyle{ a = \sqrt[3]{V} }[/math]

Verschiedene Sonderzeichen

Das griechische Alphabet ist nahezu vollständig als Kleinbuchstaben und in einigen Großbuchstaben darstellbar. Dem Backslash folgt dabei der Namen des Buchstabens (bei Großbuchstaben mit einem großen Buchstaben beginnend). Beispiel:

[math] \pi \Omega \rho [/math]

Darstellung: [math]\displaystyle{ \pi \Omega \rho }[/math]

Es ist darauf zu achten, dass das in der Physik meist verwendete kleine griechische theta (z. B. als Formelzeichen für die relative (Celsius-) Temperatur verwendet) in den üblichen Zeichensätzen anders dargestellt wird. Die "klassische" Form des kleinen theta heißt in LaTeX \vartheta.

[math] \theta \ \ \vartheta [\math]

[math]\displaystyle{ \theta \ \ \vartheta }[/math]

Das Kommando \dot erzeugt keinen Multiplikationspunkt in der Mitte, sondern punktuiert das nachfolgende Zeichen:

[math] v = \dot{s} [/math]

Darstellung: [math]\displaystyle{ v = \dot{s} }[/math]

Auch mehrere Punkte sind möglich, bekommen aber dann ein neues Kommando:

[math] a = \ddot{s} [/math]

Darstellung: [math]\displaystyle{ a = \ddot{s} }[/math]

Der Multiplikationspunkt heißt dagegen \cdot. Das Beispiel zeigt außerdem noch einige andere häufig benötigte mathematische Symbole.

[math] \cdot \pm \leq \geq \equiv \approx \sim \ne [/math]

Darstellung: [math]\displaystyle{ \cdot \pm \leq \geq \equiv \approx \sim \ne }[/math]

Pfeile können erzeugt werden mit

[math] \leftarrow \rightarrow \Leftarrow \Rightarrow \longleftarrow \longrightarrow \Longleftarrow \Longrightarrow [/math]

Darstellung: [math]\displaystyle{ \leftarrow \rightarrow \Leftarrow \Rightarrow \longleftarrow \longrightarrow \Longleftarrow \Longrightarrow }[/math]

Auch Doppelpfeile sind darstellbar:

[math] \leftrightarrow \Leftrightarrow \longleftrightarrow \Longleftrightarrow [/math]

ergibt [math]\displaystyle{ \leftrightarrow \Leftrightarrow \longleftrightarrow \Longleftrightarrow }[/math]

Buchstaben werden im Mathematikmodus automatisch [math]\displaystyle{ kursiv }[/math] gesetzt. Um Bezeichnungen von Funktionen wie Sinus, Cosinus oder Logarithmus besser von Variablennamen unterscheiden zu können, gibt es eine Reihe von Makros, die aus dem Backslash gefolgt von der allgemein üblichen Kurzbezeichnung der betreffenden Funktion besteht. Diese Funktions-Formelzeichen werden dann in Normalschrift gesetzt.

Beispiele:

[math] \sin \ \cos \ \ln \ \log \ \lg \ \tan \ \arctan [/math]

Darstellung: [math]\displaystyle{ \sin \ \cos \ \ln \ \log \ \lg \ \tan \ \arctan }[/math]

Diverse Akzentzeichen besitzen auch ein jeweils eigenes Kommando, das in der Elektrotechnik häufigste dürfte das Dach (für den Spitzenwert einer veränderlichen Größe) sein:

[math] \hat{p} = \hat{u} \cdot \hat{i} [/math]

Darstellung: [math]\displaystyle{ \hat{p} = \hat{u} \cdot \hat{i} }[/math]