Difference between revisions of "SoC topic improvements"

From GeeklogWiki
Jump to: navigation, search
(Objective)
Line 3: Line 3:
 
== Introduction ==
 
== Introduction ==
  
When Geeklog 1.9.0 is released Topics will be able to have child Topics and, Blocks and Articles can be assigned to one or more Topics. With these new features of Geeklog, this makes a number of the ideas in the  Google Summer of Code [[SoC category plugin|Category Plugin]] project not relevant. This new Topic Improvements project takes into account some of the projects from the Category Plugin and adds in a few new ideas.
+
When Geeklog 1.9.0 is released Topics will be able to have child Topics and, Blocks and Articles can be assigned to one or more Topics. With these new features of Geeklog, this makes a number of the ideas in the  Google Summer of Code 2010 [[SoC category plugin|Category Plugin]] project not relevant. This new Topic Improvements project takes into account some of the projects from the Category Plugin and adds in a few new ideas.
 
 
== Incentive ==
 
 
 
 
 
 
  
 
== Objective ==
 
== Objective ==
  
The feature list for the Category plugin can be broken down into two main parts, Geeklog Core changes and the plugin itself:
+
The feature list for the Topic Improvements can be broken down into several parts:
 
 
 
 
=== Core Changes ===
 
  
 +
Plugin API
 
* Add new plugin API to integrate extra fields from one or more plugins into edit forms. This should allow for displaying, validation and saving the information. Some functionality will also be required to tell the plugin what plugins it should not integrate into
 
* Add new plugin API to integrate extra fields from one or more plugins into edit forms. This should allow for displaying, validation and saving the information. Some functionality will also be required to tell the plugin what plugins it should not integrate into
 
* Add new plugin API to integrate extra fields from one or more plugins into submission forms  
 
* Add new plugin API to integrate extra fields from one or more plugins into submission forms  
 
* Add this functionality to the admin editors and submission forms of Articles, Category plugin, Static Pages plugin, Polls plugin, Links Plugin and Calendar plugin
 
* Add this functionality to the admin editors and submission forms of Articles, Category plugin, Static Pages plugin, Polls plugin, Links Plugin and Calendar plugin
 
* Add support of adding one or more categories to Articles using the above API
 
* Add support of adding one or more categories to Articles using the above API
 +
allowing plugins to display items amongst the articles when a topic is displayed
 +
 +
  
  
Line 30: Line 26:
 
Menu:
 
Menu:
 
* Based on Topics
 
* Based on Topics
 +
* Ability to add menu items to other Geeklog objects and webpages
 +
* Replaces/Adds to Topics Block and Top Menu
 
* Admin Interface for changing the style of the menus
 
* Admin Interface for changing the style of the menus
 
* Minimum support for CSS 2 styling
 
* Minimum support for CSS 2 styling
 
 
=== Topic Enhancements Plugin ===
 
 
The Category plugin work can be broken down into several sub parts:
 
 
  
 
Topics:
 
Topics:
Line 46: Line 38:
  
 
Tags:
 
Tags:
 +
* A Topic can be defined as a tag
 
* Tag Cloud block
 
* Tag Cloud block
 
* Page with Tag Cloud which lists items from selected tag as well as other tags the items belong too.  
 
* Page with Tag Cloud which lists items from selected tag as well as other tags the items belong too.  

Revision as of 20:10, 1 March 2012

(Return to the main idea page for the Google Summer of Code)

Introduction

When Geeklog 1.9.0 is released Topics will be able to have child Topics and, Blocks and Articles can be assigned to one or more Topics. With these new features of Geeklog, this makes a number of the ideas in the Google Summer of Code 2010 Category Plugin project not relevant. This new Topic Improvements project takes into account some of the projects from the Category Plugin and adds in a few new ideas.

Objective

The feature list for the Topic Improvements can be broken down into several parts:

Plugin API

  • Add new plugin API to integrate extra fields from one or more plugins into edit forms. This should allow for displaying, validation and saving the information. Some functionality will also be required to tell the plugin what plugins it should not integrate into
  • Add new plugin API to integrate extra fields from one or more plugins into submission forms
  • Add this functionality to the admin editors and submission forms of Articles, Category plugin, Static Pages plugin, Polls plugin, Links Plugin and Calendar plugin
  • Add support of adding one or more categories to Articles using the above API

allowing plugins to display items amongst the articles when a topic is displayed



Topic Admin Editor


Menu:

  • Based on Topics
  • Ability to add menu items to other Geeklog objects and webpages
  • Replaces/Adds to Topics Block and Top Menu
  • Admin Interface for changing the style of the menus
  • Minimum support for CSS 2 styling

Topics:

  • A Category can be defined as a tag
  • A Category or plugin item can be defined as a menu item
  • Admin Category Page - Some sort of tree user interface to display categories on left with selected category/item info on the right


Tags:

  • A Topic can be defined as a tag
  • Tag Cloud block
  • Page with Tag Cloud which lists items from selected tag as well as other tags the items belong too.


What's Related Block:

  • Based on Topic relationships (Any other related info???)
  • Block should be able to display by using an autotag

Level of Difficulty

medium

This project will require someone to spend time understanding how Geeklog Blocks and the core plugin API works. You will also need to install a number of the more popular plugins that offer similar features to see how they work. As of version 1.8.0, Geeklog now includes jQuery. jQuery could be used with this project for the menu system and/or the Category Admin editor tree.


Further Reading