Konzeption hinter WackoWikiIn der Einfachheit liegt die höchste Vollendung
Diese Seite ist für fortgeschrittene Nutzer. |
In Kürze: wenn Anführungszeichen-Seiten mit ihrem WikiNamen aufgeschrieben werden (Ein Wort mit einem Grossbuchstaben am Anfang und einem weiteren mitten im Wort), wird entweder zu dieser Seite verlinkt, wenn sie im System existiert – andernfalls erscheint neben dem Namen ein Fragezeichen, nach Klick auf dieses wird eine neue Seite erstellt.
Alle im System existierenden WikiNamen werden automatisch im Text verlinkt
Ursprünglich wurde das Konzept der InterWiki-Adressierung entwickelt, um Verweise direkt in Cluster anderer Wikis zu setzen. Dazu existiert eine externe Liste mit gespeicherten Adressnamen. Jede Anfrage mit – ((Hauptseite:Suchterm)) oder ((Hauptseite:Suchterm Beschriftung des Hyperlinks)) – verlinkt automatisch auf die gewünschte Seite mit dem Suchwort.
zum Beispiel:
Der Verweis zu Wards Portland Patern Repository PPR:WikiNewbieToBeginners entsteht aus dem einfachen Syntax von PPR:WikiNewbieToBeginners.
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.
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, in NPJ und in anderen Wikis genutzt wird, kann auch für eigene Entwicklungen eingesetzt werden. Dazu kannst du den WackoFormatierer und optional den graphischen WikiEditor in dein Projekt einbauen.
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:
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.
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.
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.
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:
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.
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.
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.
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.
Dazu gehören alle Regeln, die häufig zur Darstellung in einfachen Texten genutzt werden und innerhalb eines Zeilenumbruchs (Absatzes) Verwendung finden.
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 ganzenzusammenBlock 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>
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.
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.
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 |
| |
|
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.
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.
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öglicherweise die Formatierungsregeln zu erweitern.
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.
So selten wie möglich.
Die Wackowiki Formatierung ist eine auf das Wesentliche reduzierte “Mark-up”-Methode, die schnell und einfach funktionieren 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 Konsequenzen 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.
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.
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 Gestaltung von ICQ- und E-Mailunterhaltungen
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.
Es ist hier nicht die geeignete Stelle um die technischen Details des WackoFormatierers zu erklären. Die Grundlagen sind allerdings erwähnenswert.
Erstens, der Formatierer selbst beruht auf Standardsprachen (namentlich perl-kompatiblen Standards) und funktioniert entsprechend den Prinzipien “rekursiver Auswahl”. Es 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. 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. Im ersten Schritt verarbeitet er eine reduzierte Anzahl an Regeln, die es möglich macht die Textfragemente zu scannen nachdem in diesen Fragmenten Formatierungen untersagt wurden. Im Textfragment werden alle Highlighter separiert, was vor Überlappung der Highlighter mit anderen Textformatierern schützt. Im Anschluss werden die restlichen Formatierungsregeln verarbeitet.
Drittens, ermöglicht es der Formatierer den formatierten Code zu cachen. Der Cache enthält ein “halbfertiges Produkt”, da die Textformatierung Funktionen beinhalten, die eine Interaktion mit dem Nutzer erfordern, als auch Referenzen zu Seiten erzeugen, die für verschiedene Nutzer unterschiedlich verarbeitet werden können. Die endgültige Formatierung – die schnellste Variante, ohne rekursive Verfahren zu benötigen – wird bewerkstelligt durch das Zusammensetzen von der “halbfertigen Version”, die Erstellung von Seitenverweisen (Hyperlinks) und dem Einfügen von Aktionen.
Falls du dich für die Technik in allen Einzelheiten interessierst, schaue dir den Quelltext des Wacko-Formatierers an.
Service “Net Project Journal”
OpenWiki — the still some historical roots of the WackoWiki-Formatierung
Beispiele der klassischen Formatierung auf c2.com
русский вариант ((http://babelfish.altavista.com/babelfish/trurl_pagecontent?lp=ru_en&url=http%3A%2F%2Fnpj.ru%2Fnpj
Das sind die Wiki Design Prinzipien, zusammengestellt von WardCunningham:
Hier noch weitere Prinzipien, welche vielen Wiki-Autoren und Betreibern von Wikis die Richtung geben:
... es gibt sicher noch vieles mehr, was wichtig ist. Ein sicherer Webserver, zum Beispiel.
Mit einem Doppelklick kann jeder jede Seite ändern. Du kannst also die vorliegenden Seiten immer wieder neu editieren und jede gemachte Veränderung wird archiviert. Aber wie kommt man dann mit Rowdys zurecht?
Zum Schutz vor Rowdys gibt es ein sehr bequemes Werkzeug: alle Versionen des Dokumentes werden bewahrt. So man kann jede Veränderung zwischen zwei Versionen nachvollziehen und zum Beispiel die letzte sinnvolle Version wiederherstellen.
Aber wie kann man das alles verwenden?
detailierte Übersicht der Anwendungsbereiche
P.S So allen таки mit den Rowdys wie zu kämpfen? Den Zugriff auf die Aufzeichnung von нерегистрированных der Benutzer zu schließen uDie beschädigten Versionen wiederherzustellen.ng
P.P.S Es sich ergibt was die volle Kontrolle für контентом den Besuchern übergeben wird?S Nicht ganz. Wesentlich – ja. Aber откатить ist die falsche Veränderung immer möglich.cha
P.P.P.S. Ок, werden wir den Andrang der Rowdys vorstellen. Wiki wird парализован einfach sein.f1. Es ist die Widersee der “falschen” Veränderungen in Zusammenhang mit der großen Frequenz der Veränderungen unmöglich.f2. Es ist die Eintragung der “richtigen” Veränderungen unmöglich, da sie im Strom “falsch” verloren werden werden und werden zusammen mit ihnen aufgehoben sein.ung: In der Praxis war solcher während{bis}. Wenn solches entstehen wird, weiß{kenne} ich die Reihe der Weisen, damit zu kämpfen. Zum Beispiel, den Zugriff auf die “strittigen” Dokumente{Ausweise} auf « nur den registrierten Benutzern » oder auf noch mehr eng umzutauschen.}
P.S so
everything after all as to fight with the hooligans?
* to shut access to the record from the neregistrirovannykh users
* to restore the damaged versions.
P.P.S Is obtained that complete control of
kontentom it is transferred to visitors?
* not entirely.Essential – yes. But to roll away incorrect change is
always possible.
P.P.P.S. Ok, let us present the influx of hooligans. Wiki will be simply paralyzed.
1. Is impossible the recoil of “incorrect” changes in connection with the
high frequency of changes.
2. Is impossible the introduction of “accurate” changes, since they will be lost in the
flow of “incorrect” and they will be abolished together with them
RomanIvanov: In practice it was thus far not
similar. If such arises, I know a number of the methods to fight
with this. For example, to replace access to the “questionable”
documents on only to “registered users” or to even the narrower.
einarbeiten Inhalte aus /Wacko Doc Deutsch / Einfuehrung In Wiki / Im Detail?
Erweiterte Einführung in Wiki==
Was ist ein Wiki?==
Sicherlich kennen Sie den Unterschied zwischen einer Webseite und einem Forum. Trotzdem wollen wir nochmal einen Blick auf beide werfen:
Wenn Sie jetzt eine webasierte Lösung benötigen, um über ein Thema zu diskutieren oder Informationen darüber auszutauschen, wäre ein Mittelding zwischen Webseite und Forum die beste Lösung. Die Möglichkeit, Informationen in der Geschwindigkeit eines Forums auszutauschen und gleichzeitig die thematische Struktur einer Webseite beizubehalten.
Und eben diesen Mittelweg bietet ein Wiki wie WackoWiki.
Was sind die Kernpunkte eines Wiki?==
Freie Editierbarkeit==
Das Grundprinzip eines jeden Wiki ist die freie Editierbarkeit. Jeder darf jede Seite verändern. Und dass, ohne komplizierte Werkzeuge: derselbe Browser, mit dem Sie diese Seite betrachten dient auch dazu, sie zu ändern. Mit anderen Worten: wenn Ihnen dieser Text nicht gefällt, klicken Sie auf den “editieren”-link oder doppelklicken mit der Maus auf ihn – und ändern Sie ihn.
Die Idee dahinter ist, dass auf diese Weise eine schnellerer Informationsfluss gewährleistet ist. Fehler können von jedem ausgebessert werden, der sie erkennt. Dokumentationen z.B. können von den Entwicklern immer auf dem aktuellen Stand gehalten werden, gleichzeitig ist jeder Leser in der Lage, Unklarheiten aufzuzeigen und Texte zu kommentieren.
Das Konzept der vollkommenen Offenheit ist im wirklichen Leben aber nicht immer von Vorteil und deswegen macht Wacko es möglich, flexibel Rechte zu vergeben.
Wenn Sie sich fragen, warum eine, auch nur teilweise realisierte, Offenheit im Netz überhaupt funktioniert lesen Sie warum Wacko funktioniert.
Problemloses Erstellen von Neuen Seiten==
Es ist ziemlich einfach, in Wikis neue Seiten zu erstellen?.
Einfache Verlinkung==
Einfaches Konzept der Formatierung==
Die Textformatierung folgt größtenteils dem Konzept der Zwei-Zeichen-Regel und ist damit schnell erlernbar. Html – Kenntnisse sind nicht erforderlich.
Automatische Archivierung alter Versionen==
Zum Schutz vor Rowdys gibt es ein sehr bequemes Werkzeug: alle Versionen des Dokumentes werden bewahrt. So kann man jede Veränderung zwischen zwei Versionen nachvollziehen und zum Beispiel die letzte sinnvolle Version wiederherstellen.
Umsetzung des Hypertextkonzeptes==
Eine Webseite wird ebenso wie ein Forum in den meisten Fällen hierarchisch gegliedert sein. Durch die einfache Verlinkung und die Volltextsuche ist ein wesentlich besseres Untergliedern von Informationen möglich.
Informationen über die Wikiphilosophie? oder über die Besonderheiten und Funktionen? von WackoWiki.
Warum funktioniert ein Wiki?==
Kritikpunkte an Wikis und deren Erwiderung sind unter WarumWikifunktioniert nachzulesen.
Konzept der Formatierung zu Wacko Wiki/... verschieben -> da nicht allgemein, sondern Wacko spezifisch
