Viktigt

Översättning är en gemenskapsinsats du kan gå med i. Den här sidan är för närvarande översatt till 100.00%.

19. Bilaga: Bidrag till denna manual

För att lägga till material i den här kursen måste du följa riktlinjerna i den här bilagan. Det är inte tillåtet att ändra villkoren i detta appendix annat än för att förtydliga dem. Detta för att säkerställa att kvaliteten och konsekvensen i denna manual kan upprätthållas.

19.1. Ladda ner resurser

Källan till detta dokument finns tillgänglig på GitHub. Se GitHub.com för instruktioner om hur du använder versionskontrollsystemet git.

19.2. Manuellt format

Den här handboken är skriven med hjälp av Sphinx, en Python-dokumentgenerator som använder reStructuredText markup-språk. Instruktioner om hur du använder dessa verktyg finns på deras respektive webbplatser.

19.3. Lägga till en modul

För att lägga till en ny modul:

  1. Skapa först en ny katalog (direkt under den översta nivån i katalogen qgis-training-manual) med namnet på den nya modulen.

  2. Under den nya katalogen skapar du en fil som heter index.rst. Lämna den här filen tom tills vidare.

  3. Öppna filen index.rst under katalogen på översta nivån. Dess första rader är:

    .. toctree::
   :maxdepth: 2

   foreword/index
   introduction/index

Du kommer att märka att detta är en lista med katalognamn, följt av namnet index. Detta dirigerar indexfilen på högsta nivån till indexfilerna i varje katalog. Den ordning i vilken de listas avgör vilken ordning de kommer att ha i dokumentet.

  1. Lägg till namnet på den nya modulen (dvs. det namn som du gav den nya katalogen) följt av /index i listan på den plats där du vill att modulen ska visas.

  2. Tänk på att hålla en logisk ordning på modulerna, så att senare moduler bygger vidare på den kunskap som presenterats i tidigare moduler.

  3. Öppna den nya modulens egen indexfil (module_name/index.rst).

  4. Längst upp på sidan skapar du modulrubriken:

    1. skriva en första rad med asterisker (*).

    2. Därefter följer en rad med markeringsfrasen Module:, följt av namnet på din modul.

    3. Avsluta med ytterligare en rad med samma antal asterisker.

    Observera

    Under- och överstrykningen får inte vara kortare än den rad som innehåller modulens titel.

  5. Lämna en linje öppen under denna.

  6. Skriv ett kort stycke som förklarar syftet med och innehållet i modulen.

  7. Lämna en rad öppen och lägg sedan till följande text:

    .. toctree::
   :maxdepth: 2

   lesson1
   lesson2

    … där lektion1, lektion2, etc., är namnen på dina planerade lektioner.

Indexfilen på modulnivå kommer att se ut så här:

*******************************************************************************
Module: Module Name
*******************************************************************************

Short paragraph describing the module.

.. toctree::
   :maxdepth: 2

   lesson1
   lesson2

19.4. Lägga till en lektion

Så här lägger du till en lektion i en ny eller befintlig modul:

  1. Öppna modulkatalogen.

  2. Öppna filen index.rst (som skapades ovan när det gäller nya moduler).

  3. Se till att namnet på den planerade lektionen anges under toctree-direktivet, som visas ovan.

  4. Skapa en ny fil under modulkatalogen.

  5. Ge den här filen exakt samma namn som du angav i modulens fil index.rst och lägg till tillägget .rst.

Observera

För redigeringsändamål fungerar en .rst-fil precis som en vanlig textfil (.txt).

  1. För att börja skriva lektionen skriver du markeringsfrasen Lesson, följt av lektionens namn.

  2. På nästa rad skriver du en rad med likhetstecken (=), inte kortare än lektionens titel.

  3. Lämna en linje öppen efter detta.

  4. Skriv en kort beskrivning av lektionens avsedda syfte.

  5. Inkludera en allmän introduktion till ämnet. Se de befintliga lektionerna i den här handboken för exempel.

  6. Under detta börjar du ett nytt stycke som inleds med följande fras:

    **The goal for this lesson:**

  7. Förklara kortfattat det avsedda resultatet av att slutföra denna lektion.

  8. Om du inte kan beskriva målet med lektionen i en eller två meningar kan du överväga att dela upp ämnet i flera lektioner.

Varje lektion kommer att delas upp i flera avsnitt, som kommer att behandlas härnäst.

19.5. Lägga till en sektion

Det finns två typer av avsnitt: ”Följ med” och ”Prova själv”.

  • Ett ”följ med”-avsnitt är en detaljerad uppsättning anvisningar som är avsedda att lära läsaren hur man använder en viss aspekt av QGIS. Detta görs vanligen genom att ge så tydliga anvisningar som möjligt, klick för klick, varvat med skärmdumpar.

  • Ett ”prova själv”-avsnitt ger läsaren en kort uppgift att prova själv. Det är vanligtvis förknippat med en post i svarsrutan nedanför, som visar eller förklarar hur man ska utföra uppgiften och visar det förväntade resultatet om möjligt.

Varje avsnitt kommer med en svårighetsgrad. En lätt sektion betecknas med ★☆☆, måttlig med ★★☆ och avancerad med ★★★.

19.5.1. Lägga till en ”följ med”-sektion

  1. För att starta detta avsnitt skriver du markeringsfrasen för den avsedda svårighetsgraden (som visas ovan).

  2. Lämna ett mellanslag och skriv sedan Follow Along:.

  3. Lämna ytterligare ett utrymme och skriv sektionens namn (använd endast en inledande versal, samt versaler för egennamn).

  4. På nästa rad skriver du en rad med minustecken/streck (-), inte kortare än avsnittets titel.

  5. Skriv en kort introduktion till avsnittet och förklara dess syfte. Ge sedan detaljerade (klick-för-klick) instruktioner om den procedur som ska demonstreras.

  6. I varje avsnitt ska du inkludera interna länkar, externa länkar och skärmdumpar efter behov.

  7. Försök att avsluta varje avsnitt med ett kort stycke som avslutar det och leder naturligt till nästa avsnitt, om möjligt.

19.5.2. Lägga till en ”prova själv”-sektion

  1. För att starta detta avsnitt skriver du markeringsfrasen för den avsedda svårighetsgraden (som visas ovan).

  2. Lämna ett utrymme och skriv sedan Try Yourself:.

  3. På nästa rad skriver du en rad med minustecken/streck (-), inte kortare än avsnittets titel.

  4. Förklara den övning som du vill att läsaren ska genomföra. Hänvisa till tidigare avsnitt, lektioner eller moduler om det behövs.

  5. Bifoga skärmdumpar för att förtydliga kraven om en beskrivning i klartext inte är tydlig.

I de flesta fall kommer du att vilja ge ett svar på hur du ska utföra uppgiften som ges i detta avsnitt. För att göra det måste du skapa och mata in ett svarsblock under instruktionerna.

  1. Först skapar du den anpassade hopfällbara widgeten som innehåller svaret:

    .. admonition:: Answer
   :class: dropdown

  2. Håll ett indrag i förhållande till ovanstående block och skriv instruktionerna för hur du slutför uppgiften med hjälp av länkar och bilder där det behövs.

19.6. Lägg till en slutsats

För att avsluta en lektion:

  1. Skriv frasen Slutsats, följt av en ny rad med minustecken/streck (-).

  2. Skriv en slutsats för lektionen och förklara vilka begrepp som har behandlats under lektionen.

19.7. Lägg till en sektion för vidare läsning

Detta avsnitt är valfritt.

  • Skriv frasen Further Reading, följt av en ny rad med minustecken/streck (-).

  • Inkludera länkar till lämpliga externa webbplatser.

19.8. Lägg till ett avsnitt om vad som händer härnäst

  1. Skriv frasen ”Vad händer härnäst?”, följt av en ny rad med minustecken/streck (-).

  2. Förklara hur den här lektionen har förberett eleverna för nästa lektion eller modul.

  3. Kom ihåg att vid behov ändra avsnittet ”Vad händer härnäst” i den föregående lektionen så att det hänvisar till den nya lektionen. Detta är nödvändigt om du har infogat en ny lektion bland befintliga lektioner eller efter en befintlig lektion.

19.9. Använda Markup

För att följa standarderna i det här dokumentet måste du lägga till standardmarkeringar i din text.

19.9.1. Nya koncept

Om du förklarar ett nytt begrepp måste du skriva det nya begreppets namn kursivt genom att omsluta det med asterisker (*).

This sample text shows how to introduce a *new concept*.

19.9.2. Betoning

  • För att betona en viktig term som inte är ett nytt begrepp, skriv termen i fetstil genom att omge den med dubbla asterisker (**).

  • Använd detta sparsamt! Om det används för mycket kan läsaren uppfatta det som att du skriker eller är nedlåtande.

This sample text shows how to use **emphasis** in a sentence. Include the
punctuation mark if it is followed by a **comma,** or at the **end of the
sentence.**

19.9.3. Images

  • När du lägger till en bild ska du spara den i en img-mapp bredvid lektionsfilen.

  • Inkludera det i dokumentet så här:

    .. figure:: img/image_file.extension
   :align: center

  • Kom ihåg att lämna en rad öppen ovanför och under bildmarkeringen.

19.9.6. Använd text med fast bredd

  • När du skriver text som användaren måste ange, ett sökvägsnamn eller namnet på ett databaselement, t.ex. ett tabell- eller kolumnnamn, måste du skriva det med monospaced text. Till exempel:

    Enter the following path in the text box: ``path/to/file``.

19.9.7. Märkning av grafiska gränssnittsobjekt

  • Om du refererar till ett GUI-objekt, t.ex. en knapp, måste du skriva dess namn i det GUI-etikettformat. Till exempel:

    To access this tool, click on the :guilabel:`Tool Name` button.

  • Detta gäller även om du nämner namnet på ett verktyg utan att användaren behöver klicka på en knapp.

19.9.9. Lägga till anteckningar

  • Du kan behöva lägga till en anteckning i texten, som förklarar extra detaljer som inte enkelt kan göras till en del av lektionens flöde. Detta är markeringen:

    [Normal paragraph.]

.. note:: Note text.
  New line within note.

  New paragraph within note.

[Unindented text resumes normal paragraph.]

19.9.10. Lägga till en notering om sponsring/författarskap

Om du skriver en ny modul, lektion eller ett avsnitt på uppdrag av en sponsor måste du inkludera ett kort sponsormeddelande som sponsorn väljer. Detta måste meddela läsaren namnet på sponsorn och måste visas under rubriken för den modul, lektion eller det avsnitt som de sponsrat. Det får dock inte vara en annons för deras företag.

Om du har erbjudit dig att skriva en modul, lektion eller ett avsnitt i din egen kapacitet, och inte på uppdrag av en sponsor, kan du inkludera en författarnotering under rubriken för den modul, lektion eller det avsnitt som du har författat. Detta måste ha formen ”Denna [modul/lektion/avsnitt] har skrivits av [författarens namn].” Lägg inte till ytterligare text, kontaktuppgifter etc. Sådana uppgifter ska läggas till i avsnittet ”Contributors” i förordet, tillsammans med namnet på den eller de delar som du har lagt till. Om du endast har gjort förbättringar, korrigeringar och/eller tillägg, ange dig själv som redaktör.

19.10. Tack!

Tack för att du bidrar till detta projekt! Genom att göra det gör du QGIS mer tillgängligt för användarna och tillför värde till QGIS-projektet som helhet.