Khuôn Mẫu (Templates)

Hướng dẫn sau đây sẽ cung cấp các kiểu mẫu cho các phần tử giao diện và các thư mục.

Trình Đơn Thao Tác (Operator Menus)

Mỗi thao tác phải có tiêu đề hoặc trang riêng cho mình, dựa trên chiều dài của nội dung. Phần đầu phải là một tham chiếu nhắc nhở, giải thích bối cảnh của thao tác:

.. admonition:: Reference
   :class: refbox

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

Bảng (Panels)

Các bảng nên được giải thích dưới tiêu đề riêng của chúng, các bảng lồng nhau, cái nọ trong cái kia, nên sử dụng phân hạng tiêu đề cấp thứ, theo chiều nhỏ dần đi. Mỗi bảng điều khiển có thể có trang riêng của mình, dựa trên độ dài của tài liệu, và/hoặc số lượng bảng. Các trình đơn mở rộng, dùng để bật/tắt tính chất nào là cái sẽ hiện ra cho người dùng thấy, cái nào không, nên được đối xử như các bảng thứ:

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

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

Tính Chất (Properties)

Các tính chất nên được giải thích bằng cách sử dụng các danh sách định nghĩa. Các tính chất bị ẩn giấu đi, dưới ảnh hưởng của các tính chất khác thì nên được sử dụng định nghĩa lồng dưới nhau:

Property
   Property description.

   Hidden Property
      Hidden property description.

Các trình đơn cho phép lựa chọn từng cái một thì nên được ghi lại bằng cú pháp sau:

Menu Label
   General description of the menu.

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

Nút (Nodes)

Các nút phải luôn có ba tiêu đề: đầu vào, tính chất và đầu ra. Nếu nút không có một cái nào đó thì phải có một lưu ý nhắc nhở về sự vắng mặt của chúng. Ở cuối trang có thể có một phần về (các) ví dụ, tuy không bắt buộc:

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

Bố Trí của Thư Mục (Directory Layout)

Các phần nên được cấu trúc một cách chung chung như sau:

  • directory_name/

    • index.rst (có chứa các kết nối đến những tập tin nội bộ)

    • introduction.rst

    • section_1.rst

    • section_2.rst

Lấy ví dụ:

  • rendering/

    • index.rst

    • cycles/

      • index.rst

      • introduction.rst

      • materials/

        • index.rst

        • introduction.rst

        • volumes.rst

Đại ý là chúng ta cần phải gộp toàn bộ các nội dung của một phần vào nằm trong một thư mục. Lý tưởng nhất là mỗi phần có một bản index.rst (chứa TOC cho phần đó) và introduction.rst (giới thiệu) cho nội dung của phần đó.

Bảng Mục Lục (Table of Contents)

Theo mặc định, một bảng nội dung nên có hai tầng bậc:

.. toctree::
   :maxdepth: 2

   introduction.rst
   perspective.rst
   depth_of_field.rst