Profile Enhancements - Customizable Roster

Customizable Roster

Introduction:

This Mod is ideal for a Guild/Clan roster, but it is also a great replacement for the memberlist. Customize it any way you like: add or remove columns with just a few easy edits. The installer includes permission control that allows you to set which groups appear on the roster and which ones can view it. The most popular option is the ability to control advanced sorting; check it out!

Click Here For A Preview

Installation:

Step 0: If you are upgrading from a previous version, save a copy of your old showroster.php and rename your showroster templates (I recommend giving them an underscore prefix; Example: _SHOWROSTER). When upgrading from version, make a copy of all your templates, then revert the templates back to their default, and then uninstall the older version. Also, make sure you delete the bitfield_showroster.xml file in the /includes/xml directory; this will cause database errors if not deleted.

Step 1: Download the showroster_vX.X.X.zip file and unzip it.

Step 2: Upload the files to their correct directories.

Upload the showroster.php to the /forum/ directory.
Delete the bitfield_showroster.xml in the /forum/includes/xml/ directory (if there).

Step 3: Admincp > Plugin & Products > Manage Products > Add/Import Product

Import the product-showroster_v4.x.x.xml file.

Step 4: Admincp > User Profile Fields > Add New/Update User Profile Field

Add all the Profile Fields you plan to use and keep track of their number(s) (i.e. field6, field7, etc.).

Step 5: Admincp > Settings > Options > ShowRoster Settings

Update the settings for your roster: usergroups allowed to view the roster, usergroups that are displayed on the roster, the title and field# for each of your columns on the roster, and any of the many other settings.

Step 6: Admincp > Styles & Templates > Expand > ShowRoster Templates > SHOWROSTER, showroster_header, and showroster_userbits

You only need to adjust these if you have custom adjustments to make. Otherwise, there is no longer a need to change these.

NOTE: See installation and upgrading instructions in the included corresponding txt files.

Version Updates: See 2nd post.
FAQ: See 3rd post.
Screenshots: See 4th post.

PLEASE CLICK INSTALLED.
Support will be given to those that do.

[IR15H]

Glad to see this has made it to vB4 .

Originally Posted by kevius

i'm sorry but, where is the sort menu ?????

Beneath the main navigation menu when you're on the Roster 'tab'.

Originally Posted by dennisuello

How do I rename the tab? I don't want it to say Roster.

Edit the template showroster_navbar, change <a class="navtab" href="showroster.php{vb:raw session.sessionurl_q}">Roster</a> to whatever you want.

-----------------------

I had a play around with the templates on my test site, mainly moving all the styling to a separate css sheet so that the table would take on the style of whatever the user was viewing in, but also the odd tweak. Below are two examples;

Grouped:


Single Table:


I also thought of some ideas/requests for future versions;

• as mentioned previously, default order is that which user group IDs are entered in the settings
• multiple rosters
• allow HTML in group titles (where my first screen shot has all the <span> stuff)
• make each group listing collapsible
• find a way to get multiple-selection user profile fields to work in the roster
• add page pagination for long rosters
• add an age column (assuming user has set age to be public)
• add a PM/Email/MSN/Skype column (following default permissions)
• phrase the few remaining unphrased words (eg. Roster)

Anyway, if you're interested in the template/css changes I made let me know and I'll give you what I've done.

Hope your exam went okay .

[Bojangles]

Great mod!

I would love to see the ability (in a future version) to replace the text group name with an image instead (image path is entered as an option in the group). If that ever happens, would it look prettier to have the image centered over the listing of the people in the group, instead of fixed on the left?

Thanks again for making this!

[CoZmicShReddeR]

IR15H I think that is amazing and exactly what this needed!

Please share if you could with Sarcoth or maybe with us here... I would love that if you could share it with me either way...

Thanks!

[Sarcoth]

Originally Posted by IR15H

I had a play around with the templates on my test site, mainly moving all the styling to a separate css sheet so that the table would take on the style of whatever the user was viewing in, but also the odd tweak.

Are you talking about the different browser types? Hmmm, I know the tables looked different in Firefox and IE, but I didn't know I could do much about that. I'm interested in the css sheet and what you did to the templates if you don't mind. Thank you.

Originally Posted by IR15H

I also thought of some ideas/requests for future versions;

• as mentioned previously, default order is that which user group IDs are entered in the settings
• multiple rosters
• allow HTML in group titles (where my first screen shot has all the <span> stuff)
• make each group listing collapsible
• find a way to get multiple-selection user profile fields to work in the roster
• add page pagination for long rosters
• add an age column (assuming user has set age to be public)
• add a PM/Email/MSN/Skype column (following default permissions)
• phrase the few remaining unphrased words (eg. Roster)

1) You mean the default order isn't working for you? I did add it to this version, but it only works when the default sort is usergroupid.
2) I had thought of doing that already, but just haven't gotten around to it. Easy enough to do.
3) Hmmm, that may be more of a challenge. I know how to do collapsable groups, but I wonder how that would work for this type of mod. This would be a fun one to work on.
4) I guess I've never used them so never noticed they were not working. I'll chalk this one up for much later.
5) Ack, sadly I don't know about that for this mod. I'd be better off redoing the whole code and mimicing the memberlist.php. This mod was initially built as a way to reuse the showgroup.php file, but it became so customizable I had to redo it as a mod. You're welcome to the challenge if you'd like.
6) I had this once, but removed it since I didn't see it in use anywhere. I'll readd the code and then provide a way to have it added without actually adding ANOTHER column. Maybe just set it up in a way that you can type birthday in one of the field columns.
7) I had thought of doing this as well. I'll look into it but this one may be two versions later.
8) Yea, I meant to actually do that in the last version. I was so excited about getting the big things working that I never got around to this.

Thanks for the suggestions.

Originally Posted by IR15H

Hope your exam went okay .

It didn't actually. I decided to read only 2 of the 3 chapters so I only got around 70%. But, the good news is, that was good enough to give me a 90.8 in the class. I still have 2 more tests to take this semester, but they will only improve my grade, not make it worse. So, basically, if I get 62 out of the remaining 168 questions, I'll have a 100 for the semester. Not important since I already have an A. I thought the extra credit would be easier and more fun than taking the tests...I was right.

[Sarcoth]

Originally Posted by Bojangles

Great mod!

I would love to see the ability (in a future version) to replace the text group name with an image instead (image path is entered as an option in the group). If that ever happens, would it look prettier to have the image centered over the listing of the people in the group, instead of fixed on the left?

Thanks again for making this!

I'm not sure putting images in the group names would be widely used. Plus, it would be code intensive adding the code in there for the select few that want to do that. Instead, I'll see what I can do in telling you how to accomplish it on your own. Let me know if you are still interested.

[IR15H]

Originally Posted by Sarcoth

Are you talking about the different browser types? Hmmm, I know the tables looked different in Firefox and IE, but I didn't know I could do much about that. I'm interested in the css sheet and what you did to the templates if you don't mind. Thank you.

As far as I can see, they render the same way in the latest versions of FireFox, IE and Chrome. I've attached the xml file with the template changes.

1) You mean the default order isn't working for you? I did add it to this version, but it only works when the default sort is usergroupid.

The default order works fine but what I would like is a custom order, which is defined by the order in which I enter the user group IDs in the settings box. In regards to the other suggestions, thanks for the feedback on them (although I think you missed the one about HTML in the user group titles).

As for your exam, I did the trick of only revising half of the material once but nailing it so I got the mark I needed, sounds like you're going to get the marks you need too .

[CoZmicShReddeR]

Thanks IR15H,
I think having the gamerscard icons show or the mini banners would be a nice plus or someone could make an addon for ShowRoster for those that want it to display... Same with the Messengers Icons...

[Sarcoth]

Originally Posted by IR15H

As far as I can see, they render the same way in the latest versions of FireFox, IE and Chrome. I've attached the xml file with the template changes.



The default order works fine but what I would like is a custom order, which is defined by the order in which I enter the user group IDs in the settings box. In regards to the other suggestions, thanks for the feedback on them (although I think you missed the one about HTML in the user group titles).

As for your exam, I did the trick of only revising half of the material once but nailing it so I got the mark I needed, sounds like you're going to get the marks you need too .

Thanks for the file, I'll check it out.

I spent days trying to get the custom order to work when sorting was used and it broke no matter how I tried it. I don't think it will work because the way the grouping is done. Maybe one day I'll try to change over to something else.

Nope, #2 was the HTML one. I missed the multiple rosters suggestion. Still not sure how to do it. That is one I'd like to do though. The main problem there is how to do permissions. I would definitely need to add some tables and a lot more code to make it to work. Not sure I'll have the time to come up with something like that in the near future.

[Andyucs]

Originally Posted by IR15H

.

Thank you

very nice upgrade

[IR15H]

Originally Posted by CoZmicShReddeR

Thanks IR15H,
I think having the gamerscard icons show or the mini banners would be a nice plus or someone could make an addon for ShowRoster for those that want it to display... Same with the Messengers Icons...

It's easy enough to get banners for xbox, xfire etc. by going to the relevant site, selecting the banner you like, then editing the generated code very slightly and putting it in your showroster_userbits template. For example;

Replace {vb:var userinfo.{vb:var columns[columnX]}} with the following;

• xfire
  

  <img src="http://miniprofile.xfire.com/bg/sh/type/3/{vb:var userinfo.{vb:var columns[columnX]}}.png" alt="{vb:var userinfo.{vb:var columns[columnX]}}" />

• xbox
  

  <img src="http://card.mygamercard.net/presence/{vb:var userinfo.{vb:var columns[columnX]}}.png" alt="{vb:var userinfo.{vb:var columns[columnX]}}" />

Replace X with whatever column you're using for xfire/xbox etc.

Originally Posted by Sarcoth

Thanks for the file, I'll check it out.

I spent days trying to get the custom order to work when sorting was used and it broke no matter how I tried it. I don't think it will work because the way the grouping is done. Maybe one day I'll try to change over to something else.

Nope, #2 was the HTML one. I missed the multiple rosters suggestion. Still not sure how to do it. That is one I'd like to do though. The main problem there is how to do permissions. I would definitely need to add some tables and a lot more code to make it to work. Not sure I'll have the time to come up with something like that in the near future.

Every time I look at PHP I can never quite figure it out and end up with a headache but from what I can gather, you've basically said;

1. What usergroups do you want to show on the roster?
2. What attribute of usergroups should be the primary one, user id or user title?
3. How should I sort that attribute, ascending or decending? (If none defined, then sort ascending)

As I don't really understand PHP, this may be overly simplistic, but what happens if you simply remove steps 2 and 3? Is the default behaviour to simply fetch display in the order they are entered, or is there some inherit sort behaviour that needs to be overwritten?

---------------------

In regards to multiple rosters, I was thinking along the lines of two entries for showroster_display_groups in the settings then some crazy if conditions like if showroster_display_groups_2 is not blank then display roster2, which would use the same fields/columns as roster1, but appear on a different tab. Of course the downside to that approach would be that you'd be limited to using the same user profile fields for both rosters. However, as I said, I don't really understand PHP so don't know how feasible such an idea would be.

Originally Posted by Andyucs

Thank you

very nice upgrade

Glad you like it .