Denne manualen bruker flere konvensjoner for å markere visse ord og fraser og for å dra oppmerksomheten til spesielle biter av informasjonen.
1.1. Typografiske konvensjoner
Fire typografiske konvensjoner er brukt for å dra oppmerksomheten til spesielle ord og fraser. Disse konvensjonene, og omstendighetene de skal brukes i, er som følger.
Fastbredde Fet
Brukt til å markere inndata til systemet, inkludert terminal kommandoer, filnavn og -stier. Det er også brukt for å markere enkelt taster og tastekombinasjoner. For eksempel:
For å se innholdet i filen Min_neste_bestselgende_roman i ditt nåværende arbeidsområde, skriv cat min_neste_bestselgende_roman kommandoen i terminalen og trykk Enter for å kjøre kommandoen.
Avsnitt over inkluderer et filnavn, en terminalkommando og en tast, alle er presentert i Fastbredde Fet og er tydelige i sammehengen.
Tastekombinasjoner kan også bli uthevet fra enkelttaster med bindestreken som binder alle deler av tastekombinasjonen. For eksempel:
Trykk Enter for å kjøre kommandoen.
Trykk Ctrl+Alt+F1 for å bytte til den første virtuelle terminalen. Trykk Ctrl+Alt+F7 for å returnere til X-Windows sesjonen din.
Den første setningen markerer de forskjellige tastene man skal trykke. Den andre markerer to sett av tre taster, der hvert sett av knapper skal trykkes på samtidig.
Hvis kildekode er diskutert, klassenavn, metoder, funksjoner, variabelnavn og returnerte verdier nevnt i et avsnitt vil bli presentert lik den ovenfor, i Fastbredde Fet. For eksempel:
Filrelaterte klasser inkluderer filsystem for filsystemer, fil for filer, og dir for mapper. Hver klasse har sitt eget sett med tillatelser assosiert med seg.
Proporsjonal Fet
Dette betegner ord og fraser som kan møtes i et system, inkludert programnavn; dialogbokstekst; knapper med etiketter; sjekkbokser og radioknapper; menytitler og undermenytitler. For eksempel:
Velg ifra hovedmenylinja for å starte Brukervalg for Mus. I fanen Generelt, trykk på Venstrehendt sjekkboksen og trykk Lukk for å skifte den primære museknappen fra høyre til venstre (som gjør musa bedre egnet for venstrehendte).
For å sette spesialtegn inn i ei gedit fil, velg ifra hovedmenylinja. Så velger du fra Tegnkart menylinja, skriv navnet på tegnet i Søk: feltet og trykk Neste. Tegnet du søkte etter vil bli fremhevet i Tegntabellen.Dobbeltklikk på det fremhevete tegnet for å plassere det i Tekst som skal kopieres feltet og trykk på Kopier knappen. Nå går du tilbake til dokumentet ditt og velger fra menylinja til gedit
Teksten ovenfor inkluderer programnavn; meny- og punktnavn som går igjennom hele systemet; programspesifikke menynavn; og knapper og tekster som man finner i et grafisk brukergrensesnitt (GUI), alt er presentert i proporsjonal fet og skilt ut i konteksten.
Legg merke til at brukes til å indikere navigasjon igjennom en meny og dens undermenyer. Dette er for å unngå vanskelig-å-følge 'Velg fra undermenyen i menyen i fra hovedmenylinja' tilnærmingen.
Fastbredde Fet KursivProporsjonal Fet Kursiv
Uansett om det er Fastbredde Fet Kursiv eller Proporsjonal Fet, Kursiv indikerer at det er utskiftbar eller variabel tekst. Kursiv viser tekst som du ikke skriver inn direkte eller viser tekst som forandrer seg etter omstendighetene. For eksempel:
For å koble til en fjernmaskin ved hjelp av ssh, skriv sshbrukernavn@domenenavn i terminalvinduet. Hvis fjernmaskinen er eksempel.com og ditt brukernavn på den maskinen er ola, skriv ssh ola@eksempel.com
mount -o remount filsystem kommandoen igjenmonterer det navngitte filsystemet. For eksempel for å igjenmontere /home filsystemet, er kommandoen mount -o remount /home.
For å se hvilken versjon en installert pakke er i, bruk rpm -q pakke kommandoen. Den vil returnere et resultat likt dette: package-version-release
Legg merke til at ordene ovenfor i fet kursiv — brukernavn, domenenavn filsystem, pakke, versjon og utgivelse. Hvert ord isteden for noe annet, enten for tekst du skal skrive inn når du du skal kjøre kommandoen eller for tekst som skal vises av systemet.
Bortsett fra standard bruken for å presentere tittelen til et arbeid, markerer kursiv den første bruken i en viktig term. For eksempel:
Når Apache HTTP Serveren aksepterer en anmodning, starter den underprosesser eller tråder for å håndtere dem. Denne gruppen av underprosesser eller tråder er kjent som server-pool. Med Apache HTTP Server 2.0 har ansvaret for å lage og opprettholde disse server-poolene blitt sammenfattet til en gruppe av moduler kalt Multi-Processing Modules. (MPMs). Ulikt de andre modulene, er det bare en i MPM gruppen som kan bli lastet av Apache HTTP Serveren.
1.2. Blikkfangersitatkonvensjoner
To, vanligvis på flere linjer, datatyper er satt ut visuelt i fra den omliggende teksten.
Utdata sendt til en terminal er vist i Fastbredde Roman og presentert slik:
bøker Skrivebord Dokumentasjon utkast manuskript foto ting svn
bøker_testes Skrivebord1 nedlastinger bilder notater skrifter svger
Oppført kildekode er også vist i Fastbredde Fet men er presentert og markert som følgende:
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("Echo ble skapt");
System.out.println("Echo.echo('Hallo') = " + echo.echo("Hallo"));
}
}
1.3. Notater og advarsler
Til slutt, vi bruker tre visuelle metoder for å dra oppmerksomheten til informasjon som kanskje hadde blitt oversett ellers.
Notat
En notat er et tips eller en snarvei eller en alternativ innfallsvinkel til en forestående oppgave. Å ignorere en notat skal ikke ha noen negative konsekvenser, men du går kanskje glipp av et triks som ville gjort livet ditt enklere.
Viktig
Bokser markert som viktig beskriver i detalj ting som er lett å overse: Forandringer i konfigureringen som kun gjelder i den nåværende sesjonen, eller tjenester som trenger en omstart før oppdateringen vil tre i kraft. Å ignorere bokser markert som viktig vil ikke føre til tap av data, men kan skape irritasjon og frustrasjon.
Advarsel
En advarsel burde ikke ble ignorert. Å ignorere advarsler vil mest sannsynlig føre til tap av data.