#
Vim Tipp zur Verwendung von
VimWiki Mit VimWiki könnt Ihr persönliche Wikis in Eurem Lieblings-Editor bewirtschaften. Notizen, Tagebuch, automatisierte HTML-Ausgabe - und alles ist konfigurierbar. Das #
VimWiki Plugin ist einer der Vim-Bausteine, den ich am intensivsten nutze. Mit der Zeit habe ich mir ein paar Grundregeln zurecht gelegt, die mir die zügige Arbeit erleichtern und Flüchtigkeitsfehler vermeiden helfen, damit es keine "OUPS..!" Momente gibt.
Tipp 1: alle-dateinamen-klein-schreiben - Es ist ultra einfach: Mitten im Test
v+motion zum Markieren tippen, mit <CR> / Enter aktivieren und schon ist ein Link zur neuen Wiki-Datei erstellt. Nochmal Enter, und die Datei öffnet sich zum Bearbeiten.
>> Doch halt: Dabei hilft es sehr, wenn schon diese Bezeichnung im Fließtext kleingeschrieben wird. Ich fülle Leerzeichen zusätzlich immer-mit-binde-strichen auf.
>> Grund: Nach einer Weile gerät in Vergessenheit, wie man seinerzeit dieses Thema geschrieben hat. Dann will man aber genau auf diese Datei verlinken und manuell per
[[Datei zum Thema]] einen Link dorthin einbauen.
>> Pustekuchen! Wenn nur ein Buchstabe falsch ist, wird auf diese Weise eine
neue Datei erstellt! Das Löschen per
:VimWikiDelete sollte von der neuen, leeren Datei aus erfolgen, und der eben erstellte Link muss auch noch korrigiert werden. Bei fertigen Links ist das Markieren und Bearbeiten im Visual Mode aber nicht so einfach und erfordert Aufwand.
>> Abhilfe bringt wie erwähnt eine selbst auferlegte Namenskonvention. Muss es im Fließtext unbedingt "normal" geschrieben sein, gibt es dafür die Möglichkeit, ähnlich wie in Markdown Links mit Beschreibung anzulegen, sogar mit Überschrifts-Ankern:
[[datei-zum-thema#Link-Verzeichnis|Links zum Thema XY]] . Ist es aufgefallen? Der Anker zur Überschrift "Link-Verzeichnis" muss natürlich exakt so geschrieben werden, wie die Überschrift lautet. Der Teil nach der
| Pipe ist schließlich das, was als hervorgehobener Link im Fließtext erscheint.
Tipp 2: Privatsphäre schützen - der (optional) automatisierte HTML-Export beim Speichern einer .wiki Textdatei verführt dazu, diese Seiten auch online zu stellen oder anderweitig im Browser zu lesen.
>> Obacht, denn auch die "Diary" Wiki-Dateien werden in HTML umgewandelt! Wenn da sehr Privates drin steht, will man das nicht aus Versehen mit hochladen
>> Abhilfe schafft die Funktion
:X (groß geschrieben).
- Mit
:X wird die Verschlüsselung angestoßen. - Voraussetzung: In der .vimrc Datei muss ein Eintrag stehen wie
set cm=blowfish2 oder in Langform set cryptmethod=blowfish2. "Blowfish 2" ist derzeit das Stärkste an Verschlüsselung, was Vim bietet. Nicht das Gelbe vom Ei, aber immerhin gelangen die Inhalte Eurer Tagebucheinträge nicht mehr im Klartext in online lesbaren HTML Dateien. - Nach
:X also mit Enter bestätigen, Ihr werdet 2x nach einem Passwort gefragt (gut merken, es gibt keine Recovery-Option!). Stimmen die beiden Eingaben nicht überein, passiert nichts, einfach nochmal von vorne starten -
:w zum Speichern nicht vergessen, sonst bleibt die Verschlüsselung nicht erhalten. - Wenn automatisiertes HTML-Erstellen nicht konfiguriert ist, sollte jetzt ein
:VimWiki2HTML ausgeführt werden, um die HMTL-Datei unlesbar zu machen. - Sollte einmal die Verschlüsselung aufgehoben werden, einfach erneut
:X aufrufen und 2x ein leeres Passwort per <CR> festlegen. Danach wieder speichern.
Tipp 3: Markdown- statt VimWiki-Syntax verwenden - VimWiki kennt seine eigene Syntax, die per default auch eingestellt ist. Sie ist Markdown ähnlich, aber nicht identisch (siehe oben, Linkstruktur).
>> In der .vimrc Datei kann auch festgelegt werden, dass originales Markdown oder Mediawiki-Syntax verwendet wird. Siehe dazu
:h vimwiki und dort nach
/vimwiki-option-syntax suchen. Der Eintrag in der .vimrc sieht für Markdown dann so aus:
let g:vimwiki_list = [{'path': '~/my_site/',
\ 'syntax': 'markdown', 'ext': '.md'}]
Um Mediawiki zu verwenden, einfach
'media' statt
'markdown' konfigurieren und eine passende Dateiendung bei
'ext' festlegen.
>> Vor- und Nachteile: Weder Markdown noch Mediawiki werden zur Zeit in HTML umgewandelt. Das kann aber noch kommen (ich warte seit 3 Jahren drauf, na vielleicht auch nicht)... Was aber den Vorteil hat, dass man die vorhin besprochene Problematik "Privatsphäre" zumindest aktuell nicht mit HTML-Dateien bekommen kann :)
Tipp 4: Umbenennen nur mit den Plugin-Tools - Wenn Ihr feststellt, dass Dateinamen nicht Euren Vorstellungen entsprechen, macht bitte nicht den Fehler, diese Dateien im Finder, Explorer, Thunar etc. umzubenennen. Damit zerschießt Ihr Euch den Wiki-Index, die Zuordnungen passen nicht mehr.
>> Der korrekte Weg läuft übers Aufrufen einer spezifischen Datei. Öffnet diese und führt dann
:VimWikiRenameLink aus. Ihr werdet feststellen, dass in schneller Folge alle Wiki-Dateien aufgerufen werden, um sie nach dem alten Link-Namen und Verweisen darauf zu durchsuchen. Wird der Begriff gefunden, wird er auch geändert. Besonderheit: Sind verschlüsselte Dateien darunter, unterbricht diese Suche und fragt nach der Eingabe des Passwortes - und zwar für jede verschlüsselte Datei einzeln! ...noch ein Grund, sich gleich beim ersten Mal an bestimmte Namenskonventionen zu halten
