Redigering av manualen

Du kan ändra manualen genom att redigera lokala textfiler. Dessa filer hålls synkroniserade med dem som finns online via ett arkiv, och baserat på detta uppdaterar servern onlinehandboken.

Manualen är skriven i märkspråket reStructuredText (RST) och kan redigeras med en vanlig textredigerare. För en lokal förhandsgranskning konverterar (bygger) du manualens källfiler från RST till HTML-webbsidor.

Uppdatera

Kontrollera först att din lokala kopia av handboken är uppdaterad med onlinearkivet med hjälp av:

make update

Skriver

Du kan nu redigera dokumentationsfilerna, som är filerna .rst i mappen manual, med hjälp av en valfri textredigerare.

Se till att läsa Guide för skrivstil för konventioner och Stilguide för uppmärkning för att lära dig hur du skriver i märkspråket reStructuredText.

Trevligt skrivande!

Större förändringar

Om du ska lägga till eller se över ett avsnitt bör du noga kontrollera att det inte redan finns. På vissa ställen är dokumenten så oorganiserade att avsnitt kan vara duplicerade eller på en konstig plats. Om du hittar ett duplicerat avsnitt eller ett avsnitt på fel plats, skapa en fråga <https://projects.blender.org/blender/documentation/issues/new>`__ som förklarar problemet och inkludera eventuellt en revision (faktiska ändringar).

Innan du gör några ändringar som inte är enkla och klart motiverade (t.ex. flytta runt mappar) bör du kontrollera med en manualförvaltare att ditt bidrag ligger i linje med gemenskapens vision för manualen. Detta säkerställer att din tid och goda vilja används på bästa sätt eftersom det annars är möjligt att dina ändringar av någon anledning kommer i konflikt med varandra och avvisas eller behöver tidskrävande granskning. Till exempel kan en annan person redan arbeta med det avsnitt som du vill ändra, avsnittet kan vara planerat att tas bort eller att uppdateras enligt en planerad ändring av Blender.

Kommunicera tidigt och ofta är nyckeln till en produktiv miljö, att inte slösa bort människors ansträngningar och att uppnå en bättre Blender-manual som resultat.

Få hjälp/svar

Om du är osäker på funktionalitet som du vill dokumentera, bör du ställa dina frågor till Blender-utvecklarna som ansvarar för det området eller fråga på den inofficiella användarstödskanalen i kanalen #docs eller #blender-coders i Chatt.

Blender själv har ett system med modulägare med medlemmar som är utvecklare och konstnärer som ansvarar för design och underhåll av de tilldelade Blender-områdena. Se modulsidorna för mer information.

Förhandsvisa

För att se dina ändringar, bygg manualen enligt instruktionerna. Tänk på att du också kan bygga endast det kapitel du just redigerat för att snabbt kunna se det. Öppna de genererade .html-filerna i mappen build/html med din webbläsare, eller uppdatera sidan om du redan har den öppen.

Skicka upp

När du är nöjd med dina ändringar kan du ladda upp dem så att de finns med i onlinehandboken. Till att börja med görs detta genom att skicka in patchar så att någon kan granska dina ändringar och ge dig feedback. Därefter kan du göra dina ändringar direkt. Den här processen beskrivs i detalj i nästa avsnitt.