Templates – Шаблони

Наступний путівник надає патерни для елементів інтерфейсу та каталогів.

Operator Menus – Меню Операторів

Кожен оператор повинен отримати свій заголовок або сторінку залежно від довжини вмісту. На початку повинно бути мати попереджувальне застереження, що документує контекст оператора:

.. admonition:: Reference
   :class: refbox

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

Panels – Панелі

Панелі повинні документуватися за їх власним заголовком, вкладені панелі повинні використовувати спадні рівні заголовка. Кожна панель може мати власну сторінку залежно від довжини документації та/або кількості панелей. Розгорнуті меню, що перемикають, які властивості представляються користувачу, повинні оброблятися як підпанелі:

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

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

Properties – Властивості

Властивості повинні документуватися за допомогою списків визначень. Властивості, які сховані на основі інших властивостей, повинні використовувати вкладені визначення:

Property
   Property description.

   Hidden Property
      Hidden property description.

Вибір меню повинен документуватися за допомогою наступного синтаксису:

Menu Label
   General description of the menu.

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

Nodes – Вузли

Вузли повинні завжди мати три уводи заголовків, властивостей та виводів з приміткою про відсутність, якщо вузол їх немає. В кінці сторінки може бути секція факультативних прикладу(ів):

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

Directory Layout – Розстава Директорій

Підрозділи повинні у загальному бути структуровані так:

• directory_name/

  • index.rst (містить посилання на внутрішні файли)

  • introduction.rst

  • section_1.rst

  • section_2.rst

Наприклад:

• rendering/

  • index.rst

  • cycles/

    • index.rst

    • introduction.rst

    • materials/

      • index.rst

      • introduction.rst

      • volumes.rst

Ідея полягає в тому, щоб укласти весь вміст розділу всередину теки. В ідеалі кожен розділ повинен мати index.rst (що містить зміст TOC для цього розділу) та introduction.rst (вступ) до вмісту розділу.

Table of Contents – Зміст

Стандартно, зміст повинен показувати два рівні глибини:

.. toctree::
   :maxdepth: 2

   introduction.rst
   perspective.rst
   depth_of_field.rst