Wikimarkup-opas
Käytä Wikimarkupia - unohda Rich Text Editor!
Sisällys
1. Wikimarkup-notaatiosta
2. Perusnotaatio
3. Erikoismerkit
4. Linkit
5. Muotoilu
1. Wikimarkup-notaatiosta
Tämä on suomenkielinen pikaohje Hy:n wikissä käytettyyn wikimarkup-notaatioon. Ohje perustuu Mirka Muukkosen (ja kumpp.) Tietosin sisäiseen käyttöön tekemään ohjeeseen, kiitokset kaikille laatimiseen osallistuneille!
| Seikkaperäisempi wikimarkup-ohje englanniksi Kätevä englanninkielinen pikaohje wikimarkupiin näkyy aina wikimarkup-editointitilan oikeassa reunassa. Sieltä löytyy myös linkki kattavaan englanninkieliseen wikimarkup-ohjeeseen "full notation guide" - kannattaa tallentaa omiin kirjanmerkkeihin! |
2. Perusnotaatio
2.1 Korostukset
| Notaatio | Lopputulos |
|---|---|
| *lihavointi* | lihavointi |
| _kursiivi_ | kursiivi |
| -yliviivattu- | |
| +alleviivattu+ | alleviivattu |
| näin saa ^yläindeksin^ | näin saa yläindeksin |
| näin saa ~alaindeksin~ | näin saa alaindeksin |
| {{ konekirjoitustekstiä }} | konekirjoitustekstiä |
| {color:red}värillistä{color} | värillistä |
2.2 Otsikot
Otsikoita on kuuden tasoisia.
3. Erikoismerkit
Wikissä on joitain erikoismerkkejä, kuten vaikkapa {. Jos niitä haluaa kirjoittaa normaalisti tekstin sekaan, täytyy niiden eteen laittaa kenoviiva \, jotta erikoismerkitys mitätöityy (Englanniksi escaping a special character).
| Vrt. myös noformat ja code Kun käyttää tageja {noformat} tai {code}, erikoismerkkien eteen ei tarvitse kirjoittaa kenoviivaa, vaan ne tulkitaan tekstinä. (esimerkkejä käytöstä kohdassa Muotoilu) |
Tähän kerätään listaa erikoismerkeistä.
| Merkki | Käyttö |
|---|---|
| \ | Kenoviivaa käytetään mitätöimään erikoismerkkien merkitys. Kenoviivan voi kirjoittaa tekstiin ihan normaalisti, sitä ei tarvitse mitätöidä. |
| \ \ | Rivinvaihto. Koostuu kahdesta peräkkäisestä kenoviivasta. Niissä ei siis kuulu olla välilyöntiä välissä kuten esimerkissä. En kuitenkaan löytänyt tapaa kirjoittaa kahta peräkkäistä kenoviivaa näkyviin. (Paitsi käyttämällä noformat-tagia, jolloin tekstin ympärille ilmestyy laatikko.) |
| { } | Käytetään ympäröimään erilaisia macroja. (Niistä lisää kohdassa Muotoilu.) |
| {{ }} | Kaksinkertaisissa kaarisulkeissa olevasta tekstistä tulee monospace-muotoiltua. |
| [ ] | Hakasulkeita käytetään linkkien teossa. |
4. Linkit
4.1 Wikissä linkittäminen
Wikissä voi tehdä linkkejä kahdella tavalla. Tässä on neuvottu miten linkit kirjoitetaan käsin, alempana käytännön esimerkkejä.
Linkkien yleinen rakenne:
- Hakasulkeet [] ympärillä.
- Pystyviivan | käyttö on vapaaehtoista. Jos pystyviivoja on yksi, pystyviivan vasemmalla puolella on linkkialias eli teksti, jonka käyttäjä näkee linkkinä. Pystyviivan oikealla puolella on se osoite, josta haluttu sivu tai sivun kohta löytyy.
- Jos selattava sivu ja linkin kohdesivu sijaitsevat saman wikialueen sisällä, osoitteeksi riittää sivun nimi. Wikialueen nimen voi myös kirjoittaa linkkiin varmuuden vuoksi tai jos liikutaan eri wikialueiden välillä.
- Osoiteosassa wikialue ja wikisivu erotetaan toisistaan kaksoispisteellä.
- Osoiteosassa voidaan kertoa ankkuri, johon halutaan linkittää. Ankkuri lisätään wikisivun perään osoiteosaan risuaidalla erotettuna. Ankkurin käyttö edellyttää tietysti, että ankkuri on luotu.
- Ankkuri luodaan notaatiolla {anchor:ankkurisana} ja sijoitetaan haluttuun kohtaan dokumenttia.
- Jos osoite on wikin ulkopuolinen www-sivu, osoiteosaan tulee sivun url.
| Näin se kirjoitetaan | Tältä se näyttää | Tätä se tekee |
|---|---|---|
| [Wikimarkup] | Wikimarkup | Linkki samalla wikialueella sijaitsevaan sivuun. Sivun nimi toimii linkkitekstinä. |
| [support:Wikimarkup] | Wikimarkup | Linkki, jonka rakenne on [Wikialue:Wikisivun nimi]. Ajaa saman asian kuin edellinen, tässä vain määritellään sivun sijainti tarkemmin. |
| [tämä sivu|support:Wikimarkup] | tämä sivu | Linkki, jonka rakenne on [linkin teksti|Wikialue:Wikisivun nimi]. Tällä tavoin voi siis tehdä linkkialiaksia. |
| [tämä juttu|#ankkurisana] ... {anchor:ankkurisana} |
tämä juttu ... |
Rakenteella [linkin nimi|#ankkurisana] luodaan linkki, joka osoittaa samalla sivulla siihen kohtaan, johon on kirjoitettu {anchor:ankkurisana}. HUOM Ankkurisanassa ei voi olla ääkkösiä yms. erikoismerkkejä! |
| [tämä juttu|support:Wikimarkup#ankkurisana] ... {anchor:ankkurisana} |
tämä juttu ... |
Jonkin toisen sivun ankkuriin voi myös linkittää lisäämällä edellisen kohdan rakenteeseen ankkuria ennen sivun nimi tyyliin [linkin nimi|wikisivun nimi#ankkurisana] |
| [http://www.google.fi] | http://www.google.fi | Linkki Wikin ulkopuolelle. |
| http://www.google.fi | http://www.google.fi | Linkki Wikin ulkopuolelle. Hakasulkeita ei siis tarvita ulkopuolelle osoittavissa linkeissä, jollei linkkitekstiä haluta määritellä erikseen, kuten alla. |
| [kuukkeli|http://www.google.fi] | kuukkeli | Linkkialiaksella varustettu linkki Wikin ulkopuolelle. |
4.2 Wikiin linkittäminen
Wikiin voi linkittää ihan normaalisti, kuten muihinkin osoitteisiin. Esimerkiksi tämän sivun osoite on https://wiki.helsinki.fi/display/support/Wikimarkup. Jos linkin haluaa osoittamaan johonkin sivulla olevaan ankkuriin, se onnistuu lisäämällä osoitteen loppuun #wikisivu-ankkuri eli vaikkapa https://wiki.helsinki.fi/display/support/Wikimarkup#Wikiopas-linkit.
| Tiny Link toimii varmemmin! Selaimen osoite-riviltä kopioitujen linkkien ohella kannattaa muistaa myös kätevät Tiny Linkit (löytyvät Info-välilehdeltä). Ovat kieltämättä vähän kryptisiä mutta toisaalta "ikuisia", eli linkki ei mene rikki vaikka sivun nimi (tai alue) vaihtuisi! Erityisen käteviä sähköposteissa tai muissa web-sivustoissa. |
5. Muotoilu
Tämä vielä kesken...
Jos kirjoittaa
{noformat}
Tähän voi kirjoittaa erikoismerkkejä, kuten {, [ ja |
{noformat},
se näyttää tältä:
Tähän voi kirjoittaa erikoismerkkejä, kuten {, [ ja |
Jos kirjoittaa
{code}
Tähän voi kirjoittaa erikoismerkkejä, kuten {, [ ja |
{code},
se näyttää tältä: