ZBrushInfo Templates

From ZBrush Info

What Are Templates?

Roughly speaking, a Template is equivalent to a style in a standard word processor. It allows you to apply a visual effect to text or paragraphs in such a manner that if the appearance of the template is later changed, that change will automatically be used wherever in the wiki that template was used.

As a concrete example, consider the "Important" template defined below. At some point in the future, we might decide that "important" notes should be made even more prominent by giving them a red background; this could be done simply by modifying the template, and then any text in the wiki that was enclosed in an "Important" template would also be displayed with a red background.

How Are Templates Used?

In markup, most templates are used very simply; they are just enclosed in double braces, with the template name coming first, followed by a "|", followed by the text to which the template applies:

{{TemplateName|Text to which template applies.}}

The following describes the templates that should be used in ZBrushInfo to maintain a consistent appearance across all pages. For each template, the template name and description of how it should be used is given, followed by an example of how the template would appear in ZBrushInfo markup, followed by an example of what is finally displayed by that markup.

Templates Defined for Use in ZBrushInfo

Font Style Templates

• Def Template: This is used when first defining a word or phrase the user may not be familiar with. Later instances of the same word are phrase on the same page are typed normally.

  An {{Def|alpha}} is a grayscale image. In ZBrush you can use an alpha to render displacement, to... .

  An alpha is a grayscale image. In ZBrush you can use an alpha to render displacement, to... .

• Em Template: Emphasizes text. Similar to italicizing text, but correctly handles the case of emphasized text inside of emphasized text.

  Proper grammar is "{{Em|I'm feeling {{Em|well}}}}".

  Proper grammar is "I'm feeling well'".

• Bold Template: Bold text.

  Proper grammar is "{{Bold|I'm feeling well}}".

  Proper grammar is "I'm feeling well".

• Ctl Template: Used to give the names of ZBrush controls a standard appearance. Note that the ":" symbol should be used to separate ZBrush menus and submenus.

  In ZBrush, {{Ctl|Edit:Undo}} and {{Ctl|Edit:UNDO}} are two different options.

  In ZBrush, Edit:Undo and Edit:UNDO are two different options.

• Key Template: Used to denote shortcut keys and similar things.

  Use {{Key|Ctrl+N}} to clear the current layer.

  Use Ctrl+N to clear the current layer.

• File Template: Used for file names.

  Put {{File|ZMapper.zsc}} into the ZPlugins directory.

  Put ZMapper.zsc into the ZPlugins directory..

• InlineCode Template: Use when you want to show code without putting it in a separate paragraph. This is probably of interest mostly to ZScript and plugin developers.

  Use {{InlineCode|[VarSet, x, 3]}} to set {{InlineCode|x}} to 3.

  Use [VarSet, x, 3] to set x to 3.

Paragraph Style Templates

• Note Template: This puts text into a "note". Use it to indicate points that the user should be particularly aware of, such as nonintuitive aspects of a control or process. However, for very important items, use the Important template.

  {{Note|This is a note.}}

  Note: This is a note.

• Important Template: Similar to the 'Note' template, but used for things the user must be aware of. This should be used sparingly.

  {{Important|This is ''really important''}}

  This is really important

• Aside Use to mention things that might be of interest, but are not part of the main subject of the text.

  {{Aside|Asides are often used in poetry textbooks.}}

Image-Related Templates

• Img, ImgSm, and ImgLg Templates: Convenient shorthand for showing images in a standard (centered, framed, optional caption, and restricted to a certain width) format. Img restricts images to a "medium" width, while ImgSm and ImgLg restrict the images to smaller and larger widths.
  Using these templates (or specifying thumbnails and widths using the standard Image:... markup) can significantly reduce the displayed size and download size of "overly large" images, and thus increase page download speed and reduce the burden on the server.
  For example, the example below references an image more than 300KB in size, and occupying a standard page width.

  {{Img|Skin DCP 0168abc.jpg|Example of a large image shown at a smaller size.}}

  

  ...and even smaller (note that the caption is optional):

  {{ImgSm|Skin DCP 0168abc.jpg}}

  

  

Other Templates

• Srch Template: Allows easy insertion of 'inline searches'. Basically, these are links in the text that automatically perform a search on a predefined word or phrase when a user clicks on them.

  Pixols are a fundamental concept of ZBrush, and are {{Srch|pixols|referred to many times in the wiki}}.

  Pixols are a fundamental concept of ZBrush, and are referred to many times in the wiki.

• ToDo Template: Use to show in the markup where something still needs to be done; the text in the ToDo template is not visible, but can still be searched. To find all instances of the ToDo template, just do a search on "ToDo".

  Here {{ToDo|Insert Link}} you can see how to use ZBrush primitives.

  Here you can see how to use ZBrush primitives.

• Anchor Template: Allows easy placement of an anchor on a page. The anchor will not be visible, but can be linked to using

  [[Page#AnchorName]]

  from any other page.

  {{Anchor|ExampleAnchor}}A link of the form [[ZBrushInfo Templates#ExampleAnchor|Example Anchor]] will now open this page at this location.

  A link of the form Example Anchor will now open this page at this location.

Omitting the "piped" part of the link will result in a link that displays as ZBrushInfo Templates#ExampleAnchor. This is visually less appealing but often preferable because it makes clear where the link will take the user. For example, Material Palette#Color Bump