Changeset 598654
- Timestamp:
- 09/13/2012 06:24:14 PM (13 years ago)
- File:
-
- 1 edited
-
cac-featured-content/trunk/README.md (modified) (2 diffs)
Legend:
- Unmodified
- Added
- Removed
-
cac-featured-content/trunk/README.md
r598653 r598654 1 ![Commons Logo]() 2 1 3 # Introduction 2 The CAC Featured Content Widget is a plugin developed for the [CUNY Academic Commons](http://commons.gc.cuny.edu) an academic social network powered by WordPress, BuddyPress, and MediaWiki. The widget provides several useful tools for featuring selected content, such as Featured Blogs, Featured Groups, Featured Posts, Featured Members and Featured Resources. Currently the plugin will work on both single and multisite installs, but is BuddyPress *dependent*. It will *not*work on a non-BuddyPress install.4 The CAC Featured Content Widget is a plugin developed for the [CUNY Academic Commons](http://commons.gc.cuny.edu) an academic social network powered by WordPress, BuddyPress, and MediaWiki. The widget provides several useful tools for featuring selected content, such as Featured Blogs, Featured Groups, Featured Posts, Featured Members and Featured Resources. Currently the plugin will work on both single and multisite installs, but is BuddyPress __dependent__. It will __not__ work on a non-BuddyPress install. 3 5 4 6 # Features 5 7 The five featured content types (blog, group, post, member and resource) share a lot of the code behind the scenes. Their layouts (views) and structure are all very similar. It's only the specific details about each that change. The admin interface for the plugin has been augmented with autocomplete functionality to help simplify administrative tasks. The featured blog address, featured group name, featured post name and featured member username will all provide results from your BuddyPress/MultiSite installation as you type. 6 8 7 If the description provided by the chosen featured content type is not suitable, for whatever reason, the plugin offers a *Custom Description* text field to provide an alternative. The text entered in this field will override any description that was automatically parsed by the plugin while querying for your featured content type. This field also serves as the only description for the *Featured Resource*content type.9 If the description provided by the chosen featured content type is not suitable, for whatever reason, the plugin offers a __Custom Description__ text field to provide an alternative. The text entered in this field will override any description that was automatically parsed by the plugin while querying for your featured content type. This field also serves as the only description for the __Featured Resource__ content type. 8 10 9 The crop length (in characters) of the description can be controlled via the plugin's *Crop Length*input field. Either the automatically parsed description, or the custom description text, will be cropped with ellipses appended to the end. The default is 250 characters.11 The crop length (in characters) of the description can be controlled via the plugin's __Crop Length__ input field. Either the automatically parsed description, or the custom description text, will be cropped with ellipses appended to the end. The default is 250 characters. 10 12 11 The widget that's displayed to the user on the front of the site provides a link after the description to allow the visitor to view the remainder of the featured content in its full glory. The link text defaults to "Read More...", but can be customized through the *Read More Label*field.13 The widget that's displayed to the user on the front of the site provides a link after the description to allow the visitor to view the remainder of the featured content in its full glory. The link text defaults to "Read More...", but can be customized through the __Read More Label__ field. 12 14 13 You have almost complete control over the plugin's image handling capabilities. The *Display Images* checkbox toggles the displaying of all images. When images are displayed they will be chosen based on the type of featured content, unless you enter a URL to a specific image in the *Image URL* field. For groups, the image is the group’s avatar; for members their personal avatar is used; for a blog the author’s avatar is used; and for posts the image used is either the first image within the post or the avatar of the post's author. The resource type will use the URL from the *Image URL* field to load an image from an external source. The size of the thumbnail displayed in the widget can be controlled through the *Image Width* and *Image Height*fields, which are both set to 50px by default.15 You have almost complete control over the plugin's image handling capabilities. The __Display Images__ checkbox toggles the displaying of all images. When images are displayed they will be chosen based on the type of featured content, unless you enter a URL to a specific image in the __Image URL__ field. For groups, the image is the group’s avatar; for members their personal avatar is used; for a blog the author’s avatar is used; and for posts the image used is either the first image within the post or the avatar of the post's author. The resource type will use the URL from the __Image URL__ field to load an image from an external source. The size of the thumbnail displayed in the widget can be controlled through the __Image Width__ and __Image Height__ fields, which are both set to 50px by default. 14 16 15 The incorporation of additional methods for including images is planned for future releases. 17 __Note:__ *The incorporation of additional methods for including images is planned for future releases.* 16 18 17 19 # Technical Details 18 For the interested reader, this plugin behaves similarly to the WordPress template hierarchy or a loose interpretation of the Model-View-Controller (MVC) design paradigm. Execution begins in `cac-featured-content.php`. This is the main plugin file, containing the usual WordPress plugin comments and the definition of the `CAC_Featured_Content_Widget` class. This class/plugin structure is a modified version of the WordPress plugin widget boilerplate available [here](). This file also defines the `CAC_Featured_Content_View` class which will be used by `cac-featured-controller.php` to gather information specific to the type of featured content to be displayed. The `CAC_Featured_Content_Widget` class is responsible for generating the widget view in both the admin section as well as the front of your site, and handles all the database updating when an option has changed. This class is instantiated on the `widgets_init` hook during WordPress' initialization, and acts as the 'M' in MVC.20 For the interested reader, this plugin behaves similarly to the WordPress template hierarchy or a loose interpretation of the Model-View-Controller (MVC) design paradigm. Execution begins in `cac-featured-content.php`. This is the main plugin file, containing the usual WordPress plugin comments, and begins loading the plugin by requiring `cac-featured-main.php` on the bp_include action hook. This ensures BuddyPress has been loaded prior to loading the rest of the plugin's files. `cac-featured-main.php` contains the definition of the `CAC_Featured_Content_Widget` class. This class/plugin structure is a modified version of the WordPress plugin widget boilerplate available [here](https://gist.github.com/1229641). This file also defines the `CAC_Featured_Content_View` class which will be used by `cac-featured-controller.php` to gather information specific to the type of featured content to be displayed. The `CAC_Featured_Content_Widget` class is responsible for generating the widget view in both the admin section as well as the front of your site, and handles all the database updating when an option has changed. This class is instantiated on the `widgets_init` hook during WordPress' initialization, and acts as the 'M' in MVC. 19 21 20 When the widget is rendered on the front of your site the widget()method of the `CAC_Featured_Content_Widget` class is called. This method simply delegates that job to `cac-featured-controller.php`. This file acts as the 'C' in MVC, it gathers all the details specific to the requested featured content type and stores them in an instance of the `CAC_Featured_Content_View` class mentioned above. It leans on some static methods defined in `cac-featured-helper.php` to perform some of the heavy lifting in finding specific blogs, posts and images. Once parsing of this file has completed it passes execution onto the appropriate view template, stored in the views/ subdirectory.22 When the widget is rendered on the front of your site the `widget()` method of the `CAC_Featured_Content_Widget` class is called. This method simply delegates that job to `cac-featured-controller.php`. This file acts as the 'C' in MVC, it gathers all the details specific to the requested featured content type and stores them in an instance of the `CAC_Featured_Content_View` class mentioned above. It leans on some static methods defined in `cac-featured-helper.php` to perform some of the heavy lifting in finding specific blogs, posts and images. Once parsing of this file has completed it passes execution onto the appropriate view template, stored in the views/ subdirectory. 21 23 22 24 The 'V' in MVC comes from one of the five files in the views directory. Each file contains the appropriate PHP and HTML markup to render its specific featured content type. … … 27 29 28 30 ### 1.0.0 29 separated plugin responsibilities into MVC-like structure30 rewrote readme files31 added code to handle multiste and non-multisite installs32 simplified html structure in all view files33 added autocomplete functionality34 rewrote helper class to work with new admin widget layout35 rewrote admin js file to work with new admin widget layout36 started new clean cac-featured-content plugin structure31 * separated plugin responsibilities into MVC-like structure 32 * rewrote readme files 33 * added code to handle multiste and non-multisite installs 34 * simplified html structure in all view files 35 * added autocomplete functionality 36 * rewrote helper class to work with new admin widget layout 37 * rewrote admin js file to work with new admin widget layout 38 * started new clean cac-featured-content plugin structure
Note: See TracChangeset
for help on using the changeset viewer.