Baseline
[www.vanrenterghem.biz.git] / phpBB2 / install.txt
1 ################################################################# 
2 ## MOD Title: eXtreme Styles mod 2
3 ## MOD Author: CyberAlien <no@public.email> (CyberAlien) http://www.phpbbstyles.com
4 ## MOD Description: 
5 ##              This mod is heavily optimized version of phpBB templates system
6 ##              and has some additional features. It compiles and executes
7 ##              files much faster, has cache system that speeds up templates
8 ##              many times, allowes to use php in templates and few other new
9 ##              features to style designers. Also it has huge control panel
10 ##              that replaces phpBB styles management with more efficient
11 ##              easy to use functions. It also allowes to quickly import/export
12 ##              styles using .style format.
13 ## MOD Version: 2.2.1
14 ##
15 ## Installation Level:  Easy
16 ## Installation Time:   1-2 Minutes
17 ## Files To Edit (0):
18 ## Included Files (64): admin/admin_xs.php,
19 ##                      admin/xs_cache.php
20 ##                      admin/xs_chmod.php
21 ##                      admin/xs_clone.php
22 ##                      admin/xs_config.php
23 ##                      admin/xs_download.php
24 ##                      admin/xs_edit.php
25 ##                      admin/xs_edit_data.php
26 ##                      admin/xs_export.php
27 ##                      admin/xs_export_data.php
28 ##                      admin/xs_frame_top.php
29 ##                      admin/xs_frameset.php
30 ##                      admin/xs_import.php
31 ##                      admin/xs_include.php
32 ##                      admin/xs_include_import.php
33 ##                      admin/xs_include_import2.php
34 ##                      admin/xs_index.php
35 ##                      admin/xs_install.php
36 ##                      admin/xs_style_config.php
37 ##                      admin/xs_styles.php
38 ##                      admin/xs_uninstall.php
39 ##                      admin/xs_update.php
40 ##                      admin/xs_main.cfg
41 ##                      language/lang_english/lang_xs.php
42 ##                      xs_mod/formIE.css
43 ##                      xs_mod/images/button.gif
44 ##                      xs_mod/images/cellpic1.gif
45 ##                      xs_mod/images/cellpic2.jpg
46 ##                      xs_mod/images/cellpic3.gif
47 ##                      xs_mod/images/cellpic4.gif
48 ##                      xs_mod/images/dot.gif
49 ##                      xs_mod/images/spacer.gif
50 ##                      xs_mod/images/top_bg.gif
51 ##                      xs_mod/images/top_bg2.gif
52 ##                      xs_mod/images/top_logo.jpg
53 ##                      xs_mod/style.css
54 ##                      xs_mod/tpl/cache.tpl
55 ##                      xs_mod/tpl/clone.tpl
56 ##                      xs_mod/tpl/clone2.tpl
57 ##                      xs_mod/tpl/config.tpl
58 ##                      xs_mod/tpl/downloads.tpl
59 ##                      xs_mod/tpl/edit.tpl
60 ##                      xs_mod/tpl/edit_data.tpl
61 ##                      xs_mod/tpl/edit_data_list.tpl
62 ##                      xs_mod/tpl/edit_file.tpl
63 ##                      xs_mod/tpl/export.tpl
64 ##                      xs_mod/tpl/export2.tpl
65 ##                      xs_mod/tpl/export_data.tpl
66 ##                      xs_mod/tpl/export_data2.tpl
67 ##                      xs_mod/tpl/frame_top.tpl
68 ##                      xs_mod/tpl/frameset.tpl
69 ##                      xs_mod/tpl/ftp.tpl
70 ##                      xs_mod/tpl/import.tpl
71 ##                      xs_mod/tpl/import2.tpl
72 ##                      xs_mod/tpl/index.tpl
73 ##                      xs_mod/tpl/install.tpl
74 ##                      xs_mod/tpl/message.tpl
75 ##                      xs_mod/tpl/style_config.tpl
76 ##                      xs_mod/tpl/styles.tpl
77 ##                      xs_mod/tpl/uninstall.tpl
78 ##                      xs_mod/tpl/update.tpl
79 ##                      xs_mod/tpl/update2.tpl
80 ##                      xs_mod/tpl/xs_footer.tpl
81 ##                      xs_mod/tpl/xs_header.tpl
82 ## Files To Overwrite (1):      includes/template.php
83 ############################################################## 
84 ## For Security Purposes, Please Check: http://www.phpbb.com/mods/ for the 
85 ## latest version of this MOD. Downloading this MOD from other sites could cause malicious code 
86 ## to enter into your phpBB Forum. As such, phpBB will not offer support for MOD's not offered 
87 ## in our MOD-Database, located at: http://www.phpbb.com/mods/ 
88 ############################################################## 
89 ## Author Notes: 
90 ##
91 ##
92 ## Important:
93 ##
94 ## Create directory "cache" within your phpBB2 root folder (if it isn't created
95 ## yet) and chmod it to 777 (or change the owner to you httpd-servers owner).
96 ##
97 ## If you do not know how to CHMOD this article should help you: 
98 ## http://www.phpbb.com/kb/article.php?article_id=22
99 ##
100 ##
101 ## Important:
102 ##
103 ## When upgrading from mod version 1.19 or older version you MUST delete all
104 ## files of old mod from directory "admin".
105 ##
106 ## Latest version of this mod can be found at this url:
107 ## http://www.phpbbstyles.com
108 ##
109 ## Additional documentation for this mod can be found at this url:
110 ## http://www.phpbbstyles.com/viewforum.php?f=6
111 ##
112 ##
113 ## MOD Features:
114 ##              - Fast templates compilation algorythm
115 ##              - Fast templates execution (even if not cached)
116 ##              - Cache system that doesn't use database
117 ##              - Auto-check errors in templates while compiling
118 ##              - Almost all features of this mod can be configured in acp
119 ##              - PHP code in templates. PHP code should start with
120 ##                <?php or <!-- PHP --> and end with ?> or <!-- ENDPHP -->
121 ##                Short tags are not allowed. See manual for examples of code.
122 ##              - Unlimited <!-- BEGIN blah --><!-- END blah --> switches in one line.
123 ##              - Include other tpl files with <!-- INCLUDE file.tpl -->
124 ##              - You can configure separate .tpl files for usual template.php
125 ##                and eXtreme Styles template.php. It can be configured in xs.cfg
126 ##                (like jumpbox.tpl for usual phpbb and jumpbox_xs.tpl for xs mod
127 ##                that is included with this mod)
128 ##              - Variable {LANG} that corresponds to current language. Can be
129 ##                used to create truly multi-lingual templates (you can use this
130 ##                in urls: "images/lang_{LANG}/icon_blah.gif").
131 ##              - Variable {PHP} that corresponds to file extension with session
132 ##                data. Can be used to avoid modding when you need to add some
133 ##                url (like "somescript.{PHP}" or "script.{PHP}test=1")
134 ##                Variable contains "?" or "&" at the end so you could easily
135 ##                add arguments to url.
136 ##              - Variable {TEMPLATE} that corresponds to current template
137 ##                directory (like "templates/subSilver/"). Can be used to avoid
138 ##                filenames case confusion and to fix phpBB path error when
139 ##                confirm_body.tpl and message_body.tpl are used in acp.
140 ##              - In admin control panel you can switch all users from one style
141 ##                to another and easily change default style.
142 ## New Features in 2.0:
143 ##              - Faster template compilation
144 ##              - Mod has its own interface independant from current style
145 ##              - Mod completely replaces phpBB styles management
146 ##              - Cache management
147 ##              - Import/Export styles
148 ##              - Clone templates and styles
149 ##              - Better install/uninstall for styles
150 ##              - Templates editor. Can also edit text files and .htaccess
151 ##              - Tokens IF, ELSEIF, ELSE, ENDIF, DEFINE, UNDEFINE
152 ## New Features in 2.1:
153 ##              - Built-in support for Category Hierarchy mod 2.1.x
154 ##              - Style configuration (applies only to complex configurable styles)
155 ## New Features in 2.2:
156 ##              - Support for BEGINELSE command
157 ##
158 ##  /***************************************************************************
159 ##  *
160 ##  *   This program is free software; you can redistribute it and/or modify
161 ##  *   it under the terms of the GNU General Public License as published by
162 ##  *   the Free Software Foundation; either version 2 of the License, or
163 ##  *   (at your option) any later version.
164 ##  *
165 ##  ***************************************************************************/
166 ##
167 ############################################################## 
168 ## Before Adding This MOD To Your Forum, You Should Back Up All Files Related To This MOD 
169 ############################################################## 
171
172 #-----[ COPY ]------------------------------------------ 
173
175 copy root/admin/admin_xs.php to admin/admin_xs.php
176 copy root/admin/xs_cache.php to admin/xs_cache.php
177 copy root/admin/xs_chmod.php to admin/xs_chmod.php
178 copy root/admin/xs_clone.php to admin/xs_clone.php
179 copy root/admin/xs_config.php to admin/xs_config.php
180 copy root/admin/xs_download.php to admin/xs_download.php
181 copy root/admin/xs_edit.php to admin/xs_edit.php
182 copy root/admin/xs_edit_data.php to admin/xs_edit_data.php
183 copy root/admin/xs_export.php to admin/xs_export.php
184 copy root/admin/xs_export_data.php to admin/xs_export_data.php
185 copy root/admin/xs_frame_top.php to admin/xs_frame_top.php
186 copy root/admin/xs_frameset.php to admin/xs_frameset.php
187 copy root/admin/xs_import.php to admin/xs_import.php
188 copy root/admin/xs_include.php to admin/xs_include.php
189 copy root/admin/xs_include_import.php to admin/xs_include_import.php
190 copy root/admin/xs_include_import2.php to admin/xs_include_import2.php
191 copy root/admin/xs_index.php to admin/xs_index.php
192 copy root/admin/xs_install.php to admin/xs_install.php
193 copy root/admin/xs_style_config.php to admin/xs_style_config.php
194 copy root/admin/xs_styles.php to admin/xs_styles.php
195 copy root/admin/xs_uninstall.php to admin/xs_uninstall.php
196 copy root/admin/xs_update.php to admin/xs_update.php
197 copy root/admin/xs_main.cfg to admin/xs_main.cfg
198 copy root/includes/template.php to includes/template.php
199 copy root/language/lang_english/lang_xs.php to language/lang_english/lang_xs.php
200 copy root/xs_mod/formIE.css to xs_mod/formIE.css
201 copy root/xs_mod/images/button.gif to xs_mod/images/button.gif
202 copy root/xs_mod/images/cellpic1.gif to xs_mod/images/cellpic1.gif
203 copy root/xs_mod/images/cellpic2.jpg to xs_mod/images/cellpic2.jpg
204 copy root/xs_mod/images/cellpic3.gif to xs_mod/images/cellpic3.gif
205 copy root/xs_mod/images/cellpic4.gif to xs_mod/images/cellpic4.gif
206 copy root/xs_mod/images/dot.gif to xs_mod/images/dot.gif
207 copy root/xs_mod/images/spacer.gif to xs_mod/images/spacer.gif
208 copy root/xs_mod/images/top_bg.gif to xs_mod/images/top_bg.gif
209 copy root/xs_mod/images/top_bg2.gif to xs_mod/images/top_bg2.gif
210 copy root/xs_mod/images/top_logo.jpg to xs_mod/images/top_logo.jpg
211 copy root/xs_mod/style.css to xs_mod/style.css
212 copy root/xs_mod/tpl/cache.tpl to xs_mod/tpl/cache.tpl
213 copy root/xs_mod/tpl/clone.tpl to xs_mod/tpl/clone.tpl
214 copy root/xs_mod/tpl/clone2.tpl to xs_mod/tpl/clone2.tpl
215 copy root/xs_mod/tpl/config.tpl to xs_mod/tpl/config.tpl
216 copy root/xs_mod/tpl/downloads.tpl to xs_mod/tpl/downloads.tpl
217 copy root/xs_mod/tpl/edit.tpl to xs_mod/tpl/edit.tpl
218 copy root/xs_mod/tpl/edit_data.tpl to xs_mod/tpl/edit_data.tpl
219 copy root/xs_mod/tpl/edit_data_list.tpl to xs_mod/tpl/edit_data_list.tpl
220 copy root/xs_mod/tpl/edit_file.tpl to xs_mod/tpl/edit_file.tpl
221 copy root/xs_mod/tpl/export.tpl to xs_mod/tpl/export.tpl
222 copy root/xs_mod/tpl/export2.tpl to xs_mod/tpl/export2.tpl
223 copy root/xs_mod/tpl/export_data.tpl to xs_mod/tpl/export_data.tpl
224 copy root/xs_mod/tpl/export_data2.tpl to xs_mod/tpl/export_data2.tpl
225 copy root/xs_mod/tpl/frame_top.tpl to xs_mod/tpl/frame_top.tpl
226 copy root/xs_mod/tpl/frameset.tpl to xs_mod/tpl/frameset.tpl
227 copy root/xs_mod/tpl/ftp.tpl to xs_mod/tpl/ftp.tpl
228 copy root/xs_mod/tpl/import.tpl to xs_mod/tpl/import.tpl
229 copy root/xs_mod/tpl/import2.tpl to xs_mod/tpl/import2.tpl
230 copy root/xs_mod/tpl/index.tpl to xs_mod/tpl/index.tpl
231 copy root/xs_mod/tpl/install.tpl to xs_mod/tpl/install.tpl
232 copy root/xs_mod/tpl/message.tpl to xs_mod/tpl/message.tpl
233 copy root/xs_mod/tpl/style_config.tpl to xs_mod/tpl/style_config.tpl
234 copy root/xs_mod/tpl/styles.tpl to xs_mod/tpl/styles.tpl
235 copy root/xs_mod/tpl/uninstall.tpl to xs_mod/tpl/uninstall.tpl
236 copy root/xs_mod/tpl/update.tpl to xs_mod/tpl/update.tpl
237 copy root/xs_mod/tpl/update2.tpl to xs_mod/tpl/update2.tpl
238 copy root/xs_mod/tpl/xs_footer.tpl to xs_mod/tpl/xs_footer.tpl
239 copy root/xs_mod/tpl/xs_header.tpl to xs_mod/tpl/xs_header.tpl
241
242 #-----[ SAVE/CLOSE ALL FILES ]------------------------------------------ 
243
244 # EoM