TWiki Shorthand

Einleitung

Mit Twiki zu arbeiten ist so leicht wie Text zu tippen - genau wie E-Mail. Du brauchst kein HTML zu können, obwohl Du es benutzen kannst, wenn Du willst. Links zu Themen entstehen automatisch, wenn Du ein WikiWord einfügst. Und TWiki's Shorthand ("Stenografie") macht es möglich, viele sonst komplizierte HTML-Codes durch ein paar einfache Zeichen auszudrücken, die sich leicht lernen und behalten lassen. Wie Shorthand funktioniert, erklärt die Tabelle unten.

Tipp: Wenn Du eine neue oder schon existierende Seite in TWiki bearbeitest, kannst Du diese Tabelle einfach in einem zweiten Browser-Fenster geöffnet lassen, so dass Du schnell nachsehen kannst, wie Du zum Beispiel eine neue Überschrift oder eine Tabelle einfügst.

Textformatierung mit Shorthand

1. Absatz

2. Absatz

---++ Sushi

---+++ Maguro

*Fett*

_Kursiv_

__Fett kursiv__

=Feste Breite=

==Fett feste Breite==

_Das funktioniert_,
_das nicht _

<verbatim>
class Tier.Katze {
  void schnurren() {
    <code here>
  }
}
</verbatim>

class Tier.Katze {
  void schnurren() {
    <code here>
  }
}

-------

   * Listeneintrag

      * untergeordneter Text

   1 Sushi
   1 Dim Sum

   Sushi: Japan
   Dim Sum: S.F.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| mehrere Spalten |||
| A4 \  | next \  | next |

WebNotify

Know.ReadmeFirst

[[wiki syntax]]

[[Main.TWiki users]]

[[WikiSyntax][syntax]]

[[http://gnu.org][GNU]]

[[Startseite#NichtHier]]

[[#MeinAnker][Spring]]

#MeinAnker hierher

<nop>SunOS

Shorthand und HTML

Du kannst im Prinzip jedes HTML-Tag problemlos benutzen, OBWOHL es besser wäre, das nicht zu machen. Mit Shorthand kannst du eigentlich fast alles machen, was du sonst mit HTML machen würdest, und der Text bleibt übersichtlich und einfach zu ändern.

Hyperlinks

Die Möglichkeit Links einzubauen, ohne das irgendwelche Formatierung nötig ist, ist der wesentliche Bestandteil von TWiki, möglich durch die WikiWords. Neue TWiki-Verlinkungsregeln sind lediglich eine Erweiterung der Syntax, die neue flexible Optionen bietet.

Interne Links

• GoodStyle ist ein WikiWord, das zur GoodStyle-Seite von Indymedia Documentation Project verlinkt. Das gilt also für alle Seiten, denen (in diesem Fall) .../twiki/bin/edit/TWiki/ vorangestellt ist (ggf. auch ohne "bin/"). Wie etwa http://.../twiki/bin/view/TWiki/TextFormattingRulesDe , der Seite auf der du dich gerade befindest. Wenn du GoodStyle schreibst, während Du woanders bist, ensteht einfach eine neue Seite mit diesem Namen dort.

• GibtsNochNicht^? ist eine Seite, die erst noch geschrieben werden muss. Sie entsteht in dem du auf das ? klickst. (Klick ruhig drauf, aber danach auch auf Cancel - sonst ruinierst du dieses Beispiel!).

Externe Links

• http://..., https://..., ftp://... und mailto:...@... werden automatisch verlinkt.

• E-Mail-Adressen wie name@domain.com werden automatisch verlinkt.

• [[Eckige Klammern]] machen es ganz einfach Links einzufügen, auch ohne WikiWords zu verwenden. Siehe Erzwungene Links.

TWiki-Variablen

TWiki-Variablen sind Begriffe, die zwischen Prozent-Zeichen (%) stehen. Sobald ein Topic (also eine TWiki-Seite) geladen wird, in der solche Variablen vorkommen, werden diese Variablen durch bestimmte Texte ersetzt. Es gibt viele vordefinierte Variablen, es ist aber sogar möglich, eigene zu erstellen. Damit ergeben sich ganz neue Möglichkeiten. Hier ein paar gängige Variablen:

• %TOC% : TOC steht für table of contents, zu deutsch: Inhaltsverzeichnis. Wo diese Variable eingefügt wird, zeigt TWiki automatisch ein Inhaltsverzeichnis über die mittels ---+ bis ---++++++ definierten Überschriften an. Ganz oben auf dieser Seite findest Du ein solches Inhaltsverzeichnis, das automatisch generiert und beim Hinzukommen neuer Überschriften aktualisiert wird.

• %WEB% : Das aktuelle TWiki-Web (ein Bereich im TWiki), also jetzt z.B. TWiki.

• %TOPIC% : Das aktuelle Topic (eine einzelne TWiki-Seite), also jetzt z.B. TextFormattingRulesDe.

• %ATTACHURL% : Der Pfad zu den auf diesem Topic hochgeladenen Dateien. Das lässt sich gut nutzen, wenn Du eine Datei hochgeladen hast und in der Seite einen Link auf diese Datei einfügen willst. Gib _%ATTACHURL%/image.gif_ ein, um die URL der Datei oder das Bild innerhalb des Texts anzuzeigen..

• %INCLUDE{"SomeTopic"}% : Hiermit kannst Du ganze Topics in ein neues Topic einfügen. Standardmässig wird dabei das aktuelle Indymedia Documentation Project-Web verwendet, Du kannst aber auch andere angeben. Beispiel: %INCLUDE{"TWiki.TWikiWebsTable"}%

• Es gibt noch viele andere Variablen, eine Liste findest Du hier: TWikiVariables.

Achtung: Benutz immer GROSSBUCHSTABEN, wenn Du Variablen notierst. So klappt's nämlich nicht: %web%, so aber schon: %WEB%

Häufige Probleme

Die Formatierungsregeln von TWiki sind ziemlich einfach zu benutzen und schnell eingegeben. Es gibt allerings ein paar Dinge, auf die mensch achten sollte. Hier ein Ausschnitt aus der TextFormattingFAQ:

• F: Text zwischen Winkelklammern (<filename>) wird nicht angezeigt. Wie schaffe ich es, dass er doch angezeigt wird?
  • A: Die Zeichen '<' und '>' haben in HTML eine spezielle Bedeutung, denn sie definieren HTML-Tags. Du musst einen Umweg benutzen, um sie anzuzeigen: schreib '<' statt '<' und '>' statt '>'.
    Beispiel: Gib beim Editieren des Topics 'prog <filename>' ein, damit es hinterher so aussieht: 'prog <filename>'.

• F: Warum wird das ='&'=-Zeichen manchmal nicht angezeigt?
  • A: Das '&' - Zeichen hat eine besondere Bedeutung, denn es definiert ein HTML-Tag. Durch es wird eine sogenannte HTML-Entität begonnen, z.B. ist '©' der Ausdruck, der in HTML verwendet wurd, um das Copyright-Zeichen (©) anzuzeigen. Du musst einen Umweg benutzen, um das kaufmännische 'und' anzuzeigen. Schreib '&' statt '&'.
    Beispiel: Gib beim Editieren des Topics 'Dies & das' ein, damit es später so aussieht: 'Dies & das'.

-- AnNa - 01 Dec 2002
to top