Erilliset sivut selittävät esimerkkikoodin yleistä syntaksia.
Näiden typograafisten ohjeiden noudattaminen takaa, että dokumentaatiosi voi olla tarkka ja helposti vietävä kotoistamistarkoituksiin.
Käytä lihavoitua tekstiä korostamiseen
Esimerkiksi:
Käytä kursivoitua tekstiä painottamiseen
Joitakin esimerkkejä:
Tip |
---|
Käyttäjä käynnistää Ohjelmat, ohjelmat käynnistävät 'komponentit |
Käytä tätä yhdistelmää korvattavaa tai muuttuvaa tekstiä varten.
Joitakin esimerkkejä:
ssh
username@domain.name pääteikkunassa Konsole.rpm -q
packagename aiheuttaa kohteessa package-version-release.Koodi pitäisi esittää tasavälisenä tekstinä, tavallisesti laatikoituna, kuten näytetään alla. Syötetekstillä on pelkkä keltainen tausta. Tulostetekstille taustaväri on violetinharmaa.
{{Input|3=Syöte|<nowiki> qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit rm -r ~/.kde/share/apps/nepomuk rm -r ~/.kde4/share/apps/nepomuk nepomukserver</nowiki>}}Tämä näyttää tämän kaltaiselta:
qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit rm -r ~/.kde/share/apps/nepomuk rm -r ~/.kde4/share/apps/nepomuk nepomukserver
{{Output|3=Tuloste|<nowiki>päätetuloste näytetään myös koodina, mutta harmaalla taustalla</nowiki>}}mikä näyttää seuraavana
päätetuloste näytetään myös koodina, mutta harmaalla taustalla
Note |
---|
Huomaa 3=Kotoistettu teksti|<nowiki>-käyttö joissakin teksteissä </nowiki> sellaisten tilanteiden välttämiseksi, jotka rikkovat näyttömuodon |
{{Input|<syntaxhighlight lang="php" rivi> # Alusta yhteinen koodi $preIP = dirname( __FILE__ ); require_once( "$preIP/includes/WebStart.php" ); </syntaxhighlight>}}
# Alusta yhteinen koodi $preIP = dirname( __FILE__ ); require_once( "$preIP/includes/WebStart.php" );
<code></code>Se
näyttää
tämän näköisen koodin.<tt> </tt>on hyödyllinen näytettäessä tiedostonimiä ja polkuja. Se näyttää tältä: a/path/to/here
Tageja <blockquote> ja </blockquote> pitäisi käyttää, kun lainataan muiden töitä tai muita sivuja. Tämä tuottaa tasasuhteisen kursiivifontin, joka sisältää täytemerkkejä.
Tässä on näyttöesimerkki, jonka saat käyttämällä lohkolainaustageja.
Vaikka yllä olevat kriteerit saattoivat täyttyä, älä käytä vahvistettua tekstiä kappaleotsakkeissa tai linkeissä.
Vahvennettua tekstiä pitäisi välttää näiden mallinteiden sisäisessä tekstissä. Painottamiseen voidaan yhä käyttää kursiivia tekstiä - käytä sitä säästeliäästi vaikutuksen maksimoimiseksi.
Voit käyttää erilaisia luetteloja sivuillasi — etumerkillisiä, numeroituja tai alkioituja. Lisätietoja löytyy Työkalupakki-sivulta.
Tekstin kirjoittamisen jälkeen jotain markup-merkkejä lisätään automaattisesti kotoistamisjärjestelmään. Tämä tarkoittaa, että milloin näet tyhjän rivin, se aloittaa uuden yksikön. Kun teksti esitellään kotoistajille, he näkevät sen tyypillisesti yksi yksikkö kerrallaan, joten on tärkeää olla jättämättä tyhjiä rivejä keskelle sellaista tekstiä, jota tulisi käsitellä yhtenä yksikkönä. Normaalisti koko kappale pitäisi pitää yhdessä yksikössä; ja missään oloissa lausetta ei pitäisi jakaa kahteen yksikköön!
Jos tarvitset rivinvaihdon kesken kappaletta, suositeltavampi tapa saavuttaa se rikkomatta kappaletta on käyttää <br /> sen rivin lopussa, jossa haluat rivinvaihdon tapahtuvan (ei uuden rivin alussa). Jos tarvitse tilaa rivien väliin, lisää <br /><br />.
Kotoistamisjärjestelmä merkitsee jokaisen kotoistetun yksikön kotoistamattomaksi, jos se sisältää minkään tyyppisiä parittomia sulkumerkkejä. Jos tarvitset parittomia sulkumerkkejä tekstissäsi, lisää parillinen sulkumerkki kommenttitagiin, kuten tämä, like this:
<!-- }} -->{{ Rivi Tonen rivi}}<!-- {{ -->
Tämä koskee kaiken tyyppisiä sulkeita, jopa tavallisia kaarisulkeita. (Tietysti on tavallisesti parempi välttää tyhjiä rivejä markup-yksikön sisällä - katso Asioiden pitäminen yhdessä.)
{{Input|1=cmd1 {{!}} cnd2}}
which displays cmd1 | cnd2
{{Input|1=cmd1 | cnd2}}
you get instead cnd2
the problem being, that cmd2
is seen as a second parameter to the template, which in this case is not used.
{{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}
, which also displays cmd1 | cmd2
Everything that is translatable is contained within <translate> and </translate> tags. In most cases any images should be contained within the translatable section, as it is sometimes necessary to use localised versions of the images to explain a point. The rule of thumb is "If in doubt, include it!".