Þessi handbók styðst við nokkrar venjur við framsetningu á ákveðnum gerðum texta til að gefa áherslur og að draga athyglina að sérstökum gerðum upplýsinga.
1.1. Venjur við framsetningu
Fjórar gerðir framsetningar eru notaðar til að draga athyglina að ákveðnum gerðum texta. Þessar gerðir, og aðstæðurnar sem þær eru notaðar við, er lýst hér á eftir.
Jafnbreitt feitletrað
Er notað til að afmarka inntak í kerfið, þar með taldar skeljarskipanir, skráaheiti og slóðir. Einnig notað til að afmarka lyklaborðsmerkingar og flýtilyklasamsetningar. Til dæmis:
Til að skoða innihald skrárinnar næsti_bestsellerinn_minn.txt sem er í möppunni þar sem þú ert staddur, skrifaðu þá cat næsti_bestsellerinn_minn.txt skipunina á skipanalínu og ýttu síðan á Enter til að framkvæma skipunina.
Þetta var dæmi um skráarheiti, skeljarskipun og lyklaborðsmerkingu, allt sett fram með jafnbreiðu feitletri og þannig auðþekkjanlegt í þessu samhengi.
Flýtilyklasamsetningar er hægt að þekkja frá lyklaborðsmerkingum á bandstrikinu sem tengir saman alla hluta samsetningarinnar. Til dæmis:
Ýttu á Enter til að framkvæma skipunina.
Ýttu á Ctrl+Alt+F1 til að skipta yfir á fyrsta sýndarskjáinn. Ýttu á Ctrl+Alt+F7 til að snúa til baka í X-Windows setuna þar sem þú varst.
Í fyrri setningunni er afmarkaður einn lykill sem á að ýta á. Í seinni setningunni eru afmarkaðar tvær samsetningar, hvor með þremur lyklum sem á að halda niðri samtímis.
Ef um er að ræða grunnkóða (source code) þá eru skilgreiningar á borð við 'class, method, function' auk heita á breytum og reiknuðum gildum sem koma fram í texta sett fram eins og hér að ofan, með jafnbreiðu feitletri. Til dæmis:
Með skráatengdum klössum (classes) má telja filesystem fyrir skráakerfi, file fyrir skrár, og dir fyrir möppur. Hver klassi á sér sitt tilgreinda sett af heimildum.
Hlutfallsbreitt feitletrað
Þetta er notað til að auðkenna orð og texta sem rekast má á í kerfinu, þar má nefna heiti forrita; texta í samskiptagluggum; merkta hnappa; merkingar á stillihnöppum og hakreitum auk heita á valmyndum. Til dæmis:
Veldu úr aðalvalmyndinni til að ræsa Stillingar músar. Á flipanum sem er merktur Hnappar er hægt að haka við Vinstri handar mús og smella síðan á Loka til að víxla aðalmúsartakkanum frá vinstri til hægri (sem gerir músina þægilegri fyrir örvhenta).
Til að setja sérstakt stafatákn inn í skrá sem opin er í gedit, veldu þá úr aðalvalmyndinni. Veldu þvínæst úr valmynd Stafaval forritsins, settu inn heiti táknsins í Finna reitinn og smelltu á Næsta hnappinn. Táknið sem þú leitaðir að verður þá upplýst á flipanum Stafatafla. Tvísmelltu á þetta tákn til að færa það yfir í Afrita texta: reitinn, smelltu síðan á Afrita hnappinn. Nú getur þú snúið aftur í skrána þína og valið af valmynd gedit forritsins.
Textinn hér að ofan er með nöfnum forrita; heitum á kerfisvalmyndum og kerfishlutum; heitum valmynda sem notuð eru í sérstökum forritum; auk hnappa og texta sem sýnd eru í grafísku notendaviðmóti (GUI) - allt er þetta sett fram í hlutfallsbreiðu feitletruðu letri og þannig auðþekkjanlegt í þessu samhengi.
Takið eftir að styttingin er notuð til að gefa til kynna ferð frá einu atriði í valmynd yfir í annað, þá gjarnan undirvalmynd. Þetta er gert til að lenda ekki í torlæsilegri 'Veldu úr undirvalmyndinni í valmyndinni í aðalvalmyndastikunni' runu.
Jafnbreitt feitt skáleturhlutfallsbreitt feitt skáletur
Hvort sem um er að ræða jafnbreitt eða hlutfallsbreitt feitletur, það að skásetja textann þýðir að hann er útskiftanlegur eða breytilegur. Skáletrun merkir þannig texta sem þú setur ekki inn bókstaflega sem slíkan, eða texta sem breytist eftir því í hvaða samhengi hann stendur. Til dæmis:
Til að tengjast fjarlægri tölvu með ssh, sláðu inn ssh notandanafn@heiti.léns á skipanalínu. Ef fjarlæga vélin heitir tildaemis.is og notandanafn þitt á þeirri vél er nonni, sláðu þá inn ssh nonni@tildaemis.is.
Skipunin mount -o remount skráakerfi endurtengir tilgreint skráakerfi. Sem dæmi, til að endurtengja /home skráakerfið, þá er skipunin mount -o remount /home.
Til að sjá hvaða útgáfu þú ert með af uppsettum pakka, notaðu skipunina rpm -q forritspakki. Þetta mun birta niðurstöðu á eftirfarandi sniði: forritspakki-útgáfa-uppfærsla
Taktu eftir feit- og skáletruðu orðunum hér að ofan — notandanafn, heiti.léns, skráakerfi, forritspakki, útgáfu- og uppfærslunúmer. Hvert þeirra er staðgengill fyrir önnur raunveruleg orð sem ýmist eru sett inn af notanda þegar skipanir eru gefnar, eða eru sýnd sem niðurstaða af útreikningum eða vinnu kerfisins.
Fyrir utan að standa fyrir heiti á verkefni þá er skáletrun notuð til að undirstrika mikilvægi nýrra og mikilvægra skilgreininga. Til dæmis:
When the Apache HTTP Server accepts requests, it dispatches child processes or threads to handle them. This group of child processes or threads is known as a server-pool. Under Apache HTTP Server 2.0, the responsibility for creating and maintaining these server-pools has been abstracted to a group of modules called Multi-Processing Modules (MPMs). Unlike other modules, only one module from the MPM group can be loaded by the Apache HTTP Server.
1.2. Framsetning tilvitnana
Tvær gerðir tilvitnana í gögn, oft margar línur, eru skildar frá textanum í kring.
Úttak sem birtist í skjáhermi er sett í jafnbreiðu rómönsku letri og er sýnt eins og hér
bækur Desktop drasl myndir skriftur uppkast tilraunir
bækur_prufa Desktop1 mss niðurhal svn vinnugogn is.svg
Útlistun á grunnkóða er einnig haft í jafnbreiðu rómönsku letri en er sett fram og litað eins og sést hér:
package org.jboss.book.jca.ex1;
import javax.naming.InitialContext;
public class ExClient
{
public static void main(String args[])
throws Exception
{
InitialContext iniCtx = new InitialContext();
Object ref = iniCtx.lookup("EchoBean");
EchoHome home = (EchoHome) ref;
Echo echo = home.create();
System.out.println("Bjó til bergmál");
System.out.println("Echo.echo('Deijó') = " + echo.echo("Deijó"));
}
}
1.3. Athugasemdir og viðvaranir
Að lokum eru hér sýndar þrjár mismunandi gerðir sjónrænna merkinga sem við notum til að draga athyglina að upplýsingum sem annars gætu farið framhjá fólki.
Athugsemd
Athugasemd er ýmist gott ráð, fljótleg leið eða önnur aðferð til að framkvæma tilgreint verk. Að hunsa athugasemd ætti ekki að hafa neinar neikvæðar afleiðingar aðrar en þær að þú gætir misst af tækifæri til að gera þér lífið örlítið auðveldara.
Mikilvægt
Mikilvægir reitir lýsa hlutum sem auðvelt er að missa af: til dæmis breytingum á stillingum sem varða engöngu þáverandi setu, eða þjónustur sem þyrfti að endurræsa áður en breytingar eða uppfærsla verður virk. Að hunsa mikilvæga reiti veldur ekki gagnatapi en getur leitt af sér ýmis önnur óþægindi.
Aðvörun
Aðvörun ætti að taka alvarlega. Ef aðvörun er hunsuð með öllu aukast líkur á gagnatapi verulega.