Plantilles¶

Aquesta guia proporciona patrons pels elements de la interfície i carpetes.

Operadors de Menu¶

Cada operador ha de rebre el seu propi encapçalament o pàgina en funció de l’extensió del contingut. Al principi hauria d’haver una advertència de referència que documenti el context de l’operador:

.. admonition:: Reference
   :class: refbox

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

Plafons¶

Els plafons s’han de documentar al seu propi encapçalament, els plafons aniuats haurien d’utilitzar nivells decreixents d’encapçalament. Cada plafó podria tenir la seva pròpia pàgina en funció de l’extensió de la documentació i/o la quantitat de plafons . Els menús ampliats que permuten les propietats que es presenten a la usuària s’han de tractar com subplafons:

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

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

Propietats¶

Les propietats s’han de documentar utilitzant llistes de definició. Les propietats que estan amagades en función d’altres propietats han d’uilitzar definicions imbrincades:

Property
   Property description.

   Hidden Property
      Hidden property description.

Els menus de selcció s’han de documentar utilizant aquesta sintaxi:

Menu Label
   General description of the menu.

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

Nodes¶

Els nodes han de tenir sempre tres entrades de capçalera, propietats i sortides amb una nota d’absència si el node no en conté. Al final de la pagina pot haver-hi un exemple(s) de secció opcional:

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

Estructura dels directoris¶

Les seccions s’haurien d’estructurar d’aquesta manera:

directory_name/
- index.rst (conté enllaços a documents interns)
- introduction.rst
- section_1.rst
- section_2.rst

Per exemple:

rendering/
- index.rst
- cycles/
  - index.rst
  - introduction.rst
  - materials/
    - index.rst
    - introduction.rst
    - volumes.rst

La idea és incloure tot el contingut d’una secció dins d’una carpeta. Idealment, cada secció hauria de tenir un index.rst (que contingui la taula de continguts de la secció) i un introduction.rst amb la introducció al contingut de la secció.

Taula de continguts¶

Per defecte, la taula de continguts hauria de mostrar dos nivells:

.. toctree::
   :maxdepth: 2

   introduction.rst
   perspective.rst
   depth_of_field.rst