Archiv/MoinMoin DesktopEdition

Archivierte Anleitung

Dieser Artikel wurde archiviert, da er - oder Teile daraus - nur noch unter einer älteren Ubuntu-Version nutzbar ist. Diese Anleitung wird vom Wiki-Team weder auf Richtigkeit überprüft noch anderweitig gepflegt. Zusätzlich wurde der Artikel für weitere Änderungen gesperrt.

Zum Verständnis dieses Artikels sind folgende Seiten hilfreich:

  1. Archive entpacken

  2. Ein Terminal öffnen

  3. Einen Editor öffnen

  4. Programme automatisch starten, optional

  5. Kurznamen für Befehle definieren, optional

Inhaltsverzeichnis
  1. Installation
  2. Konfiguration
    1. Grundeinstellungen
    2. Servereinstellungen
    3. Automatisch im Browser öffnen
  3. Benutzung
    1. Start/Stop Alias
    2. Sprache
    3. Zugang
  4. Struktur
    1. Wiki-Seiten
    2. Erweiterungen
    3. Themes
  5. Links

./logo.png MoinMoin DesktopEdition {en} (aka MMDE) ist die Desktop-Variante des MoinMoinWikis {en} . Die DesktopEdition ist im Vergleich zur Server-Variante leichter zu installieren und läuft "out-of-the-box", bietet aber für große Projekte nicht die nötige Performance und Flexibilität, unter anderem da die DesktopEdition mit einem integrierten Webserver betrieben wird und Benachrichtigungsfunktionen nicht verfügbar sind.

Die Veröffentlichung einer separaten DesktopEdition wurde mit Version 1.5.5a eingestellt und mit dem regulären Wiki verschmolzen. Die regulären Versionen können nun als Desktopwiki gestartet werden, wozu kein Webserver nötig ist.

Installation

Vorrausgesetzt wird, dass Python installiert ist, was bei Ubuntu standardmäßig der Fall ist.

Die aktuelle MoinMoin-Version kann von moinmo.in {en} als Tarball heruntergeladen und entpackt werden [1]. Die Desktop-Edition von MoinMoin kann dort ebenfalls runterladen.

Um die weitere Beschreibung zu vereinfachen, wird davon ausgegangen, dass der Programm-Ordner moin-desktop in das Homeverzeichnis entpackt wurde, somit als ~/moin-desktop zur Verfügung steht.

Konfiguration

Grundsätzlich muss das Desktop-Wiki nicht konfiguriert werden und ist "out-of-the-box" lauffähig. Wer jedoch sein Desktop-Wiki individuell anpassen möchte oder mehrere Wikis gleichzeitig betreiben will, sollte hier weiterlesen.

Grundeinstellungen

Grundeinstellungen, wie der Name und das Logo des Wikis werden in der Datei wikiconfig.py im Verzeichnis moin-desktop vorgenommen. Ein Texteditor, der Syntaxhighlighting für Python-Code beherrscht, bietet sich zur Bearbeitung an [3].

Eine Beispielkonfiguration könnte wie folgt aussehen:

1
2
3
4
5
6
from MoinMoin.multiconfig import DefaultConfig

class Config(DefaultConfig):
    sitename = "Mein Desktop Wiki"
    logo_string = u'<img src= "/moin_static180/meinlogo.png"> Mein Desktop Wiki'
    acl_rights_after = acl_rights_default = u"All:read,write,delete,revert,admin"

Ist das Desktop-Wiki aus dem Internet erreichbar, sollten die Administrationsrechte beschränkt werden:

1
    acl_rights_default = u"All:read,write,delete"

Die Datei meinlogo.png muss dabei im Verzeichnis ~/moin-desktop/wiki/htdocs liegen, wo auch das sogenannte Favicon, welches vom Browser angezeigt wird, zu finden ist. Bei Version 1.5.5a muss im logo_string der Ort /wiki/meinlogo.png statt /moin_static180/meinlogo.png lauten.

Servereinstellungen

Einstellungen, die die Serverfunktion betreffen, werden in der Datei wikiserverconfig.py (im Verzeichnis moin-desktop) vorgenommen. Eventuell muss die Datei erst angelegt werden [3]. Die 1.8-er Version hat schon eine Datei mit Voreinstellungen, die man auskommentieren kann.

Eine Beispielkonfiguration für 1.5.5a kann wie folgt aussehen:

1
2
3
4
from __main__ import DefaultConfig
class Config(DefaultConfig):
    port = 8080
    interface = "127.0.0.1" # Netzwerk-Schnittstelle

Dabei ist port = 8080 der Port, auf dem der Webserver läuft und der Standard-Port der DesktopEdition. Es reicht, dies bei einer angepassten Version zu ändern um gleichzeitig verschiedene Versionen der DesktopEdition zu benutzen.

Die Netzwerk-Schnittstelle, an die der Webserver gebunden wird, ist im Beispiel die interne Adresse [127.0.0.1]. Für alle Schnittstellen wird "" notiert.

Automatisch im Browser öffnen

Damit beim Start der Desktop Edition sofort deren Startseite im Browser geöffnet wird, muss die Datei moin.py im Verzeichnis moin-desktop bearbeitet werden [3]. Dieser Weg funktioniert nur bei der Version 1.5.5a.

Zunächst muss Zeile 11 ergänzt werden und sieht anschließend wie folgt aus:

1
import os, sys, webbrowser

Am Ende der Datei muss vor folgendem Abschnitt:

# Run moin moin server:
run(Config)

ein weiterer Abschnitt ergänzt werden:

# Run browser
iface = Config.interface or 'localhost'
url = "http://" + iface + ":" + str(Config.port)
webbrowser.open(url)

Mit diesen Einstellungen wird mit dem Starten des Desktop-Wikis die Startseite des selben in dem Browser geöffnet, der durch das Alternativen-System festgelegt ist.

Benutzung

Die MoinMoin - Desktop Edition wird im Terminal gestartet [2], der Befehl mit Pfadangabe lautet:

python ~/moin-desktop/wikiserver.py 

für die 1.8 oder für die 1.5.5a:

python ~/moin-desktop/moin.py 

In der Standard-Konfiguration kann nun die Startseite im Browser unter der Adresse http://localhost:8080/ aufgerufen werden.

Man kann den Befehl auch zum Autostart [4] hinzufügen, wenn der Server immer gestartet werden soll. Man muss dann natürlich immer den kompletten Pfad zu der Datei moin.py angeben.

Start/Stop Alias

Um die DesktopEdition beliebig starten und stoppen zu können, bietet es sich an, zwei Kurznamen für die Befehle zu erstellen [5].

Um mit dem Befehl moin die DesktopEdition im Hintergrund und ohne irgendwelche Ausgaben zu starten und mit moin0 zu beenden, sind beispielsweise folgende Aliase zu gebrauchen:

alias moin="python ~/moin-desktop/moin.py > /dev/null 2>&1 &"
alias moin0="kill \`pidof python ~/moin-desktop/moin.py\`"

Sprache

Um die Sprache umzustellen, wechselt man zur Seite http://localhost:8080/SystemPagesSetup, wo unter anderem Deutsch installiert werden kann. Wenn keine Installation angeboten wird, muss man erst einen Benutzer anlegen und sich als dieser anmelden.

Zugang

Auf der Seite Benutzer anlegen oder für 1.5.5a BenutzerEinstellungen kann ein Account angelegt werden. Da die Mailzustellung in der Desktop Edition nicht funktioniert, sollte man sich sein Passwort gut merken.

Struktur

Grundsätzlich besteht ein MoinMoin-Wiki aus einem MasterWiki und dem eigenem (angepasstem und erweiterten) Wiki. Die Dateien des MasterWiki liegen im Ordner ~/moin-desktop/moinmoin und sollten vom Benutzer unberührt bleiben. Der Benutzer arbeitet stets mit seinem eigenen Wiki, dass im Ordner ~/moin-desktop/wiki liegt. So ist sichergestellt, dass man das MasterWiki bei einem Update seitens MoinMoin aktuell halten kann, ohne Teile aus dem eigenen Wiki zu beschädigen.

Wiki-Seiten

Eine neue Seite mit dem Namen Willkommen wird als erste Revision im MoinMoin Quellcode in der Datei ~/moin-desktop/wiki/data/pages/Willkommen/revisions/00000001 gespeichert. Die aktuelle Versionsnummer von Willkommen wird in der Datei ~/moin-desktop/wiki/data/pages/Willkommen/current hinterlegt.

Erweiterungen

Plugins können im Ordner ~/moin-desktop/wiki/data/plugin sortiert nach Art des Plugins abgelegt werden. Die folgende Tabelle gibt Aufschluss über die verschiedenen Plugins und über Bezugsquellen. Wiki/Icons/develop.png

Plugins
PluginFunktionBeispielMarktplatz {en}
actionBenutzer-AktionenSeite zur Bearbeitung öffnenActionMarket {en}
filterFilter zur Indexerstellungnoch nicht implementiertFilterMarket {en}
formatterRegeln zur FormatierungMoinMoin Markup zu LatexFormatterMarket {en}
macroAutomatisch erstellte InhalteDynamische Listen wie KategorienMacroMarket {en}
parserMoinMoin Markup RegelnSyntaxhiglighting in CodeblöckenParserMarket {en}
processorProzessorenveraltet - die Unterstützung wurde eingestelltProcessorMarket {en}
themesDarstellungs-Themenhuman, humanb, rightsidebarThemeMarket {en}
xmlrpcXML-ProzesseInterWiki-weite SucheXmlRpcMarket {en}

Ab der Version 1.6 wurde die Unterstützung für Prozessoren entfernt.

Themes

Die Plugins zur Themen-Darstellung beinflussen das grundlegende Aussehen der Seiten, wobei Cascading Style Sheets (css/) und Bilder (img/) eine wichtige Rolle spielen. Beide zugehörigen Ordner finden sich unter ~/moindesktop/wiki/htdocs/THEMENAME/.