Denne manual bruger flere konventioner til at belyse visse ord og sætninger og gør opmærksom på specifikke stykker af information.
1.1. Typografikonventioner
Der bruges fire typografikonventioner til at gøre opmærksom på specifikke ord og sætninger. Disse konventioner, og de omstændigheder de passer til, er som følger.
Fastbredde fed
Bruges til at belyse systeminddata, som f.eks skalkommandoer, filnavne og stier. Bruges også til at belyse versaler og tastekombinationer. For eksempel:
For at se indholdet af filen min_næste_bedstsælgende_roman i dit nuværende arbejdskatalog, indtast cat min_næstebedstsælgende_roman kommandoen i en skal og tryk Enter til at køre kommandoen.
Det ovenstående inkluderer et filnavn, en skalkommando og en versal, alle præsenteret i Fastbredde fed og alle kan skelnes, takket være konteksten.
Tastekombinationer kan skelnes fra versaler ved bindestregen der forbinder hver del af tastekombinationen. For eksempel:
Tryk Enter til at køre kommandoen.
Tryk Ctrl+Alt+F1 for at skifte til den første virtuelle terminal. Tryk Ctrl+Alt+F7 for at vende tilbage til din X-Vinduesession.
Den første sætning belyser den særlige versal at trykke på. Den anden belyser to sæt af tre versaler, hvert sæt trykkes samtidig.
Hvis kildekode er diskuteret, vil klassenavne, metoder, funktioner, variabelnavne og returnerede værdier er nævnt indeni en paragraf, vil den blive præsenteret som ovenfor, i Fastbredde fed. For eksempel:
Filrelaterede klasser inkluderer filsystem for filsystemer, fil for filer, og arkiv for arkiver. Hver klasse har deres eget sæt af rettigheder.
Proportionelt fed
Disse betegnende ord eller sætninger kan man støde i et system, deriblandt også programnavne; dialogbokstekster; knapper med etiketter; tjekboks- og radioknapetiketter; menutitler og undermenutitler. For eksempel:
Vælg fra hovedmenuen for at starte Indstillinger for mus. I Knapper-fanebladet, tryk på Venstrehånds mus-tjekboksen og tryk Luk for at skifte den primære museknap fra venstre til højre (gør musen bedre egnet til venstrehåndsbrug).
For at indsætte et specielt tegn ind i en geditfil, vælg fra hovedmenuen. Derefter skal du vælge fra Tegnoversigt-menuen, indtast navnet på tegnet i Find-feltet og tryk Næste. Tegnet du søgte efter vil blive belyst i Tegntabellen. Dobbeltklik på dette belyste tegn for at placere det i Tekst at kopiere-feltet og derefter trykke på Kopiér-knappen. Skift nu tilbage til dit dokument og vælg fra geditmenuen.
Ovenstående tekst inkluderer programnavne; globale menunavne og punkter; programspecifikke menunavne; og knapper og tekst fundet i en grafisk brugerflade, alt sammen præsenteret i Proportionelt fed og alle skelnet af konteksten.
Bemærk stenografiet som bruges til at indikere sidebevægelsen gennem en menu og dens undermenuer. Dette er for at undgå den der er svær at følge 'Vælg fra -undermenuen i -menuen i hovedmenuen'-tilgangen.
Fastbredde Fed SkråskriftProportionel fed skråskrift
Uanset om det er Fastbredde fed eller Proportionel fed, er tilføjelsen af Skråskrift indikationen af genplacérbar eller variabelt tekst. Skråskrift markerer teksten du ikke bogstaveligt skriver ind eller vist tekst der ændrer sig alt efter omstændighederne. For eksempel:
For at forbinde til en fjernmaskine ved at bruge ssh, skal du skrive ssh brugernavn@domæne.navn i en skal. Hvis fjernmaskinen er eksempel.dk og dit brugernavn på maskinen er john, skal du skrive ssh john@eksempel.dk.
mount -o remount file-system-kommandoen genmonterer det navngivne filsystem. For eksempel, for at genmontere /home-filsystemet, er kommandoen mount -o remount /home.
For at se versionen af en installeret pakke, skal du bruge rpm -q pakke-kommandoen. Den vil returnere et resultat som følger: pakke-version-udgivelse
Bemærk at ordene i fed skråskrift ovenfor — brugernavn, domæne.navn, filsystem, pakke, version og udgivelse. Hvert ord er en pladsholder, enten for tekst du indtaster når du kører en kommando eller for tekst vist af systemet.
Bortset fra standardbrug til at præsentere titlen på et arbejde, markerer skråskrift første brug af en ny og vigtig term. For eksempel:
Når Apache HTTP-serveren accepterer forespørgsler, afsender den børneprocesser eller tråde til at behandle dem. Denne gruppe af børneprocesser eller tråde er kendt som en server-pool. Under Apache HTTP-server 2.0 er ansvarligheden for at skabe og vedligeholde disse server-pools blevet spredt til en gruppe af moduler kaldet Multi-Processing moduler (MPMs). Modsat andre moduler, kan kun et modul fra MPM-gruppen indlæses af Apache HTTP-serveren.
1.2. Konventionen for trækcitater
To, normalt multilinjer, datatyper bliver visuelt adskilt fra den omkringsstående tekst.
Uddata sendt til en terminal er vist i Fastbredde Roman og præsenteret således:
bøger Skrivebord dokumentation kladder mss fotos ting svn
bøger_tests Skrivebord1 hentet billeder noter skripter svgs
Kildekodevisninger er også vist med Fastbredde Roman, men er præsenteret og belyst således:
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("Created Echo");
System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
}
}
Til sidst, bruger vi tre visuelle stile til at fange opmærksomheden på information der ellers ville blive overset.
Note
En note er et tip eller genvej eller en alternativ tilgang til opgaven. At ignorere en note bør ikke have nogen negative konsekvenser, men du går måske glip af et trick der gør dit liv nemmere.
Vigtigt
Vigtigt-bokse forklarer ting der er let at overse: konfigurationsændringer der kun tilhører den nuværende session, eller tjenester der skal genstartes før en opdatering vil fungere. At ignorere Vigtigt-bokse vil ikke medføre datatab, men kan medføre irritation og frustation.
Advarsel
En advarsel bør ikke ignoreres. At ignorere advarsler vil højst sandsynligt medføre datatab.