Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Forum development: Difference between revisions

From MoodleDocs
(Created page with "Ludo's DFwikiteam in UPC-Barcelona leaded by Jordi Piguillem are working in the new Wiki module for Moodle 2.0 = Development process and testing = == First alpha release == [h...")
 
(Oops. Copied the wrong content.)
 
Line 1: Line 1:
Ludo's DFwikiteam in UPC-Barcelona leaded by Jordi Piguillem are working in the new Wiki module for Moodle 2.0
Please post ideas for implementation and design for the forum upgrades.


==Things we know==


= Development process and testing =
* New categorization scheme that will allow posts and discussions to be marked (e.g. trackers, questions, answers, more info, bugs, etc.)
* Sorting and "sticky" threads
* Defined API that allow forums to be used anywhere
* Display mechanism that would allow different display templates for different forum types...
* Anonymous Forum Capability: Users can post information anonymous in a particular forum
...lets add our top plans here, and add details in further pages...


== First alpha release ==
(Remind me to talk about this at the developer meeting, I have a rather radical idea cooking that would affect this - Martin D).
[http://moodle.org/mod/forum/discuss.php?d=137439|Discussed at the Wiki forum]  [http://dl.dropbox.com/u/765393/wiki20.zip|download release]


=== Howto install ===
==Details==
Works with Moodle 2.0 devel tested Nov 9th, 2009


Copy the Mod/wiki folder into the moodle's Mod/wiki folder (replacing completelly the folder)
Categorization: Let's itemize a list of features with details/ideas for implementation. Perhaps a 'label/filter' system would work well (ie Gmail)?
And you may also copy the contents of the /blocks folder into the /blocks folder of the moodle 2.0.
A clean install worked fine, so far.


=== Main Features in this version===
Sorting and Sticky threads:


This version features a functional wiki featuring Creole 1.0 parser, Mediawiki like parser, and HTML WYSIWYG page edition. The teacher can let the students choose the page format of make mandatory one format.
* Should be allowed to have a forced display order set by instructor
The blocks don't work very well.
* sticky threads remain at the top regardless of other sorting
As you may see the page differences engine has been borrowed from OUWiki.
* sort by user, date, thread name, post count
A migration engine is in place, but requires heavy testing.
* I think the new table class can handle the majority of this for us. But we may need to keep the sticky threads in a seperate section somehow


=== Needs heavy testing ===
API: should allow a forum to "belong" to a module instance rather than a course. This would allow a forum to exist within a module, and not be displayed on a course main page. Any other "hooks" that may be necessary to generalize the forum module.


Migration from Wiki, NWiki and ouwiki form Moodle 1.9.6
Display Templates: Review the new table API and see if that can handle the templating issues for us. Provide a way to specify a display format and have the forum module return a table object


===Bugs reported ===
Double Window: old wish to have a resource - or another object for discussion - on the left and a forum on the right.
Place your complaints here


* http://tracker.moodle.org/browse/MDL-20812
The ability to see the rest of the thread, not just the previous post perhaps in an iframe (like phpbb) starting with the previous post but scrollable back uptowards the top of the thread.
 
----
 
= Design and tecnical stuff =
 
==Database design==
Changes compared to OU wiki
* used section titles instead of byte ranges
* section titles must bu unique on each page
* synonyms table
* text format in versions table (and maybe caching field for parsed text)
* Do we need one wiki per student mode?
* page lock option
 
[[Image:Wikidatabasedesign.png]]
 
==Formats, Editors & Filters==
 
Implemented in core.
 
===Filters===
We need filtering before and after conversion to HTML.
 
===Editors===
New mforms editor element should support all types of formats.
 
===Formats===
Responsible for conversions and diffs.
 
==Locking==
 
Should use section titles instead of byte ranges.
 
==Version & diffs==
 
Diffs not part of wiki code anymore, instead handled by format plugins.
 
==Comments==
 
We need general comments framework - to be used in blogs, glossary, database mod, assignments and wiki.
 
Questions:
* do we need attachments? yes
* threads? no
* edit timeouts like in forum? yes
* some more capabilitites
 
==Groups==
 
Group mode can be used for emulation of one wiki per student mode.
 
==Grading==
 
General grading support for assignments and wikis with group grading mode.
 
Grading is handled by gradebook plugins. Grading means the act of setting final grade. This is not a peer review.
 
Gradebook plugins may use ratings, display overview of all pages, all contributions, etc.
 
==Rating==
 
Optional peer review - ratings, could be something like proposal for final grade.
 
Two different types of ratings - open on wiki pages view, the other on versions history page. First for rating of page as the result of collaborative work, the other rating of individual contributions.
 
==File handling==
 
Supported in moodle core (file handling, editors, etc.).
 
==Backup/Restore==
 
Only basic restore support for 1.6-1.9. Full support only for 2.x
 
==Tags==
 
Core tags library.
 
==Blocks==
 
* Index map - ideally graph, text too?
* Add new or missing page
* List of orphaned pages
* My contributions
* Search?? better to have generic search
* standard tags (nothing special)
* navigation
* full list of pages
 
==Permissions==
 
view, edit, comment, change locking, manage (general)
 
==Templates==
 
we need to store the template in database, we need it in group mode
 
==Export/Import==
portfolio and repository API
 
==See also==
 
*[[NWiki roadmap]]

Latest revision as of 08:18, 21 September 2011

Please post ideas for implementation and design for the forum upgrades.

Things we know

  • New categorization scheme that will allow posts and discussions to be marked (e.g. trackers, questions, answers, more info, bugs, etc.)
  • Sorting and "sticky" threads
  • Defined API that allow forums to be used anywhere
  • Display mechanism that would allow different display templates for different forum types...
  • Anonymous Forum Capability: Users can post information anonymous in a particular forum

...lets add our top plans here, and add details in further pages...

(Remind me to talk about this at the developer meeting, I have a rather radical idea cooking that would affect this - Martin D).

Details

Categorization: Let's itemize a list of features with details/ideas for implementation. Perhaps a 'label/filter' system would work well (ie Gmail)?

Sorting and Sticky threads:

  • Should be allowed to have a forced display order set by instructor
  • sticky threads remain at the top regardless of other sorting
  • sort by user, date, thread name, post count
  • I think the new table class can handle the majority of this for us. But we may need to keep the sticky threads in a seperate section somehow

API: should allow a forum to "belong" to a module instance rather than a course. This would allow a forum to exist within a module, and not be displayed on a course main page. Any other "hooks" that may be necessary to generalize the forum module.

Display Templates: Review the new table API and see if that can handle the templating issues for us. Provide a way to specify a display format and have the forum module return a table object

Double Window: old wish to have a resource - or another object for discussion - on the left and a forum on the right.

The ability to see the rest of the thread, not just the previous post perhaps in an iframe (like phpbb) starting with the previous post but scrollable back uptowards the top of the thread.