Tags:
create new tag
, view all tags
(Die diversen Links müssen ggf an die eigene Umgebung angepaßt werden!)

Texte formatieren

Um Texte in diesem Wiki zu formatieren, müssen sie kein HTML kennen (obwohl sie es verwenden können, wenn sie möchten). Die Wiki-Software verfügt über eine eigene Syntax (auf engl. "Shorthand"), die leicht zu erlernen und behalten ist. Untenstehend finden sie eine tabellarische Übersicht. Sie können diese Seite auch jederzeit als Popup-Fenster öffnen, wenn sie in der Bearbeitungsansicht einer Seite auf Regeln zur Textformatierung (Dies hier ggf durch eigenen Seitennamen ersetzen!) am unteren Rand des Eingabefensters klicken.

Diese "Regeln zur Textformatierung" bieten einen Überblick über die gesamte Syntax, ohne allerdings ins Detail zu gehen. Sie finden zu jeder Option ein kurze Erläuterung und ein Beispiel. Detaillierte Beschreibungen der wichtigsten Wiki-Funktionen finden sie bspw. in den Tutorials, weitere Hilfe-Dokumente auf der Hilfe-Seite. (Auch diese Seitennamen ggf ändern!)

Wiki-Syntax

Textformatierung und ~umbruch

Abschnitte

Abschnitte werden durch Leerzeilen erzeugt. Beispiel:
   Erster Abschnitt.

   Zweiter Abschnitt
Erster Abschnitt.

Zweiter Abschnitt

Überschriften

Drei Bindestriche (-) am Zeilenanfang, gefolgt von Plus-Zeichen (+) und dem Text der Überschrift. Ein Plus-Zeichen erzeugt eine Überschrift erster Ordnung, 2 Plus-Zeichen eine Überschrift zweiter Ordnung usw.; maximal sechs Plus-Zeichen können verwendet werden. Beispiel:
---++ Tyler Durden

---+++ Project Mayhem

Tyler Durden

Project Mayhem

Fettgedruckter Text

Text erscheint fettgedruckt, wenn er in Sternchen (*) eingeschlossen wird. Beispiel:
*Fett*
Fett

Kursiver Text

Text erscheint kursiv, wenn er in Unterstriche (_) eingeschlossen wird. Beispiel:
_Kursiv_
Kursiv

Kursiver und fetter Text

Text wird _kursiv und fett, wenn er in doppelte Unterstriche (__) eingeschlossen wird. Beispiel:
__Kursiv und Fett__
Kursiv und Fett

Schreibmaschinenschrift (fester Abstand)

Text erscheint in Schreibmaschinenschrift, wenn er in Gleichheitszeichen (=) eingeschlossen wird. Beispiel:
=Schreibmaschinenschrift (fester Abstand)=
Schreibmaschinenschrift (fester Abstand)

Fette Schreibmaschinenschrift

Text erscheint in fetter Schreibmaschinenschrift, wenn er in doppelten Gleichheitszeichen (==) eingeschlossen wird. Beispiel:
==Fette Schreibmaschinenschrift==
Fette Schreibmaschinenschrift

Hinweis zu Fett-, Kursiv- und Schreibmaschinenschrift

ALERT! Achten sie darauf, daß zwischen den * _ = == -Zeichen und dem Text keine Leerzeichen sind! Beispiel:
_Dies funktioniert ohne Leerzeichen_,
_Dies hier nicht, weil ein Leerzeichen am Ende ist _
Dies funktioniert ohne Leerzeichen, _Dies hier nicht, weil ein Leerzeichen am Ende ist _

Vorformatierter Text

Umschließen sie Programmcode und anderen vorformatierten Text mit <verbatim> und </verbatim> Tags.
IDEA! Benutzen sie <pre> und </pre> Tags stattdessen, wenn sie möchten, daß HTML interpretiert wird.
ALERT! Jedes Tag muß in einer eigenen Zeile stehen. Beispiel:
<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}

Farbiger Text

Farbigen Text erhalten sie, indem sie den Text mit folgenden Markierungen umschließen: %FARBNAME%Text .... Eine Liste der Farbnamen finden sie unter Vordefinierte Farbnamen und Icons#FarbNamen. Achten sie darauf, daß sie die Farbnamen groß schreiben!
ALERT! Gehen sie mit farbigem Text bitte sparsam um - die Übersichtlichkeit geht sonst schnell verloren.
%RED%Ein bißchen Text in rot%ENDCOLOR%, dann in %BLUE%blau%ENDCOLOR% und schließlich in %MAROON%schönem kastanienbraun%ENDCOLOR%. Ein bißchen Text in rot, dann in blau und schließlich in schönem kastanienbraun..

Horizontale Trennlinie

Drei Bindestriche (---) am Zeilenanfang. Beispiel:
---

Links

Sie können Links erzeugen, ohne irgendwelche besonderen Befehle zu benutzen, indem sie WikiWörter verwenden. Diese Wörter werden automatisch als Verweise dargestellt.

Interne Links

  • Beispiel: TextFAQ ist ein WikiWort, das zu der TextFAQ-Seite zeigt.
  • NochNichtGeschrieben ist eine Seite, die es noch nicht gibt, der Verweis zeigt also ins Leere. Sie können die Seite erzeugen, indem sie auf das ? hinter dem Namen klicken. (Aber erzeugen sie diese spezielle Seite bitte nicht, sonst funktioniert dieses Beispiel nicht mehr wink )
  • [[Mit doppelten eckigen Klammern]] können sie auch Links erzeugen, die keine WikiWörter sind. Beispiel: Aus [[Regeln zur Textformatierung]] wird Regeln zur Textformatierung.
  • Wollen sie, daß Linkziel und der angezeigte Linktext unterschiedlich sind, so verwenden sie folgende Konstruktion: [[Linkziel][Linktext]]. Beispiel: Aus [[Hilfe][Hier werden sie geholfen]] wird Hier werden sie geholfen.

Externe Links

  • Beispiele: http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://... und mailto:...@... werden automatisch als Verweis dargestellt.
  • Email-Adressen in der Form name@domain.com ebenfalls.
  • Wollen sie einen externen Link mit einem beschreibendem Text versehen, dann verwenden sie folgende Konstruktion: [[Linkziel][Linktext]]. Beispiel: Aus [[http://www.telepolis.de][Online Magazin Telepolis]] wird Online Magazin Telepolis.

Links durch WikiWörter

GroßgeschriebeneZusammengesetzteWörter (sog. WikiWörter) werden automatisch als Link dargestellt.
ALERT! wenn sie eine Seite in einem anderen Netz verlinken wollen, schreiben sie: Netz.WikiWort. Beispiel:
WikiName

Spielwiese.MeineWikiTestseite
WikiName

MeineWikiTestseite

Erzwungene Links mit eckigen Klammern

Sie können einen Link "erzwingen", indem sie Text in doppelte eckige Klammern einschließen.
IDEA! Der Text innerhalb der Klammern darf auch Leerzeichen enthalten; der Seitenname wird dann automatisch durch weglassen der Leerzeichen und Großschreibung der einzelnen Wörter gebildet. Zum Beispiel: [[Regeln zur Textformatierung]] zeigt auf die Seite RegelnZurTextformatierung. Wenn sie auf Seiten in einem anderen Netz verweisen wollen, müssen sie wieder ein Netz. voranstellen. Beispiel:
[[Regeln zur Textformatierung]]

[[Spielwiese.Eine neue Testseite]]
Regeln zur Textformatierung

Spielwiese.Eine neue Testseite

Deskriptive Links

Wenn sie erreichen wollen, daß Linktext und Linkziel unterschiedlich sind, dann benutzen sie folgende Notation: [[Linkziel][Linktext]]. Das Linkziel kann sowohl intern (bspw. ein WikiWort) oder extern (bspw. http://TWiki.org/) sein.
IDEA! Sie können auch sog. Ankeradressen verwenden, um zu einer bestimmten Stelle in einer Seite zu springen: [[Start#MeinAnker][Zu meiner Startseite]] und [[http://gnu.org/#Action][GNU Action]]. Beispiel:
[[WikiWort][Wiki-Wörter]]

[[http://gnu.org][GNU]]
Wiki-Wörter

GNU

Anker (Sprungadressen)

Sie können innerhalb einer Seite eine Sprungadresse (sog. Anker) definieren, zum Beispiel wenn sie von einer anderen Seite direkt an diese Stelle verweisen wollen. Um einen Anker festzulegen, schreiben sie #AnkerName am Zeilenanfang. Der Name des Ankers muß0 ein WikiWort sein. Um auf einen Anker zu verweisen, benutzen sie die [[MeineSeite#MeinAnker]] Syntax. Wenn der Link innerhalb derselben Seite ist, können sie den Seitennamen auch weglassen. Beispiel:
[[Hilfe#InterAktion]]

[[#MeinAnker][Springe]]

#MeinAnker Hierhin
Hilfe#InterAktion

Springe

Hierhin

Einen Link verhindern

Wenn sie nicht wünschen, daß ein WikiWort verlinkt wird, dann stellen sie ihm ein <nop> -Tag voran. Beispiel:
GmbH



<nop>GmbH
GmbH

GmbH

Links abschalten

Für ganze Abschnitte können sie das automatische verlinken von WikiWörtern verhindern, wenn sie diese mit <noautolink> und </noautolink> -Tags umschließen. ALERT! Jedes Tag muß in einer eigenen Zeile stehen. ALERT! Dies funktioniert auch mit Tabellen, aber nur, wenn zwischen dem Tabellenende und dem </noautolink> -Tag noch eine Leerzeile steht. Beispiel:
 <noautolink>
 RedHat &
 SuSE
 </noautolink>
RedHat & SuSE

Mailto:Links

Um schönere 'mailto:'-Links zu erhalten, können sie folgende Syntax verwenden: [[mailto:user@domain Text]]. Beispiel:
[[mailto:a@z.com E-Mail]]

[[mailto:a@z.com?subject=Beschwerde Sich beschweren]]
E-Mail

Sich beschweren

Listen

Aufzählungen

In einer eigenen Zeile: drei Leerzeichen und ein Sternchen (*), gefolgt von einem Leerzeichen und dem Listeneintrag. Beispiel:
   * Listeneintrag
  • Listeneintrag

Verschachtelte Listen

Sechs, Neun, ... Leerzeichen und ein Sternchen (*), gefolgt von einem Leerzeichen und dem Listeneintrag. Beispiel:
      * Eingerückter Eintrag (6 Leerzeichen = Einrückungstiefe 2)
    • Eingerückter Eintrag (6 Leerzeichen = Einrückungstiefe 2)

Nummerierte Listen

Drei Leerzeichen und eine Zahl, gefolgt von einem Leerzeichen und dem Listeneintrag.
IDEA! Sie können irgendeine Zahl eingeben, die Nummerierung erfolgt automatisch.
IDEA! Das Einrücken funktioniert wie bei den 'normalen' Listen: einfach sechs, neun, ... Leerzeichen verwenden. Beispiel:
   1 Sushi
   1 Dim Sum
  1. Sushi
  2. Dim Sum

Definitionslisten

Drei Leerzeichen, der zu definierende Term, ein Doppelpunkt, ein Leerzeichen, gefolgt von der Definition.
ALERT! Der Term darf keine Leerzeichen enthalten. Wenn sie einen Term haben, der aus mehreren Wörtern besteht, trennen sie die Wörter durch Bindestriche oder verwenden sie anstelle eines Leerzeichens dies: &nbsp;. Beispiel:
   Mosel: Ein Fluß in Westdeutschland.
   Cantores&nbsp;Trevirenses: Ein Chor aus Trier.
Mosel
Ein Fluß in Westdeutschland.
Cantores Trevirenses
Ein Chor aus Trier.

Tabellen

Die Zellen werden von senkrechten Strichen (|) umschlossen.
IDEA! | *fette* | Zellen werden als Spaltenöpfe formatiert.
IDEA! Sind zwischen den -Markierungen und dem Zelleninhalt keine Leerzeichen, so wird der Zelleninhalt linksbündig formatiert (default).
IDEA! |   Gleicher   | Abstand (in Leerzeichen) zu den |-Markierungen bedeutet, daß der Inhalt zentriert wird.
IDEA! |     Rechtslastige | Zellen (rechts weniger Leerzeichen zwischen Inhalt und | als links) bedeuten, daß der Inhalt rechtsbündig dargestellt wird.
IDEA! | 2 Spalten || umfassende Zellen werden als ebensolche wiedergegeben.
IDEA! Falls sie in einer Zelle einen Zeilenumbruch erzwingen wollen (wenn sie eine lange Zeile haben und die Lesbarkeit verbessern wollen), dann können sie den Zelleninhalt über mehrere Zeilen verteilen, indem sie an das Ende jeder Zeile ein '\' (Backslash) setzen. Beispiel:
| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| mehrspaltig |||
| A4 | weiter | weiter |
L C R
A2 2 2
A3 3 3
mehrspaltig
A4 weiter weiter

Bilder und Anhänge

Beispiel:

HTML benutzen

Sie können fast alle HTML-Tags benutzen, es gibt jedoch einige Aspekte, die sie dabei beachten sollten.

HTML und Usability

  • Auf Seiten, die von mehreren Personen bearbeitet werden (und das soll ja die Mehrzahl der Seiten in dieses Wikis sein), empfiehlt es sich, die oben beschriebene Wiki-Syntax ("Shorthand") zu benutzen, da sie einfacher und vor allem übersichtlicher als HTML ist.
  • ALERT! Dieses Wiki soll soweit wie möglich auf verschiedenen Browsern und Betriebssystemen funktionieren - HTML-Tags die nicht zu HTML 3.2 kompatibel sind, schränken dies unter Umständen ein.

HTML-Anzeige

  • Zur Ansicht (also in der Seitenansicht) wird die Wiki-Syntax im Quelltext nach XHTML 1.0 gewandelt. Um also an das Markup einer Seite zu gelangen, wählen sie die Option "Quelltext anzeigen"/"View Source" in ihrem Browser.
  • ALERT! Die öffnenden und schließenden spitzen Klammern (<...>) eines HTML-Tags müssen sich in derselben Zeile befinden, sonst funktioniert der Befehl nicht.
    • Dies erlaubt es ihnen, einzelne öffnende oder schließende spitze Klammern einzugeben, ohne die HTML-Notierung dafür benutzen zu müssen (zum Beispiel a > b anstelle von a &gt; b).

Variablen

Variablen werden stets von Prozentzeichen (%) eingeschlossen und bei Abruf der Seite evaluiert. Wenn sie nicht wissen, was eine Variable ist, dann benutzen sie besser keine und machen sich besser erst einmal mit den restlichen Funktionen des Wikis vertraut. Variablen bieten die Möglichkeit, Redundanzen zu vermeiden und sog. dynamische Inhalte zu erzeugen. Einige Beispiel für vordefinierte Variablen sind:

  • %TOC% : Generiert automatisch ein Inhaltsverzeichnis (basierend auf den Überschriften) am Anfang der Seite.
  • %WEB% : Der Name des Netzes, in dem sie sich gerade befinden, ist Codev.
  • %TOPIC% : Der Name des Themas/der Seite, die gerade angezeigt wird, ist: GerTranTextFormattingRules.
  • %ATTACHURL% : Die Adresse für Attachments einer Seite/eines Themas. Beispiel: Wenn sie eine Datei an ein Thema anhängen, dann können sie mit %ATTACHURL%/datei.endung darauf verweisen.
  • %INCLUDE{"IrgendeinThema"}% : Eine sog. "Server side include", fügt automatisch "IrgendeinThema" in die aktuelle Seite ein.
  • %SEARCH{"sushi"}% : Fügt automatisch die Suchergebnisse nach "sushi" in die Seite ein.

  • In WikiEinstellungen werden Einstellungen für viele Variablen festgelegt, u.a.:
    • Zeilenumbruch: Schreiben sie %BR% um eine neue Zeile zu beginnen.
    • Farbiger Text: Schreiben sie %RED% Rot %ENDCOLOR% und %BLUE% Blau %ENDCOLOR% und sie erhalten: Rot und Blau (Großschreibung beachten!).
    • Icons: Schreiben sie %H% Hilfe, %T% Tip, %X% Warnung und sie erhalten: HELP Hilfe, TIP Tip, ALERT! Warnung.

Plugins

Die Funktionalität dieser TWiki-Software kann duch sogenannte Plugins erweitert werden. Derzeit sind die folgenden Module installiert:

  • SpreadSheetPlugin (2014-09-23, $Rev: 28085 (2014-09-23) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables or anywhere in topic text
  • AutoSectionsPlugin (2016-07-29, $Rev: 30263 (2016-10-05) $): Automatically make editable sections based on headings
  • BackupRestorePlugin (2013-02-16, $Rev: 25448 (2013-10-14) $): Administrator utility to backup, restore and upgrade a TWiki site
  • BlackListPlugin (2013-02-28, $Rev$): Utility to keep malicious users away from a public TWiki site
  • CalendarPlugin (2016-01-22, 29936): Show a monthly calendar with highlighted events
  • ChartPlugin (2013-05-23, $Rev: 25974 (2013-05-23) $): Visualize TWiki tables with area charts, bar charts, line graphs, scatter charts and sparklines
  • ColorPickerPlugin (2013-02-15, $Rev: 25074 (2013-10-14) $): Color picker, packaged for use in TWiki forms and TWiki applications
  • CommentPlugin (2013-02-10, $Rev: 24977 (2013-10-14) $): Quickly post comments to a page without an edit/preview/save cycle
  • DatePickerPlugin (2013-09-04, $Rev: 26272 (2013-10-14) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
  • EditTablePlugin (2013-12-03, $Rev: 26647 (2013-12-03) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
  • GaugePlugin (2013-05-16, $Rev: 25944 (2013-05-16) $): Create gauges (graphical or not), typically used for dashboards
  • GeoLookupPlugin (2012-11-21, $Rev: 24174 (2012-11-21) $): Lookup geolocation by IP address or domain name
  • HeadlinesPlugin (2013-11-18, 26619): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
  • IfThenActionPlugin (2015-04-20, $Rev: 29087 (2015-04-20) $): Execute if-then actions on topic view, save, file upload, and user registration, with rules defined in a topic
  • InterwikiPlugin (2013-02-12, $Rev: 25126 (2013-10-14) $): Text ExternalSite:Page links to a page on an external site based on aliases defined in a rules topic
  • JQueryPlugin (2013-09-28, $Rev: 26439 (2013-10-14) $): jQuery JavaScript library for TWiki
  • LocalCityTimePlugin (2011-07-13, $Rev: 21742 (2011-07-13) $): Shows the local time of a city embedded in a TWiki topic.
  • PercentCompletePlugin (2012-12-05, $Rev: 24337 (2012-12-06) $): Percent complete selector, for use in TWiki forms and TWiki applications
  • PreferencesPlugin (2013-09-08, $Rev: 26286 (2013-10-14) $): Allows editing of preferences using fields predefined in a form
  • QRCodePlugin (2012-11-14, $Rev: 24045 (2012-11-15) $): Create QR Code (a matrix barcode) in TWiki pages, useful for mobile applications
  • RecentVisitorPlugin (2012-12-22, $Rev: 24176 (2012-11-22) $): Show recent visitors to a TWiki site
  • RenderListPlugin (2013-01-28, $Rev: 24820 (2013-10-14) $): Render bullet lists in a variety of formats
  • SetGetPlugin (2015-04-09, $Rev: 29040 (2015-04-09) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
  • ShareMePlugin (2012-12-01, $Rev: 24254 (2012-12-01) $): Icon bar to share a TWiki page on popular social media sites such as Facebook, StumbleUpon, Twitter
  • SlideShowPlugin (2015-01-14, $Rev: 28669 (2015-01-14) $): Create web based presentations based on topics with headings.
  • SmiliesPlugin (2013-01-13, $Rev: 24784 (2013-10-14) $): Render smilies as icons, like  :-)  as smile or  :eek:  as eek!
  • TWikiDrawPlugin (2013-05-17, $Rev: 25952 (2013-05-17) $): Vector drawing editor and clickable maps for diagrams and workflows
  • TWikiOrgPlugin (1.001): TWiki.org specific extensions
  • TWikiSheetPlugin (2016-04-14, $Rev: 30150 (2016-04-14) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
  • TablePlugin (2013-09-25, $Rev: 26425 (2013-10-14) $): Control attributes of tables and sorting of table columns
  • TagMePlugin (2014-05-15, $Rev: 27384 (2014-05-15) $): Tag wiki content collectively or authoritatively to find content by keywords
  • TinyMCEPlugin (2013-09-18, $Rev: 26397 (2013-10-14) $): Integration of the Tiny MCE WYSIWYG Editor
  • TwistyPlugin (2013-03-22, $Rev: 25508 (2013-10-14) $): Twisty section JavaScript library to open/close content dynamically
  • VarCachePlugin (2012-11-14, $Rev: 24077 (2012-11-15) $): Cache TWiki variables in selected topics for faster page rendering
  • WatchlistPlugin (2016-02-13, $Rev$): Watch topics of interest and get notified of changes by e-mail
  • WysiwygPlugin (2013-09-18, $Rev: 26391 (2013-10-14) $): Translator framework for WYSIWYG editors

Häufige Fehler:

Zwei sehr häufige Fehler bzw. Probleme von Benutzern, die deshalb hier nochmals besondere Erwähnung finden:

  • Frage: Text in spitzen Klammern (<Text>) wird nicht angezeigt. Wie kann ich das ändern?
    • Antwort: Die '<' und '>' Zeichen haben eine spezielle Bedeutung in HTML, mit ihnen werden sogenannten HTML-Tags (Formatierungsbefehle) definiert. Sie müssen sie umgehen (engl. 'escape'), deshalb schreiben sie '&lt;' anstelle von '<' und '&gt;' anstelle von '>'.
      Beispiel: Schreiben sie 'Der &lt;Benutzername&gt;' um 'Der <Benutzername>' zu erhalten.

  • Frage: Warum wird das '&' -Zeichen manchmal nicht angezeigt?
    • Antwort: Das '&' -Zeichen (es heißt "Ampersand", "kaufmännisches Und") hat eine besondere Bedeutung in HTML, es ist das Startzeichen für sogenannte "character entities", bspw. ist '&copy;' das © Copyright-Zeichen. Um '&' darzustellen müssen sie es umgehen (engl. escapen): Schreiben sie '&amp;' anstelle von '&'.
      Beispiel: Schreiben sie 'Dies &amp; Das' um 'Dies & das' zu erhalten.


-- ChristianKohl - 07 Jan 2004
Topic revision: r1 - 2004-01-07 - ChristianKohl
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.