JOT2012 Demo3-ohje

Emacs käynnistyy komennolla emacs, jonka jälkeen voi antaa käynnistysoptioita tai tiedostopolkuja. Monesti tämä käynnistää vain tekstiversion, mutta esim. Linuxissa käynnistyy graafinen versio. Jos haluatte käynnistää vain tekstiversion, se tapahtuu komennolla emacs -nw. Graafisen version saa käyntiin kullekin käyttöliittymälle ominaisella tavalla, esim. Windowsissa Start-valikosta.

Käydäänpä läpi Emacsin näyttö, nyt tekstimoodissa. Ensin kuvaruudun tai ikkunan ylälaidasta löytyvät valikot, jotka aktivoituvat joko hiirellä tai F10 näppäimellä.

File Edit Options Buffers Tools Help                                            

Sitten tulee varsinainen työalue. Käynnistyessään Emacs näyttää oletuksena pienen opetustekstin Emacsin kä(ytöstä. Lue se.

Welcome to GNU Emacs, one component of the GNU/Linux operating system.

Get help           C-h  (Hold down CTRL and press h)
Emacs manual       C-h r        Browse manuals     C-h i
Emacs tutorial     C-h t        Undo changes       C-x u
Buy manuals        C-h C-m      Exit Emacs         C-x C-c
Activate menubar   M-`
(`C-' means use the CTRL key.  `M-' means use the Meta (or Alt) key.
If you have no Meta key, you may instead type ESC followed by the character.)
Useful tasks:
Visit New File                  Open Home Directory
Customize Startup               Open *scratch* buffer

GNU Emacs 23.1.1 (x86_64-redhat-linux-gnu, GTK+ Version 2.18.9)
 of 2012-02-27 on x86-007.build.bos.redhat.com
Copyright (C) 2009 Free Software Foundation, Inc.

GNU Emacs comes with ABSOLUTELY NO WARRANTY; type C-h C-w for full details.
Emacs is Free Software--Free as in Freedom--so you can redistribute copies
of Emacs and modify it; type C-h C-c to see the conditions.
Type C-h C-o for information on getting the latest version.

Viimeisenä tulevat tilarivi ja viestirivi. Tilariviltä näet, missä tilassa Emacs on, kellonajan, jne. Tätä riviä voit itse muokata. Huomaa, että ainakin graafisessa versiossa voit myös muuttaa tiloja hiirellä klikkailemalla.

-UUU:%%--F1  *GNU Emacs*    Top L1     (Fundamental)----9:39 0.10---------------
For information about GNU Emacs and the GNU system, type C-h C-a.

Viimeinen rivi on viestirivi, jossa näkyvät Emacsin *Messages* puskuriin tulostuvat viestit. Jos Emacs kysyy syötettä, se myös annetaan tällä rivillä. Jos käytät Puttyn läpi Emacsia, tai melkein mitä muuta tahansa, ovat värit lähinnä karmeat. Se on Puttyn ominaisuus, joskin Emacsistakin voit värejä vaihtaa.

Emacsiin voi ladata tiedostoja muokattavaksi näppäilyllä C-x C-f. Nyt on oltava tarkkana, ettei näppäile f ilman Ctrl-näppäintä, sillä se käynnistää toisen komennon. Onnistuneen komennon annon jälkeen Emacs kyselee tiedoston nimeä, jonka antaminen päätetään <Ret>, eli Return tai Enter näppäimen painamiseen, siis rivinvaihtoon.

Varsinaisesti Emacsissa ei koskaan muokata tiedostoa, vaan puskuria, jossa on tiedoston sisältö. Yleensä puskuriin liittyy jokin tiedosto, muttei välttämättä. Puskurin sisällön voi tallentaa siihen liittyvään tiedostoon näppäilyllä C-x C-s, tai johonkin toiseen tiedostoon näppäilyllä C-x C-w.

Emacs lopetetaan näppäilyllä C-x C-c. Jos puskureissa on tallentamattomia tietoja, Emacs käy nämä läpi ja varmistaa tallennetaanko tiedo vai ei.

Yleensä kursorinäppäimet toimivat liikkumisessa puskurin sisällä. Jos näin ei kuitenkaan ole, on käytössä seuraavat näppäinkomennot.

Emacsia voi halutessaan käyttää Vim-editorin tavoin, ts. siten, että Emacsia käytettäessä käytetäänkin Vim-komentoja. Tämä onnistuu asentamalla Emacsiin evil mode laajennos.

• Siirry jalavan kotihakemistosi juuresta kansioon .emacs.d, ts. anna komento

  cd .emacs.d
  

  Jos sinulta ei löydy tällaista kansiota, luo se ensin kommennolla

  mkdir .emacs.d
  

• Tämän jälkeen, ollessasi hakemistossa .emacs.d, asenna evil mode kloonaamalla Git-varasto kommennolla

  git clone git://gitorious.org/evil/evil.git
  

  Sinulle syntyy tällöin evil-niminen alihakemisto .emacs.d-kansioon.

• Kerro vielä Emacsille, että haluat ottaa käyttöön evil-mode -laajennoksen. Tämä tapahtuu lisäämällä kotihakemistossasi sijaitsevaan .emacs-tiedostoon seuraavat rivit

  (add-to-list 'load-path "~/.emacs.d/evil")
  (require 'evil)  
  (evil-mode 1)
  

  Yllä asetus (evil-mode 1) tarkoittaa sitä, että aina kun aukaistaan Emacs, se toimmii oletuksena Vimin tavoin. Tämän rivin voi jättää toki halutessaan pois, ja käynnistää Vim-laajennoksen Emacsista aina tarvittaessa komennolla

  M-x evil-local-mode
  

  Tämän komennon voi sitoa kätevästi näppäimeen F6 lisäämällä .emacs-tiedostoon

  (global-set-key (kbd "<f6>") 'evil-local-mode)
  

  Emacsia ei tarvitse käynnistää uudelleen, vaan voit mennä tuon rivin loppuun ja näppäillä C-M-x, siis Control-Alt-x tai Control-Cmd-x, ja Emacs suorittaa rivin koodin. Nyt F6 käynnistää ja lopettaa Evil-moodin.

Emacsille on useitakin Git-moodeja, joilla gitin peruskäyttö onnistuu Emacsin komennoilla. Mukana tuleva git-tuki on kovin vajavainen, joten kannattanee ladata jokin muu git-liitos, esimerkiksi http://philjackson.github.com/magit/index.html. Git-moodin käynnistää komento git-status, joka on hyvä sitoa johonkin näppäimeen, vaikka F12, luvun Vim-apuja lopun ohjein.

Tekstin kopiointi, leikkaus ja liimaus onnistuu seuraavaasti:

Tekstin erikoisempia muokkauskomentoja ovat mm. seuraavat:

Ja lisää löytyy, paitsi editorien dokumentaatiosta, linkeistä http://karl-voit.at/vim-emacs-cheatsheet_of_freezing_hell.txt ja http://www.elmindreda.org/emacs.html.

CLOSED: 2012-09-27 Thu 13:32
Alla on esimerkki org-mode dokumentin rakenteesta.

#+TITLE: Otsikko

* Eka taso
** Toka taso
Lorem ipsum hipsum tipsum...
*** Kolmas taso
Kettu loikki yli
- järven,
- kiven tai
- kannon.

Org-mode käyttää puurakennetta, missä puun haarautuminen esitetään asteriskeilla *. Voidaan ajatella, että asteriskien määrä kertoo otsikon tason aivan kuten <Hn> tagi HTML:ssä. Tiedostoa voi muokata suoraan, mutta myös tasoittain.

Seuraava esimerkki esittelee hieman rikkaamman org-dokumentin.

 1:  #+TITLE: Otsikko
 2:  
 3:  * Eka taso <2012-08-15 Wed>
 4:    CLOCK: [2012-08-17 Fri 11:00]--[2012-08-17 Fri 11:15] =>  0:15
 5:  ** DONE [#A] Toka taso                                              :foo:bar:
 6:     CLOSED: [2012-08-17 Fri 11:02] DEADLINE: <2012-08-20 Mon>
 7:     Lorem ipsum hipsum tipsum
 8:  *** TODO Kolmas taso                                                    :foo:
 9:      SCHEDULED: <2012-11-17 Sat>
10:      :PROPERTIES:
11:      :Luokka:  Luontohavainto
12:      :Havaitsija: Meeri Metsänkävijä
13:      :END:
14:  Kettu loikki yli
15:  - [X] järven,
16:  - [ ] kiven tai
17:  - [ ] kannon.
18:   

Esimerkissä näkyy paljon päiväyksiä. Org-mode antaa työkalut näiden luomiseen ja muokkaamiseen. Päiväyksiä voi syöttää näppäinkomennolla C-c ., joka aukaisee kolmen kuukauden kalenterin sisältävän puskurin. Syöttöriville tulee kehoite päivämäärän syötöstä, ja oletuksena on nykyinen päivä. Päivän voi valita kalentereista, kirjoittaa uuden, tai sitten antaa muutoksen nykyisestä päiväyksestä. Esimerkiksi syöte +3d antaa päiväyksen kolme päivää tämänhetkisen päiväyksen jälkeen. Määräajan asetus muokattavalle otsikolle annetaan näppäinkomennolla C-c s. Määräajat ilmestyvät SCHEDULED-tarkenteella otsikon alle. Takarajat saa syötettyä näppäilemällä C-s d, ja ne ilmestyvät myös otsikon alle DEADLINE-tarkenteella. Näistä lisää kappaleessa Org-mode ja ajanhallinta.

Esimerkissä on myös käytetty TODO- ja DONE-tarkenteita riveillä 5 ja 8. Näillä voidaan seurata ja ohjata työnkulkua. Voit myös määritellä omia, vastaavia tarkenteita. Tarkenteiden tilaa voi vaihtaa näppäinkomennolla S-<oikea> ja S-<vasen>. Kohtia voi myös priorisoida, kuten rivin 5 merkintä [#A] näyttää. Näitä voi myös muokata, ja vaihto tapahtuu näppäilyillä S-<ylös> ja S-<alas>. Lisätietoa löytyy jälleen kappalleesta Org-mode ja ajanhallinta.

Otsikot voi myös merkata tageilla, jotka näkyvät rivin lopussa kaksoispisteellä eroteltuna. Näppäily C-c C-c otsikkorivillä käynnistää tagimuokkaimen. Tageja hienompia metatietoja voi antaa otsikon perässä tulevaan laatikkoon, joka on merkattu :PROPERTIES: … :END: merkinnöillä. Kullakin rivillä on yksi tieto, ensin nimi ympäröitynä kaksoispisteillä, sitten arvo, joka päättyy rivin loppuun.

Kaikkia näitä metatietoja voi käyttää esimerkiksi org-dokumentin näkymän rajoittamiseen, tiedon esittämiseen kalenterissa tai tapahtumalistauksena, tai Org-moden toiminnan säätelyyn. Niiden sisältämää tietoa voi myös käsitellä ohjelmallisesti tai laskennallisesti, vaikkapa työtunteja laskemalla. Esimerkkejä tulee myöhemmissä kappaleissa.

Kannattaa koko ajan muistaa, että org-dokumentit ovat ulkonäöstään huolimatta pelkkää tekstiä, ja siten luettavissa ja muokattavissa muillakin editoreilla.

Tärkeimmät näppäinkomennot lienevät <TAB> ja S-<TAB>. Pelkkä <TAB> vaihtaa alipuun näkyvyyttä, onko puu supistettuna pääotsikoihin, näkyvätkö alkiotsikot vai näkyykö kaikki. Näppäilyllä S-<TAB> taas vaikutetaan koko dokumentin näkyvyyteen vastaavasti. Org-tiedostossa voi liikkua nopeammin taulukon org-dokumentissa-liikkuminen esittämillä komennoilla.

Kappaleita voi editoida otsikkotasolla mm. taulukon kappaleen-liikutus kuvaamilla komennoilla. Taulukossa on myös kuvattu joukko muita editointikomentoja.

Kaikista kuormitetuin näppäimistökomento lienee kuitenkin C-c C-c, joka tekee, tilanteesta riippuen, vaikka mitä. Otsikkorivillä se käynnistää tagien muokkauksen. Taulukossa se sovittaa taulukon ulkoasun tekstiin. Se päivittää hyperlinkkejä, alaviitteitä, tai vaihtaa valintalaatikoiden tilan. Paljon muutakin se tekee ja näitä on selitelty pitkin tekstiä. Yleensä kannattaa kokeilla sitä, jos ei tiedä, mitä muuta voisi kokeilla.

Tekstin korostus tapahtuu org-modessa ympäröimällä korostettava teksti korostusmerkeillä, kuten taulukossa korostus on esitetty.

Linkit on merkitty org-dokumentissa hakasulkeilla:

[[kohde][tarkenne]]

missä kohde on kohteen tunniste ja tarkenne lyhyt, näkyvä kuvaus linkille. Linkkejä on helppo lisätä näppäilemällä C-c C-l. Linkin kohde voi olla org-dokumentin sisällä tai ulkopuolella. Esimerkiksi URI toimii hyvin kohteena, samoin vaikkapa sähköpostin tunniste. Org-dokumentin sisälle viitatessa voi kohteeksi antaa otsikon sisällön, jolloin linkki osoittaa kyseiseen otsikkoon. Muualle org-mode sisällä viitatessa tulee käyttää ankkureita. Ankkurit merkitään <<kohde>> ja niitä voi olla kaikkialla tekstissä. Erikoisempia ovat radiokohteet, jotka merkitään <<<radiokohde>>> Näissä sisällä oleva teksti aktivoituu linkiksi kaikkialla dokumentin sisällä, eli tuolla ylläolevalla määrittelyllä jokainen /radiokohde/ sana muuttuisi linkiksi tuohon ankkuriin. Nämä linkit voi päivittää näppäilemällä linkin päällä C-c C-c.

Linkkiä voi seurata hiirellä tai näppäilyllä C-c C-o. Jos linkki on dokumentin sisäinen, pääsee kohteesta takaisin näppäilyllä C-c & -- tätä voi myös hyödyntää muualla merkkaamalla paikan C-c % näppäilyllä, jolloin C-c & palaa siihen takaisin. Näppäilyt C-c C-x C-n ja C-c C-x C-p siirtävät kohdistimen seuraavaan tai edeltävään linkkiin.

Yksi hienoimmista ominaisuuksista Org-modessa on sen tapa käsitellä taulukoita. Taulukko kirjoitetaan seuraavasti:

| A | B |  C |
|---+---+----|
| 2 | 3 |  5 |
| 3 | 4 |  7 |
| 5 | 7 | 12 |
#+TBLFM: 

Taulukon luominen ja muokkaaminen on helpompaa kuin miltä näyttää. Tarvitsee vain kirjoittaa ensimmäinen rivi ja näppäillä C-c <RET>, niin Org-mode tekee taulukon lopun. Rivin viimeisessä sarakkeessa <TAB> luo uuden rivin ja siirtää kohdistimen sen ensimmäiseen sarakkeeseen, muuten <TAB> siirtää kohdistimen seuraavaan sarakkeeseen, S-<TAB> edelliseen. <RET> luo uuden rivin ja vaihtaa kohdistimen sille samaan sarakkeeseen, kuin missä näppäintä painettiin. Kursorinäppäimet meta-näppäin pohjassa muuttavat sarakkeiden ja rivien järjestystä. Uuden rivin tai sarakkeen saa näppäilyllä M-S-<alas> ja M-S-<oikea>, kun taas M-S-<vasen> ja M-S-<ylös> poistavat sarakkeen tai rivin. Olemassa olevasta taulukkomaisesta tekstistä saa Org-moden ymmärtämän taulukon valitsemalla sen ja näppäilemällä C-c |. Org-mode tukee myös Emacsin table.el-moodin taulukoita. Valitettavasti näitä voi käyttää vain tiedon taulukkomaiseen esittämiseen, kun taas Org-moden omat taulukot taipuvat hienoiseen taulukkolaskentaankin.

Org-modessa voi otsikoille määritellä ajankohdan (C-c C-s) tai aikarajan (C-c C-d). Org-mode osaa näyttä tiedot näiden kenttien avulla aikajärjestyksessä tai kalenterissa. Komennolla M-x org-agenda voi generoida esimerkiksi kuluvan viikon tapahtumalistan tai editoidun puskurin aikajanan. Tarvittaessa aikoja voi myös kasvattaa (S-<ylös>) ja vähentää (S-<alas>), esimerkiksi aikaleimassa 2012-02-28 Tue päivän 28 kohdalla kasvattaminen muuttaa päiväykseksi 2012-02-29 Wed. Jos muokkaat aikaleimaa käsin, C-c C-c sen sisällä muuttaa sen validiksi. Pelkän aikaleiman saa lisättyä tekstiin näppäinkomennolla C-c ., joka käynnistää kalenteriselaimen ja kehotteen. Kehotteeseen voi ajan lisäksi syöttää vaikkapa +2d , jolloin aikaleimaksi tulee aika kahden päivän päästä aikaleiman tekohetkestä.

Org-modesta löytyvät myös kellot, joiden avulla voi mitata esim. tehtävään käytettyä aikaa. Kello käynnistetään komennolla C-c C-x C-i, ja sammutetaan komennolla C-x C-c C-o. Tällöin lähimpään otsikkoon lisätään CLOCK:-kenttä, siihen alku- ja loppuaika, sekä näiden erotus, eli tapahtuman kesto. Luonnollisesti edellä mainitut muokkauskomennot toimivat näillekin ajoille, ja kesto lasketaan aina uusiksi muutoksen jälkeen. Jos se sattuu jäämään päivittymättä, C-c C-c aikaleimassa korjaa taas tilanteen.

Komennolla C-c C-x C-d kunkin alipuun sisältämät aikaleimat lasketaan ja näytetään otsikoiden yhteydessä. Komennolla C-c C-x C-r generoituu dynaaminen lohko, joka sisältää koosteen halutun alueen aikaleimoista. Taulu päivittyy taas näppäilemällä C-c C-c lohkon aloitusrivillä. Tämän taulun tieto riittää vaikka projektin ajanseurantaan.

Alla esimerkki yksinkertaisesta tällaisesta lohkosta:

#+BEGIN: clocktable :maxlevel 3 :scope subtree
Clock summary at [2012-08-27 Mon 15:59]

| Headline                 | Time   |   |      |
|--------------------------+--------+---+------|
| *Total time*             | *1:00* |   |      |
|--------------------------+--------+---+------|
| Org-mode ja ajanhallinta |        |   | 1:00 |
#+END:

Ja tässä siitä generoitunut taulu:

Clock summary at 2012-08-27 Mon 16:02

Org-modella tehdyt dokumentit voi muuttaa tai julkaista myös useissa muissa formaateissa. Ajanhallinnan yhteydessä sivuttiin jo org-dokumentin muuttamista TaskJugglerin ymmärtämään muotoon. Seuraavassa on lueteltu esimerkkejä muista, yleisimmistä, muutostoiminnoista. Kaikki muokkaus- ja julkaisutoiminnot löytyvät näppäilyllä C-c C-e.