Contents
 Welcome
 Getting Started
    How to Order
    How to Get Support
    Online Information
    What is a Static Help System?
    What is a Dynamic Help System?
    What is a PDF Manual?
    End-User License Agreement
 Installation
    System Requirements
    Installing IIS
    Installing the Software
    Entering Your Activation Key
    How to run the software
    URL Parameters
    Service Pack History
 Basic Functions
    Projects
       Creating a New Project
       Editing a Project
       Deleting a Project
       Copying a Project
       Backing up Your Project
       Uploading a Project
       Setting Project Properties
    Context-sensitive Help
       Windows Applications
          Windows Application Help Button
          Windows Form Help Button
          Windows Field Help Button
          Windows F1 Application Help
          Windows F1 Form Help
          Windows F1 Field Help
       Web Applications
          Web Application Help Button
          Web Form Help Button
          Web Field Help Button
          Web F1 Application Help
          Web F1 Form Help
          Web F1 Field Help
          Popups
          Callouts
    Skins
       Applying Skins
       Customizing an Existing Skin
       Creating a New Skin
    Table of Contents
       Adding a Page
       Adding an External Page
       Adding an Embedded Project
       Renaming a Page
       Deleting a Page
       Page Properties
       Page Styles
       Treeview Styles
       Dragging & Dropping Pages
    Working with Tables
       Adding a Table
       Table Properties
       Cell Properties
    Working with Images
       Adding an Image
       Uploading an Image
       Image Properties
       Adding Hotspots to an Image
    Keywords and Index
       Display Keywords in Edit Mode
       Display Index in Live Mode
    Links
       Adding Page Links
       Adding Internet Links
       Adding Email Links
       Adding Document Links
       Removing a Link
    Publishing
       Publishing a Static Help System
       Static Help System Options
       Uploading to your Website
       Legacy Help System
       Publishing a Dynamic Help System
       Publishing a PDF Manual
 Advanced Functions
    Movies & Animations
       Adding a Flash Animation
       Adding a Media Animation
    Variables
       User Defined Variables
       HTML Snippets
       System Variables
    Conditional Content
       Conditional Pages
       Conditional Text
    Templates
       Customizing a Page Template
       Creating a Page Template
       Customizing the PDF Template
       Creating a Project Template
       Editing a Project Template
       Deleting a Project Template
    Security
       Project Login
       Application Login
       Adding a Project Username
       Editing a Project Username
       Deleting a Project Username
       Adding an Application Username
       Editing an Application Username
       Deleting an Application Username
       Page Security
 Toolbar Reference
    System Toolbar
    Contents Toolbar
    Editor Toolbar
    Function Toolbar
    Skin Editor Toolbar
    Snippet Editor Toolbar
 FAQ
    General Questions
    Installation Questions
  
Index

Home > Installation > URL Parameters

URL Parameters





Dynamic Help Console Parameters

Parameter  

Description

Mode

Starts the project in either live mode or edit mode.

Syntax: Mode=live|edit
Example1: WebServer1/helpconsole2007/Help Project/?mode=live
Example2: http://www.company.com/help/Help Project/?mode=live
Example3: http://www.company.com/help/Help Project/?mode=edit

Note: the user must have 'design' permissions to open a project in edit mode.

Page

Displays the specified page when a help system is opened.

Syntax: Page=<Page Filename>
Example1: WebServer1/helpconsole2007/Help Project/?page=faq_legacy.htm
Example2: http://www.company.com/help/Help Project/?page=faq_legacy.htm

Skin

Applies the specified skin when a help system is opened.

Syntax: Skin=<SkinName>
Example1: WebServer1/helpconsole2007/Help Project/?skin=blue
Example2: http://www.company.com/help/Help Project/?skin=blue

 

 

Note: Place a question mark (?) before the first parameter and an ampersand (&) before additional parameters.
Example - WebServer1/helpconsole2007/Help Project/?mode=edit&skin=blue


Static Help Console Parameters

Parameter  

Description

Page

Displays the specified page when the help system is opened.

Syntax: ?<Page Filename>
Example1: WebServer1/helpconsole2007/Help Project/static/default.htm?faq.htm

Example2: WebServer1/MyApp/help/default.htm?faq.htm
* This assumes that your application is running under the virtual directory "MyApp" and the folder containing your help system is named "help"

Example3: http://www.company.com/help/default.htm?faq_legacy.htm
* This assumes that your application is running on the domain "company.com" and the folder containing your help system is named "help"

 

 

 

 



See also
System Requirements
Installing IIS
Installing the Software
Entering Your Activation Key
How to run the software
Service Pack History


 

   
HelpConsole 2007 - Professional

Copyright © 2004 - 2007 Extreme Ease Software Inc. All Rights Reserved.