Difference between revisions of "Viewer Help Templates"

Revision as of 09:45, 28 October 2011

General notes

Category: All Viewer help templates are in Category:Viewer Help Templates.

Special CSS style: The special style to use when you want to see something in the wiki, but not in help content is

<div class="help-hidden">.... <div/>

Transclusion issue:

If you change a template or any page, but don't change a page that uses (transcludes) that page, the help app will not recognize that the page content has changed and so will not pick up the change. You MUST either edit the page to make it update or request a rebuild via Rebuild Request.

See http://jira.secondlife.com/browse/EXT-4054

Work in progress templates

Template:Help Placeholder - Use to add text to articles for help app testing purposes. Also puts the article in Category:Missing Help Articles, which we may use for management.
Template:tbd - Use to denote a section that has missing information. Use it with no parameter just to highlight the section; use with a single parameter to comment. Puts the article in Category:Help Articles with Missing Information. Examples:
- Blah - Does foo Information needed! .
- Blah - Does foo Information needed! There is some info missing here! xxxx.

Template:red - Somewhat overlaps with "tbd" but is a lot more time-sensitive, Torley uses it to SCREAM AT HIM for followup research notes, Issue Tracker bug-reporting, and soforth. Some of these may stabilize to tbd; else, they should be cleared ASAP.
- Template:redbug - Specifically used for issues you want to report on the Issue Tracker. Once reported, change the template instance to link to the specific bug so we can keep track.

Obsolete articles

Use this one for articles that were moved/renamed, and are being kept around temporarily "just in case" they are needed for some reason:

Template:Obsolete Help Article - puts article in Category:Obsolete Help Articles

Categorization / Workflow templates

When you add the following templates to an article, the article is placed into the "corresponding category".

Template	Description	Corresponding Category
Template:Help Placeholder	Temporary placeholder until "real" content is added.	Category:Missing Help Articles
Template:Help WIP	Article is a work in progress. Writing and editing is ongoing. Also use this during review process to "send an article back" to the author.	Category:Help Articles in Progress
Template:Help Article Ready for Review	Article is ready for content review / tech edit.	Category:Help Articles Ready for Review
Template:Help Article Ready for Copy Edit	Article is ready for copy edit	Category:Help Articles Ready for Copy Edit
Template:Help Article Ready for Translation	Use to handoff article for localization.	Category:Help Articles Ready for Translation
Template:FROZEN Help Article - In Translation	Indicates the article is being translated and should not be modified.	Category:FROZEN Help Articles
Template:Translated Help Article	English articles: indicates article has been returned from localization; Translated articles adds "lang" variable used by other templates and categorizes by language.	* For English articles (with no parameter), adds article to Category:Translated Help Articles For translated articles (with locale code parameter), defines lang variable and adds to the appropriate category: Category:German Help Articles Category:French Help Articles Category:Japanese Help Articles
Template:Modified Translated Help Article	Indicates an article that has been edited since it was returned from translation. When handed off to localization again, move to FROZEN state.	Category:Modified Translated Help Articles

Linking, layout, and formatting templates

Template:UIref - Used for UI reference articles. No internationalization required.
Template:Xref - Link to Glossary term. Internationalized.
Template:Vh - Link to another help article, without capitalization (e.g. for task articles, contents, etc.) Internationalized.
Template:Win - Display name of Viewer window (CAPITALIZES). Not internationalized.
Template:Winlink - Link to an help UI ref article on a Viewer window (CAPITALIZES). Internationalized.
Template:Report Bug - Displays link to report bug Viewer help article. To be internationalized.
Template:SLlink - Link to a page on secondlife.com (or other LL-owned site) that has localized versions. Internationalized.

New:

Transclusion template: Template: Help Transclusion (This is not really being used currently).

Template:Advanced Feature - Use for windows that have a help button but are not to be documented.
Template:Signpost

Localization of templates

For the above templates to work with localized articles, we must include the following template at the TOP of each translated article. For example:

{{Translated Help Article|de|<date of import>}}

Indicates that the article is a German translation and defines a variable that is used to localize other templates. Also puts the article into a category called "De/<date>" for example, Category:De/17 Feb 2010 Import.

See Template:Translated Help Article.

Localization Viewer Help Template Test Page

Icon templates (2.0.0 and 2.0.1)

General UI Icons

Checkmark	Template:Icon_Activate_Checkmark
Add	Template:Icon_Add_Item
Audio	Template:Icon_Audio
Close	Template:Icon_Close
Dock	Template:Icon_Dock
Forward Arrow	Template:Icon_ForwardArrow
Group	Template:Icon_Generic_Group
Gear	Template:Icon_Gear
Help	Template:Icon_Help
Info	Template:Icon_Info
Lock	Template:Icon_Lock
Person	Template:Icon_Generic_Person
Search	Template:Icon_Search
Close Notification	Template:Icon Toast CloseBtn
Trash	Template:Icon_TrashItem
Undock	Template:Icon_Undock

Bottom bar icons

Conversations	Template:Icon_Instant_Messages
Notifications	Template:Icon_Notifications
Snapshot	Template:Icon_Snapshot
Voice Off	Template:Icon_Voice_Off
Voice On	Template:Icon_Voice_On

Camera & Movement Icons

See as avatar	Template:Icon_Cam_Avatar
View object	Template:Icon_Cam_Free
Orbit camera	Template:Icon_Cam_Orbit
Pan camera	Template:Icon_Cam_Pan
Flying mode	Template:Icon_Move_Fly
Running mode	Template:Icon_Move_Run
Walking mode	Template:Icon_Move_Walk
Rear View	Template:Icon_Cam_Back
Front View	Template:Icon_Cam_Front
Group View	Template:Icon_Cam_Group
Mouselook View	Template:Icon_Cam_Mouselook

Sidebar Icons

Home	Template:TabIcon_Home
Open	Template:TabIcon_Open
Close	Template:TabIcon_Close
People	Template:TabIcon_People
Places	Template:TabIcon_Places
My Profile	Template:TabIcon_Profile
My Appearance	Template:TabIcon_Appearance
My Inventory	Template:TabIcon_Inventory

Media Icons

Back	Template:WebIcon_Back
Forward	Template:WebIcon_Forward
External Browser	Template:WebIcon_External_Browser
Home	Template:WebIcon_Home
Refresh	Template:WebIcon_Refresh
Stop	Template:WebIcon_Stop
Zoom Out	Template:WebIcon_Zoom_Out
Zoom In	Template:WebIcon_Zoom_In
Damage	Template:WebIcon_Damage
Health	Template:WebIcon_Health
Flag	Template:WebIcon_Flag
Lock	Template:WebIcon_Lock

Pause	Template:WebIcon_Pause
Play	Template:WebIcon_Play
Skip Backward	Template:WebIcon_Skip_Back
Skip Forward	Template:WebIcon_Skip_Forward
Stop	Template:WebIcon_Stop_Playback

Power Off	Template:Icon_Power_Off
Power On	Template:Icon_Power_On

Content Permissions Icons

Note: These are very similar to the Inventory icons and names, but the differences were great enough that I decided they needed to be a separate set.

Animations	Template:InvIcon_Animations
Body Parts	Template:InvIcon_Body_Parts
Clothing	Template:InvIcon_Clothing
Gestures	Template:InvIcon_Gestures
Notecards	Template:InvIcon_Notecards
Objects	Template:InvIcon_Objects
Scripts	Template:InvIcon_Scripts
Sounds	Template:InvIcon_Sounds
Textures	Template:InvIcon_Textures

Inventory Icons

Note: These are very similar to the Content Permissions icons, but there are ultimately more of them, and they are named differently.

Animation	Template:InvIcon_Animation
Shape	Template:InvIcon_BodyShape
Calling Card	Template:InvIcon_CallingCard
Collapse	Template:InvIcon DisclosureArrow Closed
Expand	Template:InvIcon DisclosureArrow Opened
Clothing	Template:InvIcon_Clothing
Eyes	Template:InvIcon_Eyes
Folder	Template:InvIcon_FolderClosed
Gesture	Template:InvIcon_Gesture
Gloves	Template:InvIcon_Gloves
Hair	Template:InvIcon_Hair
Jacket	Template:InvIcon_Jacket
Landmark	Template:InvIcon_Landmark
Link	Template:InvIcon_LinkItem
Broken Link	Template:InvIcon_LinkItem_Broken
Look Folder	Template:InvIcon_LookFolderClosed
Notecard	Template:InvIcon_Notecard
Object	Template:InvIcon_Object
Pants	Template:InvIcon_Pants
Script	Template:InvIcon_Script
Shirt	Template:InvIcon_Shirt
Shoes	Template:InvIcon_Shoe
Skin	Template:InvIcon_Skin
Skirt	Template:InvIcon_Skirt
Snapshot	Template:InvIcon_Snapshot
Socks	Template:InvIcon_Socks
Sound	Template:InvIcon_Sound
Tattoo	Template:InvIcon_Tattoo
Texture	Template:InvIcon_Texture
Trash	Template:InvIcon_Trash
Underpants	Template:InvIcon_Underpants
Undershirt	Template:InvIcon_Undershirt

Build Tools Icons

Focus	Template:ToolIcon_Focus
Move	Template:ToolIcon_Move
Edit	Template:ToolIcon_Edit
Create	Template:ToolIcon_Create
Land	Template:ToolIcon_Land

Cube	Template:ToolIcon_Cube
Prism	Template:ToolIcon_Prism
Pyramid	Template:ToolIcon_Pyramid
Tetrahedron	Template:ToolIcon_Tetrahedron
Cylinder	Template:ToolIcon_Cylinder
Hemicylinder	Template:ToolIcon_Hemicylinder
Cone	Template:ToolIcon_Cone
Hemicone	Template:ToolIcon_Hemicone
Sphere	Template:ToolIcon_Sphere
Hemisphere	Template:ToolIcon_Hemisphere
Torus	Template:ToolIcon_Torus
Tube	Template:ToolIcon_Tube
Ring	Template:ToolIcon_Ring
Tree	Template:ToolIcon_Tree
Grass	Template:ToolIcon_Grass

Adult Content

Please talk to Torley if you want to make changes to these. Per CR-8179, they're dependent on Adult Content team's work! Eventually they should be localized like other templates.

General	Template:Mrg
Moderate	Template:Mrm
Adult	Template:Mra