JoomlaXTC Reading ListReading List enhances content-rich sites by letting users keep a personalized reading list of Joomla articles and/or K2 Items from your website. They can later browse and read the articles in an easy to use interface, with options to share their content selection list with friends and other sites.
InstallationInstallation is done as with any standard Joomla extension following these steps:
Enabling Reading List on your siteThe configuration of Reading List is very simple, however some steps are necessary to fine-tune its functionality according to your needs. We start by first creating a menu entry for the component, then enabling the content plugins:
Making a Reading List menu entryThe Reading List view can be accessed by creating a menu option on your website. Use the standard Joomla Menu Manager to edit and add a menu option then click on the "Select" button in the Menu Item Type field and click on "Content Reading List" option from the "JoomlaXTC Reading List" section shown in the pop-up window. Set all menu options as desired. Once the menu option is saved, a user can navigate your website and click on it to see their personal Reading List.
Enabling the PluginsThe content plugins must be enabled first by going to the Extensions / Plug-In manager menu option and clicking on the plugin status icon to enable them. Once enabled, content articles will display a button to enable addition or removal of the article into the Reading List. It is preferred to have only one active content plugin at a time, you might find some data conflict if you choose to enable both at the same time. The plugins have a few settings you can adjust as needed:
Using the Reading ListOnce installed and configured, users can start using the Reading List. Since the content selection is a personal choice, users must be logged in first for the Reading List buttons to appear on the content articles, otherwise the Guest button will be shown if enabled.
Viewing the Reading ListAfter adding a few articles to the Reading List, the user can select the menu option to view his/her reading list:
Enabling the moduleIn the image above, you can notice the Reading List module being shown at the left. When enabled, the module can serve as a control panel for the Reading List view. Clicking on a category name in the module will change the view to display only the articles from that category. It can also display the two sharing options for the Reading List articles. To enable the module, first install it and follow these steps:
Enabling the information moduleThe information module provides a short message indicating the state of the user's reading list along with a link to the reading list component.
To enable the module, first install it and follow these steps:
Sharing the Reading ListThere are two ways to share a Reading list: Copy list links option can be used to paste the actual links of article pages in social networks, forums and more. Just click on the "Copy List Links" and a pop-up window will be shown where you can copy the HTML code for the articles shown in the list to be pasted elsewhere. Share this list option allows users to email a secure link of the Reading list to their friends, they in turn can visit the site to see what's on their friend's Reading list. Friends can also keep visiting the Reading List for future content updates. These features can be enabled or disabled by the Administrator by editing the component and/or module parameters as follows: For the component:
Customizing the listThe Reading List elements follow the standard Joomla templating rules and more. This makes custom layout and styling very simple by just adding template override files to any of the Reading List extensions, including the plugins! Although Joomla offers guidance on how to make template overrides in their wiki, we have a little recap here:
ModuleThe module has only one layout available, customize it as follows: Copy modules/mod_jxtc_readinglist/tmpl/default.php file as templates/yourtemplate/html/mod_jxtc_readinglist/default.php file. Modules are a bit different when it comes to custom layouts, as you can have more than one .php file in the tmpl folder of the module itself, and then choose which one to use using the "Alternative Layout" in the Advanced parameters section.
PluginsJoomla plugins do not allow for custom template overrides, but we have made our plugins follow the same principle for ease of styling, these are the files to copy for each: For Joomla content plugin: Copy plugins/content/jxtcreadinglist/tmpl folder as templates/yourtemplate/html/jxtcreadinglist folder. For K2 content plugin: Copy plugins/content/jxtcreadinglistk2/tmpl folder as templates/yourtemplate/html/jxtcreadinglistk2 folder. Plugins have two main .php files each: add.php and remove.php. These are the programs that render the Add and Remove buttons visible on content Articles and Items in the frontend.
More customizationsThe default Reading List component views make use of the standard Joomla Sliders functionality and a custom .css file to present the articles, of course you are free to change this when using template overrides, however to change the "looks" and styling of the default Joomla Sliders you must edit the corresponding classes in your Joomla template's .css file.
Copyright 2012,2013 Monev Software LLC www.joomlaxtc.com