Makroja
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:
{makron_nimi:parametri=arvo|parametri2=arvo|parametri3=arvo}
Makro on kokonaisuudessaan määritelty aaltosulkujen { ja } sisään, ja eri parametrit on erotettu toisistaan pystyviivalla eli putkimerkillä |.
Confluencen käyttöoppaassa 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.
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:
{toc}
Esimerkkitoteutus näkyy oikeassa palstassa ylhäällä.
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:
{children}
Esimerkki:
Kokeile lisätä tälle sivulle uusi alasivu: Add => page, niin näet kuinka uusi sivu ilmestyy yllä olevaan listaan automaattisesti.
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:
{rss:url=http://www.hs.fi/uutiset/rss/|showTitlesOnly=true|max=5|titleBar=false}
Tuo Helsingin Sanomien sivuilta 5 tuoreinta uutisotsikkoa näin:
Could not access the content at the URL because it is not from an allowed source.
http://www.hs.fi/uutiset/rss/
You may contact your site administrator and request that this URL be added to the list of allowed sources.
Include ja Excerpt Include
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:
{include:Liitettävän sivun nimi}
Tässä esimerkki, jossa sisältö on liitetty sivusta Include-esimerkki (käy muokkaamassa tiedostoa, niin huomaat, että esimerkkisivulle tehty muutos päivittyy tähän alapuolelle):
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 ja alla olevaa liitettyä osuutta:
Tämä on sivun tiivistelmä. Tämä on ainoa näkyviin tuleva osuus, kun sivu liitetään osaksi toista sivua Excerpt Include -makron avulla.Calendar - kalenteritoiminto
Mahdollistaa kalenterin liittämisen sivulle. Kalenteria voi käyttää paikallisena kalenterina, tai siihen voi liittää ulkoisia kalentereja esim. iCal -muodossa.
{calendar:id=myCalendar|title=My Calendar|defaultView=month}
Esimerkki: Jussin kalenterit
Gallery - kuvagalleria
Mahdollistaa sivulle liitettyjen kuvatiedostojen esittämisen kuvagalleriana.
{gallery:title=Gallerian otsikko|sort=date}
Esimerkki: Jussin kuvia
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:
{viewfile:Testipresentaatio.ppt}
Tuo näkyviin tämän sivun liitteenä olevan Testipresentaatio.ppt -PowerPoint-tiedoston:
Error rendering macro 'viewfile'
com.atlassian.confluence.macro.MacroExecutionException: com.atlassian.confluence.macro.MacroExecutionException: The viewfile macro is unable to locate the attachment "Testipresentaatio.ppt" on this page
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.
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:
{contentbylabel:label=korjatkaa|showLabels=false|showSpace=false|space=@self}
Alla olevaan listaan tulevat mukaan kaikki tämän työtilan (space=@self) sivut, joihin on merkitty label "korjatkaa":
-
Page:
-
Page:
Create Page - linkki uuden sivun luomiseksi
Tällä makrolla voi tehdä oman linkin uuden sivun luomista varten mihin tahansa kohtaan sivulle.
Merkintätapa:
{create-page:prompt=Anna nimi uudelle sivulle|target=edit}Luo uusi alasivu{create-page}
Kokeile tästä:
Luo uusi alasivu
Tämä voi joissain tilanteissa olla selvempi käytäntö kuin ylävalikon Add => Page käyttäminen.
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:
{recently-updated}
Ja tulos on seuraava:
Recently Updated
-
-
-
image-2024-9-27_14-3-9.png27.9.2024 • attached by Riku Väkeväinen
-
image-2024-9-27_13-56-29.png27.9.2024 • attached by Riku Väkeväinen
-
image-2024-9-27_13-51-22.png27.9.2024 • attached by Riku Väkeväinen
-
image-2024-9-27_13-47-47.png27.9.2024 • attached by Riku Väkeväinen
-
image-2024-9-27_13-36-15.png27.9.2024 • attached by Riku Väkeväinen
-
image-2024-9-27_13-26-52.png27.9.2024 • attached by Riku Väkeväinen
-
image-2024-9-27_13-23-8.png27.9.2024 • attached by Riku Väkeväinen
-
image-2024-9-27_13-14-11.png27.9.2024 • attached by Riku Väkeväinen
-
image-2024-9-27_13-12-57.png27.9.2024 • attached by Riku Väkeväinen
-
image-2024-9-27_13-9-10.png27.9.2024 • attached by Riku Väkeväinen
-
SiemensNX_Asennusohje.pdf27.9.2024 • attached by Sami Pussinen
-
image-2024-9-27_11-9-32.png27.9.2024 • attached by Riku Väkeväinen
-
image-2024-9-27_11-6-10.png27.9.2024 • attached by Riku Väkeväinen
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.
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ä.
YouTube-videot
Merkintätapa:
{widget:url=http://www.youtube.com/watch?v=crnLQB4Uf6w}
Upottaa sivulle osoitteessa http://www.youtube.com/watch?v=crnLQB4Uf6w sijaitsevan YouTube-videon Arabianranta-rap:
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.
Flickr-kuvat
Merkintätapa:
{widget:url=http://www.flickr.com/photos/tags/helsinki/}
Upottaa sivulle selailtavan valokuvagallerian kuvapalvelu-Flickristä. Tässä esimerkissä esitetään kuvia, johin Flickrin käyttäjät ovat liittäneet tagin helsinki:
Tässä on linkitetty yksittäiseen kuvaan käyttäjän callion valokuva-albumissa:
{widget:url=http://www.flickr.com/photos/callion/4227979490/}
Ja tulos on seuraava:
Google Docs -presentaatio
Kun Widget-makron url-osoitteeksi laitetaan Google Docs -presentaation osoite, esimerkiksi tämä wikin perusteitä käsittelevä -presentaatio, saadaan se upotettua sivulle näin:
Merkintätapa:
{widget:url=http://twitter.com/sosiaalinen}
Upottaa sivulle Twitter-käyttäjän sosiaalinen animoidun Twitter-virran:
Error rendering macro 'widget'
com.atlassian.confluence.api.service.exceptions.IllegalURLException: The provided url is not included in the whitelist!
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.
Työlilojen valinta uutisvirtaan - spaces
{blog-posts:spaces=katalyytti,@self}
Hakisi uutiset katalyytti -työtilasta sekä tästä kyseisestä työtilasta (spaces=katalyytti,@self),
Labeleillä suodattaminen - labels
{blog-posts:labels=metropolia,opetus|spaces=@all}
Hakisi kaikista työtiloista (spaces=@all) uutiset, joissa on label metropolia, opetus tai molemmat, kun taas:
{blog-posts:labels=+metropolia,+opetus|spaces=@all}
Hakisi uutiset, jotka on merkitty molemmilla labeleillä.
Käyttäjätunnuksilla suodattaminen - author
{blog-posts:spaces=@all|author=a3454,kokkj|labels=metropolia}
Hakisi kaikista työtiloista ne uutiset, jotka on kirjoittanut käyttäjä a3454 tai kokkj ja joissa on label metropolia.
Sisällysluettelo:
- Created by Jussi Linkola, last modified on 22.1.2010
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 59 Next »
- No labels