EXT: cgswigmore¶

What is it about¶

Swigmore institute (cgswigmore) is a TYPO3 extensionwhich was developed to displayinformation about work groups (departments/defined as “sections”), publications, staff members and job offers on your homepage. Foreachsectionit provides a list- andasingle view.Thesingle view includes the section's member list, a list ofthepublications and a detailed description.

The extension uses html templates to change the style of the output. The extension itself is multi-lingual, atthemoment English and German are available.

Swigmore institute uses true MN-relation tables for the staff members, the publications etc..

Using cgswigmoreneeds some configuration, but it is easily to set up. The best way is to create one main templatecontainingall global information for yourpage. In page-dependent sub-templates you can customize the configuration.

Screenshots¶

T he extension's data should be managed in different SysFolders.

Here you can see the input form for a new section:

A section contains the section's name, title, image, description and extra fields for the main and secondary leader.

The section's front-endlist viewcould look like this:

Installation¶

Go to the extension's manager, choose Import extensions and search for“ cgswigmore ”. Install the extension and create any required tables.

Setting up the extension -a step by step tutorial¶

Step 1

Let us start setting up the base structure of the homepage ( cgswigmore test site ).

Until n ow the test homepage contains one SysFolder whichcontains the typo3 configuration ( config ) and the typo3 template settings ( site ).Additionally the SysFolder contains a folder called data , where youcanset up the extension's templates in different sub-folders.

Setting up a section:The homepage's structure contains a page for Sections (UID=5) and a sub-page for Details (UID=8).If you don't want to use a sub-page for Details, you can combine the Details and Section page, however you must set the UID correctly.

Step 2 – Configuration of cgswigmore in the folder data

We create a new template in the folder data , which will contain all global configuration for cgswigmore.Define the template as following:

plugin.tx_cgswigmore_pi1 {

     section {
             templateFile = EXT:cgswigmore/res/section.html
             sectionUID = 8
             sort = sorting ASC
     }
}

This is a minimal configuration for the element. We define thesectionUIDproperty to the Detail page with UID 8.

Attention with the definitions:“ Sections ” means the page which will display the data.“ sections” is a SysFolder which will contain the data.“section” (used in the template above) is a part of cgswigmore's configuration.

Step 3

Now add the template you created in Step 2 to your page (eg. Homepage ).

Step 4

Configure the Section 's page (UID 5) and edit the page properties.

You can set the ' General Record Storage page' to the sections folder, this will tell cgswigmore wheretofind the dataprovided for being displayed. Finally you have to create a template in the Sections page with the following content:

plugin.tx_cgswigmore_pi1 {
    display = SECTION
}
page.10.subparts.CONTENT < plugin.tx_cgswigmore_pi1

At the Section's page (front-end) now you can see the section list (if you created any, refer to the first part of the user manual).

Thereexistmore options for the “section” element (step 2),but thosewill be explained later.

Step 5

Settingup a staff item (member):First create a new SysFolder (e.g. data/staff - UID=9) and a page (e.g. homepage/Staffpage - UID=10) to view the staff's information.

Secondly edit the template in the SysFolder staff .Add the following configuration:

plugin.tx_cgswigmore_pi1 {
     staff {
             templateFile = EXT:cgswigmore/res/staff.html
             sort = name ASC
             staffUID = 10
             link.sprintf = %s %s
     }
}

Now you can create new staff member itemsin the SysFolder staff .

Do you see a problem?

You cannot select any section item for the staff member youcreated. To enable this option, go to the page properties and set the ' General Record Storage page' to the data/sections SysFolder.

Step 6

Now go to the page (e.g. Homepage/Staffpage - UID=10) you created for the staff member items. There you create a template with the following content:

plugin.tx_cgswigmore_pi1 {
    display = STAFF
}
page.10.subparts.CONTENT < plugin.tx_cgswigmore_pi1

Then set the ' General Record Storage page' to the SysFolder staff .

If you go to the staff's site on the front-end (e.g. Homepage/Staffpage - UID=10) youmostprobably see another problem.

The link/text for the sections are not generated.

To solve this problem you have to overwrite the SysFolders UID in the global configuration template (/data) by setting the section. recordIds property. So the final template for the page (UID=10) looks like this:

plugin.tx_cgswigmore_pi1 {
     display = STAFF

     section.recordIds = 7
}
page.10.subparts.CONTENT < plugin.tx_cgswigmore_pi1

The sameconflicthas the section's staff view ( Homepage/Sections/Detail ). Also there the staff members can't be displayed because of the ' General Record Storage page' . Edit the Sections template, at the end it should look like this:

plugin.tx_cgswigmore_pi1 {
    display = SECTION

    staff.recordIds = 9
}
page.10.subparts.CONTENT < plugin.tx_cgswigmore_pi1

Step 7

Setting up of publications:

First create a new SysFolder ( data/publication – UID=11) and a new page (e.g. Homepage/Pubpage - UID=12), thenedit the template in the SysFolder data . Add the following configuration for the publications:

plugin.tx_cgswigmore_pi1 {
     publication {
             templateFile = EXT:cgswigmore/res/publication.html
             link = 0
             sort = date DESC
     }
}

Before you add a new publication you should set the ' General Record Storage page' of the data/ publication SysFolder to the data/ sections folder.

Step 8

Go to the publication page ( Homepage/Pubpage ), set the ' General Record Storage page' for the publication's SysFolder (UID=11) and create a new template with the following content:

plugin.tx_cgswigmore_pi1 {
    display = PUBLICATION
}
page.10.subparts.CONTENT < plugin.tx_cgswigmore_pi1

Edit the templates for the staff member item page ( Homepage/Staffpage ) and the Sections page ( Homepage/Sections ) to find the publications. Simply add the following lines to the templates:

 publication {
        recordIds = 11
}

Step 9

Creatingjob categories

Simply adda single SysFolder ( data/jobcategory - UID=13) and create some job categories.

Step 10

Within the job categoriesyoucan create job offers. Create a SysFolder ( data/job - UID=14) and a page ( Homepage/Job - UID=15). The job page's 'General Record Storage page' should point to the job categires SysFolder.

Edit the template in the SysFolder data and add the following lines:

 job {
        templateFile = EXT:cgswigmore/res/job.html
        category {
                sort = sorting ASC
        }
        job {
                sort = crdate DESC
        }
}

Step 11

The next step is to create a template in the page Job (UID=15) with the content:

plugin.tx_cgswigmore_pi1 {
     display = JOB

     staff {
             recordIds = 9
     }
}
page.10.subparts.CONTENT < plugin.tx_cgswigmore_pi1

Note thatwe haveset the recordIds property for the staff member items. The extension again needs this setting to find the staff member items in the correct SysFolder.

Step 12

Finally I woud like to explain the set up for a location page.Howeverthere are muchnicerextensionsavailabledoingthe same job.

Create a SysFolder (data/location - UID=16) and a page (Homepage/Location - UID=17). Now configure the template in the SysFolder data and add the following lines:

plugin.tx_cgswigmore_pi1 {
     location {
             templateFile = EXT:cgswigmore/res/location.html
     }
}

Step 13

Go to the Location page (UID=17) and set the 'General Record Storage page' to the location's SysFolder (UID=16). Create a new template which contains:

plugin.tx_cgswigmore_pi1 {
     display = LOCATION

     location {
             uid = 1 # the uid of the location to display
     }
}
page.10.subparts.CONTENT < plugin.tx_cgswigmore_pi1

The template in the SysFolder data should now look like this:

plugin.tx_cgswigmore_pi1 {
     section {
             templateFile = EXT:cgswigmore/res/section.html
             sectionUID = 8
             sort = sorting ASC
     }
     staff {
             templateFile = EXT:cgswigmore/res/staff.html
             sort = name ASC
             staffUID = 10
             link.sprintf = %s %s
     }
     publication {
             templateFile = EXT:cgswigmore/res/publication.html
             link = 0
             sort = date DESC
     }
     job {
             templateFile = EXT:cgswigmore/res/job.html
             category {
                     sort = sorting ASC
             }
             job {
                     sort = crdate DESC
             }
     }
     location {
             templateFile = EXT:cgswigmore/res/location.html
     }
}

Thistutorialcontains only some options which are supported by cgswigmore. See the configuration chapter for more details.

Styling cgswigmore¶

Cgswigmoreprovidesa CSS style which you can include or/and modify.Of course some basic CSS knowledge is required. To include the CSS file add the following line to your templage ( SysFolder /data).

page.includeCSS.file00101010 = EXT:cgswigmore/res/css/cgswigmore.css

Using your own html templates¶

Itispretty easy to use your own HTML template. Each section has its own template. The default templates are located at typo3conf/ext/cgswigmore/res and contain all the supported markers by cgswigmore.

Display code¶

With the display code you can decide which information willbe shownon the homepage. The supported codes are:

UserFunc¶

Cgswigmore provides three predefined user functions which can be used in the extension's configuration.Howeverit is important that typo3 knows this user functions before. Insert the following lines in your configuration template:

page.includeLibs.userFuncs1 = EXT:cgswigmore/userFunc/class.user_cgswigmore_userfunc_pubmed.php
page.includeLibs.userFuncs2 = EXT:cgswigmore/userFunc/class.user_cgswigmore_userfunc_file.php
page.includeLibs.userFuncs3 = EXT:cgswigmore/userFunc/class.user_cgswigmore_userfunc_file_icon.php

Common properties¶

Here are some properties which are common for all the elements listed below.

The templateFile property isnotoptional and must be set for each configured item. The other options explained here are optional, but as you have seen in the step by step tutorial, sometimes they are required.

templateFile = EXT:cgswigmore/res/section.html
templateFile = EXT:cgswigmore/res/staff.html
templateFile = EXT:cgswigmore/res/publication.html
templateFile = EXT:cgswigmore/res/job.html
templateFile = EXT:cgswigmore/res/location.html

SECTION¶

The configuration of the section element will be done inplugin.tx_cgswigmore_pi1.sectionas we already used in thetutorial. Additionally to the previously presented basic properties you can use the following options:

sort = <field> DESC

image {
       height = 70
       format = png
       quality = 100
}

user_cgswigmore_userfunc_file_icon->linkFileIcon

STAFF¶

Configuration of the staff element will be done inplugin.tx_cgswigmore_pi1.staffas we already used it in the tutorial. Additionally to the previously presented basic properties you canusethe following options:

sort = <field> DESC

link.sprintf = <b>%s</b> %s

section.doNotLink = 1

image {
       width = 80
       format = png
       quality = 100
}

PUBLICATION¶

Configuration of the publication element will be done inplugin.tx_cgswigmore_pi1.publicationas we already used it inthe tutorial. Additionally to the previously presented basic properties you can use the following options:

user_cgswigmore_userfunc_file->linkFile

user_cgswigmore_userfunc_pubmed->linkPubMed

user_cgswigmore_userfunc_file_icon->linkFileIcon

sort = <field> DESC

JOB¶

Configuration of the job element will be done inplugin.tx_cgswigmore_pi1.jobas we already used it in the tutorial. Additionally to the previously presented basic properties you can use the following options:

view = AIO

view = CJS

sort = <field> DESC

sort = <field> DESC

icon.userFunc = user_cgswigmore_userfunc_file_icon->linkFileIcon

LOCATION¶

Configuration of the location element will be done inplugin.tx_cgswigmore_pi1.locationas we already used it in the tutorial before. Additionally to the previously presented basic properties you can use the following options:

image {
       width = 80
       format = png
       quality = 100
}