EXT: PURE¶

What does it do?¶

This extension provides users of PURE v. 4 and TYPO3 to insert information from PURE – Persons, publications and activities.

The benefit of this is that you can decide what information you want to show, and then this information automatically get updated if users updates their information in the PURE system.

For example you can say you want to insert a list of persons from a specific department. Then this queried to PURE server and the person from that specific department will be listed on the page in a table. From there you can click on a person and get all the information about that person.

With this extension you can insert the following:

• Show a single person
• Show a single publication
• Show a single activity
• List of persons – Layouts: List, sortable table
• List of publications – Layout: Sortable list – Extra: RSS Feeds also available
• List of activities – Layout: Sortable list
• Search for persons – Layouts: A simple search box
• Search for publications – Layouts: A simple search box or an advanced form with filters
• Search for activities – Layouts: A simple search box or an advanced form with filters

All the layouts included for persons is also using the microformat hCard .

When clicking on a link to a specific person, publication or activity this in showed on a master page.

All information queried from a PURE server is also being cached in TYPO3.

Note: This is extension is currently only adapted to the danish model (Aarhus University) of PURE.

This manual is also available as a PDF document. Click here to download it .

Screenshots¶

Image 1: Configuration of "List of persons"

Image 2: Output after configuration of "List of persons"

Image 3: Extension configured to only show publications from a specific year

Image 4: Master page showing information about a specific person

How to insert information from PURE¶

On a page where you want to insert something, this can be a business card for a person, a list of persons from a department or a list of publications spanning over some years, this can be done by following this standard procedure:

When you are in the TYPO3 back-end and have a page where you want information to appear, then click on icon named Create new element .

Choose PURE under Plugins .

Click the tab named Plugin .

Under General Settings click the type of information you want to insert in the right side. When you click the item will be displayed in the left side. Note that you can choose to setup multiple views by adding more to the left side.

For every new tab appearing to the right of the tab named Template make sure to set it up. This is done by clicking the tab and choosing the options you like to have.

When you are done click the button named Save document in the top.

Here is a image of the output generated by following the previous pictures:

FAQ¶

Installation and setup¶

Requirements: This extension depends on the following extension: dynaflex

Install the extension using Ext Manager .

On a SITE include Pure (pure) and Pure css (pure) – The last one of these two is optional. This is done by going to Template → A page → Edit the whole template record → Includes → Choose Pure (pure) and Pure css (pure) under Include static (from extensions) .

Setup a master page for the extension (see section “How to setup the MASTER PAGE”).

How to setup the MASTER PAGE¶

To get the extension to work on a website a page that is going the be the master page for the extension must be configured.

This is done like this:

Create a new page in TYPO3.

Insert the extension on this page ( Create new element → Choose PURE under Plugins ).

Write down the PID (Page ID) of the configured page.

The plugin on this page in the back-end will say it is not configured. Just ignore this.

The extension on the website now need to know which page you did make as the master page. This is done by setting the constant plugin.tx_pure_pi.singlePid to the PID from step 3. This can also be done in the TYPO3 back-end like this:

Click the tab named Template in the right side and choose a page.

Choose Constant Editor in the drop-down menu.

Choose PLUGIN.PURE in the next drop-down menu.

Write the PID in under The PID of the page that contain empty PURE plugin which can be found under the category Links and targets .

TypoScript configuration¶

The following section will describe the different TypoScript constants that can be set. The default column is the values set by the TS template Pure (pure) .

“plugin.tx_pure_pi” have the following TypoScript properties.

plugin.tx_pure_pi.templates.singlePidsTemplates {

    persons = TEMPLATE_PERSONS_SIMPLE
    single_person = TEMPLATE_SINGLE_PERSON_BASIC

    single_activity = TEMPLATE_SINGLE_ACTIVITY_FULL
    activities = TEMPLATE_ACTIVITIES_SIMLPLE

    single_publication = TEMPLATE_SINGLE_PUBLICATION_FULL
    publications = TEMPLATE_PUBLICATIONS_SIMLPLE

    cv = TEMPLATE_SINGLE_PERSON_CV
    keyword = TEMPLATE_SINGLE_PERSON_KEYWORD

    keyword_page = TEMPLATE_KEYWORDSANDPERSONS
    keyword_persons = TEMPLATE_PERSONS_NAMES
    keyword_keyword = TEMPLATE_KEYWORD_TITLES

    rss = TEMPLATE_PUBLICATIONS_RSS

    search_persons = TEMPLATE_SEARCH_PERSONS_SIMPLE
    search_persons_result = TEMPLATE_PERSONS_TABLE

    search_activities = TEMPLATE_SEARCH_ACTIVITIES
    search_activities_result = TEMPLATE_ACTIVITIES_SIMLPLE_WITHOWNER

    search_publications = TEMPLATE_SEARCH_PUBLICATIONS
    search_publications_result = TEMPLATE_PUBLICATIONS_SIMLPLE
}

RealUrl¶

When the extension is up and running the configured master page will function as a gateway to display information about persons, publications and activities. If the MASTER PAGE was named persons in the root,then information from PURE can be accessed directly by this page. For example it possibly to show a person by ID/e-mail by entering the following URL:

http://www.example.com/persons/?tx_pure_pi[personId]= ID

Ex.: http://cs.au.dk/persons/?tx_pure_pi[personId]=email@cs.au.dk

The URL can be more beautiful by using something like the realurl extension. By using for example the following configuration for this extension:

'postVarSets' => array(
        '_DEFAULT' => array(
                'act' => array(
                        array(
                                'GETvar' => 'tx_pure_pi[actId]',
                        ),
                ),
                'person' => array(
                        array(
                                'GETvar' => 'tx_pure_pi[personId]',
                        ),
                ),
                'org' => array(
                        array(
                                'GETvar' => 'tx_pure_pi[orgId]',
                        ),

                ),
                'showtype'=> array(
                        array(
                                'GETvar' => 'tx_pure_pi[showType]',
                         ),
                ),
                'pub' => array(
                        array(
                                'GETvar' => 'tx_pure_pi[pubId]',
                        ),
                ),
        ),
);

The URL from before will then be: http://www.example.com/persons/person/ ID

Ex.: http://cs.au.dk/persons/person/email@cs.au.dk/

How to get a dynamic title on the MASTER PAGE¶

To get a dynamic title on the master page (e.g., a name as title, when viewing a person), please to the following:

Click the tab named Template in the right side and choose the master page.

Choose Info/Modify in the drop-down menu.

Click on Edit the whole template record .(Click the button Click here to create an extension template , if there is now template on the page yet)

Insert the following code inside the text area for Setup :

includeLibs.pagetitle = EXT:pure/class.tx_pure_pagetitle.php
config.titleTagFunction = tx_pure_pagetitle->changetitle
lib.pageTitle = USER
lib.pageTitle {
     userFunc = tx_pure_pagetitle->changetitle
}

Insert content using the custom tag “pure”¶

One can insert some PURE output using the custom tag pure. The syntax of this tag is:

<pure template="name" type="[person | acitivity | publication]" function="[list | single]" >extraParam1=value1,...,extraParamN=valueN</pure>

An example could be:

<pure template="TEMPLATE_PERSONS_SIMPLE" type="person" function="single">personEmployeeIds=psb@cs.au.dk</pure>

One can also generate the custom tag from PHP using the class tx_pure_tag, using the function:

public function generate($template, $type, $function, array $params)

An example using this:

require_once(t3lib_extMgm::extPath('pure').'class.tx_pure_tag.php');
$tagGenerator = t3lib_div::makeInstance('tx_pure_tag');
$parameters = array('personEmployeeIds' => 'psb@cs.au.dk');
echo $tagGenerator->generate('TEMPLATE_PERSONS_SIMPLE', 'person', 'single', $parameters);

12