Viewerhelp:Layout Testbed

From Second Life Wiki
Jump to: navigation, search

This is an article to see how various things look in the Viewer help skin.

Examples of using window templates

There are two templates that will capitalize window names:

  • Template:win simply capitalizes whatever you provide as the single parameter.
  • Template:winlink creates a link to the article (without the "Viewerhelp:" namespace) provided as the first parameter; the optional second parameter is the display text, which defaults to the value of the first parameter. It also capitalizes the text.

Using the win template

This wikitext:

Use the {{Win|Environment Editor}} to change its appearance.

Results in:

Use the Environment Editor to change its appearance.

Using the Winlink template

This wikitext

Click the '''Hardware''' button to open the {{Winlink|Preferences - Graphics - Hardware Settings|Hardware Settings}} window.

Results in:

Click the Hardware button to open the Hardware Settings window.

This wikitext:

{{Winlink|About - Credits}}

Results in:

About - Credits

Issue around styling standards

We should attempt to use consistent format and styling wherever possible within help. Also keep in mind that much help content may be transclued into KB articles. So using the same conventions as the KB makes sense. HOWEVER, the skin looks different, and that may not always make sense....

Help stylesheet

Help has its own CSS; therefore, any styles we want to carry over from the wiki (i.e. defined in Mediawiki:Common.css, we will need to specifically tell Makai. However, inline styles, such as used in some templates will work just fine.

TOCs

Generally there won't be much call for table of contents; except for certain very long articles, e.g. Viewerhelp:Glossary. The TOC needs better styling in the help skin.

UI reference

Propose to use Jeremy's template Template:UIref that puts each UI widget be a table, versus the the articles imported from XUI file that puts each UI widget in a head 3, for: Viewerhelp:Advanced_Water_Editor_-_Settings

Tables

There may not be much call for tables in help, but just in case, here is the standard KB help table. Let's make sure it looks OK in the help skin:

Column A Column B Column C
Row A fill in these
Row B values and win

Images

Again, images may not be as common in help articles, but we may want to adopt some standards. TBD at this point.

KB Templates

NEED TO MAKE SURE ALL THE KB TEMPLATES HAVE THE "font: black" in the inline CSS. Otherwise, they are unreadable.

KBwarning.png Warning: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

KBcaution.png Important: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

KBtip2.png Tip: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

KBnote.png Note: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.


Typographical conventions

UI elements

Style guide says that all UI elements are referred to in bold text.

Files, paths, URLs, code, and other typed user input

Use KB Style Guide.

IMPORTANT: NEED TO MAKE SURE HELP CSS HAS THE SAME STYLING, e.g. for code tag.

Use the "<code>" tag to show a background-colored, fixed-pitch font for file names, directory paths, URLs (or portions thereof), code snippets, and other typed user input. For example:

  • Look in C:\Program Files\Second Life\app_settings\.
  • Edit the settings.xml file.
  • Retrieve your capability from https://cap.secondlife.com/get_reg_capabilities
  • Use the max_results query parameter to limit the number of results returned.
  • Use the AgentLimit object to programmatically limit the number of agents present in a Region.
  • In the top box, type 512.
  • In the Region field, type Sandbox Newcomb.

Changes to KB templates

It is possible for KB templates to detect whether they are transcluded into a KB or VH article, and change their appearance accordingly. Example:

Template:TestKBWarning

Copyright Linden Research, Inc. All rights reserved.