Difference between revisions of "SoC comments and trackbacks"
(GSoC idea: merging comments with trackbacks/pingbacks) |
m (on review, decided to downgrade the difficulty level to just "medium") |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
== Incentive == | == Incentive == | ||
| − | For user feedback on articles (as well as other objects), Geeklog supports both comments as well as trackbacks and pingbacks (simply referred to as "trackbacks" from now on). These are displayed at the end of an article, in two separate sections. | + | For user feedback on articles (as well as other objects), Geeklog supports both comments as well as [http://www.geeklog.net/article.php/trackback-pingback trackbacks and pingbacks] (simply referred to as "trackbacks" from now on). These are displayed at the end of an article, in two separate sections. |
The idea for this project is to merge the two sections, so users interested in any feedback on the article only have to check one list instead of two. This would also allow new ways of interaction, like commenting on trackbacks. | The idea for this project is to merge the two sections, so users interested in any feedback on the article only have to check one list instead of two. This would also allow new ways of interaction, like commenting on trackbacks. | ||
| Line 29: | Line 29: | ||
* By default, trackbacks should probably be displayed just like regular comments. Define and use some CSS classes for the "trackback comments", though, so that the site owner can make them look different if they want to. | * By default, trackbacks should probably be displayed just like regular comments. Define and use some CSS classes for the "trackback comments", though, so that the site owner can make them look different if they want to. | ||
| + | * This would be a good opportunity to review the default settings for trackbacks and pingbacks to ensure they are set in a way such that trackbacks behave and "feel" like comments as much as possible (e.g. create text excerpts for pingbacks). | ||
| Line 40: | Line 41: | ||
== Level of Difficulty == | == Level of Difficulty == | ||
| − | ''medium | + | ''medium'' |
As mentioned above, the migration part will require extensive testing. Debugging problems with this part will require some knowledge of tree structures. | As mentioned above, the migration part will require extensive testing. Debugging problems with this part will require some knowledge of tree structures. | ||
| + | |||
| + | ''Possible mentor:'' [http://www.geeklog.net/users.php?mode=profile&uid=408 Dirk Haun] | ||
| Line 48: | Line 51: | ||
* [[CommentAlgorithm|Representing Geeklog's Comments in the Database]] | * [[CommentAlgorithm|Representing Geeklog's Comments in the Database]] | ||
| + | * Somewhat related: The code that produces text excerpts for pingbacks [http://project.geeklog.net/tracking/view.php?id=1186 needs some improvements] ... | ||
[[Category:Summer of Code]] [[Category:Development]] | [[Category:Summer of Code]] [[Category:Development]] | ||
Latest revision as of 13:45, 20 March 2013
Contents
Incentive
For user feedback on articles (as well as other objects), Geeklog supports both comments as well as trackbacks and pingbacks (simply referred to as "trackbacks" from now on). These are displayed at the end of an article, in two separate sections.
The idea for this project is to merge the two sections, so users interested in any feedback on the article only have to check one list instead of two. This would also allow new ways of interaction, like commenting on trackbacks.
Details
Database Tables
Internally, trackbacks are stored in a table that shares a lot of common fields with the comments table. Merging those two tables should be possible without adding a lot of overhead.
The main difference would be that trackbacks are always top-level comments, i.e. they refer to the article in question, not to other comments.
Moderation
Like comments, it should be possible to (optionally) keep trackbacks in a moderation queue, so that they won't be visible on the site until approved by a moderator.
Migration
The main focus of this project would be on the migration of the trackbacks to a new shared comments+trackbacks table. Older trackbacks would have to be inserted between the comments in the correct order, since comments are organized in a tree structure that must be updated when merging the tables. There are also concerns about running into timeouts when doing this on a site with a lot of comments (think Groklaw).
This part of the project requires the most attention as well as extensive testing.
Miscellaneous
- By default, trackbacks should probably be displayed just like regular comments. Define and use some CSS classes for the "trackback comments", though, so that the site owner can make them look different if they want to.
- This would be a good opportunity to review the default settings for trackbacks and pingbacks to ensure they are set in a way such that trackbacks behave and "feel" like comments as much as possible (e.g. create text excerpts for pingbacks).
Bonus
Geeklog has an API for plugins to allow trackbacks. To our knowledge, no plugin currently exists that actually uses this API. If time permits, it would be nice to implement the trackback API in a plugin that already supports comments (e.g. the Static Pages plugin that ships with Geeklog) to ensure that
- the trackback API actually works
- the trackback API still works, now that comments and trackbacks have been merged
Level of Difficulty
medium
As mentioned above, the migration part will require extensive testing. Debugging problems with this part will require some knowledge of tree structures.
Possible mentor: Dirk Haun
Further Reading
- Representing Geeklog's Comments in the Database
- Somewhat related: The code that produces text excerpts for pingbacks needs some improvements ...
