Introduction

This is the home of the LCLS Accelerator Operations Help System, which provides centralized HELP information about the invoking LCLS Controls application. Please note that the HELP System is not a general information system.

Confluence Accounts and Passwords

Accounts are not needed to view LCLS Help pages, which has public view access. Accounts are only required for editing pages. To request for an account with edit access to LCLS Help, complete the Confluence Account form for the group "LCLS Accelerator Operations Help System".

Confluence Account
Confluence Password Request

How-To

To add a HELP page:

  1. From anywhere in the LCLS Help Space (URL = https://confluence.slac.stanford.edu/pages/LCLSHELP/...), log in by clicking "Log In" in the upper right hand of the page
  2. Click on Add > Page in the upper right hand of the page
  3. For the page title, use the naming convention "System/Application Type - Location/Application" such as "PPS - IN20" or "HLA - SCORE"
  4. Once you have added content, click the "Save" button
  5. Select Browse > Pages in the blue bar above to organize pages.

To implement HELP from application

The Help page will be invoked by a user clicking the HELP button from within the application. A Help button with the same look and feel, as shown below, should be located at the upper right hand corner of display screens and used by all LCLS controls applications.

A browser window will display the operations-oriented instructive information about the invoking application and display. Controls will provide an example for a common HELP button and placement. Implementation of the URL should be as follows:

  • EDM: a command line procedure
  • Java: URL directly
  • Matlab: URL directly

Guidelines for HELP Authors

  • The HELP System pages should only contain information about the invoking page. It is not intended for use as a general information system. Please do not include any hyperlinks to pages outside of the HELP System or include attachments other than images displayed on the help page.
  • Style: Headings should use Heading 2, text should use Paragraph

Help Pages

Home Screen Help

  • No labels