Meta:BR/Guides/Templates

From BlenderWiki

There are a few templates defined on this Wiki. To enhance readability and consistency you are kindly requested to use these templates and only these templates

[edit] Navigation Templates and Versioning

There are navigation templates to be used at the beginning and end of each official doc pages...

[edit] Header

{{DV/navigator|VER|PreviousPage|FollowingPage}}

Produces the header you see in most pages.

DV - The Documentation Volume, currently the only one supported is UM, that is User Manual, soon RE (reference) will also be available.
VER - The Blender version the page refers to, should be 2.32, 2.34, 2.37 whatever.
PreviousPage - The link to the previous page in the TOC, written exactly as you woud write it in a [[ ]] link pair.
FollowingPage - The link to the following page in the TOC, written exactly as you woud write it in a [[ ]] link pair.

[edit] Footer

{{DV/foot|PreviousPage|FollowingPage}}

Produces the footer you see in most pages.

PreviousPage, FollowingPage - These items have the same meaning than in the previous case (#Header).

[edit] Version Tag

{{Version|VER}}

Can be used immediately after a section title to mark that that section is relevant to a different blender version than the rest of the page.

VER - see the #Header section.

[edit] Interface Templates

[edit] Keyboard Representation

To show hotkey descriptions, you must use proper templates. Generally, a key template such as Ctrl Z will involve:

two opening braces: {{
then the template code name (for a Ctrl key press here): CK
then often a 'pipe' symbol (Shift \ on a US keyboard) followed by the text you want to insert: |Z
then two closing braces: }}

[edit] Key Presses

{{K|A}} → A
{{K|Shift}} → Shift
{{K|Space}} → Space
{{K|F12}} → F12

[edit] Key Presses with modifiers

{{SK|A}} → Shift A
{{CK|A}} → Ctrl A
{{AK|A}} → Alt A
{{CAK|A}} → Ctrl Alt A
{{SAK|A}} → Shift Alt A
{{SCK|A}} → Shift Ctrl A
{{SCAK|A}} → Shift Ctrl Alt A

[edit] Numeric Keypad

{{N|0}} → NumPad 0
{{CN|0}} → Ctrl NumPad 0
{{CAN|0}} → Ctrl Alt NumPad 0
{{AN|-}} → Alt NumPad -

[edit] Cursor Keys

{{K|←}} → ←
{{K|→}} → →
{{K|↑}} → ↑
{{K|↓}} → ↓

[edit] Mouse Buttons

{{MB|L}} → LMB
{{MB|R}} → RMB
{{MB|M}} → MMB

[edit] Mouse Buttons with modifiers

{{CMB|L}} → Ctrl LMB
{{AMB|L}} → Alt LMB
{{SCMB|L}} → Shift Ctrl LMB
{{SCAMB|L}} → Shift Ctrl Alt LMB
{{CAMB|R}} → Ctrl Alt RMB
{{SAMB|R}} → Shift ALT RMB

[edit] Mouse Wheel

{{MW}}→ MW
{{MW|Up}} → MW Up
{{MW|Down}} → MW Down
{{CMW}} → Ctrl MW

Maintain consistency

Please strictly abide to these rules in order for the wiki administrators to change the styles and maintain consistency!

(icons from the Tango Desktop Project)

[edit] User Interface Items

Labels, menus and their entry, or in general, any user interface item appearing on the screen should be written as follows this

{{Literal|text}} and the like produces text.

[edit] Reference Material

Sections in reference material such as the manual should use the Template:RefBox template, and the associated sub-heading structure. This helps to keep the manual consistent, with common information in well-defined and easily recognisable places, so that people can skim read to the information they're looking for more easily. See the Reference Box Guidelines for more information and a guide on how to use this structure. An example of the Reference Box is below:

Mode: Edit Mode (Mesh)

Hotkey: Ctrl R

Menu: Mesh → Edges → Loop Subdivide...

[edit] Code Markup

Code examples (e.g python code) should be marked-up as follows...

Short code examples for embedding:

<code>dummycode</code>

This produces the following:
dummycode

code markup

Maybe a seperated template would be better? -> talk page for comments. --Hoehrer

Isolated single or muliline code:

<nowiki><pre>
line 1
line 2
...

</nowiki></pre>

... produces ...

line 1
line 2
...

[edit] Tips and Notes

There are currently two templates for these things:

A sidebox with smaller cap, and bold TITLE.

{{Note|TITLE|TEXT}}

Example:

TITLE

TEXT

A box expanding with the text width up to page-width, a nice icon, and bold TITLE.

{{NiceTip|TITLE|Longer explaining Text}}