Typografiske retningslinjer

Der er separate sider, som forklarer sidelayout og syntaks med eksempelkode.

Vigtigt

Hvis du følger disse typografiske retningslinjer, så sørger du for, at din dokumentation let og præcist kan oversættes. Nogle af retningslinjerne er måske ikke relevante for alle sprog. Dette bør anføres på de særlige sider for specifikke sprog, som der linkes til fra Arbejdsgang ved oversættelse. Hvis der ikke findes en side for dit sprog, så lav en og tilføj retningslinjer der.

Fed tekst

Brug fed tekst til at fremhæve

• Vinduestitler
• Almindelige etiketter, som ikke kan indstilles af brugeren
• Ikontitler
• Programnavne

For eksempel:

• Fremhæver du et afsnit, så bliver det kopieret til Klipper.

Kursiveret tekst

Brug kursiv til at fremhæve

• Ord eller fraser som i almindelig tekst
• Titler, når du henviser til andre arbejder
• Første brug af et uvant ord

Nogle eksempler:

• Gem dit arbejde ved dette trin.
• Detaljer kan findes i Samba 3 by Example...
• KDE-manualer er i Docbook-format

Tip

Programmer startes af brugere, komponenter bruges af programmer

Kombineret fed og kursiveret tekst

Brug denne kombination til tekst, som skal erstattes eller er variabel.

Nogle eksempler:

• For at forbinde til en netværksserver skriver du type ssh [email protected] i Konsole.
• I rpm-baserede distributioner vil kommandoen rpm -q pakkenavn resultere i pakke-version-udgave.

Skrivemaskinetekst

Kode bør repræsenteres med skrivemaskinetekst, oftest indrammet som vist nedenfor. Inputtekst vises på en lysegul baggrund. Outputtekst har en gråviolet baggrundsfarve.

• Brug skabelonen for at sikre konsistens formattering af kode, hvad enten det drejer sig om enkelte linjer eller blokke

• Brug skabelonen Input således:

  {{Input|1=<nowiki>
  qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
  rm -r ~/.kde/share/apps/nepomuk
  rm -r ~/.kde4/share/apps/nepomuk
  nepomukserver</nowiki>}}

  Dette vil blive vist således:

  qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
  rm -r ~/.kde/share/apps/nepomuk
  rm -r ~/.kde4/share/apps/nepomuk
  nepomukserver

• Output virker på samme måde:

  {{Output|1=<nowiki>terminal output 
  is also shown as code, 
  but on a grey background</nowiki>}}

  vises som

  terminal output 
  is also shown as code, 
  but on a grey background

Note

Bemærk brugen af 1=<nowiki> noget tekst </nowiki>. Undertiden kan dele af uformateret tekst forvirre wiki-fortolkeren. Blokken <nowiki>...</nowiki> beskytter mod dette. Hvis der optræder noget i stil med n= i den uformaterede tekst, så kan skabelonfortolkeren blive forvirret. Det indledende 1= beskytter imod dette. Derudover har dette markup ingen effekt. Kort sagt: Det kan ikke skade, og det beskytter mod muligheden for nogle ubehagelige sideeffekter.

• Det vil forstyrre formatteringen, hvis en af skabelonerne Input eller Output starter på en ny linje i en liste. Fortsæt simpelthen på samme linje for at rette dette.

• Du kan også kombinere input/output-områder med GeSHi syntaxhiglighting. Et inputopmåde som dette

  {{Input|<syntaxhighlight lang="php" line>
  # Initialise common code
  $preIP = dirname( __FILE__ );
  require_once( "$preIP/includes/WebStart.php" );
  </syntaxhighlight>}}

  vil resultere i

  # Initialise common code
  $preIP = dirname( __FILE__ );
  require_once( "$preIP/includes/WebStart.php" );
  

• Enkelte kodeord kan holdes i tekstlinjen ved at bruge

  <code></code>

  . Det vil vises på denne måde. Bemærk, at hvis tagget <code> står umiddelbart efter et nylinjetegn, så vil det ikke blive vist korrekt.

• Filnavne og stier bør bruge skabelonen Path (se herunder).

Advarsel

Kodestumper i teksten bør være korte! Det ser mærkeligt og grimt ud, når en streng af kodeord deles over flere linjer. Og husk: selv om det ser godt ud i din egen browser, så er det ikke alle, der har den samme skærmstørrelse! Og selv, hvis din tekst ser godt ud på alle skærmstørrelser, så kan det stadig være et problem for oversættelser. Det er bedst at bruge skabelonen Input til kode, medmindre det er meget kort.

Note

Du bør undgå at bruge skalkommandoer og andre kodeord som verber. Det bliver vanskeligt at oversætte. Brug altid kodeord som om de er egennavne,

Citater

Taggene <blockquote> og </blockquote> bør bruges, når du citerer andres arbejde eller andre sider. Dette giver en kursiveret tekst med lidt indrykning.

Her er et eksempel på, hvordan det ser ud, når du bruger blockquote-taggene

Tekst i afsnitsoverskrifter

Selv nå kriterierne ovenfor er opfyldt, så skal du aldrig bruge fed eller kursiveret tekst i afsnitsoverskrifter eller i links.

Tekst i skabelonerne Information, Note, Tip og Warning

Fed tekst bør undgås i tekster i disse skabeloner. Kursiveret tekst kan stadig bruges — brug det sparsomt for at opnå den bedste effekt.

Lister

Du kan have forskellige slags lister i dine sider — punktopstillinger, nummererede lister og emnelister. Find detaljer på siden Værktøjskassen.

Hold ting sammen

Efter at din tekst er blevet skrevet tilføjer oversættelsessystemet automatisk noget markup. Dette betyder, at når som helst der optræder en tom linje, så startes en ny enhed. Når din tekst præsenteres for oversætterne, så vil de typisk se en enhed ad gangen, så det er vigtigt ikke at have tomme linjer midt i noget, som bør behandles som en enhed. Normalt skal hele afsnit holdes samlet i en enhed; og du må under ingen omstændigheder splitte et sætning op imellem flere enheder!

Hvis du har brug for en ny linje midt i et afsnit, så er den bedste måde at opnå dette uden at lave blanke linjer at bruge <br /> for enden af linjen (ikke på en ny linje), hvor du vil have linjeskiftet Hvis du skal bruge mellemrum mellem linjerne, så skriv <br /><br />.

Ikke-afstemte parenteser

Oversættelsessystem markerer enhver oversat enhed som ufuldstændigt oversat, hvis den indeholder ikke-afstemte parenteser af nogen slags. Hvis du har brug for ikke-afstemte parenteser i din tekst, så tilføj en matchende parentes i en kommentartag som her:

<!-- }} -->{{ En linje 

En anden linje }}<!-- {{ -->

Dette gælder for alle slags parenteser, også de ganske almindelige runde. (Det er selvfølgelig bedst at undgå blanke linjer i en opmarkeret enhed — se Hold ting sammen.)

Specielle tags

Tastetryk og menuvalg

• <keycap> and </keycap> angiver tastenavne, fx Enter
• <keycap></keycap> kan også bruges omkring grupper at taster, som skal nedtrykkes samtidigt, fx Ctrl + Alt + F1. (Bemærk brugen af "(mellemrum)+(mellemrum)" imellem tasterne).
• Følger af menuvalg skal bruge <menuchoice> og </menuchoice> , for eksempel View -> Message List -> Aggregation -> Standard Mailing List
• Generelt bruges <menuchoice></menuchoiсe>, når brugeren skal vælge et element, også når det ikke er i en menu.
• Hvis du bidrager til en manual-side, så bør du altid bruge den markup, som beskrives herover. For andre sider er der dog en skabelon til at indgive menuvalg: {{Menu|Top|sub|...}}. Fx giver {{Menu | View | Message List | Aggregation | Standard Mailing List}} resultatet View → Message List → Aggregation → Standard Mailing List
• Hvis du vil bruge <menuchoice> men bruge → i stedet for ->, så skriver du & rarr; (uden mellemrummet imellem '&' og r!) som i <menuchoice> View</menuchoice> & rarr; <menuchoice>Message List</menuchoice>, hvilkeg giver View → Message List. (Beemærk, at tegnet → skal være udenfor tagget manuchoice for at blive vist korrekt)

Filer og filstier

Traditionally, file names and paths have been marked up between <tt>...</tt> tags.

<tt>~/.kde/share</tt>

yields

~/.kde/share

There is now also a template for this, which should be preferred in new content for ordinary UserBase pages (but not for manual pages, please!):

{{Path | ~/.kde/share }}

yields

 ~/.kde/share 

Det problematiske pipe-tegn

I nogle situationer kan pipe-tegnet ikke bruges - for eksempel når man føjer parametre til en skabelon. I sådanne situationer kan du i stedet bruge skabelonen {{!}}, som viser pipe-tegnet. Hvis du for eksempel skal vise en kommandolinje med et pipe-tegn i ved brug af skabelonen {{Input|...}}, så er den enkleste måde at gøre det på således: {{Input|1=cmd1 {{!}} cmd2}} som viser

cmd1 | cmd2

Hvis du blot skriver {{Input|cmd1 | cmd2}} så får du i stedet

cmd1 

Problemet er, at cmd2 bliver opfattet som en ekstra parameter til skabelonen, som i dette tilfælde ikke bliver brugt.

I mange tilfælde kan du også omgive tekst, som indeholder pipe-tegnet med <nowiki>... </nowiki>-tags, som her: {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}, hvilket også giver

cmd1 | cmd2

Indhold, der skal oversættes

Alt, der skal oversættes placeres imellem taggene <translate> og </translate>. I de fleste tilfælde bør billeder være imellem det indhold, der skal oversættes, da det undertiden er nødvendigt at bruge lokaliserede udgaver af et billede for at forklare en pointe. Tommelfingerreglen er: "Når du er i tvivl, så inkludér det!".