Paper Manager

Joomla 3 component & plugin

Joomla 3.x

Paper Manager is a Joomla 3 extension allowing the management of scientific publications. The extension is useful for websites related to research laboratories and organizations. Lists of scientific papers are commonly present in such websites. A single paper can be included in more than one of these lists. For example it can be shown on a page dedicated to the conference publications of the lab and also on the profile pages of the authors. Paper Manager allows a specific paper entry to be displayed on multiple pages without copying html code on all the relative articles. The extension consists of a component and a content plugin. The component is used for CRUD operations on papers, paper categories and authors while the plugin displays lists of papers inside content (ex. articles), using special code snippets.

Please note that the extension has not been thoroughly tested and it may contain critical bugs. You can contact me on chris lezos email for bug reports and feature requests.

Download Demo

Installation

The component and plugin come archived in a package file. A package is an extension that is used to install multiple extensions in one go. Follow the next steps to install Paper Manager on your website.

  1. From the administration of your Joomla website navigate to “Extensions → Extension Manager”.
  2. Under “Upload & Install Joomla Extension” click “Choose File” and select the Paper Manager package installation file “pkg_papermanagerlite-x.x.x”.
  3. Click “Upload & Install”. You will get a confirmation message that the component and plugin were successfully installed.
  4. From the menu on the left click “Manage” and confirm that both the component and the plugin have been installed. Look up “Content - Paper Manager Lite Plugin”, “Paper Manager Lite” and “Paper Manager Lite Package”.

Uninstallation

  1. From the administration of your Joomla website navigate to “Extensions → Extension Manager” and select “Manage” from the menu on the left.
  2. Uninstall “Paper Manager Lite Package”. If you get an error message uninstall “Content - Paper Manager Lite Plugin” and/or “Paper Manager Lite” as well.

Using the component

The Paper Manager component lets the user manage the paper collection. It offers three CRUD editors. One for the paper categories, another for the authors and a third one for the papers themselves. Each can be accessed from the administration by navigating to “Components → Paper Manager Lite → Categories”, “Components → Paper Manager Lite → Authors” and “Components → Paper Manager Lite → Papers” respectively. Each item in these lists has the following fields:

Paper Manager ER
ER diagram of Paper Manager component logic.

Paper Manager component - Quick tutorial

Paper Manager Categories

Paper Manager Authors

Paper Manager Paper
Paper Manager Papers

Using the plugin

The Paper Manager plugin loads Paper Manager publications within content (ex. articles). It works in a similar way with the “Content - Load Modules” plugin, which is included in the core Joomla distribution. Special code snippets are used in the content that are translated into HTML code in the front-end (lists of papers in our occasion).

You have to enable the plugin before using it. To do this, navigate to “Extensions → Plugin Manager” and enable “Content - Paper Manager Lite Plugin”.

Plugin parameters

Each style outputs the following HTML code:

<ul class="papermanager_front_list">
     <li class="papermanager_front_list_item">Item 1</li>
     <li class="papermanager_front_list_item">Item 2</li>
     …
     <li class="papermanager_front_list_item">Item n</li>
</ul>
<ol class="papermanager_front_list">
     <li class="papermanager_front_list_item">Item 1</li>
     <li class="papermanager_front_list_item">Item 2</li>
     …
     <li class="papermanager_front_list_item">Item n</li>
</ol>
<ol reversed="" class="papermanager_front_list">
     <li class="papermanager_front_list_item">Item 1</li>
     <li class="papermanager_front_list_item">Item 2</li>
     …
     <li class="papermanager_front_list_item">Item n</li>
</ol>
<div class="papermanager_front_list">
     <div class="papermanager_front_list_item">Item 1</div>
     <div class="papermanager_front_list_item">Item 2</div>
     …
     <div class="papermanager_front_list_item">Item n</div>
</div>

As it can be noticed, certain CSS classes are assigned to the generated HTML code to provide a way of stylizing the output. The following CSS rules can be used as a template:

ul.papermanager_front_list{
}
ul.papermanager_front_list li.papermanager_front_list_item{
}
ol.papermanager_front_list{
}
ol.papermanager_front_list li.papermanager_front_list_item{
}
div.papermanager_front_list{
}
div.papermanager_front_list div.papermanager_front_list_item{
}

Code snippets Syntax

Code snippets should be written in the following form. Each snippet works as a query to the plugin. The plugin process the queries, retrieves the appropriate papers and generates the HTML code for each query/paper list.

{loadpapers:authors=X:categories=X:years=X:months=X:lab=X:style=X}

X denotes a value. Six constraints are used in a single snippet:

To omit a constraint from the query its value should be set to “any”. authors, categories, years, months and lab can be set to 'any' if you don't want to constrain the output to some specific value. “any” does not work for style though. style accepts the value “default” in order to make use of the style set in the plugin’s parameters.

Paper Manager plugin - Quick tutorial

{loadpapers:authors=any:categories=1:years=any:months=any:lab=1:style=olreversed}
{loadpapers:authors=2:categories=any:years=any:months=any:lab=any:style=olreversed}

Paper Manager Plugin
Paper Manager Plugin
Paper Manager Plugin