Note: Please go to docs.rightscale.com to access the current RightScale documentation set. Also, feel free to Chat with us!
Home > Reference Info > Dashboard Help Text > Library_admin_help_texts

Library_admin_help_texts

Table of Contents

New

Help Text

To add help text to any page, use the following naming convention to create the "help key" <controller><action> key. For example, to add help text to the ServerTemplates index page he would use "server</action>templates_index."</controller>

  • _index - This help text will appear on the component's index page
  • _show - This help text will appear when you view an individual component (Server, RightScript, ServerTemplate, etc.)
  • _new - This help text will appear when you create a new component (or launch).

To create conditional text, you must create custom keys and add code to the controller like this:


if @condition == true @helpmessagekey = "mycustomkey"

end

The help text will always appear in the same place, i.e. at the top of the view. If you require help text inside a tab, popup, or elsewhere, you can still use the help_message method to render the help text as you wish.

Settings > Help Text > New

Index

Help Text

To add help text to any page, use the following naming convention to create the "help key" <controller>_<action> key. For example, to add help text to the ServerTemplates index page he would use "server_templates_index."</action></controller>

  • _index - This help text will appear on the component's index page
  • _show - This help text will appear when you view an individual component (Server, RightScript, ServerTemplate, etc.)
  • _new - This help text will appear when you create a new component (or launch).
Tab-Sensitive Help

Tab help will be listed below general section help which appears across all tabs. To create tab-level text, add _tab_tabname after section name. Ex: servertemplates_tab_private (ServerTemplates > Private tab)

Show Icon
  • ssh - SSH into an instance
Add Links

[link text](http://mysite.com/ "hover text")

HelpText Inside Dashboard (for Developers)

To create conditional text, you must create custom keys and add code to the controller like this:


if @condition == true @help_message_key = "my_custom_key" end


To word wrapped with underbars will be italicized. You will need to escape them by adding a \ in front of the underbar.

The help text will always appear in the same place, i.e. at the top of the view. If you require help text inside a tab, popup, or elsewhere, you can still use the help_message method to render the help text as you wish.

Settings > Admin > Help Text > Index

- -

You must to post a comment.
Last modified
08:51, 3 Jun 2013

Tags

This page has no custom tags.

Classifications

This page has no classifications.

Announcements

None


© 2006-2014 RightScale, Inc. All rights reserved.
RightScale is a registered trademark of RightScale, Inc. All other products and services may be trademarks or servicemarks of their respective owners.