Skriv en programmanual

This page is a translated version of the page Writing an Application Manual and the translation is 100% complete.

Other languages:

Bemærkninger

Manualer vil blive inkluderet som undersider af programmets hovedside. For nemheds skyld vil jeg omtale hovedsiden som Prognavn. Strukturen bliver så noget i retning af:

Prognavn
- Prognavn/Vink og tips
Prognavn/Manual # Indholdsfortegnelse
- Prognavn/Manual/En introduktion til Prognavn
- Prognavn/Manual/Konfigurationsmuligheder
- Prognavn/Manual/Første gang du bruger Prognavn
- Prognavn/Manual/afsnit 1
- Prognavn/Manual/afsnit xxx
- Prognavn/Manual/Vink og tips
- Prognavn/Manual/Fejlløsning
- Prognavn/Manual/Programfejl
- Prognavn/Manual/Involver dig #link til techbase etc

Hvis dine afsnit bliver for lange, så kan du placere underafsnit på separate sider. Det kunne se sådan ud:

Appname/Manual # Indholdsfortegnelsen
- Appname/Manual/An Introduction to Appname
- Appname/Manual/Configuration Choices
- Appname/Manual/The First Time you use Appname
- Appname/Manual/afsnit 1
  - Appname/Manual/afsnit 1/underafsnit 1
  - Appname/Manual/afsnit 1/underafsnit 2

og så videre.

Information

Sidenavnene behøver ikke at følge dokumentets struktur tæt! I eksemplet ovenfor kunne du blot bruge Prognavn/Manual/underafsnit 2 i stedet for Prognavn/Manual/Afsnit 1/underafsnit 2 og tilsvarende for under-underafsnit (når blot denne fremgangsmåde ikke giver anledning til gentagelse af sidenavne

).

Husk!

Prøv at holde dine sidenavne korte og undgå lange stier. Meget lange sidenavne er besværlige at skrive når du linker til dem og de ser ikke godt ud på wiki-siderne. Og husk altid: Sidenavnene og deres struktur har overhovedet ingen indflydelse på den færdige håndbog! Den bestemmes helt og holdent af overskrifterne i den faktiske tekst.

For at den automatisk dannede Docbook skal få samme indholdsfortegnelse som den, du laver på UserBase og for at linkene skal fungere i Docbook er der et par retningslinjer, som skal følges:

Indholdsfortegnelsen i Docbook vil indeholde alle afsnit og underafsnit, uanset om de har deres egen side eller ej. Omvendt vil under-underafsnit ikke blive medtaget i Docbooks indholdsfortegnelse, ikke engang hvis de har deres egne sider.

Alle sider skal starte med en overskrift som det allerførste på siden, enten et afsnit (== ... ==), et underafsnit (=== ... ===) eller et under-underafsnit (==== ... ====); ellers vil Docbook-strukturen blive ødelagt.

Titlen på et afsnit/underafsnit skal være præcis det samme som sidens navn, eller vil links ikke fungere i Docbook.

Titlen på et underafsnit skal skrives således: ===titel===, selv hvis det er det højeste niveau på siden; ellers bliver strukturen af Docbook ødelagt. Tilsvarende, hvis du har meget lange underafsnit med under-underafsnit på egne sider, så skal disse under-underafsnits titler skrives således: ====titel====.

Under-underafsnit, som ikke skal med i indholdsfortegnelsen og som ikke skal have deres egne sider i Docbook skal være på niveau 4 eller lavere, dvs. ==== eller mere.

Links til sider i manualen skal passe præcist med sidernes navne (dvs. ingen links via omdirigeringer!)

Hvis du vil linke til et underafsnit på en side, så skal du have et anker ved linkets mål. Har du ikke det, så vil linket hverken virke i Docbook eller i oversættelser.

Note

Hvert underafsnit (===) får sin egen side i Docbook, uanset om det er en del af en længere side på UserBase. Dette betyder, at et afsnit (==), som indeholder et antal underafsnit men ingen tekst før det første underafsnit får en Docbook-side, som ikke indeholder andet end links til underafsnittene.

Husk!

Hvis du på et tidspunkt beslutter dig for at ændre titlen på en sides første (under)afsnit (den første overskrift), så er det vigtigt, at du også ændrer navnet på siden til det samme og også, at du ændrer alle links til siden, sådan at de passer med det nye navn.

Husk!

Undgå enhver brug sætningstegn i sidenavne — sætningstegn som spørgsmålstegn og punktummer giver alvorlige problemer for wikisoftwaren, ikke mindst for oversættelsessystemet.

Du vil få brug for en testområde til at eksperimentere med afsnitoverskrifter og sider. Du kan enten bruge din personlige UserBase-side eller diskussionssiden knyttet til det område, hvor du arbejder. Det er en stor hjælp, hvis du fjerner alt, hvad du ikke længere skal bruge, når du er færdig med det.

Udvikling af en manual

Under udviklingen af din manual er det som regel bedst at holde den adskilt fra de almindelige UserBase-sider. Nogle foretrækker at redigere deres udkast som undersider til deres Talk:-side. Vi har også et særligt navnerum, Draft:, til dette formål.

For at lave indholdssiden til din manual skriver du blot http://userbase.kde.org/Draft:Appname/Manual i browserens adresselinje eller skriver linket [[Draft:Appname/Manual]] på en side og klikker så på det. På begge måder kommer du til en side, som siger, at den ønskede side ikke eksisterer, men at du kan oprette den ved at klikke på et link.

Indhold

Når du har lavet din plan (det kan være en langvarig proces), så lav links til alle de sider, du vil skrive i indholdsfortegnelsen. Du kan selvfølgelig altid indsætte et afsnit senere, hvis du opdager, at du har glemt noget.

Skriv manualen

Brug de røde links til at lave siderne og skriv et afsnit ad gangen.

På diskussionssiden kan du notere alt det, som du skal kigge på senere, så som links, der ikke kan laves endnu.

Husk!

Det er vigtigt at være konsistent, ikke mindst i manualer, så her er nogle almindelige regler:

Vær omhyggelig med overskriftniveauer — vi starter på andet niveau med == (Mediawiki bruge topniveauet til sidenavne)

Sørg for at se her og på Opgaver og værktøjer og Typografiske retningslinjer med jævne mellemrum

Tjek, at alle tabelceller har et mellemrumstegn efter "pipe"-tegnet. Denne regel følger traditionel wiki-formattering.

Vær konsistent i formatteringen af programnavne (undgå at skrive Amaroks, skriv Amarok's — på dansk dog Amaroks).

Sørg for, at alle billeder er i PNG-format (du kan også bruge JPEG, men i så fald bør de konverters til PNG ved hjælp af scriptet). Gør dit arbejde nemmere ved at konvertere dem fra begyndelsen af .

Fjern alle blanktegn fra billednavne.

Formatteringshensyn

For at din manual skal kunne overføres til Docbook-format er der nogle begrænsninger, som skal overholdes.

Noter og advarsler understøtter ikke alternative titler i Docbook. Skriv ikke sådan noget som
{{Remember|2=Don't Forget This!|1=You can use...}}
Argumentet 2=... har ingen mening i Docbook og programmet, som omformer wiki-siderne til Docbook kan blive meget forvirrede. Skriv kun
{{Remember|1=You can use...}}

Indlejring af video har nogle begrænsninger i sin nuværende implementering: Kun YouTube og Vimeo er understøttet og der kan kun gives en værdi som argument (videoens id).

Søgning i manualen

Før eller siden kan du få brug for at finde noget, som du skrev tidligere, men ikke kan huske hvor. Wiki'ens søgeboks er nok ikke ideel, medmindre den streng, du søger efter er meget specifik. Du kan få meget bedre kontrol over søgningen ved at bruge udvidelsen DPL. Hvis du for eksempel skal finde de sider i din manual, som indeholder en vis streng, så kan du føje følgende til hvilken side som helst:

<DPL>
  titlematch = %Appname/Manual%
  nottitleregexp = .*((/[a-z][a-z](.|-..)?)|([ _][(][a-z][a-z](...)?[)]))$
  namespace = | Draft
  include = *
  includematch = /string to search for/
  includemaxlength = 0
  resultsheader = Manual Pages:
  format = ,\n* [[%PAGE%|%TITLE%]]\n,,
</DPL>

Du kan finde flere eksempler på brugen af DPL på User:Claus_chr/DPL.

Note

Hvis du arbejder på Amaroks manual, så vær opmærksom på, at nogle af siderne afviger fra den normale navngivningskonvention. For at finde alle matchende sider fra Amaroks manual brug

titlematch = %Amarok/QuickStartGuide%|%Amarok/Manual%

(Bemærk, at der ikke må være mellemrumstegn før eller efter '|'-tegnet)

Forbered manualen for oversættelse

Den nødvendige tilpasning af markup'en er beskrevet på Preparing a Page for Translation. Følg denne guide, da nogle gamle markup-stile ikke længere er relevante.

Hvordan man laver en DocBook-manual

Når du er færdig med din manual, så kan du få den overstat til DocBook-format, sådan at dit arbejde kan bruges som enhver anden KDE-maunual. Proceduren er beskrevet på denne side.