Members Module V1.0
XU-303
Members Module V1.0 Simon Wilkinson Copyright © 2004 2004-07-24 Revision 1.0
Revision History 2004-07-24
SW
The first revision of the Members Module V1.0 document.
Table of Contents 1. Function ........................................................................................................................... 1 2. Install/uninstall ................................................................................................................... 1 3. Administration menu ........................................................................................................... 1 4. The user side ...................................................................................................................... 1 5. Blocks .............................................................................................................................. 2 6. Templates ......................................................................................................................... 2 7. Module credits ................................................................................................................... 4
1. Function
The XOOPS Members module provides a “member directory” for your website. It enables visitors to search a site’s registered members (note that this functionality is already available to administrators through the system module -> Find Users) and provides a large number of options and filters for doing so. It is useful because the main XOOPS search engine only searches module contents, it does not search member profiles.
2. Install/uninstall No special measures necessary, follow the standard installation process – extract the “xoopsmembers” folder into the ../modules directory. Install the module through Admin -> System Module -> Modules. Detailed instructions on installing modules are available in the XOOPS Operations Manual.
3. Administration menu There is no administration menu and no configuration options for this module. It is entirely accessed from the user side
4. The user side The Members module is accessed via a link in the main menu. This opens a search form that corresponds to the fields in member’s personal profile (see below). It contains a number of additional fields that allow you to search for members that have joined or logged in before or after a certain date. You can also choose how to order the search results – by user name, email, last login, joined date or number of posts. The number of members currently registered is displayed at the top of the form (see screenshot on following page). Note that you can get a list of all members by submitting the search form without entering any search criteria. XOOPS Documentation Team
2004-07-24
1
XU-303
Members Module V1.0
5. Blocks There are no blocks for this module. However, the System Module has three members-type blocks that may be of use: “New Members”, “Who’s Online” and “Top Posters”
6. Templates There are two templates for this module, accessible through Admin -> System -> Templates -> Members. •
xoopsmembers_searchform.html: Displays the form for searching the member directory (See Figure 1, “Search form” [3]).
•
xoopsmembers_searchresults.html:Displays the results of a search in a table (See Figure 2, “Search results” [4]).
2
2004-07-24
XOOPS Documentation Team
Members Module V1.0
XU-303
Figure 1. Search form The search results are presented in a table together with buttons to contact members via email, personal message, or to visit their website if they have one. Note that the “joined date” and number of posts is also displayed. Administrators may also edit or delete member accounts from here.
XOOPS Documentation Team
2004-07-24
3
XU-303
Members Module V1.0
Figure 2. Search results
7. Module credits The Contact Us module was written by Kazumi Ono, aka “Onokazu”.
4
2004-07-24
XOOPS Documentation Team