...
...
Sisällysluettelo:
| Table of Contents |
|---|
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:
| No Format | |
|---|---|
| #ffffff | |
| bgColor | #ffffff | | Wiki Markup | {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ä
...
|.
...
...
...
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:
| No Format |
|---|
{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:
| No Format |
|---|
{children} |
Esimerkki:
| Children Display |
|---|
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:
| No Format |
|---|
----
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 Feed | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
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:
| No Format |
|---|
|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
...
...
(käy
...
muokkaamassa
...
tiedostoa,
...
niin
...
huomaat,
...
että
...
esimerkkisivulle
...
tehty
...
muutos
...
päivittyy
...
tähän
...
alapuolelle):
...
| Include Page | ||||
|---|---|---|---|---|
|
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:
| Excerpt Include | ||||||
|---|---|---|---|---|---|---|
|
...
Calendar - kalenteritoiminto
Mahdollistaa kalenterin liittämisen sivulle. Kalenteria voi käyttää paikallisena kalenterina, tai siihen voi liittää ulkoisia kalentereja esim. iCal -muodossa.
| No Format |
|---|
}
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:
...
...
Gallery - kuvagalleria
Mahdollistaa sivulle liitettyjen kuvatiedostojen esittämisen kuvagalleriana.
| No Format |
|---|
kalenterit|~a3454:Jussin kalenterit]
----
h3. Gallery - kuvagalleria
Mahdollistaa sivulle liitettyjen *kuvatiedostojen esittämisen kuvagalleriana*.
{noformat}{gallery:title=Gallerian otsikko|sort=date}{noformat}
|
Esimerkki:
...
...
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:
| No Format |
|---|
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:
...
| View File |
|---|
...
|
...
|
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:
| No Format |
|---|
=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":
| Content by Label | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
Create Page - linkki uuden sivun luomiseksi
Tällä makrolla voi tehdä oman linkin uuden sivun luomista varten mihin tahansa kohtaan sivulle.
Merkintätapa:
| No Format |
|---|
{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ä:
| Wiki Markup |
|---|
{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.
...
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:
| No Format |
|---|
----
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.
...
...
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:
| No Format |
|---|
*
{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 Connector |
|---|
...
|
...
|
...
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:
| No Format |
|---|
*
{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 Connector |
|---|
...
|
...
|
...
Tässä
...
on
...
linkitetty
...
...
...
käyttäjän
...
...
valokuva-albumissa:
| No Format |
|---|
}{widget:url=http://www.flickr.com/photos/callion/4227979490/}{noformat}
|
Ja
...
tulos
...
on
...
seuraava:
...
| Widget Connector |
|---|
...
|
...
|
...
...
Google Docs -presentaatio
Kun Widget-makron
...
url-osoitteeksi
...
laitetaan
...
...
Docs
...
-presentaation
...
osoite,
...
esimerkiksi
...
tämä
...
...
...
...
...
,
...
saadaan
...
se
...
upotettua
...
sivulle
...
näin:
| No Format |
|---|
{noformat}
{widget:url=http://docs.google.com/present/
view?id=0ASaXETheSuBpZGNrdmRoYjZfMjA1ZnF0NWt2aGM&hl=en_GB}
{noformat}
----
h4. Twitter
*Merkintätapa:*
{noformat} |
...
Merkintätapa:
| No Format |
|---|
{widget:url=http://twitter.com/sosiaalinen}{noformat}
|
Upottaa
...
sivulle
...
...
...
animoidun
...
Twitter-virran:
...
| Widget Connector |
|---|
...
|
...
|
...
...
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
| No Format |
|---|
----
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),
...
Labeleillä suodattaminen - labels
| No Format |
|---|
----
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:
| No Format |
|---|
}{blog-posts:labels=+metropolia,+opetus|spaces=@all}{noformat}
|
Hakisi
...
uutiset,
...
jotka
...
on
...
merkitty
...
molemmilla
...
labeleillä.
...
Käyttäjätunnuksilla suodattaminen - author
| No Format |
|---|
----
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.
...