From WRM

Contents 1 WoW Raid Manager Configuration Reference 1.1 Version Information Section 1.2 Site Configuration Section 1.3 Guild Configuration Section 1.4 Role Configuration Section 1.5 Raid Settings Configuration Section

[edit] WoW Raid Manager Configuration Reference

The intent of this page is to provide a complete reference for all of the items on the configuration page of WoW Raid Manager. Please see the sections below for information on each configuration item.

This information is Up-to-Date as of Version 3.5.1 of WoW Raid Manager.

[edit] Version Information Section

The version information section is the "New Version Check" for phpRaid/WoW Raid Manager. This section goes out to the wowraidmanager.net website and checks for information about the current version of the application.

The following image shows how the screen will look when the version check is successful and you are running the most recent version of the software.

The following image shows how the section looks when you are running a version that is not the tip version as reported by my website.

If you see the above, it's time to head to the website and get ahold of the most recent version. This check is simply a webpage hit, if my website is ever down your site may report that it can't make a connection, this will not delay your screen load and will correct itself the next time you hit the configuration page (after the site comes back up.)

[edit] Site Configuration Section

The site configuration section is used to define most of the way the phpRaid application and the website (and other websites) interact with each other.

(Note: The picture above is representative of a point in time snapshot of the section, it may or may not contain all of the available items, please see the configuration reference below for the fully updated information on each configuration item.)

The site configuration section is intended to contain items that support the WRM website itself. The configuration items and their respective uses are described below:

• Addon URL - In the "LUA Output Raids" link, this controls the URL that appears after the text: "LUA/Macro Output -"
• Path to header image - The path to the image that appears in the upper left hand corner of the WRM header (above the menu). Changing this to a graphic of your own will change the header to one that applies more to your guild.
• Registration URL - The URL pointing to the page that allows a user to register as a user for WRM. The default value sends you to the WRM registration page. If you are using a bridge (phpBB, e107, etc.) the register link should probably point to your main site so that the users can sign up for the main site and thus get access to WRM at the same time. Note that when using a bridge the "Register" link on the left side is hidden so this value is of little use with a bridge installed, though it should still be set properly.
• "Home" Link Points To - When the user clicks the "Home" menu item, this is the URL to which they're taken. For standalone WRM installations being taken back to the same place as the "Main Page" link is probably fine. For those integrating WRM as an application inside a larger website, it is recommended that the "home" link take the user to the main website.
• RSS: URL to phpRaid Installation (No Trailing /) - This is the URL to the root of the WRM installation. "http://my.website.url/wrm".
• RSS: Site to export RSS feed to - If using the RSS Feature to export the raid list to an external CMS, set the base URL of the website you are exporting to. This is used in the XML header of the RSS feed.
• RSS: Number of Raids to Show in Feed - The number of raids (from the raid that is closest to starting to the current date) to show on the RSS feed. Set this to the maximum number of raids you want any RSS feed to show. Most RSS readers have the ability to limit the number of items they pull from the feed. If you have one reader pulling 5 items and one reader pulling 10 items, you'll want to set this config item to at least 10.
• Default Group - The selected group here will be applied to all new users upon account creation. This is a major time saving / adminstration hassle relief item. Create a basic "users" group with generic permissions (typically just the "Profile" permission) and then select that group here. When a new user is created he or she will automatically get this permission set and there will be no need to assign each user to a permission group for them to create characters and sign up for raids.
• Language - Controls the language for the WRM installation. Change this to change the display language of all the text on the WRM Website.
• Template - Allows selection of a different template than the "default" (SpiffyJr) template if other templates are installed. Note that the header image also needs to be changed (See "Path to header image" above) to integrate any new header images for the new theme. Changing the theme but failing to change the header image above could result in a theme that looks weird (at best) or lacks full functionality.
• Date format - The format that dates should be displayed in. This is a special "code" that tells the software how to format dates for display. The "Help" link takes you to the "Date" reference manual for PHP. Note that this is JUST the display for the Year, Month and Day, NOT the Time, Day of Week, etc. A couple of basic examples are below:
  • If you wish to display: "01/15/2008", your format code is: m/d/Y
  • If you wish to display: "08/01/15", your format code is: y/m/d
  • If you wish to display: "15/01/2008", your format code is: d/m/Y
  • If you wish to display: "Jan 15, 2008", your format code is: M d, Y
  • If you wish to display: "15, January - 08", your format code is: d, F - y
• Time format - The format that times should be displayed in. This is a special "code" that tells the software how to format times for proper display. The "help" link again takes you to the "Date" reference manual for PHP. Note that this is JUST the Time display, not the Date display. For those areas displaying date/time together the Date configuration item and the "time" configuration item are appended to each other. A couple of basic examples for time display are below:
  • If you wish to display: "8:30 pm", your format code is: g:i a
  • If you wish to display: "08:30 PM", your format code is: h:i A
  • If you wish to display: "20:30", your format code is: H:i
  • If you wish to display: "8:30:50 pm", your format code is g:i:s a
• Schedule Raids in 12h/24h format - This dropdown changes the way the "new raid" area looks. If the configuration item is 12h format, you will see a dropdown in the new raids form for Hour (1-12), Minute (0, 15, 30, 45), and AM/PM. If the configuration item is 24h format, you will see dropdowns in the new raids form for Hour (0 - 23) and Minute (0, 15, 30, 45). Note that this setting is entirely and completely separate from the Date and Time format listed above. After scheduling the raid, the raid times will be displayed in WRM tables as the Date/Time format above. In other words scheduling a raid in 24 hour format will not display the raid times in the tables in 24 hour format unless you have your "time format" set for 24 hour display. This item is simply a convenience item for raid leaders who prefer to think in 24 hour time format, or for international users who are used to scheduling things in 24 hour format.
• Disable phpRaid - Checking this box will "lock" WRM for all users but the administrator. When this is checked, accessing any pages (other than for the admin) will display a warning that the site is unusable at the moment. This flag can be put to good use when trying to track down a problem or when upgrading to a new version.
• Debug mode - This item is for future use. It has no use at the moment. Setting this on or off has no meaning.
• Show addon link - Turns on/off the display of the URL after the "LUA/Macro Output -" on the lua output raids page. This works in conjunction with the "Addon URL" above.
• Show id in tables - Turns on the display of the database "ID" Fields found in the WRM tables. These are auto-number primary keys for each table and provide the "linking values" between tables. These ID fields are unlikely to make much sense to the non-initiated and will have no real meaning to users. This should be used only in the case of attempting to debug problems with the database (e.g. cross linked data, etc.).
• Enable groups - Turns on support for 5 man groups in WRM. This causes several major changes to occur in the WRM code, the largest of which is that users without the "raids" permission are given access to the "raids" page and the "New Raids" button/form (allowing them to schedule a group). Locations can be locked/unlocked allowing for certain raids to be scheduled by raid leaders only and others (like 5 man dungeons) to be scheduled by normal users. See the "help" link under "Enable Groups" for more information about the Enable Groups setting.

[edit] Guild Configuration Section

The guild configuration section is used to define the main guild associated with the WRM installation. It also assists with the setup of the armory linking and other guild/character/server based information for the WRM configuration.

(Note: The picture above is representative of a point in time snapshot of the section, it may or may not contain all of the available items, please see the configuration reference below for the fully updated information on each configuration item.)

The guild configuration section is intended to contain items that define WoW Based Information such as Server, Guild Name, etc. The configuration items and their respective uses are described below:

• Name - This is the guild name. Generally WRM is hosted by one guild (even though several guilds can use one raid manager, generally one guild is the "host"). This is the guild name of that guild. It is used in the armory lookup process so it must be IDENTICAL in all respects to that recognized by the World of Warcraft Armory (including special characters, etc.). Note that this does NOT fill in the guild section in the guild's link in WRM...that must be done separately.
• Description - A quick description of the guild. This is a free-form field that is used for informational purposes only.
• Server - The World of Warcraft server the guild resides on (for instance, Alleria). This must be, again, an EXACT name as recognized by the World of Warcraft Armory.
• Faction - Alliance / Horde. This dropdown switches the WRM Software between the alliance and horde factions for things like profile creation (what races are available), and other display/usage items.
• Correct Armory Link for Server - There are 4 "armory" servers for World of Warcraft, each server serves a specific world region (for instance eu.wowarmory.com supports the European Union countries). Select the armory server that is closest to you / your region. Not all armory servers contain all armory data! My guild being on an American server only shows up on the www.wowarmory.com site, it does not show up on the eu.wowarmory.com site. Make sure you select the correct armory link for your guild/server.
• Language Code for Armory - This is the language code (international code) supported by the selected armory. For instance, I believe the EU armory supports: en/de/es/fr/uk. I can't find much documentation on this, try the language code for your specific country to see if it works. Note that this setting determines the data format for the return from the armory. If you set "fr" as your language code, the data returned from the armory will all be in french.
• Timezone - An important setting, set the timezone for your guild. Generally this should be the timezone for how you schedule raids. Most guilds will use the timezone of the server (so that times displayed are in server time) but some guilds will use the timezone of the majority of their users. The times in WRM are calculated using GMT + Timezone + DST (Daylight Savings Time, see below). Failing to set an appropriate Timezone will cause all scheduled raids in the system to be displayed at the wrong time.
• Daylight saving time? - Used as described above in "Timezone", this checkbox sets or unsets daylight savings time. It should be set/unset as DST comes and goes.

[edit] Role Configuration Section

The role configuration section is used to define the various roles associated with the profiles in WRM, as well as setting the view type for raid view.

(Note: The picture above is representative of a point in time snapshot of the section, it may or may not contain all of the available items, please see the configuration reference below for the fully updated information on each configuration item.)

The configuration items and their respective uses are described below:

• Class Role #X - Where X is 1 - 6. See Role Usage in WRM for information regarding roles and their uses in WRM.
• Select Raid View Type - This dropdown selects how the raid view (when you click on a raid named link, like on the front page or in the calendar) looks. If "By Class" is selected, the raid view will display the drafted members of the raid broken down by class (Warrior, Paladin, Shaman, etc.), this is the view everyone is used to (through v3.5.0). If "By Role" is selected, the raid drafted display will be broken down by the defined roles as listed in "Class Role #" above. See Role Usage in WRM for more information on how roles pertain and are used within WRM.

Note: Any items left "blank" (as in #5 and #6 in the picture above) will cause those roles not to be displayed or used within the software. These roles are not selectable nor are they displayed, in other words, blanking out a role "deletes" it from use.

Note Also, 6 roles is a maximum, there is no way to add more roles than 6 at the present time.

[edit] Raid Settings Configuration Section