[module] Flag Plus

TODO: this content is incomplete, unfinished, or under construction.
HOT TIP: this content is flagged as highly recommended !

Compatibility:

0
Project page quote (external)
Project page quoted on: 
2014-12-26

SYNOPSIS

The simple-yet-powerful Flag project is one of the most popular Drupal contributed projects. The Flag Plus project extends Flag with some convenient features such as:

- The ability to conveniently view and set flag applicability by custom content type (by entity type and bundle name) so that one does not have to edit each flag and select it as applicable to a newly added custom type, which can be tedious and error prone.

- An easy system for indicating whether a given content node/page is flagged or not flagged with easily-configured flag banner blocks or page decorators and CSS style options. This simple flag banner strategy can be amazingly effective for indicating publishing workflow.

This is an actively maintained and evolving tutorial development project, with a live demonstration site home page:

- http://drupal7demo.webel.com.au/module/flagplus

The Flag Plus module also now has a set of unique graphical Unified Modeling Language (UML) models that track progressive refactoring of the Flag Plus module into a more object-oriented form:

- http://drupal7demo.webel.com.au/module/flagplus/uml

Similar projects and how they are different

There are many modules that use or complement Flag, but none with the particular feature extensions offered by Flag Plus.

REQUIREMENTS

This module requires:

- The Flag module.

- The Libraries API module.

- The JQuery Colorpicker module and the JQuery Colorpicker lib.

- X Autoload, which is highly recommended for object-oriented projects. This version of the Flag Plus module is being progressively migrated to leverage more OOP (but without yet full integration with Webel IT Australia's Drupal7 OO bridge project OOE).

A fully object-oriented version of Flag Plus (called Flag Plus OO) is also being developed that leverages the Object Oriented Examples bridge for Drupal7 under development by Webel IT Australia. The version of Flag Plus here is deliberately a "straight" Drupal7 version.

INSTALLATION

- Install as you would normally install a contributed drupal module. See Installing modules (Drupal 7) for further information.

- Be sure to also follow these instructions for installation of the Colorpicker lib.

CONFIGURATION

- There is a configuration overview page with instructions at: /admin/config/structure/flagplus

Flag settings power-editing

- You can configure which Flags are applicable to which bundles (custom types) "by bundle" using a handy checkbox form for each bundle at /admin/structure/flagplus/bybundle/edit. This is convenient when new entity type bundles are added, because you don't have to tediously edit each Flag's settings and choose it's applicability. (See image examples below.)

Flag Plus banners decorator and/or banners block

- There is an option for whether the Flag Plus banners decorator or the banners block is shown for node content, as well as an option to show a block title and highlight the banners block, and some banners styling options. Configure them at: /admin/config/structure/flagplus/banners

- It is mostly recommended that you always use the banners decorator - which can be turned on and off for 'full' and/or 'teaser' node view modes - instead of the banners block. However, there may be cases where you want to indicate flag status in say the theme's sidebars, rather than above the main page content, using the banners block.

- If using the banners block remember to also enable it be allocating it to a theme region (usually to the first/top block within the Content region) at: /admin/structure/blocks.

- For each Flag, the colors for the banners background, text, and border, and whether to show banners for when a node is flagged or not, can also be set at /admin/config/structure/flagplus/banners. You can also choose to show only the Flag title, only the banner message, or both, for each Flag.

Fine-tuning of banner styles

You may fine tune the appearance of banners by overriding the CSS styles of /flagplus/flagplus-banners.css.

MAINTAINERS

webel - http://drupal.org/user/392755

No other maintainers are currently sought.

CREDITS

The Flag Plus module is developed by Webel IT Australia, specialists in PHP-driven Drupal CMS web engineering, UML, SysML, Java and XML. In addition to using Drupal CMS for developing clients' web sites, Webel has used Drupal CMS for many years to develop educational web sites promoting graphical software engineering with Unified Modeling Language (UML) and graphical systems engineering with Systems Modeling Language (SysML):

- http://www.webel.com.au

- http://drupal7demo.webel.com.au

Depends on modules [Drupal7]

DEMOS

TODO

CREDITS

The Flag Plus module is developed by Webel IT Australia, specialists in PHP-driven Drupal CMS web engineering, UML, SysML, Java and XML. In addition to using Drupal CMS for developing clients' web sites, Webel has used Drupal CMS for many years to develop educational web sites promoting graphical software engineering with Unified Modeling Language (UML) and graphical systems engineering with Systems Modeling Language (SysML):

- http://www.webel.com.au

- http://drupal7demo.webel.com.au

SPONSORS SOUGHT

If you are interesting in seeing Flag Plus expanded, or in seeing a Drupal8 version developed, please consider supporting the project. Donations to the Flag Plus project may be made online via PayPal.

Images
Concerns, issues, warnings, gotchas
Have to reload page "by hand" GET after changing flag status with Flag AJAX link to show banners change

Am working on getting forced page refresh after using the Flag AJAX links for flagging/un-flagging a node, so that the changes in the Flag Plus banners can be seen immediately.

Visit also