eKansion dokumentaatio kirjoitetaan käyttämällä Markdown -merkkaustapaa. Tämän lisäksi doc.ekansio.fi sivustolle on tehty oma tag -merkkauskieli, jolla voidaan viitata resursseihin tai tehdä määrämuotoisia muotoiluja.

Julkaisutiedot

Projektivaihe

Mihin projektin läpivientivaiheeseen amteriaali kuuluu

(Tuotekehitys: tarvitaako?)

Määrittely

Rakenne

Näkymät

Toiminnot

Käyttö

Julkaisu

Kenelle materiaali on näkyvissä

Root

PHP

Admin

User

Public

Tila

Materiaalin tila

Tekemättä: Puuttuu kokonaan.

Kesken: Tehty osittain.

Valmis: Tarkistettu ja valmis.

Tarkastettu

Koska materiaali on viimeksi tarkastettu.

Julkaisupäivä

Luotu

Muokattu

versionumero

Versiohistoria

Päivä

Versio

Kuvaus

Linkit

Linkki doc.ekansio.fi sivulle

Linkki alkaa '/'. Kaikki linkit case insensitive. (Tyhjä merkki vain esimerkissä, ei tule oikeasti).

[Viikkokalenteri]( /Extension/ViewType/Viikkokalenteri)

Viikokalenteri

Linkki eKansio -järjestelmään

Linkki alkaa 'admin/'. Ohjaa siihen järjestelmään josta käyttäjä on tullut. (Tyhjä merkki vain esimerkissä, ei tule oikeasti).

[Asetukset]( admin/kayttaja/asetukset)

Asetukset

Kuvat

Kuvake

admin/images/kuvake/ -kansiossa olevan kuvan näyttäminen.

name

Kuvan nimi, ilman tiedostopäätettä.

Jos annetaan vain 1 atribuutti, se tulkitaan name -attribuutiksi.

[ icon name=addnew] Lisää uusi
[ icon info] Lisätiedot
[ icon src=/images/filetype] vaihtoehtoisesta polusta lukeminen

Lisää uusi

Lisätiedot

Dokumentaation kuva

Dokumentaatio/Kuva -kansiossa olevan kuvan näyttäminen ja linkki alkuperäiseen kuvaan.

name

Tyyppi / Nimi

size

Kuvan maksimi sivun pituus.

Oletus: 320 ja sisältöteksti, muuten 180.

width

Kuvan leveys

height

Kuvan korkeus

Kuvan näyttäminen

[ image name=View/Folder]

[image name=View/Folder]

Kuvan ja tekstin näyttäminen

[ sideimage name=View/Folder]
  Tämä teksti näytetään kuvan rinnalla.
[/sideimage]

[sideimage name=View/Folder] Tämä teksti näytetään kuvan rinnalla. [/sideimage]

Muut

Painike

Painikkeen näköisen tekstin näyttäminen.

[ button name=Painiketeksti]

Painiketeksti

Huomio

Lisähuomio tai käyttäohje. Esim. 'katso myös' tai Ensimmäinen rivi luetaan otsikoksi.

[ note]
Otsikkoteksti
Ohjeen sisältöteksti.
[ /note]

Varoitus

Erityishuomion ilmoittaminen. Esim. vanhentunut toiminto tai erikoishuomio käyttämisestä. Ensimmäinen rivi luetaan otsikoksi.

[ warning]
Otsikkoteksti
Varoituksen lisäselite.
[ /warning]

Rajoitettu oikeus

Ohjeisiin voidaan määritellä osio, joka näkyy vain jos käyttäjällä on tietty oikeus.

[ isuser] Tämä näkyy vain jos tultu järjestelmästä. [/isuser]
[ isadmin] Tämä näkyy vain jos tultu järjestelmän päätunnuksella. [/isadmin]
[ sphp] Tämä näkyy vain jos PHP -oikeudet omaavalla tunnuksella. [/isphp]
[ isroot] Tämä näkyy vain jos tultu järjestelmän päätunnuksella. [/isroot]