logoOL.gif
user_gelb_schwarz_or.gif
logoUL.gif
logoUR.gif claim.gif
LinuxUser LinuxCommunity EasyLinux Linux-Magazin International

Der folgende Text verdeutlicht Ihnen das Markup eines User-Artikels. Mit Hilfe einfacher Tags (hier grün hervorgehoben) zeichnen Sie die einzelnen Elemente Ihres Textes aus. Schreiben Sie Ihren Text als Plain-Text, auch als ASCII-Format bekannt. Dazu verwenden Sie die Kodierung ISO-8859-1 oder ISO-8859-15. Eine von beiden ist auf aktuellen Linux-Systemen meist voreingestellt.

In dieser Version wurden einige Elemente zur besseren Orientierung für Sie mitthilfe von HTML-Code hervorgehoben. Ihr Text darf jedoch keine HTML-Zeichen enthalten - außer Sie schreiben über ein Thema mit HTML-Bezug ;-)

@D:Pinguine verwalten mit dem Pinguin-Daemon

@T:Eiskalt administriert

@V:Große Mengen Pinguine lassen sich nur schwer überblicken und verwalten. Der neue Pinguin-Daemon erlaubt dies in einer neuen und zukunftsweisenden Art und Weise.

@A:Kalle Pinguin

@ZKT:README
@KL:Das README gibt dem Leser in kurzer Form einen Überblick über den genauen Inhalt des Artikels. Es soll den Leser neugierig machen. Die Überschrift des Kastens lautet immer "README" (in Großbuchstaben).
@KE:

@L:Sie haben sich in den Kopf gesetzt, einen Artikel für den LinuxUser zu schreiben? Gut. Dann beginnt der Text beim ersten Schreiben genau an dieser Stelle. Alles, was Sie weiter oben sehen -- die Dachzeile (@D:), die Überschrift (@T:) und den Vorspann (@V:) -- formulieren Sie am besten erst, wenn der gesamte Artikel fertig ist.

@L:Der Vorspann macht Werbung für den Artikel, klärt also die Frage, warum jemand den Text lesen sollte. Die Dachzeile gibt in sachlicher Form kurz Auskunft über den Inhalt des Artikels. Bei der Überschrift dürfen Sie Ihrer Phantasie freien Lauf lassen -- im Idealfall finden Sie eine bildliche Metapher, die die Redaktion später in einem Aufmacherbild umsetzt.

@L:Auch der erste Abschnitt eines Artikels hat noch mehr mit Psychologie als mit Linux zu tun: Mit ihm locken Sie den Leser quasi in den Artikel. Besonders gut funktioniert das mit einer Anekdote oder indem Sie Erfahrungen ausbreiten, die vielen nicht unbekannt sind. Ist diese Hürde überwunden, lesen die meisten erstmal weiter, und Sie gehen mit dem Text nun ins Detail.

@L:Ein Wort zu den Konventionen beim Schreiben: Achten Sie bitte darauf, identische Begriffe immer gleich zu verwenden. Es irritiert, wenn Sie einmal vom Pinguind und einmal vom PinguinD sprechen. Was das Schreiben von Software-Namen betrifft, richtet sich der LinuxUser meist danach, wie ein Projekt sich selbst schreibt -- sofern hier wie bei TeX/LaTeX Einigkeit besteht.

@L:Durchgängige Großschreibung behalten wir Akronymen wie KDE, PNG, JPG und TIF vor; spricht sich die Abkürzung wie ein Wort aus, schreiben wir sie meist auch wie ein solches: Suse, Gnome, Jpeg, Tiff.

@L:Ein paar weitere Schreibweisen haben wir der Einheitlichkeit halber festgelegt: Red Hat, OpenOffice (nicht OpenOffice.org), Trolltech, Qt, Tcl/Tk, Knoppix, Postscript, Manpage, Window-Manager, GTK, Open-Source-Software, freie Software, X Window System, der Tarball, das Tar-Archiv, die URL, die Firewall, das Release, die E-Mail, KByte, MByte und GByte.

@ZT:Rechtschreibung und Sprache

@L: Hinsichtlich der Rechtschreibung folgt LinuxUser der neuen deutschen Rechtschreibung nach der am 1. August 2006 in Kraft getretenen Fassung. Sofern diese verschiedene Schreibweisen zulässt, betrachten wir grundsätzlich diejenige als maßgeblich, die im Duden (Bd.1, "Die deutsche Rechtschreibung", 25. Aufl., 2009) durch gelbe Hinterlegung als bevorzugte Schreibweise ausgewiesen ist.

@L: In einem Fachmagazin zu Themen der Computertechnik tauchen notwendigerweise auch englischsprachige Fachbegriffe auf, für die es kein angemessenes deutsches Gegenstück gibt, wie etwa Shell oder Stack. (Ja, wir kennen Begriffe wie Befehlszeilenschnittstelle oder Kellerspeicher, die sich aber aus offensichtlichen Gründen nie in der Praxis eingebürgert haben.) Dadurch sollten Sie sich aber nicht zu Denglisch verleiten lassen, also dem Spicken von Texten mit unnötigen Anglizismen. Hängen Sie im Zweifelsfall also lieber ein Laufwerk ein, als ein Volume zu mounten.

@L: Hüten Sie sich vor allen Dingen vor "false friends" insbesondere bei den Adjektiven: So heißt performant im Deutschen soviel wie redegewandt, und weder bei granular noch granulär handelt es sich überhaupt um ein Wort aus unserer Sprache. Der Duden kennt lediglich "granulös", was körnig bedeutet. Wenn Sie also schnelle Rechner, leistungsfähige Programme und fein abgestufte Rechte meinen, dann schreiben Sie es besser auch so.

@L: Eine besonders leidige Form der Nichtübersetzung aus dem Englischen führt zu Begriffen wie Selektion und selektieren, die -- ebenso wie die Vokabeln ausmerzen und durchführen -- zum Lieblingsjargon der Nazi-Verbrecher gehörten. In LinuxUser haben diese Begriffe deshalb nichts zu suchen. Eine Selektion haben zuletzt die Schergen an den Rampen der KZs durchgeführt, um ihre Opfer anschließend auszumerzen. Ein Linux-Anwender wählt Menüpunkte aus, nimmt eine Suche vor oder beseitigt Fehler im Code.

@ZT:Befehle, Code und Navigation in grafischen Programmen

@L:Steht Code mitten im Text -- etwa der Befehl <C>pinguind<C>, so drucken wir diesen in einem nichtproportionalem Font. Um dies zu kennzeichnen, kommt das Tag <C> zum Einsatz. Mit ihm fassen Sie beispielsweise auch Datei- oder Verzeichnisnamen ein.

@L:Menü- oder Button-Bezeichnungen setzen wir dagegen kursiv mittels <I>. Als Trennzeichen zwischen Menüeinträgen dient das Pipe-Zeichen mit je einem Leerzeichen davor und dahinter: <I>Datei<I> | <I>Seite öffnen...<I>. Liegt ein Programm in deutscher Lokalisierung vor, verwenden Sie auch bitte die deutschen Bezeichnungen.

@L:Wenn Sie von Software sprechen, bei der die Schreibweise des Namens von der der entsprechenden ausführbaren Datei abweicht, verzichten Sie bitte auf die Formatierung (Beispiel: KMail, aber <C>kmail<C>). Code-Blöcke, aber auch längere einzelne Code- und Kommandozeilen setzen Sie der besseren Übersicht wegen mittels @LI: ab:

@LI:
#!/usr/local/bin/pinguinshell
for pinguin in list:
  print pinguin.id

@L:Bitte beachten Sie, dass die Redaktion längere Codezeilen später im Spaltensatz des Layouts umbrechen muss. Daher bietet es sich hin und wieder an, auf überflüssige Leerzeichen oder Leerzeilen zu verzichten, um Platz zu sparen. Nimmt ein umbrochener Listing-Text dennoch mehr als fünf Zeilen ein, lagern Sie das Listing einfach in einen entsprechenden Kasten aus, wie in Listing 1 gezeigt.

@L:Referenzieren Sie den Listing-Kasten bitte unbedingt anhand seiner Nummer, also Listing 1, denn es kann gut sein, dass das Layout ihn nicht direkt beim passenden Text, sondern zum Beispiel auf der gegenüberliegenden Seite plaziert.

@KT:Listing 1
@LI:§§nonumber
#include <iostream.h>

int main()
{
 cout << "Hallo, Pinguin!" << endl;
}
@KE:

@L:Bitte achten Sie bei abgesetzten oder ausgelagerten Kommandozeilenbefehlen darauf, keinen Platz mit überlangen Prompts zu schinden. Wenn Sie nur den Befehl selbst aufführen, bietet es sich außerdem an, das Kommando in den Lauftext zu ziehen: <C>find /home/pinguin -name pinguin.txt<C>.

@L:Geben Sie seine Ausgabe mit an, formatieren Sie die Benutzereingabe fett. Hier hat auch ein kurzer Prompt seine Berechtigung ($ für den User-Prompt, # für den Root-Prompt):

@LI:
$ <§§B>find . -name pinguin.txt<§§B>
./pinguin.txt

@L:Code- oder Befehlsteile, die der Leser an seine Umgebung anpassen muss, formatieren Sie in abgesetzten oder ausgelagerten Listings bitte kursiv mittels <§§I>:

@LI:
$ find <§§I>Verzeichnis<§§I> -name <§§I>Dateiname<§§I>

@L:Mit der zusätzlichen Angabe §§nonumber unterdrücken Sie das Nummerieren der Listing-Zeilen. Im Regelfall benötigen Sie keine Zeilennummern, da das Layout die Zeilen in einem Kasten farblich von einander absetzt.

@L:Möchten Sie jedoch die Zeilen im Text explizit referenzieren, verwenden Sie statt §§nonumber das Prefix §§donumber. Beim Konvertieren des Textes im weiteren Workflow innerhalb der Redaktion erhalten die Zeilen dann automatisch Nummer. Sie brauchen diese nicht einzugeben.

@L:Bitte beachten Sie: Ein Abschnitt -- also der Bereich zwischen zwei Zwischenüberschriften (@ZT:) -- kann aus layouttechnischen Gründen nie mit einem abgesetzten Listing (@LI:) enden. Nach diesem muss vor der nächsten Zwischenüberschrift mindestens noch ein Absatz (@L:) mit wenigstens 80 Zeichen -- das entspricht gedruckt drei Zeilen - folgen.

@ZT:Tastenkürzel

@L:Anders als Befehle im Fließtext schreiben wir Tastenkürzel nicht kursiv, sondern in eckigen Klammern: So symbolisiert [Alt]+[F4], dass der Anwender gleichzeitig die Taste [Alt] und die Funktionstaste [F4] drücken soll. Die gleichzeitig zu betätigenden Tasten verbindet ein Pluszeichen. Kommen Tasten nacheinander (nicht gleichzeitig) zur Anwendung, machen LinuxUser-Artikel das wie folgt deutlich: [Alt],[T].

@L:Da die Mehrzahl unserer Leserschaft deutsche Keyboards verwendet, heißt die Control-Taste bei uns [Strg], die Insert-Taste [Einfg], die Shift-Taste [Umschalt] und die Return-Taste [Eingabe]. Die Taste mit dem seltsamen Fenster-Zeichen darauf heißt übrigens [Super].

@L:Die Tasten werden stets so angegeben, wie sie beschriftet sind: Ein Druck auf [A] produziert ein "a", für ein "A" gilt es [Umschalt]+[A] zu drücken. Das gilt auch für Symbole -- ein Fragezeichen "?" entspricht [Umschalt]+[ß], ein Backslash "\" entsteht per [AltGr][ß].

@ZT:Glossareinträge

@L:Damit die Texte im LinuxUser nicht mit Erläterungen überladen sind, bietet das Layout die Möglichkeit, diese in einen <S>Glossareintrag<S> auszulagern. Diese erscheinen dann im fertigen Heft in der <S>Marginalspalte<S> in der Nähe des referenzierten Begriffs.


@S:<S>Glossareintrag:<S> Glossareinträge stehen in Ihrem Text optimalerweise nach dem Absatz, in dem Sie etwas erläutern möchten. Sie sollen ein Aha-Erlebnis auslösen, damit es im Lesefluss weitergeht, wenn jemand beim Lesen über das Wort stolpert. Das @S: leitet einen solchen Absatz ein. Darauf folgt gleich der in <S> eingeschlossene Begriff inklusive Doppelpunkt. Übrigens, nicht nur Wörter und Wortgruppen, sondern auch Befehle und -- wenn nötig -- darf sogar nur eine einzelne Option, ein einzelnes Zeichen einen eigenen Eintrag bekommen.

@S:<S>Marginalspalte:<S> Der Fachbgeriff für den schmalen Rand, der sich außerhalb der Textspalten befindet. Im LinuxUser stehen in der Marginalspalte häfig Glossareinträge, Bildunterschriften oder auch das Readme am Anfang des Artikels.


@ZT:Listen

@L:Setzen Sie Listen bitte mit Bedacht ein. Oftmals zeigt sich, dass ein ausformulierter Text besser für das Verständnis ist. Manchmal sorgen Auflistungen jedoch für Transparenz. Verwenden Sie dann einfach einen *, um die einzelnen Listeneinträge zu trennen. Dieser steht immer am Anfang einer Zeile, und nach einem Listeneintrag folgt eine Leerzeile:

@L:* Erster Punkt

@L:* Zweiter Punkt

@L:* Letzter Punkt

@L:Ein Abschnitt -- also der Bereich zwischen zwei Zwischenüberschriften (@ZT:) -- kann aus layouttechnischen Gründen nie mit einer Aufzählung enden. Nach dieser muss vor der nächsten Zwischenüberschrift mindestens noch ein Absatz (@L:) mit wenigstens 80 Zeichen -- das entspricht gedruckt drei Zeilen - folgen.

@ZT:Abbildungen

@L:Wenn möglich sollte jede Seite Ihres Artikels mindestens ein Bild enthalten, um eine ermüdende Bleiwüsten zu vermeiden. Bei den Abbildungen handelt es sich jedoch nicht einfach nur um schmückendes Beiwerk: Genau wie der Text selbst übermittelt ein Bild eine Information - wenn nicht, lassen Sie es getrost weg. Sie finden sicher ein anderes, das mehr sagt als tausend Worte.

@L:Im folgenden sehen Sie, wie Sie Bilder in den Text integrieren. Beachten Sie bitte, dass Abbildungen genau wie Listing-Kästen fließende Objekte sind, die im Layout garantiert nicht direkt vor oder nach dem bezugnehmenden Text zu stehen kommen. Deshalb müssen Sie Bilder im Text referenzieren (Abbildung 1). Dabei kürzen Sie das Wort "Abbildung" anders als in der Bildunterschrift nicht ab.

@BI:b01-abbildung.png

@B:Abb. 1: Denken Sie sich für die Bildunterschrift einen Satz aus, der eine zusätzliche Information gibt oder einen wichtigen Aspekt der Abbildung beschreibt.

@L:Bitte liefern Sie Abbildungen (für Screenshots grundsätzlich PNG, JPG (nur) für Fotos, Xfig- oder Postscript-Dateien für grafische Darstellungen) immer so hoch aufgelöst wie möglich mit.

@ZT:Tabellen zur Abwechslung

@L:Tabellen eignen sich für Vergleiche bei Tests oder als bewusst als Leserservice gedachte Mini-Nachschlagewerke. Auch diese müssen Sie im Text referenzieren, und zwar durch die Tabellenüberschrift (siehe Tabelle "Escape-Sequenzen"). Tabellen bekommen keine fortlaufenden Nummern. Beachten Sie bei der Formatierung bitte das Beispiel in der Tabelle "Escape-Sequenzen".

@TT:Escape-Sequenzen
@TH:Sequenz Funktion
@TL:\a Klingelton
@TL:\b Backspace
@TL:\f Formfeed
@TZT:Tabellenzwischentitel
@TL:\n Newline
@TL:\r Return
@TL:\t Tabulator
@TL:\v Vertikaltabulator
@TE:

@L:Als Feldtrenner innerhalb der Tabelle fungiert der Tabulator. Größere Tabellen erstellen Sie zweckmäßigerweise in einer Tabellenkalkulation wie OOo Calc und exportieren sie dann als durch Tabs separiertes CSV. Wie Sie sehen, steht Ihnen mit dem Absatz-Tag @TZT: in ein Weg offen, die Zeilen Ihrer Tabelle zu gliedern oder am Ende eine durchgehende Zeile für Erläterungen einzufügen. In manchen Fällen - vor allem bei Tests - stehen Bilder in Tabellenzellen. Diese binden Sie mit dem Tag <BI> ein. Beispiel: @TL:<BI>abb.png<BI>

@ZT:Spezialfälle

@L:Wollen Sie dem betreuenden Redakteur eine Textpassage erläutern, verwenden Sie für den folgenden Absatz das Tag @#:. Wie in vielen Programmiersprachen dient das Hash-Tag dem Einfügen von Notizen, die später auf jeden Fall nicht in der Ausgabe erscheinen.

@L:Legen Sie bei Begriffen, die sich aus mehren Wörtern zusammensetzen, Wert darauf, dass diese zusammen in einer Zeile stehen, so zeigen Sie dies mit einem geschützten Leerzeichen an. Ein Beispiel zeigt, wie Sie dies in Ihrem Artikeltext umsetzen: Red**Hat. Die Redaktion behät sich aber vor, sich über diese Angabe hinwegzusetzen.

@L:Bei Zahlen über Eintausend teilt ein kleiner Leeraum die Zahl in Dreiergruppen. Sie können diesen selber einfügen; ein Beispiel zeigt, wie es geht: 25:*000. Gedankenstriche schreiben Sie bitte als Doppelminus.

@L:Im Lauftext verwenden wir normalerweise keine Hochzahlen. Sie kommen aber hin und wieder in Tabellen zum Einsatz, um zu einem Punkt noch eine zusätzliche Erläterung zu liefern. Schließen Sie mit dem Tag <+> ein Zeichen ein, dann erscheint es später im Text hochgestellt. Wollen Sie dagegen ein Zeichen tieferstellen, dann verwenden Sie die folgende Notation: S<->0<->.

@ZT:Kästen und Infos

@L:Nun fehlen lediglich noch die Literaturangaben: Ein kleiner Kasten mit der Überschrift "Infos", der URLs oder Verweise auf bereits veröffentlichte Artikel zum selben (oder verwandten) Thema aufführt.

@L:Guter Service an den Lesern und Leserinnen äußert sich unter anderem auch darin, dass man nach dem Copy & Paste aus dem Browser alle unnötigen URL-Elemente (zum Beispiel überflüssige Angaben (index.html oder Session-IDs) herauslöscht. Ansonsten gilt für Referenzen wie bei Abbildungen: Alle diese Einträge [1] müssen im Text referenziert [2,3] werden.

@L:Übrigens: Ausführungen zu Themen, die im Artikeltext selbst zu weit führen, aber dennoch im Zusammenhang höchst interessant sind, lagert man am besten in Textkästen aus. Auch längliche Installationsbeschreibungen (die immer für mindestens zwei Distributionen dabei sein sollten, sobald <C>rpm -i<C>/<C>yast -i<C>, <C>apt-get install<C> oder <C>configure;make;make install<C> in Reinform nicht vollkommen glatt durchlaufen) sind besser im externen Kasten aufgehoben, um die Leser nicht zu langweilen.

@L:Solche Textkästen sehen formal aus wie der Infokasten, tragen aber statt der Überschrift "Infos" eine beschreibende Überschrift, wie das Beispiel Kasten "Wie lang ist mein Artikel" zeigt. Außerdem dient als Absatztrenner in solchen Textkästen nicht @L: sondern @KL:. Kästen nummerieren Sie - anders als Listings - nicht durch. Sie referenzieren sie im Text vielmehr anhand ihrer Überschrift.

@KT:Wie lang ist mein Artikel?

@KL:Die Frage nach der endgültigen Länge eines Artikels zählt zu den ganz großen Geheimnissen der Schreibekunst. Sie hängt nämlich nicht nur davon ab, wie lang Ihr Text ist, sondern auch davon, wieviele Abbildungen er enthält und wie groß diese im Layout ausfallen. Während eine vertikale Werkzeugleiste vielleicht maximal einen Zentimeter breit läft, nimmt der gesamte Desktop-Inhalt vielleicht anderthalb Spalten ein.

@KL:Zudem wirkt sich das Aufmacherbild am Anfang eines Artikels bei kürzeren Artikeln stärker aus. Bei einen Zweiseiter mit fünf Abbildungen plus Aufmacher passen vielleicht gerade einmal 4000 Zeichen auf eine Seite. Bei einem Fünfseiter kann es bei gleicher Anzahl Abbildungen pro Seite schon wesentlich mehr Text sein.

@KL:Schauen sich deren Dateigröße in Byte an. Teilen Sie diese Zahl durch die Anzahl geplanter Seiten. Das Ergebnis sollte zwischen 4000 und 4250 (bei sehr vielen Abbildungen und tendenziell kurzen Artikeln) liegen. Prinzipiell schadet es nie, wenn die Textdatei am Ende ein klein wenig größer (etwa 2000 Bytes) ausfällt, als das berechnete Optimum: Kürzen fällt der Redaktion in der Regel leichter als längen.

@KE:

@ZT:Sachdienliche Hinweise

@L:Damit haben Sie bereits fast alle Formatierungsmöglichkeiten für LinuxUser-Artikel beisammen. Bitte erfinden Sie keine neuen hinzu oder zweckentfremden Sie vorhandene nicht. Ob Tags zum Erzwingen von Zeilenumbrüchen oder ähnliche eigenmächtige Abweichungen - bevor der Artikel in den Satz geht, müssen sie in jedem Fall wieder entfernt werden, doppelte Arbeit also.

@L:Wenn Sie sich nicht sicher sind, wie Sie an einer bestimmten Stelle formatieren sollen, fragen Sie bitte den Redakteur, mit dem Sie Ihren Artikel abgestimmt haben.

@L:Ganz am Schluss steht die gute alte Autorenbox, die bei Autorinnen selbstverständlich die Überschrift "Die Autorin" trägt. Hier besteht die Möglichkeit, etwas Informatives oder Lustiges über sich selbst zu schreiben. Aber bitte kein Bewerbungsschreiben!

@IT:Infos

@IL:[1] Zeitschrift LinuxUser: <U>http://www.linux-user.de<U>

@IL:[2] Namensauflösung ohne DNS: Elke Jurek, "Vollkommen ohne", LinuxUser 13/2000, S. 42, <U>http://www.linux-user.de/ausgabe/2000/13/042-nodns/<U>

@IL:[3] Paketsuche: <U>http://ftpsearch.lycos.com/?form=medium<U>

@IL:[4] Pinguinverwaltung: Kalle Pinguin, "Pinguinitis", LinuxUser 14/2007, S. 5, <U>http://www.linux-community.de/Internal/Artikel/Print-Artikel/LinuxUser/2007/14/Pinguinitis<U>

@IE:

@IT:Der Autor

@IL:Kalle Pinguin ist ein absoluter Linux-Freak und ein klassischer Unix-Hacker. Wenn er nicht gerade vor seiner Kiste sitzt und Gerätetreiber schreibt, dann treffen Sie ihn vielleicht mal beim Sonnen oder Tiefseetauchen.

@IE:

Aktueller Inhalt





Seite drucken | Impressum / Kontakt | Datenschutz | © 2014 COMPUTEC MEDIA GmbH

[Linux-Magazin] [EasyLinux] [Linux-Community] [Ubuntu User]