Main.php MENU

From FMYiRCWiki

Freemed-YiRC: main.php Menu Help Page

Contents 1 Summary 2 Menu Layout 2.1 Layout Pros and Cons 3 Menu Sections 3.1 TOP 3.2 User Menu Options 3.3 Group Menu Selection 3.4 Other Options 3.5 CFS 3.6 Timecard 3.7 E-Mail 3.8 BOTTOM 4 More Documentation

Summary

This is the main menu for a user in Freemed-YiRC. This menu can look very different from user to user as it depends upon which security permissions a user has access to, as well as which modules are enabled in your Freemed-YiRC installation.

Menu Layout

The main menu typically is a narrow-width (single column) menu divided into sections vertically. With the release of Freemed-YiRC V1.10 users also have the option of setting up their main menu using multiple columns (two to three columns depending upon which modules are enabled in Freemed-YiRC). This option can be located by clicking the My Preferences link on the bottom of a users main menu and setting the main_menu_multi_cols to Enabled.

• Example screen shots of a users main menu. These menus show the exact same menu options, but just layed out differently.
  • Single column:
    • 
  • Multi-column:
    • 

• An example screen shot of a user with limited access. This users menu is only two columns because they do not have access to any of the items that typically show up in the third column.
  • 

Layout Pros and Cons

• Single-Column:
  • Pros:
    • One menu option per line.
    • Can be viewed easily on mobile devices (cell phones, PDAs, etc...) or devices with small screens.
  • Cons:
    • Potentially requires a lot of scrolling if a user has access to many modules.
• Multi-Column:
  • Pros:
    • Requires less scrolling for devices with bigger/wider screens (PC/workstations, etc...)
  • Cons:
    • Not as easily viewable on mobile devices.

Menu Sections

TOP

The very top of the Freemed-YiRC window will have a blue bar with the text Freemed-YiRC. On the right-hand side of this bar will be several quick navigation icons. For more information on the use of these icons, please take the Freemed-YiRC General Tour.

User Menu Options

This section contains menu options which are not necessarily linked to groups or residents. General system options appear here. These items are in alphabetical order, with one exception.

• Staff Directory will appear first if a user has the necessary security permission to view this option.
• On a single-column main menu these items will appear first at the top of the menu.
• On a multi-column main menu these items will appear in the left-most column.

Group Menu Selection

This section contains a list of groups to which a given user has access to. Depending on the user, this list may only contain one item, or it may contain menu. Each option will take the user to the Group Menu for that given group.

• On a single-column main menu the location of this section will vary depending upon which other modules are enabled in Freemed-YiRC.
• On a multi-column main menu these items will appear in the second column.

Other Options

This section may not appear if a given user does not have any Other options defined for them. This section will always appear, however, for the root user. This section can contain miscellaneous menu options that don't quite fit into any other menu category. This list of menu options can only be modified by the root Freemed-YiRC user (i.e., the Freemed-YiRC System Administrator). This can contain misc. reports, and may also be used to create links to other web pages/sites external to Freemed-YiRC.

• On a single-column main menu the location of this section will vary depending upon which other modules are enabled in Freemed-YiRC.
• On a multi-column main menu these items will appear in the third column.

CFS

This section will only appear if one of the Freemed-YiRC modules which uses the Custom Forms System or a module that produces documents with Invoice Numbers. For most users, this section will comprise of only one menu link: Invoice Number Lookup.

• On a single-column main menu the location of this section will vary depending upon which other modules are enabled in Freemed-YiRC.
• On a multi-column main menu these items will appear in the third column.

Timecard

This section will only appear if the Timecard Module is enabled AND the user has at least the Access security database permission for the timecard system. This section allows for quick access to viewing a users own timecard, as well as clocking on duty and off duty functions.

• On a single-column main menu the location of this section will vary depending upon which other modules are enabled in Freemed-YiRC.
• On a multi-column main menu these items will appear in the third column.

E-Mail

This section will only appear if the E-Mail Module is enabled. This section allows for quick access to the e-mail system, and includes displaying the number of unread e-mails at a glance. It also provides a quick link to create a new e-mail.

• On a single-column main menu the location of this section will appear last if enabled.
• On a multi-column main menu these items will appear in the third column.

BOTTOM

At the bottom of a users main menu there may be several items:

• A link to My Preferences - This provides a quick link to allow a user to modify options specific to that user.
• A link to Settings - This ONLY appears for the root user. This provides a link to the system settings menu.
• User name
• DB Server - This ONLY appears for the root user. This gives a quick indication as to which DB server is being used. This is helpful in environments where multiple (replicating) DB servers may be in use.

More Documentation

For more introductory information on using Freemed-YiRC, please take the General Tour!