Typografiske retningslinjer

    From KDE UserBase Wiki
    Revision as of 05:49, 28 June 2011 by Claus chr (talk | contribs) (Importing a new version from external source)

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

    Hvis du følger disse typografiske retningslinjer, så sørger du for, at din dokumentation let og præcist kan oversættes.

    Fed tekst

    Brug fed tekst til at fremhæve

    • Vinduestitler
    • Almindelige etiketter, som ikke er brugerindstillelige
    *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 di 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 violetgrå baggrundsfarve.

    • Kode, hvad enten det drejer sig om enkelte linjer eller blokke; brug skabelonen for at sikre konsistens
    • 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> for at undgå situationer, som giver problemer med visningsformatet


    • 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.
    • <tt> </tt>
      er nyttig til at vise filnavne og stier. Det ser sådan ud: en/sti/til/en/fil

    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 nogen slags ikke-afstemte parenteser. 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.)

    Special Tags

    • <keycap> and </keycap> denote (keyboard) key names e.g. Enter
    • <keycap></keycap> can also be used around groups of keys to be used concurrently, e.g. Ctrl + Alt + F1 to launch a virtual terminal. (Note that "(space)+(space)" is used to link keys to be pressed concurrently).
    • Sequences of menu choices should use <menuchoice> and </menuchoice> for example View -> Message List -> Aggregation -> Standard Mailing List
    • In general, if the user needs to choose an element, even if it is not in a menu, the <menuchoice></menuchoiсe> markup should be used.

    Translatable Content

    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!".