From BlenderWiki

Jump to: navigation, search

Pages about editing the wiki:

Writer Guide | Style Guide | Templates | Translations guide | Wiki Tasks (guide)

in progress 70%
 

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

Note
You might need to check these 2.4x templates for contents outside of Doc:Manual


[edit] Header

In the first line of a page, put this: 

{{Page/Header|<blender version>|<previous page>|<next page>}}

<previous page> and <next page> being valid links to proper pages.

Icons are clickable:

  • left arrow: previous page
  • right arrow: next page
  • up arrow: up one level in pages hierarchy

Example: 

{{Page/Header|2.49|Previous page|Next page}}

shows as


Guides - Blender 2.49

See also Template:Page/Footer

[edit] Localized headers

In case you're putting this header in a translation page, you'll see a little progress bar in the navigator showing a percentage, zero by default.

You can add two additional variables (alone or together).

Percentage of translated text
{{Page/Header|<blender version>|<previous page>|<next page>|<percentage>}}
English page the translation refers to ("oldid")
{{Page/Header|<blender version>|<previous page>|<next page>|oldid=<english revision you are translating>}}
For example if the revision number of the english page you are translating is "12345", if you put "oldid=12345" in Page/Header the progress bar image will link to the diff page between the english revision you have put (12345) and the current version of the same english page. Like this, you can easily check what's changed since your last update.
Since it is actually an external link you'll see a little white arrow near the progress bar image to indicate there's a link, or the little bar won't have any link on it.
Example: Doc:FR/Manual/Modelling/Meshes/Weight_Paint
How to retrieve the oldid
Each page has a link in the Sidebar called Permanent link, hover on it with the mouse and read the Status bar in your browser to get the revision number of that page (if you don't have a Status bar click on that Permalink and see the rev number in the URL of the resulting page)

[edit] Footer

At the bottom of a page, put this: 

{{Page/Footer|<previous page>|<next page>}}

where <previous page> and <next page> should be the same found in the header.

Icons are clickable:

  • left arrow: previous page
  • right arrow: next page
  • up arrow: up one level in pages hierarchy
  • top icon: top of the page

If the page has subpages, you'll see a hierarchy of subpages listed below the navigator

Example: 

{{Page/Footer|Previous page|Next page}}

shows as






See also Template:Page/Header

[edit] Shortcut

Put a sequence of up to 5 keys to show a shortcut:

{{Shortcut|<key1>|<key2>|...|...}}

[edit] Examples

  • {{Shortcut|cmd|shift|S}} gives ⌘ Cmd⇧ ShiftS
  • {{Shortcut|ctrl|alt|X}} gives CtrlAltX
  • {{Shortcut|ctrl|alt|shift|pad3}} gives CtrlAlt⇧ Shift3 NumPad
  • {{Shortcut|shift|mmb}} gives ⇧ ShiftMMB File:Template-MMB.png

[edit] Mouse hotkeys

You can use the symbols below:

wikitext you get
{{Shortcut|lmb}} LMB File:Template-LMB.png
{{Shortcut|mmb}} MMB File:Template-MMB.png
{{Shortcut|rmb}} RMB File:Template-RMB.png
{{Shortcut|wheelup}} WheelUp Image:Template-MWUP.png
{{Shortcut|wheeldown}} WheelDown Image:Template-MWD.png
{{Shortcut|wheel}} Wheel Image:Template-MW.png

(icons from the Tango Desktop Project)

[edit] Keyboard hotkeys

Apart from using normal letters and words, you can use the symbols below:

wikitext you get
{{Shortcut|alt}} Alt
{{Shortcut|backspace}} ← Backspace
{{Shortcut|cmd}} ⌘ Cmd
{{Shortcut|ctrl}} Ctrl
{{Shortcut|enter}} ↵ Enter
{{Shortcut|opt}} ⌥ Opt
{{Shortcut|shift}} ⇧ Shift
{{Shortcut|tab}} ⇆ Tab
{{Shortcut|space}} Space
{{Shortcut|left}} ←
{{Shortcut|right}} →
{{Shortcut|up}} ↑
{{Shortcut|down}} ↓
{{Shortcut|pgup}} PageUp
{{Shortcut|pgdown}} PageDown
{{Shortcut|pad.}} . NumPad
{{Shortcut|pad0}} 0 NumPad
{{Shortcut|pad1}} 1 NumPad
{{Shortcut|pad2}} 2 NumPad
{{Shortcut|pad3}} 3 NumPad
{{Shortcut|pad4}} 4 NumPad
{{Shortcut|pad5}} 5 NumPad
{{Shortcut|pad6}} 6 NumPad
{{Shortcut|pad7}} 7 NumPad
{{Shortcut|pad8}} 8 NumPad
{{Shortcut|pad9}} 9 NumPad
{{Shortcut|pad+}} + NumPad
{{Shortcut|pad-}} - NumPad
{{Shortcut|pad*}} * NumPad
{{Shortcut|pad/}} / NumPad
{{Shortcut|pad-enter}} ↵ NumPad

[edit] RefBox

The reference box can be used with the following example code. 

{{RefBox
|mode=Mode Type
|panel=Context → Panel Name
|hotkey={{shortcut|A}}
|menu=Menu → Sub-Menu 
|lang=en
}}

You can use localised language versions of the template by entering your two-letter language code in the "lang=" field, for example, "en" displays the template in English.

[edit] Example 

{{RefBox
|mode=Edit Mode (Mesh)
|hotkey={{shortcut|ctrl|R}}
|menu=Mesh → Edges → Loop Subdivide...
|lang=en
}}

returns:

Mode: Edit Mode (Mesh)

Hotkey: CtrlR

Menu: Mesh → Edges → Loop Subdivide...


See also Template:RefBox/guidelines for more detailed instructions.

[edit] Literal

This template should always be used to ‘wrap’ all reference to GUI items (control name, menu item, …).

Usage:

Open {{Format/Literal|Window type}} menu.

gives

Open Window type menu.

[edit] Menu

This template can be used to display menu selections.

Usage: 

{{Menu|<menuname>|<submenu1>|submenu2|…}}

The menu items are formatted using {{Literal|}}. Between them the seperator {{Menu/sep}} (currently: ' » ') is inserted. Currently up to 9 menu levels are supported.

Example: 

Import a .obj with {{Menu|File|Import|Wavefront (.obj)…}}.

Results in

Import a .obj with File » Import » Wavefront (.obj)….

[edit] Note

This template gives a box of fixed width.

{{Note|Note title|Short note text}}

gives

Note title
Short note text


while 

{{Note|Note title|Suspendisse sodales leo at dolor mollis sagittis. In tempor venenatis tellus sed tincidunt.}}

gives

Note title
Suspendisse sodales leo at dolor mollis sagittis. In tempor venenatis tellus sed tincidunt.


See also Template:NiceTip

[edit] NiceTip

This template gives a box with an icon and a title, expanding with the text width up to page-width.

{{NiceTip|Tip title|Short tip text}}

gives

Tip title:
Short tip text


while 

{{NiceTip|Tip title|Suspendisse sodales leo at dolor mollis sagittis. In tempor venenatis tellus sed tincidunt.}}

gives

Tip title:
Suspendisse sodales leo at dolor mollis sagittis. In tempor venenatis tellus sed tincidunt.


See also Template:Note

[edit] Blender/Version

For long pages presenting several sections - some of which are relative to a different version of blender – a different template is available. Put this: 

 {{Blender/Version|<blender version>}}

immediately before the interested paragraph, as displayed in the examples below.

[edit] Examples

Blender 2.5+

Here I put some text referred to Blender 2.5. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius consequat sapien. Suspendisse sodales leo at dolor mollis sagittis. In tempor venenatis tellus sed tincidunt. Nam facilisis diam in velit vulputate non ultricies lectus egestas.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius consequat sapien. Suspendisse sodales leo at dolor mollis sagittis. In tempor venenatis tellus sed tincidunt. Nam facilisis diam in velit vulputate non ultricies lectus egestas.

Blender 2.4x+

Here I put some text referred to Blender 2.4x Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse varius consequat sapien. Suspendisse sodales leo at dolor mollis sagittis. In tempor venenatis tellus sed tincidunt.

[edit] Todo

You can you this template to let people know about a todo.
Note that you can avoid to put the explanatory text. 

{{WikiTask/Todo|item}}

gives

to do
 item 
{{WikiTask/Todo}}

gives

to do
 


See also:

[edit] Onhold

You can you this template to let people know about a project being stalled for some reason.
Note that you can avoid to put the explanatory text. 

{{WikiTask/Onhold|uncertain project}}

gives

on hold
 uncertain project 
{{WikiTask/Onhold}}

gives

on hold
 


See also:

[edit] Done

You can use this template to let people know you're done with a project or a page.

Note:

  • you can avoid to put the explanatory text,
  • you can put a link to point to some useful page: in that case "done" will be linked to the url you provide. 
{{WikiTask/Done|good project}}

gives

done
 good project 
{{WikiTask/Done}}

gives

done
  
{{WikiTask/Done|click me!|link=Doc:Manual}}

gives

 click me!


See also:

[edit] Inprogress

In this template you can choose an integer number between 0 and 100 to indicate the status of your project/page.

Note:

  • you can avoid to put the explanatory text,
  • if you don't put the number, it defaults to zero,
  • you can put a link to the progress bar image, to link to some explanatory page for example. 
{{WikiTask/Inprogress|0|going to todo this page...}}

gives

in progress 0%
 going to todo this page... 
{{WikiTask/Inprogress|10|just started}}

gives

in progress 10%
 just started 
{{WikiTask/Inprogress|30|good progresses}}

gives

in progress 30%
 good progresses 
{{WikiTask/Inprogress|65|going on well}}

gives

in progress 65%
 going on well 
{{WikiTask/Inprogress|90|almost finished!}}

gives

in progress 90%
 almost finished! 
{{WikiTask/Inprogress|90}}

gives

in progress 90%
  
{{WikiTask/Inprogress}}

gives

in progress 0%
  
{{WikiTask/Inprogress|33|read the manual|link=Doc:Manual}}

gives

in progress 33%
 read the manual

clicking on the small progressbar image should send you to Doc:Manual

See also:

[edit] Priority

Use this template to indicate a level of priority for a task.

Usage:

{{Priority|low}}

returns 

{{Priority|med}}

or 

{{Priority|medium}}

returns 

{{Priority|high}}

returns 

{{Priority|exp}}

returns


You can put a link on these buttons. For example: 

{{Priority|low|link=Doc:Manual}}

returns (click on it!)

Retrieved from "http://wiki.blender.org/index.php/Meta:Guides/Templates"