WackoWiki: WackoDocDeutsch/WikiKonzeption/Formatierung ...

Home Page | Изменения | Новые Комменты | Пользователи | Каталог | Регистрация | Вход:  Пароль:  

Welches Konzept steckt hinter dem Wacko-Syntax der Formatierung? Warum ist es so wie es jetzt ist? Dieses Kapitel beschreibt die Idee hinter den Formatierungsregeln.


Wacko Formatierung

Damit wird eine besondere Methode der Textformatierung bezeichnet, die versucht die Anzahl von Formatierungszeichen (mark-ups) und die Beeintr�chtigung des originalen Textes so gering wie m�glich zu halten. Die HTML-Darstellung im Web-Browser erfolgt dann automatisch.


Der Umfang der Formatierungszeichen muss ausreichend sein f�r eine sinnvolle Darstellung gro�er und kleiner Dokumente. Neben den herk�mmlichen Formatierern wie kursiv, fett, unterstrichen und durchgestrichen gibt es hier Inhaltsverzeichnisse, �berschriften, Tabellen, Bilder, Zitatkennzeichnungen, Fu�noten und vieles andere mehr. Die Wacko-Formatierung, die hier in WackoWiki und in anderen Wikis genutzt wird, kann auch f�r eigene Entwicklungen eingesetzt werden. Dazu musst du den Wacko Formatierer und optional den graphischen WikiEditor in dein Projekt einbauen.


Ursprung und Prinzipien

Zuerst wurden in WakkaWiki, aus dem viele Forks wie eben auch WackoWiki entstanden, klare Prinzipien zur Formatierung entwickelt. Von WakkaWiki sind diese Prinzipien geerbt, welche helfen, dass die Formatierung einigerma�en bequem und nat�rlich ist.


Die Prinzipien sollen diese Zwecke erf�llen:



Prinzipien

Bedeutung erkennbar aus Form und Struktur

Das Fundament aller Wikis ist WYTIWYG. F�r das Verh�ltnis Bezeichnetes-Zeichen hei�t das: Die Semantik eines Formatierungssymbols muss sich direkt aus dem Syntax dieses Zeichens ableiten/erkennen lassen. Anders herum gesagt, muss aus der Form des verwendeten Zeichens eine sinnvolle Deutung m�glich sein.


Wir haben versucht mit den Zeichen auf der Tastatur solche sinnvollen Verbindungen herzustellen:


Damit haben wir uns von der klassischen Wiki-Formatierung entfernt, die maximal f�nf Formatierer-Symbole auf jeder Seite des Textes kennt.


Doppelzeichen-Regel

Alle Formatierungssymbole enthalten zwei Zeichen. Dadurch kann einfacher Text aus jedem beliebigen Texteditor in Wackowiki eingef�gt werden (kopieren & einf�gen). Du brauchst keine spezielle Vorbereitung des einzuf�genden Textes, denn es ist unwahrscheinlich, dass dein Text Symbole in Doppenzeichen enth�lt.


Die Formatierer, die aus 3, 4 oder bis zu 6 einzelnen Zeichen bestehen, werden zur Abtrennung der �berschriften genutzt. Je l�nger die Zeichenkette, umso “tiefer” befindet sich eine �berschrift in der Gliederungsebene des Inhaltsverzeichnisses.


Verbindung von Formatierungszeichen und einfachem Text

Es gibt Menschen, die zum Beispiel einen Minus-Strich [] immer mit “zwei minus” [ -- ] schreiben und dadurch ein Wacko-Formatierer verwenden. Das Prinzip, welches hier Abhilfe schaft, ist, dass die Formatierungszeichen immer in Ber�hrung mit dem einfachen Text kommen m�ssen, um wirksam zu werden. Am Beispiel siehst du, dass der erste Formatierer und der Zweite ohne eine L�cke an den Text anschliessen. Dies gilt nur f�r die Doppelzeichen, die gelegentlich auch in dem einfachen Text vorkommen k�nnen.




Zeilenumbruch und Absatzformatierung

Die �bertragung des Textflusses aus einem eingef�gten einfachen Text in die Wackowiki-Formatierung erfolgt fortlaufend. Durch zwei leere Zeilen beginnt ein neuer Absatz, dass heisst zwei Zeilenumbr�che werden immer als das Ende eines Textblocks interpretiert.


Formatierungszeichen, welche die Eigenschaften von Text-Zeichen und �berschriften �ndern, funktionieren nur innerhalb eines Textflusses (Zeile), der durch jeden Zeilenumbruch begrenzt wird. Damit werden vier Dinge erf�llt:



fehlertolerante Formatierung

Durch die aufgezeigten Prinzipien wird ein sehr wichtiger Aspekt ber�cksichtigt: Den Schutz der HTML-Ausgabe einer Textseite vor m�glichen Fehlern bei der Formatierung. Wegen der Regel des Abtrennens der Textbereiche k�nnen wir den Anfang und das Ende einr Formatierung genau feststellen und sofort die HTML-Tags setzen (oder eben keine setzen). Formatierungsm�glichkeiten, die ohne diese Regeln der direkten Paarbildung funktionieren, m�ssen etwas aufmerksammer auf Korrektheit �berpr�ft werden. Wie du hier in der Dokumentation sieht, ist auch das umsetzbar.


transparente Fehler

Ein Fehler bei der Benutzung der Formatierungszeichen wird sofort im Web-Browser sichtbar und intuitiv verst�ndlich. Der restliche Teil der WackoWiki Installation und die Erstellung der Seite im HTML Format wird durch diese Fehler nicht beeintr�chtigt.




Internationale Zeichens�tze

Eine weitere wichtige Sache ist es, die Zeichen zur Formatierung so zu w�hlen, dass der Hauptteil auf der Tastatur bequem zu erreichen ist. Dabei m�ssen wir vor allem bedenken, dass es verschiedene Tastaturlayouts gibt; kyrillische, lateinische und so weiter. Das ist einer der Gr�nde warum es doppelte Syntax f�r die gleiche Semantik gibt.



Formatierungsregeln

Ausgehend von unseren Prinzipien, haben wir die Formatierungsregeln weiterentwickelt und dabei auch die anderen Wikis beobachtet. Wir glauben, dass wir die Besten der vielen Regeln in WackoWiki integriert haben. Obwohl es viele Funktionen gibt, bleibt alles noch einfach und �bersichtlich. In diesem Kapitel geht es um das Verst�ndis, wie wir zu den wichtigsten Formatierungsregeln gekommen sind.


Einzeilige Formatierung

Dazu geh�ren alle Regeln, die h�ufig zur Darstellung in einfachen Texten genutzt werden und innerhalb eines Zeilenumbruchs (Absatzes) Verwendung finden.



Absatzformatierung

Hier werden mehrere Zeilen Text formatiert. Diese Regeln werden dort gestattet, wo sich die Anwendung h�ufig auf einen gro�en Textblock bezieht.


ein Textzitat, welches ein ganzen zusammen Block umfasst

oder etwa die Formatierung von CSS, diff, DTD, Javascript, mySQL, PHP, Python, SQL, XML oder �hnliches


<config>
<section name="test">
  <var>Test</var>
  <val><![CDATA[..text...]]></val>
</section>
</config>

Ausblenden von Formatierungsregeln

Formatierer werden auf zwei Arten ausgeblendet


Die erste Methode erm�glicht es einen l�ngeren Text von Formatierungen auszuschlie�en. Die zweite Methode ist bequemer wenn man zum Beispiel ein einziges WikiWort oder ein Formatierungszeichen ausblenden m�chte. Erst die Tilde ~ erm�glicht die Darstellung der doppelten Einf�hrungszeichen "" wie oben im Text. Wenn du den Quelltext der Dokumentation hier anschaust, siehst du, dass die M�glichkeit der Ausblendung von Wiki-Formatierern sehr h�ufig verwendet wird.


Hyperlinks und Bilder

Vollst�ndige URL's mit http:// werden automatisch erkannt und in einen Link umgewandelt. Handelt es sich dabei um ein Bild, wie zum Beispiel mit der Dateiendung .gif .jpeg, setzt wackowiki diese URL in ein <img> Tag. Dadurch kann die URL eines Bildes ohne nachzudenken aus der Zwischenablage eingef�gt werden und es erscheint das gew�nschte Bild. Denke daran, dass du so mit jedem Aufruf deiner Seite auch Datenverkehr mit dem Server verursachst, auf dem das Bild liegt.


Zur Beschriftung einer URL gibt es drei verschiedene M�glichkeiten:



Die Formatierung der Seitenverweise kann in der gleichen Art und Weise auch f�r interne Links genutzt werden. Die Beschriftung von Bilder erfolgt analog.





Aufz�hlungen und Listen

Die Formatierung erfolgt intiutiv mit der M�glickeit arabische und lateinische Ziffern sowie lateinische Buchstaben und einfache Punkte zu nutzen. F�r jede Ebene sind je zwei Leerzeichen einzur�cken – eine Tatsache, die in normalen Texten kaum vorkommt. Die Aufz�hlungen k�nnen auch beliebig kombiniert werden, wobei Texte f�r gew�hnlich in der Reihenfolge Ziffer, Buchstabe, Punkt formatiert werden.


Eingabe Ausgabe im Browser
1. nummeriertes Hauptelement mit Arabischen Ziffern
A. Listenelement
A. n�chster Punkt
1. einfache Aufz�hlung
1. ...

1.#2 n�chstes Hauptelement

A. Teilelement
A. Teilelement
*oberstes Listenelement
*Listenelement der n�chsten Ebene

  1. nummeriertes Hauptelement mit Arabischen Ziffern
    1. Listenelement
    2. n�chster Punkt
      1. einfache Aufz�hlung
      2. ...

  1. n�chstes Hauptelement
    1. Teilelement
    2. Teilelement
    • oberstes Listenelement
      • Listenelement der n�chsten Ebene

Damit ist es m�glich nummerierte Listen zu erstellen, sowie die Nummerierung �ber Abs�tze hinweg fortzuf�hren; 1.#n wobei n f�r die gew�nschte Folgeziffer steht. Aufz�hlungen mit Zifferen schreibt man bequemer Weise immer mit 1. erstes Element, 1. zweites Element, u.s.w. wie im Beispiel oben. Dadurch kann jederzeit die Reihenfolge der Elemente ge�ndert werden und man spart sich die aufwendige Korrektur f�r die richtige Ziffernfolge.


Tabellenformatierung

Die Tabelle – das ist der wundte Punkt jeder Formatierung. Als beste L�sung hat es sich herausgestellt, die vertikalen Linien des Rasterfeldes einer Tabelle nachzuahmen. Dieses ist einfacher als durch Bindestriche, Plus und vertikale Linien das gesamte Rasterfeld zu skizzieren, und es gibt gleichzeitig die M�glichkeit den Ausgangstext vollst�ndig in der Tabelle zu lesen. Details dazu liest du in der Formatierungs-�bersicht.


Leider k�nnen die Tabellen in bestimmten F�llen den WackoWiki Syntax verletzen. Die tats�chliche Ansicht des Dokuments ist dann nicht so wie du das erwartet hast. Vergisst man bereits eine der vertikalen Linien, so werden die darauf folgenden Formatierer nicht korrekt interpretiert. Jedoch merkst du das sofort und kannst es schnell korrigieren. Das ist der Preis, den wir bereit waren zu zahlen, f�r die Klarheit des Syntax und zugunsten der Geschwindigkeit von WackoWiki im Vergleich mit seinen Vorg�ngern.


Entwicklung zus�tzlicher Formatierer

Die bisher vorgestellten Formatierer sind bei weitem nicht alle die es gibt – nur die Grundlegenden. Falls diese f�r dich nicht ausreichend sind, schaue im Kapitel �ber die Textformatierung nach. Sollte anschlie�end klar werden, dass die bestehenden Regeln nicht weiterhelfen, dann lohnt es m�glichweise die Formatierungsregeln zu erweitern.


Wann lohnt es sich die bestehende Formatierung zu ver�ndern?

Niemals.


Die Ver�nderung der bestehenden Formatierungsregeln macht f�r dich Sinn, kann aber ein gro�er Einschnitt f�r Leute sein, die sich an die bestehenden Formatierungen gew�hnt haben. Stell dir vor wie die Seiten aussehen, wenn nach einer Aktualisierung von Wacko, die Formatierungszeichen pl�tzlich etwas ganz anderes tun, als das urspr�nglich geplant war.


Zweifellos, wenn irgendeine Regel dein konkretes Projekt wesentlich behindert, dann kann man �ber einen Austausch nachdenken.


Wann lohnt es sich neue Formatierungen einzuf�hren?

So selten wie m�glich.


Die Wackowiki Formatierung ist eine auf das Wesentliche reduzierte Mark up"-Methode, die schnell und einfach funktierieren muss, ohne sich mit den grundlegenden Funktionen zur Formatierung besch�ftigen zu m�ssen.


Wenn etwas einfach ist, ohne dass man einen Moment z�gert, dann kann man ein neue Formatierung einf�hren. Dazu musst du dich in die Lage deiner Nutzer versetzen. Sie m�ssen die Formatierung ohne z�gern nutzen k�nnen und das wird nur dann m�glich, wenn die Entwickler jede neue Regel sorgf�ltig auf die m�glichen Konzequenzen untersuchen.


Falls du die Wackowiki Formatierung erweitern m�chtest, ist es das Beste sich mit den Entwicklern von Wackowiki in Verbindung zu setzen. Vielleicht gibt es deine Idee schon, was dir dann viel Zeit spart.


Indirekte Formatierungen und Service-Funktionen

Die folgenden zwei Methoden erweitern die M�glichkeiten der Formatierung und erm�glichen damit verschiedene komplexe Darstellungen. Wer die M�glichkeiten der Formatierung aussch�pfen m�chte, dem Empfehlen wir zuallererst die folgenden Erweiterungen.


Textmarkierer (Highlighter)

Einen solchen Markierer kann man verwenden, wenn die Kernaussagen von komplexen Vorg�ngen verdeutlicht werden soll. F�r den Leser ist es dann sehr einfach zu erkennen.


Die Hervorhebung wird durch doppelte Prozentzeichen %% eingeschlossen, zum Beipsiel so %%(.html)<.div class=".test">.testdiv</.div>... %%


Als Markierungsregel wird der Syntax an verschiedenen Stellen genutzt, zur Hervorhebung von Code, zur Gestalltung von ICQ- und Emailunterhaltungen


Aktionen

Durch Aktionen wird es f�r den Entwickler m�glich komplexe Funktionen zu erstellen, die auch einen Dialog mit dem Nutzer erm�glichen. Aktionen und die zugeh�rigen Parameter werden in geschwungenen Doppelklammern {{ aufgerufen. Ein wesentlicher Teil der Funktionalit�t im Wackowiki wird durch Aktionen erm�glicht.


Die Idee dahinter ist es, in die einzelnen Seiten komplexe Funktionalit�ten einzubauen, ohne das sich der Nutzer mit den Details besch�ftigen muss.


Funktionsweise des Formatierers

Es ist hier nicht der geeignete Platz um die technischen Details zu erkl�ren. Einige Fundamente sind jedoch erw�hnenswert.


Erstens, der Formatierer selbst beruht auf Standardsprachen (namentlich perl-kompatiblen Standards) und funktioniert entsprechend den Prinzipien “rekursiver Auswahl”. Das bedeutet, dass er versucht den Text in die gr��tm�glichen Fragmente zu unterteilen und dann die Formatierungsregeln ausf�hrt. Folglich ist es nicht m�glich einzelne Formatierungsregeln in sich selbst (direkt) darzustellen, etwa ein Beispiel �ber die genutzte Formatierung zu geben indem man die Regel doppelt benutzt. Aber das ist auch nicht notwendig. Will man die Regel f�r eine spezielle Formatierung erkennen, �ffnet man die entsprechende Seite und sieht den Syntax der Formatierung.


Zweitens, arbeitet der Formatierer in mehreren Stufen um vor gelegentlichen Fehlern («random wear and tear») zu sch�tzen. By the first cut is mastered the reduced collection of rules, which makes it possible “to screen” the fragments of text, after forbidding in them marking. In the same passage are separated all “khaylaytery”, protecting thus from the overlap of khaylayterov by another marking. The second passage of formattera processes all remained rules.


Drittens, formatter makes it possible to carry out a caching of the otformatirovannogo result. Since the marking includes the functionality, which requires interaction with the user, and also references to the pages (which can be processed differently for the different users), for the caching is formed the “semifinished product”, in which remained only the rules, which are concerned references and “actions”. The finish cut of formattera � the most rapid and not requiring recursion � is achieved with the conclusion of the contained document on the basis of this “semifinished product” and make marking references and insert of “actions”.


Falls du dich f�r die Technik in allen Einzelheiten interesssierst, schaue dir den Quellcode des Wacko-Formatierers an.



�bersetze weiter aus Markup Principles assumed


 
Файлов нет. [Показать файлы/форму]
Комментариев нет. [Показать комментарии/форму]
Donate
Время работы: 0.275 s
Использовано памяти: 1.562 Mb