RSS

Vimwiki — en personlig wiki i terminalen

23 Okt

Wikisar är populära på nätet. Wikipedia.org är väl den mest kända. Men den wiki som används där, Mediawiki, används också på många andra ställen på nätet. Det är bland annat många program med fri och öppen källkod som lägger upp dokumentation och annat på sin wiki. Men det finns också små personliga wiki för skrivbordet. Här finns det grafiska program som Tomboy och Zim. Har vi liknande program för terminalen också?

Ja, det har vi. I alla fall om vi använder textredigeraren VIM. Här finns nämligen ett tillägg som heter vimwiki. Jag har nu testat tillägget och blivit förtjust i det. Inte så att jag överger task som att-göra-lista, men vimwiki känns ändå användbar till mycket. Inte minst för snabba anteckningar när jag ändå har VIM öppet för att skriva något.

En liten sammanfattning av vimwiki kan se ut så här.

  • Snabbt skriva ner anteckningar
  • Skapa att-göra-listor
  • Länka mellan olika sidor i wikin
  • Omvandla wikin till en webbsida
  • Skriva dagbok
  • Markeringsspråket man använder är Googles wiki-kod.

Och som vanligt är en av fördelarna med att använda VIM och vimwiki, att i terminalen tvingas man inte använda musen eller den bärbara datorns styrplatta. Man behöver aldrig låta fingrarna lämna tangentbordet.

Installera

  1. Laddade ner skriptet från vim.sourceforge.net.
  2. Öppnade den nedladdade filen i VIM. Ja, vim kan öppna .gz-filer och även kompilera sina egna tillägg.
  3. Med filen öppen kör man ”:so %”, som installerar skriptet.
  4. Redigera nu filen .vimrc genom att lägga till följande, som vimwiki behöver. När du är klar sparar du och stänger filen.
    • set nocompatible
    • filetype plugin on
    • syntax on
  5. Öppnade VIM.
  6. Startade wikin genom att skriva följande sekvens. Man kommer inte att se vad man skriver, men skriv sekvensen ändå.
      \ww
    

    Men när man har gjort det, får man en fråga om att skapa mappen /home/användare/vimwiki. Svara ja på den.

  7. Då öppnade sig index-filen, startsidan för wikin: index.wiki. Den är helt tom.
  8. Nu kan man börja använda wikin. Man använder samma kod som Google Wiki för att formatera sin text. (Se nedan) Tänk på att det här är förstasidan i wikin och alltså bör innehålla en lista över de filer man kan klicka sig fram till.

Nu har alltså mappen vimwiki skapats och när man har redigerat sin första sida hittar man även filen index.wiki där. Om man också börjar använda funktionen dagbok (eng. diary), så skapas även den mappen, och där hamnar daterade wiki-filer.

Hantera

Innan vi går in på hur vi ska skriva våra anteckningar, ska vi bara titta lite på vilka kommandon vi använder för att hantera wikin, länkarna och sidorna.

För att kunna öppna wikin måste du först ha öppnat VIM. Tidigare har vi sett ett sätt att öppna wikin på, men man kan också öppna den i en ny flik om man håller på med något man inte vill avsluta.

  \wt

Vill man öppna dagboken skriver man så här.

  \w\w

Det här stänger eventuella wiki-fönster och andra filer man har öppna. För att komma runt problemet, kan man först skapa en egen flik för dagboken och sedan öppna den.

  :tabnew
  \w\w

Det finns också möjlighet att döpa om och ta bort sidor.

  \wr
  \wd

När du har skapat en undersida i wikin, fungerar den på ett sätt som vilken fil i VIM som helst. Du sparar den med :w. Men för att komma tillbaka till föregående sida, t ex förstasidan, använder man bakstegstangenten. Du behöver alltså inte stänga filen. Däremot behöver du på vanligt sätt spara och stänga wikin, från första sidan, med ett :wq.

För att … Kommando
Öppna förstasidan \ww
Öppna förstasidan i ny flik \wt
Öppna dagboken \w\w
Välj och öppna förstasida \ws
Ta bort wikisida \wd
Döp om sida \wr
Följ/skapa länk Retur
Dela och följ/skapa länk Skift+Retur
Dela vertikal och följ/skapa länk Ctrl+Retur
Gå till föräldrasidan/föregående sida Baksteg
Bläddra nedåt mellan länkar Tab
Bläddra uppåt mellan länkar skift+Tab
Visa hjälp :h vimwiki-mappings

Skriva wikin

När man skriver sina wiki-sidor använder Googles wiki-språk. Den påminner en del om andra wiki-språk, men har sina små egenheter. Men har man förstått principen är det lätt. Och de mest användbara markeringarna lär man sig fort.

Varje sida bör ha en rubrik högst upp, även om det kanske inte är strikt nödvändigt.

  =Sidans rubrik=
  
  Här kommer själva texten på sidan.

Det finns tre nivåer av rubriker, så det går lätt att strukturera sin text.

Själva texten skriver man som på den gamla skrivmaskinens tid. Varje stycke omges av en blank rad. Så skriv bara på och gör en extra rad innan nästa stycke. Vill man ha fet eller kursiv text, går det bra.

  Här gör jag texten *fet* och _kursiv_.

Det går också att göra listor, punktlistor och numrerade listor. För att nästla listor räcker det med att man gör ett mellanslag i förhållande till raden över.

  * Punkt 1
  * Punkt 2
   * Punkt 2.1
   * Punkt 2.2
  * Punkt3 

För en numrerad lista skriver man så här.

  # Punkt 1
  # Punkt 2
   # Punkt 2.1
   # Punkt 2.2
  # Punkt 3 

Men det som kanske är det bästa och det som gör det här till en wiki, är att man kan skapa länkar. Inte minst första sidan bör innehålla länkar som tar en vidare till underområden av något slag. Det finns två sätt att skapa en länk.

  • Ställ markören på ett ord eller markera visuellt de ord som ska bli en länk och tryck Retur. Texten blir nu en länk.
  • Omge helt enkelt det som ska bli länken med dubbla hakparanteser.

Observera alltså att flera ord kan bilda en länk. Med båda sätten ska länken se ut så här.

  [[Min länk]]

För att gå till länken ställer man markören på den och trycker Retur. Finns sidan kommer man till den, finns den inte så skapas den.

När man sedan har redigerat den nya sidan, använder man bakstegstangenten för att gå tillbaka till föregående sida.

Grundläggande syntax för vimwiki.

Effekt Kod
Rubrik nivå 1 =Rubrik=
Rubrik nivå 2 ==Rubrik==
Rubrik nivå 3 ===Rubrik===
Fet text *fet*
Kursiv text _kursiv_
Länk [[länk]]
Länk med mellanslag [[wiki länk]]
Länk med beskrivning [[wiki länk|Beskrivning]]
Extern länk [[http://länk Länktext]]
Punktlista * Lista
Numrerad lista # Lista
Visa hjälp :h vimwiki-syntax

Omvandla till webbsida

Det går naturligtvis bra att bara skiva sina anteckningar, men de blir då begränsade till den egna datorn. Därför finns det också möjlighet att omvandla wikin till webbsidor, att göra den till en riktig wiki. Det går då att lägga upp den på någon plats på internet, om man vill det. Så för att ta sin wiki och omvandla den helt och hållet, skriver man så här.

  :VimwikiAll2HTML

Nu rullar det fram en del text i nedre delen av skärmen. När den är klar, trycker man Retur för att komma tillbaka till wikin.

  Saving vimwiki files...
  "~/vimwiki/index.wiki" 10 rader, 307 tecken
  Deleting non-wiki html files...
  Converting wiki to html files...
  Processing /home/maths/vimwiki/Anteckningar.wiki
  Processing /home/maths/vimwiki/Google wiki syntax.wiki
  Processing /home/maths/vimwiki/Uppgifter.wiki
  Processing /home/maths/vimwiki/diary/2013-10-23.wiki
  Processing /home/maths/vimwiki/index.wiki
  Default style.css has been created.
  Done!

Nu har mappen vimwiki_html skapats och det är där man hittar sina webbsidor.

För att … Kommando
Omvandla wikisida till HTML :Vimwiki2HTML
Omvandla hela wikin till HTML :VimwikiAll2HTML

Creative Commons-licens
Vimwiki — en personlig wiki i terminalen av Maths Göthe är licensierad under en Creative Commons Erkännande-IckeKommersiell-DelaLika 3.0 Unported licens.

 
Lämna en kommentar

Publicerat av på 23 oktober 2013 i Dator, Terminalen

 

Etiketter: , , , , ,

Kommentera

Fyll i dina uppgifter nedan eller klicka på en ikon för att logga in:

WordPress.com Logo

Du kommenterar med ditt WordPress.com-konto. Logga ut / Ändra )

Twitter-bild

Du kommenterar med ditt Twitter-konto. Logga ut / Ändra )

Facebook-foto

Du kommenterar med ditt Facebook-konto. Logga ut / Ändra )

Google+ photo

Du kommenterar med ditt Google+-konto. Logga ut / Ändra )

Ansluter till %s

 
%d bloggare gillar detta: