AgileApps Support Wiki Pre Release

Difference between revisions of "Application Help Tab"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 14: Line 14:
This sample help page is derived from [https://empower.softwareag.com/Products/FeatureRequestsInBrainstorm/default.asp Brainstorm]--an application built on the {{EnterpriseBrand}} that allows customers to file requests for features they would like to see.  
This sample help page is derived from [https://empower.softwareag.com/Products/FeatureRequestsInBrainstorm/default.asp Brainstorm]--an application built on the {{EnterpriseBrand}} that allows customers to file requests for features they would like to see.  


{{Important|<br>When make sure that HEADER FILES are OFF when creating the file. With headers on, JSP tags are available, but links don't work.
{{Important|<br>When make sure that HEADER FILES are OFF when creating the file. With headers on, JSP tags are available, but links don't work. Turning them off creates a vanilla HTML page.<br>''Learn more:'' [[Pages#About Header Files]]  
  Turning them off creates a vanilla HTML page.<br>''Learn more:'' [[Pages#About Header Files]]  
}}
}}



Revision as of 18:32, 20 May 2015

An application help tab gives application users a tab they can click on to get information instructions, or answers to frequently asked questions.

To create an application Help tab:

  1. Go to GearIcon.png > Developer Resources > Pages and create a JSP page.
    Be sure to turn off headers on the page you create.
    With headers on, jQuery and other platform features become available--but links fail.
    When off, you have a normal HTML page--and links work.
  2. GearIcon.png > Developer Resources > Web Tabs and create a new tab from that page.
  3. If needed, go to GearIcon.png > Preferences > Tab Preferences and specify which Roles can see the tab.
    (By default, it is available to all. Use this option to selectively turn it off.)

Sample: Self-Contained Help Page

This sample help page is derived from Brainstorm--an application built on the AgileApps Cloud platform that allows customers to file requests for features they would like to see.

Warn.png

Important:
When make sure that HEADER FILES are OFF when creating the file. With headers on, JSP tags are available, but links don't work. Turning them off creates a vanilla HTML page.
Learn more: Pages#About Header Files

The resulting page looks like this:

SampleHelpTab.png

Here is the code:

<syntaxhighlight lang="java" enclose="div">

<html> <head>

 <style>
   heading
   { 
    font-weight: bold;
    font-size: 3em;
   }
   a.rightAlign
   {
    font-size: .8em;
    position: absolute;
    right: 0px;
    width: 10%;
   }
   a.top
   {
    font-size: .7em; 
   }
   p.links
   {
    font-size: .8em;
    //text-align: center;
               line-height: 2;      
   }
   p.question
   {   
    font-weight: bold;
    font-size: 1em;
   }
   p.answer, li
   {     
     font-size: .8em;
   }
   body
   {
    font-family: arial;
    margin-left: 10px;  
                margin-right: 10px;
   }
 </style>  

</head>

<body>

 <heading>FAQ</heading>
 <a id = "pagetop" class = "rightAlign" href="#moreinfo">Contact Us</a> 

   


<a id="whatisapp">What is this app? </a> <a class = "top" href="#pagetop">[top]</a>

This app is...

<a id="more info">Is more info available? </a> <a class = "top" href="#pagetop">[top]</a>

Yes, you can send any queries or suggestions to <a href="MAILTO:someaddress@somecompany.com">someaddress@somecompany.com</a>.

</body> </html> </syntaxhighlight>