wiki:development/forum

Contact

  • Sam Minnee (sam at silverstripe dot com)
  • Sean Harvey (sean at silverstripe dot com)

Status

Brainstorming, investigation into current implementations.

Current Shortcomings

  • Early module based on an older version of SS 2
  • Lack of attention to forum/trunk because of early branch out
  • Lack of extensibility because of lack of initial data model (e.g. no DataObjectDecorators?)
  • Bug fixes/features in different branches which haven't made their way to the main branch
  • Lack of documentation

Requirements

  • Ability to add an additional data model to the existing forum without rewriting half the code
    • Investigate SS.com "extensions" to the forum in order to better understand requirements
    • Use DataObjectDecorators? to extend classes (?)
  • Documentation for how to extend the forum with an additional data model. e.g. "How to extend the forum"
  • Ensuring that the forum makes full use of the theme functionality, e.g. calls in the template to $ThemeDir? instead of "forum"
  • Bug fixing and merging of custom SS.com branch into the main branch so it can be maintained in the future
    • The forum extension capability is required before this activity can happen

Testing

Testing is an important requirement for ongoing development of functionality. Some useful tests would include:

  • Data integrity testing - creating a post, an additional post, etc.
  • Attaching a file to a post, and deleting it again
  • Testing the HTML output of a post is what was actually posted
    • Making sure that certain BB tags code actually outputs the appropriate HTML, such as a <pre> tag surrounding text.
    • Ensuring that what forum members have chosen to show as public content is actually what is shown, and nothing else (testing the HTML output)