...
...
Sisällysluettelo:
...
Mitä ovat makrot?
Makrot ovat Confluence-wikialustan erityisominaisuuksia, jotka mahdollistavat ohjelmallisten ja dynaamisten sisältöjen liittämisen osaksi wikisivua.
Miten toiminnallisuus liitetään wiki-sivulle?
- Aseta kohdistin sille kohdalle sivua, johon haluat sijoittaa toiminnallisuuden.
- Edit
- (Mikäli etsimäsi makro ei tullut näkyviin) Other macros
Mitkä ovat yleisimpiä makroja?
Table of Contents
Sisällysluettelo
Vihje: Sisällysluettelon hierakia perustuu sivun otsikkotasoihin (Heading 1, Heading 2 jne.)
Gallery
Kuvagalleria.
Tasklist
Tehtäväluettelo
Children Display
Luettelo alasivuista
Vihje: Sitä voi käyttää esimerkiksi kokouspöytäkirjojen arkistoinnissa: Lisätään pöytäkirja uudeksi alasivuksi, jolloin listaus tapahtuu pääsivulle automaattisesti makron avulla. Näin vähenee yksi linkitysoperaatio, kun linkkiä uuteen dokumenttiin ei tarvitse luoda manuaalisesti.
Team Calendars
Kalenteri.
Gliffy Diagram
Diagrammi.
Blog Posts
Blogikirjoitus
Vihje: Makrolla on mahdollista liittää wikisivulle wikissä julkaistuja uutisia blogimaisessa muodossa. Yleinen käyttökohden on liittää työtilassa julkaistut uutiset työtilan etusivulle, jolloin rakentuu blogi. Blog Posts -makro mahdollistaa kuitenkin myös monipuolisempia toimintoja, joilla uutisia voi hakea esimerkiksi eri työtiloista labeleiden ja käyttäjien perusteella suodatettuina.
Upota RSS-syöte sivulle
Vihje: Sitä voi käyttää ulkoisten verkkopalvelujen sisältöjen esittämiseen. Esimerkiksi eri uutispalvelut ja blogit tarjoavat usein sisältönsä myös RSS-muodossa.
Widget Connector
Upota Youtube-video, Flickr-kuva,
Google Drive -dokumentti, Twitter-virta tai muu dokumentti sivulle
Recently Updated
Luettelo tuoreutuksista.
Include Page
Sisällytä toinen sivu osaksi sivua
Vihje: Includea voi käyttää esimerkiksi usein toistuvien sivurakenteiden (navigaatio tai footer, eli sivun loppuosassa oleva toistuva tunniste kuten logo tai yhteystiedot) rakentamisen yhdelle sivulle, joka voidaan liittää muille sivuille. Näin yhdelle sivulle tehdyt muutokset päivittyvät automaattisesti kaikille sivuille, joille tuo sisältö on liitetty.
Include Excerpt
Sisällytä toisen sivun osa osaksi sivua
Vihje: Exerpt Include toimii yhdessä Excerpt -makron kanssa, jolloin sivulle voidaan määritellä tiivistelmä, joka Exerpt Includen avulla voidaan liittää toiselle sivulle siten, että laajempi sisältöosuus ei liity mukana.
Content by Label
Tee luettelo tietyllä tagilla eli avainsanalla merkityistä sivuista
Vihje: Täydennystä kaipaaville sivuille liitetään label korjatkaa. Tämän jälkeen voidaan automaattisesti listata kaikki korjausta kaipaavat sivut, jolloin ylläpitäjät löytävät ne helposti. Tämä on erittäin monipuolinen makro, jota voi säätää monilla parametreillä.
Add Page
Lisää uusi sivu
Vihje: Tämä voi joissain tilanteissa olla selvempi käytäntö kuin ylävalikon Add => Page käyttäminen.
Table Plus
Mahdollistaa tavallista taulukkoa toiminnallisemman taulukon, jossa voi olla esimerkiksi rivien automaattinen järjestäminen avaimen mukaan ja laskuominaisuuksia.
,
| Div |
|---|
|
|
| bgColor | #ffffff |
|---|
| Wiki Markup |
|---|
Sisällysluettelo:
{toc}\\
\\
h2. Ohjeita ja vinkkejä eri makrojen käyttöön
Makrot ovat Confluence-wikialustan erityisominaisuuksia, jotka mahdollistavat *ohjelmallisten ja dynaamisten sisältöjen liittämisen* osaksi wikisivua. Markojen lisääminen ja muokkaaminen on helpointa tehdä *Wiki Markup* \-editointitilassa, kun sivu on editoitavana.
Makrot liitetään haluttuun kohtaan wikisivua, ja ne muodostuvat seuraavasti:
{noformat}{makron_nimi:parametri=arvo|parametri2=arvo|parametri3=arvo}{noformat}
Makro on kokonaisuudessaan määritelty aaltosulkujen \{ ja \} sisään, ja eri parametrit on erotettu toisistaan pystyviivalla eli putkimerkillä \|.
[Confluencen käyttöoppaassa|http://confluence.atlassian.com/display/CONF210/Working+with+Macros] on kattavat ohjeet kaikkien makrojen käyttöön. Tässä oppaassa esitellään Metropoliassa hyödyllisiksi havaittuja makroja ja niiden perusominaisuuksia.
Yksi yksinkertaisimmista makroista on alla ensimmäisenä oleva Table of Contents.
----
h3. TOC - automaattinen sisällysluettelo
*Table of Contents* \-makro luo sivulle *automaattisesti sisällysluettelon* sivulla olevien otsikkojen mukaan, kun otsikoinnissa käytetään Wiki Markupin mukaista hierarkkista otsikkomerkintää (h2., h3., h4. jne.).
*Merkintätapa:*
{noformat}{toc}{noformat}
Esimerkkitoteutus näkyy oikeassa palstassa ylhäällä.
----
h3. Children - alasivujen listaus
*Children*\-makro *listaa automaattisesti kaikki sivun alasivut* linkkeinä varsinaisille sivuille.
Sitä voi käyttää esimerkiksi kokouspöytäkirjojen arkistoinnissa: Lisätään pöytäkirja uudeksi alasivuksi, jolloin listaus tapahtuu pääsivulle automaattisesti makron avulla. Näin vähenee yksi linkitysoperaatio, kun linkkiä uuteen dokumenttiin ei tarvitse luoda manuaalisesti.
*Merkintätapa:*
{noformat}{children}{noformat}
Esimerkki:
{children}
Kokeile lisätä tälle sivulle uusi alasivu: *Add => page*, niin näet kuinka uusi sivu ilmestyy yllä olevaan listaan automaattisesti.
----
h3. RSS - syötteenlukija
*RSS*\-makro mahdollistaa *ulkoisen RSS-syötteen liittämisen sivulle*.
Sitä voi käyttää ulkoisten verkkopalvelujen sisältöjen esittämiseen. Esimerkiksi eri uutispalvelut ja blogit tarjoavat usein sisältönsä myös RSS-muodossa.
*Esimerkki:*
{noformat}{rss:url=http://www.hs.fi/uutiset/rss/
|showTitlesOnly=true|max=5|titleBar=false}{noformat}
Tuo Helsingin Sanomien sivuilta 5 tuoreinta uutisotsikkoa näin:
{rss:url=http://www.hs.fi/uutiset/rss/|showTitlesOnly=true|max=5|titleBar=false}
----
h3. Include ja Excerpt Include
h4. Include - sivun esittäminen osana toista sivua
*Include* ja *Excerpt Include* ja mahdollistavat *wikisivun liittämisen osaksi toista sivua*.
Includea voi käyttää esimerkiksi usein toistuvien sivurakenteiden (navigaatio tai footer, eli sivun loppuosassa oleva toistuva tunniste kuten logo tai yhteystiedot) rakentamisen yhdelle sivulle, joka voidaan liittää muille sivuille. Näin yhdelle sivulle tehdyt muutokset päivittyvät automaattisesti kaikille sivuille, joille tuo sisältö on liitetty.
*Merkintätapa:*
{noformat}{include:Liitettävän sivun nimi}{noformat}
Tässä esimerkki, jossa sisältö on liitetty sivusta [Include-esimerkki|Include-esimerkki] (käy muokkaamassa tiedostoa, niin huomaat, että esimerkkisivulle tehty muutos päivittyy tähän alapuolelle):
{include: Include-esimerkki}
h4. Excerpt Include - sivun tiivistelmän esittäminen osana toista sivua
*Exerpt Include* toimii yhdessä Excerpt \-makron kanssa, jolloin sivulle voidaan määritellä tiivistelmä, joka Exerpt Includen avulla voidaan liittää toiselle sivulle siten, että laajempi sisältöosuus ei liity mukana.
Tähän on liitetty sivu [Exerpt Include -esimerkki], jossa alku on määritelty tiivistelmäksi. Vertaa [varsinaista tiedostoa|Exerpt Include -esimerkki] ja alla olevaa liitettyä osuutta:
{excerpt-include:Exerpt Include -esimerkki|nopanel=true}
----
h3. Calendar - kalenteritoiminto
Mahdollistaa *kalenterin liittämisen sivulle*. Kalenteria voi käyttää paikallisena kalenterina, tai siihen voi liittää ulkoisia kalentereja esim. iCal \-muodossa.
{noformat}{calendar:id=myCalendar|title=My Calendar|defaultView=month}{noformat}
Esimerkki: [Jussin kalenterit|~a3454:Jussin kalenterit]
----
h3. Gallery - kuvagalleria
Mahdollistaa sivulle liitettyjen *kuvatiedostojen esittämisen kuvagalleriana*.
{noformat}{gallery:title=Gallerian otsikko|sort=date}{noformat}
Esimerkki: [Jussin kuvia|~a3454:Kuvia]
----
h3. View File - liitetiedoston esittäminen osana sivua
*View File* \-makrolla sivulle voi upottaa liitetiedoston siten, että tiedostoa voi selailla osana sivua. Makro osaa näyttää *Office 97-2003* dokumentteja (Word, Excell ja PowerPoint) ja *PDF*\-tiedostoja.
*Merkintätapa:*
{noformat}{viewfile:Testipresentaatio.ppt}{noformat}
Tuo näkyviin tämän sivun liitteenä olevan Testipresentaatio.ppt \-PowerPoint-tiedoston:
{viewfile:Testipresentaatio.ppt|width=510px}
Näin käyttäjien ei tarvitse ladata esitystä omalle koneelleen nähdäkseen sen. Esityksen voi avata myös kokoruututilaan, jolloin sitä voi käyttää esimerkiksi luennolla wikin kautta.
----
h3. Content by Label - sivujen listaaminen labeleiden mukaan
Tällä makrolla voi *listata sivuja, jotka on merkitty eri labelein*.
Voitaisiin esimerkiksi sopia, että täydennystä kaipaaville sivuille liitetään label _korjatkaa_. Tämän jälkeen voidaan automaattisesti listata kaikki korjausta kaipaavat sivut, jolloin ylläpitäjät löytävät ne helposti. Tämä on erittäin monipuolinen makro, jota voi säätää monilla parametreillä.
*Merkintätapa:*
{noformat}{contentbylabel:label=korjatkaa
|showLabels=false|showSpace=false|space=@self}{noformat}
Alla olevaan listaan tulevat mukaan kaikki tämän työtilan (space=@self) sivut, joihin on merkitty label "korjatkaa":
{contentbylabel:label=korjatkaa|showLabels=false|showSpace=false|space=@self}
----
h3. Create Page - linkki uuden sivun luomiseksi
Tällä makrolla voi tehdä oman linkin uuden sivun luomista varten mihin tahansa kohtaan sivulle.
*Merkintätapa:*
{noformat}{create-page:prompt=Anna nimi uudelle sivulle
|target=edit}Luo uusi alasivu{create-page}{noformat}
Kokeile tästä:
{create-page:prompt=Anna nimi uudelle sivulle|target=edit}Luo uusi alasivu{create-page}
Tämä voi joissain tilanteissa olla selvempi käytäntö kuin ylävalikon *Add => Page* käyttäminen.
----
h3. Recently Updated - viimeksi päivitetyt sisällöt
Tämä makro auttaa *seuraamaan wikissä tapahtuneita muutoksia*. Yksinkertaisimmillaan se listaa työtilan 15 viimeisintä muutosta.
*Merkintätapa:*
{noformat}{recently-updated}{noformat}
Ja tulos on seuraava:
{recently-updated}
Tätä monipuolista makroa voi suodattaa eri työtilojen, labeleiden ja käyttäjien sekä sisältötyyppien mukaan. Siis varsin kiva lisä wikimertarin työkalupakkiin.
----
h3. Widget - ulkoisen sisällön upottaminen sivulle
Widget-makrolla voi wikisivulle liittää widgettejä eli vimpaimia, joiden avulla voi esittää ulkopuolissa palveluissa sijaitsevia sisältöjä.
----
h4. YouTube-videot
*Merkintätapa:*
{noformat}{widget:url=http://www.youtube.com/watch?v=crnLQB4Uf6w}{noformat}
Upottaa sivulle osoitteessa [http://www.youtube.com/watch?v=crnLQB4Uf6w] sijaitsevan YouTube-videon Arabianranta-rap:
{widget:url=http://www.youtube.com/watch?v=crnLQB4Uf6w}
YouTuben tai Vimeo-videopalvelun hyödyntäminen monipuolistaa videomateriaalin käyttöä, kun yhdessä paikassa olevaa videota voidaan liittää eri verkkosivuille useita eri tykaluja hyödyntäen.
----
h4. Flickr-kuvat
*Merkintätapa:*
{noformat}{widget:url=http://www.flickr.com/photos/tags/helsinki/}{noformat}
Upottaa sivulle selailtavan valokuvagallerian kuvapalvelu-Flickristä. Tässä esimerkissä esitetään kuvia, johin Flickrin käyttäjät ovat liittäneet tagin _helsinki_:
{widget:url=http://www.flickr.com/photos/tags/helsinki/}
Tässä on linkitetty [yksittäiseen kuvaan|http://www.flickr.com/photos/callion/4227979490/] käyttäjän [callion|http://www.flickr.com/photos/callion/] valokuva-albumissa:
{noformat}{widget:url=http://www.flickr.com/photos/callion/4227979490/}{noformat}
Ja tulos on seuraava:
{widget:url=http://www.flickr.com/photos/callion/4227979490/}
----
h4. Google Docs \-presentaatio
Kun Widget-makron url-osoitteeksi laitetaan Google Docs \-presentaation osoite, esimerkiksi tämä [wikin perusteitä käsittelevä \-presentaatio|http://docs.google.com/present/view?id=0ASaXETheSuBpZGNrdmRoYjZfMjA1ZnF0NWt2aGM&hl=en_GB], saadaan se upotettua sivulle näin:
{noformat}
{widget:url=http://docs.google.com/present/
view?id=0ASaXETheSuBpZGNrdmRoYjZfMjA1ZnF0NWt2aGM&hl=en_GB}
{noformat}
----
h4. Twitter
*Merkintätapa:*
{noformat}{widget:url=http://twitter.com/sosiaalinen}{noformat}
Upottaa sivulle [Twitter-käyttäjän _sosiaalinen_|http://twitter.com/sosiaalinen] animoidun Twitter-virran:
{widget:url=http://twitter.com/sosiaalinen}
----
h3. Blog Posts \-makron tehokäyttö
*Blog Posts* \-makrolla on mahdollista liittää wikisivulle wikissä julkaistuja uutisia blogimaisessa muodossa. Yleinen käyttökohden on liittää työtilassa julkaistut uutiset työtilan etusivulle, jolloin rakentuu blogi. Blog Posts \-makro mahdollistaa kuitenkin myös monipuolisempia toimintoja, joilla uutisia voi hakea esimerkiksi eri työtiloista labeleiden ja käyttäjien perusteella suodatettuina.
----
h4. Työlilojen valinta uutisvirtaan - spaces
{noformat}{blog-posts:spaces=katalyytti,@self}{noformat}
Hakisi uutiset katalyytti \-työtilasta sekä tästä kyseisestä työtilasta (spaces=katalyytti,@self),
----
h4. Labeleillä suodattaminen - labels
{noformat}{blog-posts:labels=metropolia,opetus|spaces=@all}{noformat}
Hakisi kaikista työtiloista (spaces=@all) uutiset, joissa on label metropolia, opetus tai molemmat, kun taas:
{noformat}{blog-posts:labels=+metropolia,+opetus|spaces=@all}{noformat}
Hakisi uutiset, jotka on merkitty *molemmilla* labeleillä.
----
h4. Käyttäjätunnuksilla suodattaminen - author
{noformat}{blog-posts:spaces=@all|author=a3454,kokkj|labels=metropolia}{noformat}
Hakisi kaikista työtiloista ne uutiset, jotka on kirjoittanut käyttäjä *a3454* tai *kokkj* ja joissa on label metropolia.
|