Skriv en programmanual

From KDE UserBase Wiki
Revision as of 05:50, 21 August 2011 by FuzzyBot (talk | contribs) (Updating to match new version of source page)

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

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.

Developing a Manual

While developing your manual it is usually best to keep it separate from the regular UserBase content. Some prefer to edit their drafts as subpages of their Talk: page. We also have a special Draft: namespace for this purpose.

To create the content page of your manual, simply write http://userbase.kde.org/Draft:Appname/Manual in the address line of your browser, or place the [[Draft:Appname/Manual]] link in a page and then click it. Either way you will be taken to a page telling you that the page does not exist, but that you can create it clicking a 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)
  • 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 du konvertere dem til PNG senere). Gør dit arbejde nemmere ved at konvertere dem fra begyndelsen af .
  • Fjern alle blanktegn fra billednavne.


Searching your manual

At some point, you may need to find something that you wrote earlier, but can't remember where. Using the wiki search box may not be ideal unless the string you search for is very specific. You can get much better control over searches using the DPL extension. For example, to to find the pages in your manual containing a certain string, you can add the following to any page:

<DPL>
  titlematch = %Appname/Manual%
  namespace = Draft
  include = *
  includematch = /string to search for/
  resultsheader = Manual Pages:
  format = ,\n* [[%PAGE%|%TITLE%]]\n,,
</DPL>

You can find more examples on using DPL on User:Claus_chr/DPL.

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.