modules/smfforum/README.txt

SMFforum Integration module
==============================================================================

This module provides integration with SMF: Simple Machines Forum
http://www.simplemachines.org/.

The following blocks are provided to integrate SMF with your Drupal site:

1) SMFforum: Hidden authentication
   With the User login block allow forum users to login to your Drupal site 
   with their drupal or forum username and passwords and provides advanced
   synchronization with the forum.
   When a user changes his/her Drupal accounts and profile settings,
   the changes will be synced back to the forum database.
   Likewise, if the user changes his/her forum profile, it will be synced back
   to the Drupal site.

2) SMFforum: New forum topics
   Display a list of the latest forum topics.

3) SMFforum: New forum posts
   Display a list of the latest forum messages.

4) SMFforum: Online forum users
   Display a list of all on-line forum users.

5) SMFforum: Forum statistics
   Display forum statistics including: number of users, threads, messages,
   newest member, etc.

6) SMFforum: Personal messages
   Display your forum personal messages if you are logged in.

7) SMFforum: Top posters
   Display a list of the top posters.

Installation
------------------------------------------------------------------------------

1) Download the SMFforum module from http://drupal.org/project/smfforum or
   from http://vgb.org.ru

2) Always download the latest smf_api_2 archive from http://vgb.org.ru
   See the "license.txt" file for details of the Simple Machines license.

3) Copy smfforum directory to your modules directory sites/all/modules/smfforum/

4) Unpack smf_api_2 archive and copy it to subdirectory
   sites/all/modules/smfforum/includes/

5) To test how you will be authenticated, login to your SMF forum as admin.
   It is assumed that you have both usernames with the same name ('admin' or your name) 
   and the same password. If you do not have so, change.

6) Open new window in browser with your Drupal site, login as admin
   navigate to Administer » modules and enable the SMFforum and profile module.

7) Navigate to Administer » settings » SMFforum settings and enter the path to
   SMF root (path to forum's Settings.php file).
   Save settings and ensure that SMFforum successfully connected
   to the SMF database and you are authenticated.
   
   If you see message "You are not authenticated in SMF now." beenig logged in SMF and Drupal 
   as admin, it is probably mean your settings are wrong.
  
   You should go to SMF settings and revise Server and qookie settings or do something else 
   in your environment, site and forum layout and settings.

8) Ensure that SMF profile fields map with corresponding
   drupal profile.module fields.

9) Ensure that corresponding profile.module fields exist.
   If necessary create profile.module fields that will be match with
   SMF profile fields.

10) Navigate to Administer » blocks.
   Enable SMFforum: Hidden authentication block. Do not disable it in the future
   if you want advanced authentication and synchronyzation.
   Enable the SMFforum blocks you want to use (optional).

11) How to make SMF work in frame

  1. Go to Administer  Site configuration  SMFforum settings

  SMF display way:
  ( ) In the window
  (*) In frame inside Drupal page

  Save configuration

  2. Go to Administer  Site configuration > Performance
  Clear cached data (Drupal 6 only)
  
  3. Go to Administer  Site building > Menus > Navigation
  See Menu item with blank title in state (Disabled)
  You may enable it if you do not want smfforum in Primary links.

  If you enable it your forum page will be with title.
  Reset will help to remove the page title if you disable it back.

  4. Go to Administer  Site building  Menus  Primary links
  Enter Menu item smfforum.

  The main page and link to SMF in frame is

  smfforum

  To change this name you may add URL aliases (core module Path must be enabled).
  
  Add next URL aliases (System path -> URL Alias)
  
  For the path 'forums'
  
  smfforum -> forums
  smfforum/index.php -> forums/index.php
  
Install first locally and ensure that with your settings it works as you expect.

Upgrade
------------------------------------------------------------------------------

1) Disable all SMFforum blocks.
2) Replace old files in your modules directory .../modules/smfforum/
3) Login to your SMF forum as admin.
4) Login to your Drupal site (www.example.com/user/login will help you).
5) Navigate to Administer » settings » SMFforum settings and ensure that SMFforum
   successfully connected to the SMF database and you are authenticated.
   Save settings!
6) Navigate to Administer » blocks.
   Enable the SMFforum blocks you want to use.

Use at you risk on production site.

Module written by Vadim G.B. vb on http://drupal.org, http://drupal.ru
------------------------------------------------------------------------------
SMFforum Integration module (Ñ) 2007-2008 by Vadim G.B. (http://vgb.org.ru)
------------------------------------------------------------------------------
1	SMFforum Integration module
2	==============================================================================
3
4	This module provides integration with SMF: Simple Machines Forum
5	http://www.simplemachines.org/.
6
7	The following blocks are provided to integrate SMF with your Drupal site:
8
9	1) SMFforum: Hidden authentication
10	With the User login block allow forum users to login to your Drupal site
11	with their drupal or forum username and passwords and provides advanced
12	synchronization with the forum.
13	When a user changes his/her Drupal accounts and profile settings,
14	the changes will be synced back to the forum database.
15	Likewise, if the user changes his/her forum profile, it will be synced back
16	to the Drupal site.
17
18	2) SMFforum: New forum topics
19	Display a list of the latest forum topics.
20
21	3) SMFforum: New forum posts
22	Display a list of the latest forum messages.
23
24	4) SMFforum: Online forum users
25	Display a list of all on-line forum users.
26
27	5) SMFforum: Forum statistics
28	Display forum statistics including: number of users, threads, messages,
29	newest member, etc.
30
31	6) SMFforum: Personal messages
32	Display your forum personal messages if you are logged in.
33
34	7) SMFforum: Top posters
35	Display a list of the top posters.
36
37	Installation
38	------------------------------------------------------------------------------
39
40	1) Download the SMFforum module from http://drupal.org/project/smfforum or
41	from http://vgb.org.ru
42
43	2) Always download the latest smf_api_2 archive from http://vgb.org.ru
44	See the "license.txt" file for details of the Simple Machines license.
45
46	3) Copy smfforum directory to your modules directory sites/all/modules/smfforum/
47
48	4) Unpack smf_api_2 archive and copy it to subdirectory
49	sites/all/modules/smfforum/includes/
50
51	5) To test how you will be authenticated, login to your SMF forum as admin.
52	It is assumed that you have both usernames with the same name ('admin' or your name)
53	and the same password. If you do not have so, change.
54
55	6) Open new window in browser with your Drupal site, login as admin
56	navigate to Administer » modules and enable the SMFforum and profile module.
57
58	7) Navigate to Administer » settings » SMFforum settings and enter the path to
59	SMF root (path to forum's Settings.php file).
60	Save settings and ensure that SMFforum successfully connected
61	to the SMF database and you are authenticated.
62
63	If you see message "You are not authenticated in SMF now." beenig logged in SMF and Drupal
64	as admin, it is probably mean your settings are wrong.
65
66	You should go to SMF settings and revise Server and qookie settings or do something else
67	in your environment, site and forum layout and settings.
68
69	8) Ensure that SMF profile fields map with corresponding
70	drupal profile.module fields.
71
72	9) Ensure that corresponding profile.module fields exist.
73	If necessary create profile.module fields that will be match with
74	SMF profile fields.
75
76	10) Navigate to Administer » blocks.
77	Enable SMFforum: Hidden authentication block. Do not disable it in the future
78	if you want advanced authentication and synchronyzation.
79	Enable the SMFforum blocks you want to use (optional).
80
81	11) How to make SMF work in frame
82
83	1. Go to Administer Site configuration SMFforum settings
84
85	SMF display way:
86	( ) In the window
87	(*) In frame inside Drupal page
88
89	Save configuration
90
91	2. Go to Administer Site configuration > Performance
92	Clear cached data (Drupal 6 only)
93
94	3. Go to Administer Site building > Menus > Navigation
95	See Menu item with blank title in state (Disabled)
96	You may enable it if you do not want smfforum in Primary links.
97
98	If you enable it your forum page will be with title.
99	Reset will help to remove the page title if you disable it back.
100
101	4. Go to Administer Site building Menus Primary links
102	Enter Menu item smfforum.
103
104	The main page and link to SMF in frame is
105
106	smfforum
107
108	To change this name you may add URL aliases (core module Path must be enabled).
109
110	Add next URL aliases (System path -> URL Alias)
111
112	For the path 'forums'
113
114	smfforum -> forums
115	smfforum/index.php -> forums/index.php
116
117	Install first locally and ensure that with your settings it works as you expect.
118
119	Upgrade
120	------------------------------------------------------------------------------
121
122	1) Disable all SMFforum blocks.
123	2) Replace old files in your modules directory .../modules/smfforum/
124	3) Login to your SMF forum as admin.
125	4) Login to your Drupal site (www.example.com/user/login will help you).
126	5) Navigate to Administer » settings » SMFforum settings and ensure that SMFforum
127	successfully connected to the SMF database and you are authenticated.
128	Save settings!
129	6) Navigate to Administer » blocks.
130	Enable the SMFforum blocks you want to use.
131
132	Use at you risk on production site.
133
134	Module written by Vadim G.B. vb on http://drupal.org, http://drupal.ru
135	------------------------------------------------------------------------------
136	SMFforum Integration module (Ñ) 2007-2008 by Vadim G.B. (http://vgb.org.ru)
137	------------------------------------------------------------------------------