home *** CD-ROM | disk | FTP | other *** search
/ InterCD 2001 December / december_2001.iso / Internet Programs / HTML Webmaster 2.0 / _SETUP.1 / readme.txt < prev    next >
Encoding:
Text File  |  2000-07-21  |  18.2 KB  |  446 lines
  1. =======================================================================
  2.    ASP Forums version 2.0 beta 2 - July 20th 2000.
  3. =======================================================================
  4.  
  5. =======================================================================
  6. "ASP Forums" - a web-based discussion forum implementation.
  7. Copyright (C) 1999, 2000  ASP Forums, http://www.aspforums.com/
  8.  
  9. This library is free software; you can redistribute it and/or
  10. modify it under the terms of the GNU Lesser General Public
  11. License as published by the Free Software Foundation; either
  12. version 2.1 of the License, or (at your option) any later version.
  13.  
  14. This library is distributed in the hope that it will be useful,
  15. but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17. Lesser General Public License for more details.
  18.  
  19. You should have received a copy of the GNU Lesser General Public
  20. License along with this library; if not, write to the Free Software
  21. Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22. =======================================================================
  23.  
  24. This is the 2.0 beta 2 release of the ASP Forums software.  It is a fully-
  25. working, free, componentless discussion forum written for Microsoft's
  26. Active Server Pages.
  27.  
  28.  
  29. CHANGES FROM 2.0 beta 1
  30.  
  31. Only minor changes from the last release.  Some people have had problems
  32. with the use of 'instanceof' in the last release, but these can be fixed
  33. by upgrading the ASP script engine via a download from
  34. http://msdn.microsoft.com/scripting/  I know this is a pain, and I'm
  35. really trying to find out a good way around it.  That may not happen,
  36. though.
  37.  
  38. * Images should be included in this release!  Apologies for the delay.
  39.  
  40. * New CLEANUP_DISC tag placed on each user-visible page.  This tag, if
  41.   it is used, must be the last ASP Forums call in the page.  It basically
  42.   closes the database connection nicely and tidies up.  Use of this
  43.   tag is recommended, but it's probably not mandatory.
  44.  
  45.   As a result of this change, it is recommended that you use the new
  46.   user-visible pages in this distribution, and re-apply any changes
  47.   you have made.
  48.  
  49. * Posting from any non-IE4/5 client now replaces carriage returns and
  50.   line feeds with HTML tags.
  51.  
  52. * New SPAN tags added around most page elements.  You can now do even
  53.   fancier CSS things than you could in the first release!  As well as the
  54.   general CSS class names which apply to all the HTML the forum generates,
  55.   you can now target specific elements such as the Posted By label on the
  56.   message display page.
  57.  
  58.   The full list of specific SPAN elements you can target are shown below.
  59.   The actual name you would target in your CSS file is the string on the
  60.   right hand side of the assignment.  You can change the class that is used
  61.   for a particular element by changing the value of the left hand side in
  62.   your aspforums.asp file.
  63.  
  64.     config.ADMINSETTING_CSSClassViewAuthor = "ASPForumsViewAuthor";
  65.     config.ADMINSETTING_CSSClassViewNoChildren = "ASPForumsViewNoChildren";
  66.     config.ADMINSETTING_CSSClassViewOneChild = "ASPForumsViewOneChild";
  67.     config.ADMINSETTING_CSSClassViewManyChildren = "ASPForumsViewManyChildren";
  68.     config.ADMINSETTING_CSSClassViewDate = "ASPForumsViewDate";
  69.     config.ADMINSETTING_CSSClassViewSubject = "ASPForumsViewSubject";
  70.     config.ADMINSETTING_CSSClassMsgPostedByLabel = "ASPForumsMsgPostedByLabel";
  71.     config.ADMINSETTING_CSSClassMsgPostedBy = "ASPForumsMsgPostedBy";
  72.     config.ADMINSETTING_CSSClassMsgPostedOnLabel = "ASPForumsMsgPostedOnLabel";
  73.     config.ADMINSETTING_CSSClassMsgPostedOn = "ASPForumsMsgPostedOn";
  74.     config.ADMINSETTING_CSSClassMsgBodyLabel = "ASPForumsMsgBodyLabel";
  75.     config.ADMINSETTING_CSSClassMsgBody = "ASPForumsMsgBody";
  76.     config.ADMINSETTING_CSSClassFormBody = "ASPForumsFormBody";
  77.     config.ADMINSETTING_CSSClassFormBodyLabel = "ASPForumsFormBodyLabel";
  78.     config.ADMINSETTING_CSSClassFormSubject = "ASPForumsFormSubject";
  79.     config.ADMINSETTING_CSSClassFormSubjectLabel = "ASPForumsFormSubjectLabel";
  80.     config.ADMINSETTING_CSSClassFormEmailResponses = "ASPForumsFormEmailResponses";
  81.     config.ADMINSETTING_CSSClassFormEmailResponsesLabel = "ASPForumsFormEmailResponsesLabel";
  82.     config.ADMINSETTING_CSSClassFormPostedBy = "ASPForumsFormPostedBy";
  83.     config.ADMINSETTING_CSSClassFormPostedByLabel = "ASPForumsFormPostedByLabel";
  84.     config.ADMINSETTING_CSSClassFormFullName = "ASPForumsFormFullName";
  85.     config.ADMINSETTING_CSSClassFormFullNameLabel = "ASPForumsFormFullNameLabel";
  86.     config.ADMINSETTING_CSSClassFormEmailAddress = "ASPForumsFormEmailAddress";
  87.     config.ADMINSETTING_CSSClassFormEmailAddressLabel = "ASPForumsFormEmailAddressLabel";
  88.     config.ADMINSETTING_CSSClassFormSearch = "ASPForumsFormSearch";
  89.     config.ADMINSETTING_CSSClassFormSearchSmall = "ASPForumsFormSearchSmall";
  90.     config.ADMINSETTING_CSSClassFormDateElement = "ASPForumsFormDateElement";
  91.     config.ADMINSETTING_CSSClassFormMonthElement = "ASPForumsFormMonthElement";
  92.     config.ADMINSETTING_CSSClassFormYearElement = "ASPForumsFormYearElement";
  93.  
  94.   So, for example, to change the way the Posted By label looks in your
  95.   form, you would set SPAN.ASPForumsFormPostedByLabel with whatever CSS
  96.   attributes you wish in your style sheet.  If you want to modify the
  97.   forum so that it outputs "MyPostedByClass" in the SPAN tag instead of
  98.   the above, you would achieve this by adding the line:
  99.  
  100.     config.CSSClassFormPostedByLabel = "MyPostedByClass";
  101.  
  102.   to your aspforums.asp file.
  103.  
  104.   If all this seems like gibberish, just ignore it.  Your forum will
  105.   continue to work.
  106.  
  107.   And thanks to John Graham for kicking this change off.
  108.  
  109.  
  110. CHANGES FROM 1.11
  111.  
  112. There are lots of changes.  Honestly.  So much has changed between the last
  113. version and this that it would take a very, very long document to even try
  114. to describe.
  115.  
  116. Upgrading will therefore be very difficult.  This is a beta release, and
  117. it probably contains lots of bugs.  On top of that, the interfaces have
  118. all changes so the information in the HowTos won't work with this version.
  119. The sense of the HowTos remains however, so it's not that difficult to work
  120. from the HowTo with the new system.  I'll update the HowTos as soon as I
  121. can, but since it has taken this long to get the 2.0 beta out I can't
  122. promise to get to it anytime soon.
  123.  
  124. Summaries of the biggest changes:
  125.  
  126. * Big cleanup of some inconsistencies within the code.  The code has been
  127.   reorganised into a more logical and object-oriented design.  It really
  128.   is much better now, and much more appropriate for developing extensions.
  129.   If you want to develop extensions to this code, or just want to see how
  130.   it all works 'under the hood', split the discussionengine.asp file up
  131.   into its constituent objects - each object is prefixed by a large
  132.   comment block so it's hard to miss.
  133.  
  134. * Sophisticated caching of database accesses.  This is a really neat
  135.   feature, but it may not be appropriate for your server/system.  I've
  136.   never had a problem with this during testing, but running it on the
  137.   live server caused some serious script crashes.  (It didn't trash the
  138.   server though - it just caused termination of that page's script.)
  139.   The problem's mostly due to the database server being on a different
  140.   machine to the web server, and when the database server gets restarted
  141.   without restarting the web server, ADO trashes the cached objects.  The
  142.   cache is disabled by default because of this, but you can turn it on
  143.   by setting:
  144.  
  145.     config.CACHE_Enabled = true
  146.  
  147.   in your aspforums.asp file.  If you do this, let me know how you get on.
  148.  
  149. * New object for all HTML, called ForumHTML.  All HTML output should
  150.   (ideally) go through this object.  It's all part of the code reorg.
  151.  
  152. * New WYSIWYG DHTML textarea.  This only works in Microsoft's Internet
  153.   Explorer 4 and 5, but it looks really, really good.
  154.  
  155. * Move to HTML as standard input format.  That means the end of those [b]
  156.   and [i] tags.  You can now input raw HTML if you are given a basic
  157.   textarea.  The rich textarea already converts what you type to HTML, so
  158.   entering HTML there won't work - the rich textarea interprets your "<"
  159.   and ">" characters to mean you want to display those characters
  160.   themselves, and thus it HTMLises them to < and > respectively.
  161.  
  162. * New consistent configuration naming convention.  All general
  163.   configuration switches and settings are now prefixed by ADMINSETTING_
  164.   or ADMINSWITCH_.  This makes it clearer what settings in the config
  165.   object can be changed safely and which require more thought before
  166.   editing.  As a result, feel free to experiment with any configuration
  167.   settings that start ADMINSETTING_ or ADMINSWITCH_.
  168.  
  169. * All strings which must be translated for a localised version of the
  170.   forum are now prefixed with USERTEXT_.  This should make it easier for
  171.   translators to extract the strings they need to translate, and help
  172.   them produce translated add-in files.
  173.  
  174. * All strings now use double-quotes as the separator.  This will have
  175.   absolutely no impact on you, I just thought I'd mention it.
  176.  
  177. * The DHTML expand/collapse is now the default view.
  178.  
  179. * There have been no database changes, so you shouldn't need to upgrade
  180.   or migrate data.
  181.  
  182.  
  183. GENERAL INFORMATION
  184.  
  185. ASP Forums is based around a single 'discussionengine.asp' file.  This
  186. file contains all the code necessary to run a forum.  The pages sent with
  187. this software are quite minimalist, and are designed to allow you to tailor
  188. the forums to your site.  The forum content in those pages is generated by
  189. 'tokens' (such as <%FORUM_TITLE_DISC%>) which are embedded in the page.
  190. These tokens are really calls to the discussionengine.asp file to insert a
  191. particular piece of text in this position on the page.  (In the above example,
  192. it inserts the name of the forum.)
  193.  
  194. You should never need to directly modify the discussionengine.asp file.
  195. Instead it should be configured via the aspforums.asp file.  This file is
  196. really much more powerful than you'd expect.  As well as containing
  197. configuration switches for the forum (a full list of which can be found at
  198. http://www.aspforums.com/ASPForums/howto/configuring.asp), it allows you
  199. to override the default methods of the forum, meaning you can substitute
  200. your own functionality.  If you don't like the way the forum messages
  201. are displayed in the main view, you can write your own function in the
  202. aspforums.asp file to do it your way.  The discussionengine.asp file is
  203. nothing more than a collection of default behaviours for a forum.  Details
  204. of how to override some common methods can be found at:
  205.  
  206.     http://www.aspforums.com/ASPForums/howto/
  207.  
  208.  
  209. CO-EXISTING WITH OTHER SOFWARE
  210.  
  211. ASP WebLog 1.x and ASP Directory 1.x WILL NOT WORK WITH THIS VERSION OF
  212. ASP FORUMS!  I'm working on an upgrade to both products, and all registered
  213. owners of both products will receive a free upgrade.
  214.  
  215.  
  216. FEATURES
  217.  
  218. * Fully threaded discussions, with automatic archiving after a configurable
  219.   period of time.
  220.  
  221. * A completely tailorable look and feel, so the user interface can be
  222.   tailored to match your site.
  223.  
  224. * 'Rich text' input, where users can safely embed URLs and images as well as
  225.   bold and italic text.
  226.  
  227. * Users can edit their own posts (if allowed by the webmaster).
  228.  
  229. * A full database backend for data storage, sorting and searching.
  230.  
  231. * A filter is applied to all discussion text, so you're not responsible for
  232.   any user's bad language.
  233.  
  234. * The 'discussion engine' does all the hard work. You only need one discussion
  235.   engine per web server, no matter how many forums you host.
  236.  
  237. * You can just extract the files and go! You don't even need to create a data
  238.   source (although it's definitely advisable) - a default file DSN is created
  239.   for you.
  240.  
  241. * Database-vendor independent. As long as your database can handle SQL through
  242.   ODBC, our forum software can use it. (Note - a bare Access forum database is
  243.   included in the distribution for easy set-up.)
  244.  
  245. * SQL-based administration - a special administration tool lets you perform any
  246.   admin task through SQL.
  247.  
  248.  
  249. INSTALLATION
  250.  
  251. Installation should just be a matter of extracting the files into a
  252. suitable sub-directory.  Full technical details of how to tailor this
  253. product are available on the ASP Forums web site at:
  254.  
  255.     http://www.aspforums.com/ASPForums/howto/
  256.  
  257.  
  258. PERFORMANCE IMPROVEMENTS
  259.  
  260. There are two things that have been said to speed up performance of ASP
  261. Forums in particular and ASP database accessing in general.  These tips
  262. are given here for your own information, without any hope of getting
  263. support on them if you try and use them!
  264.  
  265. 1. Use OLEDB instead of ODBC.  For example, the commented out line in the
  266.    default aspforums.asp file mentions the following:
  267.  
  268.    config.databaseDSN =
  269.       'Provider=Microsoft.Jet.OLEDB.4.0; Data Source=' + config.DBPath
  270.  
  271.    (That should all be on one line.)
  272.  
  273.    I'm told that OLEDB's performance is significantly better than that of
  274.    ODBC for the same throughput.
  275.  
  276. 2. Use <%Response.Buffer%> and <%Response.Flush%> at appropriate points
  277.    through your pages.  This can have a significant impact of how pages
  278.    are delivered to your clients, so make sure you understand the
  279.    ramifications of this before you do it.
  280.  
  281.    Check out: http://www.learnasp.com/advice/whybuffer.asp for some
  282.    reasons to use it.
  283.  
  284.  
  285. EMAIL CAPABILITIES
  286.  
  287. ASP Forums can optionally email the administrator each time a message is
  288. posted, as well as optionally emailing users when someone responds to a
  289. post of theirs.  Both of these features require Microsoft's CDO NTS
  290. library be installed on the server.
  291.  
  292. If this library is not present, no errors will be generated.  However, no
  293. emails can be sent without it.
  294.  
  295. The CDO NTS library is a free download from www.microsoft.com
  296.  
  297.  
  298. CONFIGURING THE FORUM SOFTWARE
  299.  
  300. Although the forum software should work as soon as you unzip it, you
  301. will almost certainly want to configure it to work on your site and
  302. also make sure it has your site's look and feel.  Full information on
  303. this is available at:
  304.  
  305.     http://www.aspforums.com/ASPForums/howto/configuring.asp
  306.  
  307. To summarise, however, you can freely edit any of the user-visible pages
  308. so long as you do not alter the forum tags.  These are the tags between
  309. the <% and %> markers.  So long as you leave those intact, you can edit
  310. the HTML layout of the forum however you choose.  If you really do want
  311. to edit the tags, a full list of possible 1.0 forum tags is as follows:
  312.  
  313.     <% FORUM_LINK_DISC %>
  314.     Displays a link to the main forum page.
  315.  
  316.     <% PARENT_MESSAGE_LINK_DISC %>
  317.     Displays a link to the parent message, if one exists.
  318.  
  319.     <% SEARCH_FORM_DISC %>
  320.     Displays the full search form.
  321.  
  322.     <% SMALL_SEARCH_FORM_DISC %>
  323.     Displays a small version of the search form.
  324.  
  325.     <% NEW_POST_BUTTON_DISC %>
  326.     Displays a button to go to the 'New Post' page.
  327.  
  328.     <% NEW_POST_LINK_DISC %>
  329.     Displays a link to go to the 'New Post' page.
  330.  
  331.     <% NEW_REPLY_BUTTON_DISC %>
  332.     Displays a button to go to the 'New Post' page to reply to the
  333.     current message.
  334.  
  335.     <% EDIT_POST_BUTTON_DISC %>
  336.     Displays a button to go to the 'Edit Post' page to edit the
  337.     current message.
  338.  
  339.     <% ALL_ROOT_POSTS_DISC %>
  340.     Displays a view containing all posts.
  341.  
  342.     <% ALL_ROOT_POSTS_THREADED_DISC %>
  343.     Displays a view containing all posts in a threaded manner.
  344.  
  345.     <%CURRENT_POSTS_THREADED_DHTML_DISC%>
  346.     Displays a view containing current posts in a threaded manner, with
  347.     some DHTML code to implement a dynamic expand/collapse mechanism
  348.     without requiring another page download from the server.  Currently
  349.     this works only in IE4 and IE5 - all other browsers see the view
  350.     functionality as with CURRENT_ROOT_POSTS_THREADED_DISC.
  351.  
  352.     <% CURRENT_ROOT_POSTS_THREADED_DISC %>
  353.     Displays a view containing current posts in a threaded manner.
  354.  
  355.     <% NEW_POST_FORM_DISC %>
  356.     Displays a form to create a new post.
  357.  
  358.     <% EDIT_POST_FORM_DISC %>
  359.     Displays a form to edit an existing post.
  360.  
  361.     <% SEARCH_RESULTS_DISC %>
  362.     Performs a search (based on input to a search form) and displays the
  363.     results.
  364.  
  365.     <% POST_MESSAGE_DISC %>
  366.     Performs the action of posting a new message.
  367.  
  368.     <% SAVE_EDITED_MESSAGE_DISC %>
  369.     Performs the action of saving an edited message.
  370.  
  371.     <% MESSAGE_DISC %>
  372.     Displays the current message.
  373.  
  374.     <% THREAD_DISC %>
  375.     Displays the current thread.
  376.  
  377.     <% ADMIN_TOOLS_DISC %>
  378.     Displays the administration tools forms.
  379.  
  380.     <% STD_MESSAGE_DISC %>
  381.     Displays the message, a forum link, a new reply button, an new post
  382.     button, and an edit post button, in that order.
  383.  
  384.     <% FORUM_TITLE_DISC %>
  385.     Displays the title of the current forum.
  386.  
  387.     <% SUBJECT_DISC %>
  388.     Displays the subject of the current message.
  389.  
  390.     <% MESSAGE_BODY_DISC %>
  391.     Displays the body of the current message.
  392.  
  393.     <% AUTHOR_DISC %>
  394.     Displays the author of the current message.
  395.  
  396.     <% AUTHOR_EMAIL_DISC %>
  397.     Displays the email address of the author of the current message.
  398.  
  399.     <% AUTHOR_FULL_NAME_DISC %>
  400.     Displays the full name of the author of the current message.
  401.  
  402.     <% DATE_CREATED_DISC %>
  403.     Displays the date on which the message was created.
  404.  
  405.     <% SORT_CODE_DISC %>
  406.     Displays the cort code of the current message.
  407.  
  408.     <% NUM_CHILDREN_DISC %>
  409.     Displays the number of children of the current message.
  410.  
  411.     <% MESSAGE_ID_DISC %>
  412.     Displays the message ID of the current message.
  413.  
  414.     <% PARENT_ID_DISC %>
  415.     Displays the parent ID of the current message.
  416.  
  417.     <% THREAD_ID_DISC %>
  418.     Displays the thread ID of the current message.
  419.  
  420.     <% ADMIN_SQL_FORM_DISC %>
  421.     Displays the administration forms.
  422.  
  423.     <% ADMIN_SQL_EXECUTE_DISC %>
  424.     Performs the administration actions associated with the
  425.     administration forms.
  426.  
  427.  
  428. SUPPORT
  429.  
  430. This product is not supported.  Much help is available on the web site,
  431. and many requests placed on the web site forums are answered.  However,
  432. no guarantees are given, and due to the increasing popularity of this
  433. software no support will be given via email.  Email requests for
  434. support will most likely be ignored.
  435.  
  436.  
  437. FOR FURTHER INFORMATION
  438.  
  439. For full details of this product, please visit the ASP Forums web site at:
  440.  
  441.     http://www.aspforums.com/ASPForums/
  442.  
  443. This product is licensed under the GNU Public License, which should be
  444. included in this distribution.  If not, copies are available at:
  445.  
  446.     http://www.gnu.org/