Mallar

Följande guide innehåller mönster för gränssnittselement och kataloger.

Operatörsmenyer

Varje operatör bör få sin egen rubrik eller sida baserat på innehållets längd. I början bör det finnas en referensuppmaning som dokumenterar sammanhanget för operatören:

.. reference::

   :Mode:      Edit Mode
   :Menu:      :menuselection:`Curve --> Snap`
   :Shortcut:  :kbd:`Shift-S`

Paneler

Paneler ska dokumenteras med en egen rubrik, nästlade paneler ska använda fallande rubriknivåer. Varje panel kan ha en egen sida beroende på hur lång dokumentationen är och/eller hur många paneler det finns. Utökade menyer som växlar mellan vilka egenskaper som presenteras för användaren bör behandlas som underpaneler:

Panel Title
===========

Nested Panel Title
------------------

Egenskaper

Egenskaper bör dokumenteras med hjälp av definitionslistor. Egenskaper som är dolda baserat på andra egenskaper bör använda nästlade definitioner:

Property
   Property description.

   Hidden Property
      Hidden property description.

Valbara menyer bör dokumenteras med följande syntax:

Menu Label
   General description of the menu.

   :Menu Item: Menu Item Definition.
   :Menu Item: Menu Item Definition.
   :Menu Item: Menu Item Definition.

Noder

Noder ska alltid ha tre rubriker: inputs, properties och outputs med en notering om avsaknad om noden inte har någon. I slutet av sidan kan det finnas ett valfritt avsnitt med exempel:

**********
World Node
**********

.. figure:: /images/render_shader-nodes_output_world_node.png
   :align: right

   The World node.

Introduction and general use case(s).


Inputs
======

This node has no inputs.


Properties
==========

This node has no properties.


Outputs
=======

This node has no outputs.


Example
=======

Layout för katalog

Avsnitten bör i allmänhet struktureras enligt följande:

  • directory_name/

    • index.rst (innehåller länkar till interna filer)

    • introduction.rst

    • section_1.rst

    • section_2.rst

Till exempel:

  • rendering/

    • index.rst

    • cycles/

      • index.rst

      • introduction.rst

      • materials/

        • index.rst

        • introduction.rst

        • volumes.rst

Tanken är att allt innehåll i ett avsnitt ska finnas i en mapp. Helst bör varje avsnitt ha en ”index.rst” (som innehåller innehållsförteckningen för avsnittet) och en ”introduktion.rst” (som introducerar innehållet i avsnittet).

Innehåll

Som standard ska en innehållsförteckning visa två nivåer av djup:

.. toctree::
   :maxdepth: 2

   introduction.rst
   perspective.rst
   depth_of_field.rst