TIM keskustelualustana

Tässä ohjeessa kerrotaan kuinka TIMIä voidaan käyttää keskustelualustana.

Periaattessa mikä tahansa tavallinenkin TIM-dokumentti on jo keskustelu, jos dokumenttiin sallitaan muutosoikeuksia. Ja kaikkiin dokumentteihin voi lisätä kommentteja (Comment/Notes). Lisäksi kaikista TIM-dokumenteista käyttäjät voivat tilata tiedon sähköpostiin, mikäli dokumenttiin tulee muutoksia tai uusia kommentteja.

Tekemällä dokumenttiin pieniä lisäyksiä, voidaan vielä helpottaa dokumentin käyttämistä keskusteludokumenttina. Riippuen lisäysten laadusta, voidaan sanoa dokuemntin olevan Chat (lisäykset vain dokumentin loppuun) tai Forum (dokumentissa voi olla useita aiheita, joihin käyttäjät voivat ottaa kantaa).

• esimerkki Forum-tyylisestä TIM-keskustelusta

Keskusteluja voidaan jakaa useita aiheita samaan dokumenttiin tai eri keskustelut voidaan kohdentaa eri dokumentteihin.

1. Keskusteludokumentin tekeminen

Helpoimmalla keskusteludokumentin (forum) kopioimalla tämän sivun lopussa oleva teksti uuden keskusteludokumentin sisällöksi ja muokkaamalla sitten sitä

Voi myös kopioida itselleen dokumentin:

• tim/pohjat/KurssiJossaDemot/2018k/chat/kurssin-keskustelu

Jos halutaan keskusteludokumentti, jossa on vain yksi keskusteludokumenttiaihe (chat), poistetaan kopioidusta pohjasta viimeinen painike.

2. Keskusteludokumentin sisällöstä

Alempana tässä dokumentissa annetaan valmiita ohjeita/ideoita erilaisten keskusteludokumenttien luomiseksi.

Aluksi kuitenkin hieman siitä, mihin keskustelu perustuu.

2.1 Käsitteitä

• kommentti - käyttäjän Comment/Note (C) -painikkeesta lisäämä kommentti
• mielipide - käyttäjän dokumenttiin lisätystä painikkeesta lisäämä TIM-lohko. Toki lohko voi olla muukin kuin mielipide, mutta tässä dokumentissa siitä käytetään tämä termiä ja dokumentin tekijä voi määritelä itse painikkeen tekstit
• keskustelun aihe - dokumenttiin lisätty lohko, jossa on otsikko ja mielipiteen lisäämispainike
• keskusteludokumentti - dokumentti, johon on lisätty keskusteluominaisuuksia
• Forum - keskustelu, jossa on useita keskusteluaiheita
• Chat - keskustelu jossa on vain yksi aihe ja lisäykset tulevat aina loppuun (tai haluttaessa alkuun)
• keskustelija - henkilö jolla on oikeus osallistua keskusteluun, eli oikeus muokata tavalla tai toisella dokumenttia

2.2 Dokumentin muutokset

Keskustelun helpottamiseksi dokumenttiin voidaan tehdä mm. seuraavia muutoksia:

• dokumentin asetuksiin rivi:

    show_authors: true

  jolloin tyylillä .chat merkityt lohkot sisältävät lohkon kirjoittajan nimen ja ajan

• painikkeet, joilla lisätään mielipiteitä/keskustelun aiheita

• dokumentin muuttaminen "eläväksi" (päivittyy automaattisesti) lisäämällä asetuksiin rivi:

    live_updates: 10

• dokumentin käyttöoikeudet, eli Edit-oikeus managesta niille, joilla on oikeus keskustella

• tyylisäädöt esimerkiksi kommenttien sijainnille, chat teksteille yms.

2.3 Menettääkö muita TIMin ominaisuuksia

Ei menetä, kaikki normaalit TIMin ominaisuudet ovat käytössä keskusteludokumentissakin ja sinne voidaan lisätä interaktiivisia tehtäviä, kuvia, videoita jne. Muokkausoikeuksien takia (toistaiseksi) automaattisen arvostelun vastauksia pääsee kyllä katsomaan (korjataan tämä myöhemmin pienentämällä keskustelijan oikeuksia).

3. Mielipiteen lisäämispainike

Pienin lisäys, jolla helpotetaan käyttäjien tekstin lisäämistä dokumenttiin on lisätä dokumenttiin mielipiteen lisäsypainike:

Lisää mielipide

Kun keskustelija painaa tätä painiketta tulee tekstiruutu johon kirjoittamalla syntyy esimerkiksi rivi (jonka muoto riippuu dokumentin tyyliasetuksista):

Tällainen painike saadaan lisättyä dokumenttiin lisäämällä uusi lohko kopioimalla editoriin seuraava teksti:

#- {forceclass="chat" .removePre}
\
[Lisää mielipide]{.timButton .addAbove}

    ⁞

Tässä rivi \ on sitä varten, että saadaan tyhjä rivi ennen painiketta. Kursorin merkki ⁞ ei ole välttämätön, mutta sitä voidan käyttää jos halutaan sen eteen, perään tai ympärille valmista pohjatekstiä joka tulee mielipiteen antajan tekstieditoriin.

Mielipidettä lisättäessä keskustelijalla on tyhjä muokkausikkuna. Mutta jos hän menee editoimaan antamaansa mielidettä, näkee hän muokkausikkunassa

#- {.chat}
Tässäpä mielipide

josta poistamalla .chat häviää hänen nimensä mielipiteen perästä.

Jos keskustelu halutaan käänteisessä järjetyksessä, voidaan laittaa niinkin, että mielipide lisääntyy painikkeen alapuolelle, eli silloin muoto olisi:

#- {forceclass="chat" .removePre}
\
[Lisää mielipide]{.timButton .addBelow}

Voitaisiin tehdä myös/tai painike, joka tuottaa lohkon, joka alkaa listatyylillä, eli:

Painikkeesi voidaan toki laittaa myös mikä tahansa kuva tms.

4. Vaihtoehtoinen tapa mielipiteen lisäämiselle

Toinen tapa lisätä mielipiteitä on tuottaa lisäämispainikkeella pohja, johon on valmiiksi laitettu käyttäjän nimi. Tällöin käyttäjä voi myös poistaa nimensä ennenkuin tallentaa mielipiteensä.

Esimerkiksi painike, jolla tulee pohja, jossa aloitetaan ranskalaisella viivalla ja tekstin perään tulee oma käyttäjätunnus saadaan koodilla

#- {.removePre}
[Lisää mielipide]{.timButton .addAbove}

    - ⁞
      [— %%username%%]{.smalltitle}

4.1 Selityksiä koodista

#- {.removePre}  

• uusi lohko, jossa piilotetaan kaikki pre-tyyliset tekstit. Pre lohkoon (ks alla) kirjoitetaan editoriin pohjaksi tuleva teksti. Jos pohjaksi ei haluta mitään tekstiä, tätä piilotusta ei tarvita.

[Lisää mielipide]{.timButton .addAbove}

• painike, jossa lukee Lisää mielipide ja joka tehdään tyylillä timButton joka lisää uuden sisällöön painikkeen yläpuolelle (addAbove)

      
    - ⁞
      [— %­%username%­%]{.smalltitle}

• teksti joka laitetaan uuden lohkon pohjaksi
• huomaa että tässä on erityisen tärkeää (ainakin toistaiseksi) tuo että teksti on erotettu yhdellä tyhjällä rivillä painikkeesta ja teksti on sisennetty vähintään 4:llä välilyönnillä, jolloin siitä tulee pre-tyyliä dokumentissa
• tässä tekstiksi on annettu
  • ranskalainen viiva -
  • paikka johon kursori tulee kun muokkausikkuna aukeaa. Tämä paikka on merkitty UTF-8 symbolilla ⁞. Se on helpointa kopioida tästä dokumentista tai tuottaa editorin Special characters kohdasta Cursor.
  • pienellä ({.smalltitle}) tuleva teksti jonka sisältönä on pitkäajatusviiva (—) ja makro jonka tilalle tulee käyttäjän tunnus (%­%username%­%)
• pohjaksi tuleva teksti voi olla mitä tahansa tai se voi puuttua kokonaan
• painikkeen tekstinä voi olla mitä tahansa, se voidaan tehdä myös muulla tyylillä. Oleellista on että siihen liittyy tyyli .addAbove, jonka ansiosta elementin painaminen aiheuttaa uuden lohkon lisäämisen "painikkeen" yläpuolelle.

5. Uuden keskusteluaiheen lisäämispainike

Jos halutaan painike, joka tuottaa vaikkapa uutta keskusteluaihetta varten toisen tason otsikon ja edellä mainitun lisäyspainikkeen, voitaisin tämä tehdä chat tyyliin perustuvalle painikkeelle koodilla:

#- {.removePre nomacros="true"}
[Lisää uusi keskustelun aihe]{.timButton  .addAbove}

    ## ⁞Otsikko keskusteluaiheelle, vaihda vain tämä, älä koske muuhun

    #- {forceclass="chat" .removePre}
    \
    [Lisää viesti]{.timButton .addAbove}
    
        ⁞

Vastaavasti lisäyspainike pohjatekstiin perustuvalle keskustelun aiheelle olisi:

#- {.removePre nomacros="true"}
[Lisää uusi keskustelun aihe]{.timButton  .addAbove}

    ## ⁞Otsikko keskusteluaiheelle

    #- {.removePre}
    [Lisää mielipide]{.addAbove .timButton}
    
        - ⁞
          [— %%username%%]{.smalltitle}

• tässä painike on tehty niin, että se lisää toisen tason otsikon ja sen alle lisää mielipiteen lisäyslohkon. Kursori viedään lisäämisen jälkeen otsikon alkuun.
• lohkon attribuuttina oleva nomacros="true" kieltää lohkossa olevien makrojen suorittamisen. Jos tämä puuttuisi, tulisi käyttäjätunnuksen kohdalle keskustelun aiheen lisääjän tunnus jokaisesta mielipiteestä.

6. Hienosäätöä

6.1 TIMin kommentit tekstien alle

Yksi muutos keskustelutyylisessä dokumentissa voisi olla kommenttien siirtäminen kunkin kappaleen alapuolelle, sen sijaan että ne ovat dokumentin oikeassa reunassa. Tämä voidaan tehdä CSS-tyyleillä ja tästä on esimerkki tämä dokumentin lopussa olevassa "pohjadokumentissa"

6.2 Elävä dokumentti

Jos halutaan, että dokumenttiin tehdyt lisäykset näkyvät heti ilman selaimen virkistämistä muiden keskustelijoiden dokumenteissa, voidaan dokumentin asetuksiin lisätä attribuutti:

live_updates: 5

Tässä 5 on päivityksen aikaväli sekunteina. Eli käytännössä keskustelijoiden selaimet tässä esimerkissä käyvät viiden sekunnin välein kysymössä TIMiltä onko dokumenttiin tullut muutoksia.

Toistaiseksi (syyskuu 2017) elävissä dokmenteissa on sellainen vika, että joskus lohkon lisääjä näkee oman lisäyksensä kahtena. Toinen poistuu kun selaimen virkistää (refresh, F5).

7. Dokumentin lopussa olevan lohkon lisäyspainikkeen poistaminen

Jotteivat käyttäjä ihan vahingossa lisää muuta kuin oikean tyylisiä lohkoja, voidaan lopussa oleva painike poistaa lisäämällä dokumentin asetuksiin rivi:

add_par_button_text:

eli lisäämispainikkeen tekstiksi laitetaan tyhjä jono, jolloin sitä ei tule.

7.1 Oikeudet

Keskustelijoille pitää antaa dokumenttiin myös oikeuksia. Oikeudethan annetaan Manage-näkymässä.

Toistaiseksi minimioikeus on antaa keskustelijoille Edit-oikeus.

Tässä on vielä muutama ongelma, jotka korjataan tulevaisuudessa:

• keskustelijat voivat muuttaa toistensa mielipiteitä
• keskustelijat eivät näe kuka on antanut kommentteja
  • tätä voi kiertää anatmalla keskustelijoille Teacher-oikeuden

Muille kun keskustelijoille voi antaa harintansa mukaan View-oikeuksia.

8. Forum-tyyppisen keskusteludokumentin luominen

Uuden Forum-tyyppisen (useita keskusteluaiheita samassa dokumentissa) keskustelun luomiseksi toimitaan seuraavaksi (tämä helpottuu tulevaisuudessa):

1. luo haluamaasi paikkaan uusi dokumentti ja annta sille kuvaava nimi
2. kopioi tämän dokumentn lopussa oleva pohja uuden dokumentin sisälläksi, joko Manage-tilasssa tai uutena "lohkona" (tällöin uudessa dokumentissa ei saa olla yhtään lisäyksiä vielä)
   • tämä tulee tulevaisuudessa näkymään valmiina Template-poohjana uutta dokuemnttia luotaessa
   • lisäksi tulee mahdollisuus jossa keskusteludokumentista saadaan yhdellä painikkeella toinen keskusteludokumentti
3. Muuta pohjassa olevia otsikoita, painikkeiden tekstäjä, pohjatekstejä ja ohjeita tarpeen mukaan.
4. Jos osaat CSS:ää, muotoile kommenttien paikkaa yms haluamallasi tavalla (ei ole pakko, jos tyydyt oletuksiin).
   • jos et halua kommentteja tekstien alle, aan TIM tyyliin oikeaan reunaan, poista kaikki note tai notes-tyylit.
5. Anna Manage-näkymässä käyttäjille haluamasi oikeudet - toistaiseksi pitää antaa keskustelijoille Teacher-oikeus jotta näkevät kuka on antanut komentteja, tämä muuttuu tulevaisuudessa - jos riittää että kommentoijat eivät näe kuka on antanut kommentin, riittää Edit-oikeus.
   - oikeustasoja tulee tulevaisuudessa lisää niin, että voi antaa vain oikeuden mielipiteen lisäämiseen, mutta ei saa muokata muuta kuin omia mielipiteitään (kuten nykyisin on kommenteissakin). Voit myös lisätä katseluoikeuden muille
6. Lisää aluksi tarvittava määrä keskustelun aiheita 'Lisää uusi keskustelun aihe' painikkeesta (tai minkä nimen annoitkin painikkeelle).
7. Kerro keskustelijoille dokumentin osoite. Esimerkiksi lisäämällä linkki siihen kurssisi tms. kotisivulle.

9. Chat-tyyppisen dokumentin luominen

Periaatteessa Chat-tyyppinen keskustelu luodaan vastaavasti, mutta siinä ei ole mahdollisuutta lisätä uusia keskusteaiheita, vaan lisäykset tulevat aina dokumentin loppuun.

1. Luo edellisillä Forum-ohjeilla keskusteludokumentti
2. Luo sinne yksi keskustelun aihe painamalla Lisää aihe-painiketta
3. Poista dokumenin lopusta painike, joka lisää uuden aiheen.

10. Puutteita

Kehityksen tässä vaiheessa on vielä muutamia bugeja/puutteita, joita korjataan resurssien sallimissa rajoissa:

• kommentit eivät päivity vielä livenä vaikka olisi live_updates, tarvitaan refresh
• kommentteja ei voi merkitä luettuiksi
• lisääjälle tulee joskus 2x lisätty lohko, tarvitaan refresh
• oikeuksia tarvitaan liikaa, ei ole vielä vaihtoehtoa, jossa keskustelijalla on oikeus vain omien mielipiteiden lisäämiseen/muokkaamiseen. Kommenteilla tämä ominaisuus on jo.
• kommenttien (Muokkaus Edit-valikosta) ja mielipiteiden (muokkaus painamalla kommenttia) muokkaus eri tavalla
• keskusteludokumentille ei ole vielä valmista pohjaa
• kommentin antajan tunnus näkyy vain Teacher-oikeuksilla

11. Pohjadokumentti keskustelun luomiseksi

Tämä tulee jatkossa olemaan valmis valinnainen Template-pohja dokumenttia luotaessa. Toistaiseksi kopioi settingsrivistä alkaen uuteen dokumenttiin.

``` {settings=""}
#live_updates: 10
show_authors: true
auto_number_headings: 2

add_par_button_text: 
css: |!!
.notes, .speaker {
    position: initial;
    margin-left: 4em;
    width: 80%;
    top: 0;
    right: calc(-30% + -1em - 5px);
}
.note {
    font-size: 0.7em;
    background: #fff;
    border-top: 1px solid;
    padding-bottom: 5px;
    overflow-y: auto;
    border-color: #d4d4d4;
}
.notes .note-badge {
    position: absolute; 
    /* position: initial; */
    bottom: 0;
    top: initial;
    left: initial;
    margin-left: auto;
    right: -1.5em;
    font-size: 15px;
    padding: 0px;
    padding-left: 2px;
    padding-right: 3px;
    background-color: #dae1e1;
    border-color: #dae1e1;
}
.timButton { /* madalletaan painiketta, poista tämä jos haluat normaalikokoiset painikkeet */
    padding-top: 1pt;
    padding-bottom: 1pt;
}   
.par:not(.chat) .authorinfo {
    display: none;
}
.par.chat .authorinfo {
    display: inline;
    top: 0;
}
.par.chat {
    top: 0;
    margin-top: 30px;
    border-top: lightgray;
    border-top-style: solid;
    border-top-width: 1px;
}
.par.chat .parContent, .par.chat .parContent p, .par.chat .parContent ul, .par.chat .parContent li {
    display: inline;
}
.par.chat .parContent li:before {
    content: "\2013  "; // 2 välilyöntiä lopussa
}
.list .parContent:before {
    content: "\2022";
    position: absolute;
    left: -1.3em;
}
.list {
    /* padding-left: 1em; */
    margin-left: 3em;
}

!!
```

# Keskusteludokumentti, vaihda tähän hyvä otsikko

#- 
Käyttäjälle: [klikkaa tästä ja ruksi jos haluat postia muutoksista](https://tim.jyu.fi/manage/%%docid%%).
Palaa sitten tänne antamaan mielipiteitä.  Jos pidät selainta auki, ja joku laittaa lisää
mielipiteitä, niin ne päivittyvät sinun selaimessasi. 

Voit lisätä uuden viestin painamalla
`Lisää viesti`.  Tai voit avata kokonaan uuden keskustelun aiheen vastaavasta
painikkesta.

Jos haluat kommentoida jotakin tiettyä viestiä, klikkaa ko viestiä, jolloin
saat siihen C-painikkeen, josta voit kommentoida kappaletta.

## Mistä keskustellaan

#- {.chat}
Täällä voi keskustella vapaasti ja lisätä uusia viestejä tai keskustelun aiheita

#- {forceclass="chat" .removePre}
\
[Lisää mielipide]{.timButton .addAbove}

    ⁞

#- { .removePre nomacros="true"}
[Lisää uusi keskustelun aihe]{.timButton  .addAbove}

    ## ⁞Otsikko keskusteluaiheelle, vaihda vain tämä, älä koske muuhun

    #- {forceclass="chat" .removePre}
    \
    [Lisää mielipide]{.timButton .addAbove}
    
        ⁞