Šablóny

Nasledujúci návod poskytuje vzory pre prvky rozhrania a priečinky.

Ponuka Operátor

Každý operátor by mal mať svoj vlastný nadpis alebo stránku podľa dĺžky obsahu. Na začiatku by malo byť referenčné upozornenie dokumentujúce kontext operátora:

.. admonition:: Reference
   :class: refbox

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

Panely

Panely by mali byť dokumentované podľa vlastného záhlavia, vnorené panely by mali používať klesajúce úrovne záhlavia. Každý panel môže mať svoju vlastnú stránku na základe dĺžky dokumentácie a/alebo množstva panelov. Rozšírené ponuky, ktoré prepínajú, aké vlastnosti sa užívateľovi zobrazia, by sa malo zaobchádzať ako s pod-panelmi:

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

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

Vlastnosti

Vlastnosti by sa mali zdokumentovať použitím zoznamov definícií. Vlastnosti, ktoré sú skryté na základe iných vlastností, by mali používať vnorené definície:

Property
   Property description.

   Hidden Property
      Hidden property description.

Ponuky výberu by mali byť zdokumentované poožitím nasledujúcej syntaxe:

Menu Label
   General description of the menu.

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

Uzly

Uzly by mali mať vždy tri nadpisy vstupy, vlastnosti a výstupy s poznámkou o absencii, ak uzol nemá žiadne. Na konci stránky môže byť nepovinná časť s príkladmi:

**********
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
=======

Rozloženie priečinka

Sekcie by mali byť všeobecne štruktúrované takto:

  • directory_name/

    • index.rst (obsahuje odkazy na interné súbory)

    • introduction.rst

    • section_1.rst

    • section_2.rst

Napríklad:

  • rendering/

    • index.rst

    • cycles/

      • index.rst

      • introduction.rst

      • materials/

        • index.rst

        • introduction.rst

        • volumes.rst

Cieľom je vložiť celý obsah časti do priečinka. V ideálnom prípade by každá sekcia mala mať index.rst (obsahujúci TOC pre túto sekciu) a introduction.rst (uvádzajúci) do obsahu sekcie.

Obsah

Predvolene by mal obsah zobrazovať dve úrovne hĺbky:

.. toctree::
   :maxdepth: 2

   introduction.rst
   perspective.rst
   depth_of_field.rst