SoC category plugin

From GeeklogWiki
Jump to: navigation, search
(Return to the main idea page for the Google Summer of Code)

Contents

Introduction

Geeklog�s current solution for categories are topics. The problem with topics is that they are only one level deep and are associated with just articles. Another issue is that blocks can only be assigned to one or all topics. This limits webmasters on how they can categorize and display information.


Incentive

The Category plugin will solve all these issues plus add in many new features. The Category plugin will work alongside Topics but in the future it could replace them. Along with the Category plugin you will be updating Geeklog�s plugin API to allow plugins the ability to hook into the admin editors of articles and other plugins. Hooks will also be required for Geeklog�s blocks.


Objective

The feature list for the Category plugin can be broken down into two main parts, Geeklog Core changes and the plugin itself:


Core Changes

  • 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
  • Add support to Blocks to display depending on the category shown (should this be some sort of new Plugin API similar to above or should the block control be built into the plugin???)


Category Plugin

The Category plugin work can be broken down into several sub parts:


Categories:

  • Any Article and plugin item (that supports the API) can be added to a category
  • A Category has one parent but can have zero, one or many categories and items assigned to it
  • A Category can have one or more item type (i.e. Articles and Static Pages could be assigned to it)
  • Security on Categories (Read/Usage, Edit)
  • A Category can be defined as a tag
  • A Category or plugin item can be defined as a menu item
  • A display system for Categories that works similar to Topics (the layout and blocks)
  • A Category at any level can be displayed (and inherit items below it if object or category can be inherited)
  • If a visitor is viewing a category they should be able to drill down and view sub categories
  • Admin Category Page - Some sort of tree user interface to display categories on left with selected category/item info on the right


Breadcrumbs:

  • Displayed when viewing a Category
  • Plugins should be allowed to pull this information to display it as well
  • Support Google Rich Snippets for Breadcrumbs


Menu:

  • Based on Categories
  • Admin Interface for changing the style of the menus
  • Minimum support for CSS 2 styling


Tags:

  • 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 Category relationships (Any other related info???)
  • Block should be able to display by using an autotag


Features to Consider for the Future

  • A number of plugins have their own category structure (See the Links and File Manager Plugin for examples). Is there a way that the Category plugin can offer this type of feature to future plugins? This would mean that the other plugin would be dependent on the Category plugin to control the category structure and allow it to display the category list in the other plugin


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

Personal tools
Namespaces

Variants
Actions
documentation
Tools