Meta:Guides/Templates
目次
Wiki Templates
There are a few templates defined on this Wiki. To enhance readability and consistency you are kindly requested to use them.
Shortcut
Put a sequence of up to 5 keys to show a shortcut:
{{Shortcut|<key1>|<key2>|...|...}}
Examples
- {{Shortcut|cmd|shift|S}} returns ⌘ Cmd⇧ ShiftS
- {{Shortcut|ctrl|alt|X}} returns CtrlAltX
- {{Shortcut|ctrl|alt|shift|pad3}} returns CtrlAlt⇧ Shift3 NumPad
- {{Shortcut|shift|mmb}} returns ⇧ ShiftMMB
- to join a shortcut and a menu (see Template:Menu):
- {{Shortcut|shift|a}}{{Menu|type=popup|Add|Mesh|Cube}} returns ⇧ ShiftA » Add » Mesh » Cube
Mouse hotkeys
You can use the symbols below:
(icons from the Tango Desktop Project)
Keyboard hotkeys
Apart from using normal letters and words, you can use the symbols below:
wikitext | you get |
---|---|
{{Shortcut/Keypress|alt}} | Alt |
{{Shortcut/Keypress|backspace}} | ← Backspace |
{{Shortcut/Keypress|cmd}} | ⌘ Cmd |
{{Shortcut/Keypress|ctrl}} | Ctrl |
{{Shortcut/Keypress|enter}} | ↵ Enter |
{{Shortcut/Keypress|end}} | ⇥ End |
{{Shortcut/Keypress|esc}} | Esc |
{{Shortcut/Keypress|home}} | ↖ Home |
{{Shortcut/Keypress|opt}} | ⌥ Opt |
{{Shortcut/Keypress|shift}} | ⇧ Shift |
{{Shortcut/Keypress|tab}} | ⇆ Tab |
{{Shortcut/Keypress|space}} | Space |
{{Shortcut/Keypress|left}} | ← |
{{Shortcut/Keypress|right}} | → |
{{Shortcut/Keypress|up}} | ↑ |
{{Shortcut/Keypress|down}} | ↓ |
{{Shortcut/Keypress|pgup}} | PageUp |
{{Shortcut/Keypress|pgdown}} | PageDown |
{{Shortcut/Keypress|pad.}} | . NumPad |
{{Shortcut/Keypress|pad0}} | 0 NumPad |
{{Shortcut/Keypress|pad1}} | 1 NumPad |
{{Shortcut/Keypress|pad2}} | 2 NumPad |
{{Shortcut/Keypress|pad3}} | 3 NumPad |
{{Shortcut/Keypress|pad4}} | 4 NumPad |
{{Shortcut/Keypress|pad5}} | 5 NumPad |
{{Shortcut/Keypress|pad6}} | 6 NumPad |
{{Shortcut/Keypress|pad7}} | 7 NumPad |
{{Shortcut/Keypress|pad8}} | 8 NumPad |
{{Shortcut/Keypress|pad9}} | 9 NumPad |
{{Shortcut/Keypress|pad+}} | + NumPad |
{{Shortcut/Keypress|pad-}} | - NumPad |
{{Shortcut/Keypress|pad*}} | * NumPad |
{{Shortcut/Keypress|pad/}} | / NumPad |
{{Shortcut/Keypress|pad-enter}} | ↵ NumPad |
See also: Template:Button and Template:Menu
User Interface Button
Use this template to show a User Interface button.
Example
Press the button {{Button|Duplicate}}.
returns:
Press the button Duplicate.
See also Template:Shortcut
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. Up to 9 menu levels are supported.
Examples
Import a .obj with {{Menu|File|Import|Wavefront (.obj)…}}.
Results in:
Import a .obj with File » Import » Wavefront (.obj)….
If used in combination with a {{shortcut}} template, you can continue a shotcut in a menu.
{{Menu|{{shortcut|shift|a}}|Add|Mesh|Cube}}
Results in: ⇧ ShiftA » Add » Mesh » Cube
See also: Template:Shortcut
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.
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.
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.
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
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
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.
Examples
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.
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.
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
item
{{WikiTask/Todo}}
gives
See also:
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
uncertain project
{{WikiTask/Onhold}}
gives
See also:
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
good project
{{WikiTask/Done}}
gives
{{WikiTask/Done|click me!|link=Doc:Manual}}
gives
click me!
See also:
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
going to todo this page...
{{WikiTask/Inprogress|10|just started}}
gives
just started
{{WikiTask/Inprogress|30|good progresses}}
gives
good progresses
{{WikiTask/Inprogress|65|going on well}}
gives
going on well
{{WikiTask/Inprogress|90|almost finished!}}
gives
almost finished!
{{WikiTask/Inprogress|90}}
gives
{{WikiTask/Inprogress}}
gives
{{WikiTask/Inprogress|33|read the manual|link=Doc:Manual}}
gives
read the manual
clicking on the small progressbar image should send you to Doc:Manual
See also:
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}}
Nowrap
The {{nowrap}} template prevents line wraps in text and links containing spaces. An example could be:
I was born on the {{nowrap|24th of December}} in Florida.
No matter how wide your screen is the date will never be wrapped around into a new line.