Install the extension with the extension manager. It's recommended to install the extension in the “local” folder (typo3conf/ext/).
After the extension manager created the new database tables and fields for STI Organisation you should see a page with the main configuration options. Here you can configure some basic options (mostly BackEnd related).
You can configure the handling of business units with a checkbox in the extension manager:
The default is, to display categories only from the “General record storage page”. For more Information about categories and the “General record storage page” have a look at the “FAQ” in section “Quickstart”.
“Dividers to Tabs” is a feature introduced with TYPO3 3.7.0 which divides the BE form of a staff record to smaller parts (“Tabs”) see screenshot in the section “Screenshots”. Here you can disable this if you don't want to use it.
Localization mode for text fieldsBy default, some text fields (description ...) from a new localized staff will be prepended with "[translate to ...]". If this is not wanted you can disable it here.
Localization mode for imagesThe image field of a localized staff is excluded by default (images are alwas taken from the record in the default language). If you need localized images (f.e. if the images show texts) you can enable the "image" field in translated staff by setting "l10n_mode_imageExclude" to 0.
Hide new localizations
Width of the left category fieldThis field shows the selected business units in the staff db-record (or parent business units in the business units db-record). If "categorySelectedWidth" is set to 0 (zero) the default width (=180px) will be taken.
Width of the right category fieldThis field shows the business unit tree in the staff db-record (or in the business units db-record). If "categoryTreeWidth" is set to 0 (zero) the default width will depend on the browser which displays the TYPO3 BackEnd. The default width for all browsers except IE is 280px, for IE the default width is 320px to suppress the unneeded horizontal scrollbar below the category tree.
This section will give you a short overview about the basic setup requirements for STI Organisation to work. For more detailed informations you can have a look in the sections “Configuration” and “Administration” in this manual.
*** Important Note ***: If you don't include the TS-template as shown in the screenshot below, the plugin will do nothing.
The TS-settings are splitted in 2 different parts now which you should be included with the “Include static (from extensions)” feature. The big advantage of this technique is, that the extension is not included in all TypoScript setups from your site by default. You can now choose if you want to include only the basic setup or to include the default CSS-Styles.
The HTML-template is CSS-based, so you should include the “default CSS-styles” template too, because it contains all the formating information.
Save your TS-template and open or create a page, where you want the staff to appear.
Click on the "create new record" link, to add a new content-element. In the next screen click on the wizard link under “Pagecontent”.
The page that now openingis called the “new Content Element Wizard”. At the bottom of this page you'll find an icon called “STI Organisation”':
Select it and choose the position (column): eg NORMAL:
A form will show up looking almost like this:
It is required, to select at least one item from the "What to display" field. If you don't do this, an error message will appear instead of the staff content-element. To select an item, click on its name in the right list. (For the first test choose “LIST” and leave the other settings at their defaults)
The “Startingpoint” is the page/sysfolder, where the extension looks for staff-records. It is not required to set this value in this field, you can also define it with TypoScript for the whole page. See: section “Configuration/Reference” in this manual (-> pid_list)
If you don't insert a page as “Startingpoint” and no value for “pid_list” is defined by TS, the current page is used. That means the extension looks for records in the same page where the content-element is.
To test the functionality of the extension you'll also need at least one staff-record. Save & Close the form for the Staff content-element and click again on the "create new record" link. Choose the "Staff" item from the list.
A form opens, showing a staff database record:
Fill in some dummy information and save & close the form.
Assuming that you did not set a "Startingpoint" in the organisation content-element, and that the newly created staff-record is located in the same page as the organisation content-element - click on the preview icon and you should see your staff in your browser.
If this is not the case, repeat the steps above. If still no staff appear on your website, have a look in the section "Troubleshooting" of this document.
There are many ways to configure this extension. This will just get you started. For detailed configuration options take a look at the parts “Administration” and “Configuration” in this manual.
There are currently 4 option-sheets in the STI Organisation content element ("General Settings", "Template", "Unit Settings" and "other settings"). First we will concentrate on General Settings because all of the required options are located in this sheet.
Notice: Most of these options can also be controlled by TS, but the settings made directly in the content element will override TS settings.
What to display:
Currently there are 7 different options in the “What to display” field (this list can be extended by other extensions). These are the function of this options:
FIELD: What to display | Description: |
|---|---|
LIST | Displays a list of staff (i.e. phone list). |
TEASER HEADOF | Displays the Leader and his deputy of a business unit as teaser. |
TEASER STAFF | Displays a list of staff as teaser. |
SINGLE | Displays a single staff item. See section “The SINGLE view”. |
SEARCH | Displays a search box and result listing for searching staff. See section “The Search”. |
HIERARCHIE | Displays a business unit selector which shows nested units in a hierarchical menu. See section “The unit selector”. |
It is possible to define multiple “What to display”-codes in a STI Organisation content-element, but some of them will not work well together. If you encounter problems with those combined content-elements, try to split them in single elements with one code per element.
Title setting (for HeadOf):
In this selectbox you can choose which title should be used when teasing the “Head” and “deputy” of a business unit.
"Group by" this field (LIST):
In this selectbox you can choose the field by which the listed staff-records should be grouped. Possible options are: “Workspace” and “Country of origin”.
"Order by" this field (LIST):
In this selectbox you can choose the field by which the listed staff-records should be ordered. Possible options are: last name and first name.
default (= nothing selected) is to order lists by the “last name, first name” field.
With the selectbox “Ascending or Descending” you can choose the sorting order.
If you want to order or group your staff by fields, not listed here, you can do this by setting those fields by TypoScript. See section “Reference“ -> “listOrderBy” and “listGroupBy”
Hierarchie selection:
The display of units in the right field of the part “Belongs to business unit(s)” depends on the StoragePid of the plugin. If you didn't change the default value of the “use StoragePid” switch in the plugin-configuration in the extension manager, it is required to define a "General Record Storage page" in the page-properties of the rootpage (the page with the “is root of the website” flag).
The "General Record Storage page" points to the folder where the ri_organisation business units are stored. See “FAQ” for more information.
If you set the “use StoragePid” value to “0” in the extension manager, you should see all categories from the whole pagetree in the select box.
It's possible to select staff for display by their assigned business units or sub units. A staff can be member of multiple business units. It's also possible to select de-select staff by their assigned locations of to display only non-categorized items. The “Hierarchy mode” selector offers the following options:
FIELD: Category mode | Description: |
|---|---|
Show all | Displays all staff no matter which business units are assigned. (Don't care about the field: Hierarchie selection) |
Show staff from selected units and sub units | Only staff is displayed, which have at least one of the selected units or subunits assigned (FIELD: Hierarchie selection). If there are more than the selected units assigned to the staff record it will be shown also. |
Show staff ONLY from selected units | Shows staff which are members of at least one of the selected business unit (FIELD: Hierarchie selection). |
Workspace selection:
It's possible to select staff for display by their assigned location. It's also possible to de-select staff by their assigned location. The “Workspace mode” selector offers the following options:
FIELD: Category mode | Description: |
|---|---|
Show all | Displays all staff no matter which workspace is assigned. |
Show items with selected workspaces | Only employees are displayed, which have at least one of the selected workspaces assigned. If there are more than the selected workspaces assigned to the staff record it will be shown also. |
Don't show items with selected workspaces | Staff which are members of at least one of the selected workspaces will not be displayed. |
Starting point and Recursive level selection:
"Starting point" is used to tell the extension where the staff records are stored. It is possible to select multiple ”Starting points”. This way, you are able to collect staff from several folders to display them in one content-element.
If you don't insert a page as "Starting point", tx_riorganisation will look for a value for “pid_list” from TypoScript. This is the recommended way to configure many organisation content-elements from one central point, e.g. from the constants field in your main TS-template. -> see files EXT:tx_riorganisation/static/constants.txt & EXT:tx_riorganisation/static/setup.txt for examples. The “Starting Point” can also be set in the Constant editor.
If no value for “Starting Point” is present at all, the current page is used. (the page where you inserted the STI Organisation content-element).
Recursive level selection:
This tells the extension how many levels of subpages to include below the page(s) given in the "Starting point" field.
In the sheet Template, you can overwrite the html-template defined globally by TypoScript with another one.
It is not required to define a template in this place, because in most cases several staff content-elements under one pagetree use the same html-template. This can be defined directly in the TS-setup or in the Constant-Editor of your main-(TS)template.
HintThe best way to include your own html-template is to link it directly in TS. Add the following line by hand to your TypoScript setup or edit the default value in the “TypoScript Object Browser”:
plugin.tx_riorganisation_pi.templateFile = fileadmin/templates/tx_riorganisation_template.html
Do not edit and save the html-template in the extension directory -> it will be overwritten if you update STI Organisation.
You can change the staff display, by simply creating a template-file. There is one default template-file included in tx_riorganisation (in the folder EXT:tx_riorganisation/pi/):
tx_riorganisation_template.html: the css-based html-template.
if you want to change the template, take a look at that file, make a copy of it and modify it to your own design. Observe the comments in the file - they are markers that define where content is inserted and which parts are used for this and that. Self explanatory to a certain degree...
Max Width/Height for images
These 2 fields offer you the possibility to set the image sizes for a certain content element different from the image sizes defined globally by TypoScript. The setting here will be applied to all images, displayed by this content element (works with: LIST, LATEST, SINGLE and SEARCH)
The sheet “Unit settings” offers a range of options regarding how to display unit-texts (titles) and unit-images.
The default setting is “Use the settings from TS” which is “Display but no link” for images and texts.
FIELD: Unit Image Link Mode, Unit Text Link Mode | Description: |
|---|---|
Use the settings from TypoScript | You can set the options for displaying category images and texts also by TS but this values are only recognized if this option is selected. See “unitImageMode” and “unitTextMode” in the Constant editor. |
Don't display at all | No unit images/texts will be displayed |
Display but no link | Unit images/texts will be displayed but not linked |
Act as link to unit shortcut | Unit images/texts will be displayed and function as a link to the page given as unit shortcut. |
Act as unit selector | Unit images/texts will be displayed and function as category selector. -> useful for filtering search results |
Other Unit settings:
FIELD: | Description: |
|---|---|
Max width of unit image | Maximum width of unit images. If one dimension of the image is larger than the given width or height, the image is downscaled. |
Max height of unit image | See above |
Max number of unit images | here you can limit the number of displayed unit images |
Max number of units texts | Same for unit texts |
PageId for single staff display:
This tells the extension on which page the single view is located. It's not required to set a value here, cause it's more efficient to set a global value for the single view (singlePid) in the constant-Editor of your root template. See: “Configuration”
PageId for unit staff list display:
This tells the extension on which page the list view is located. It's not required to set a value here, cause it's more efficient to set a global value for the single view (listPid) in the constant-Editor of your root template. See: “Configuration”
PageId to return to:Here you can set an alternative page for the "back to list" link in the single view. Works of course only if the current content element is SINGLE. By default the “back to List” Link in the SINGLE view points to the page where you came from. The setting here will override a globally given “backPid”.
Limit: max items for LIST
here you can set a limit only for this content-element. A value from this field will override the limits configured by TypoScript.
Don't display the first group header in List
as the name says.
Don't display Pagebrowser
as the name says.
Insert pagebreak in SINGLE after this number of words
If you want to override the globally configured value for “maxWordsInSingleVIew” in the current content-element, you can insert the new value here. For more information see section “Pagebreaks” in this manual.
The workspace db-record looks like this:
The business unit db-record looks like this:
By choosing the code STRUCTURE in the STI Organisation content element or by TS a category selector will be displayed which shows nested categories in a hierarchical menu.
The catmenu can work in 2 different modes:
tree (default): The hierarchical menu will be rendered like the business units in BE fields. The shown “tree” is build by images and can show userdefinded icons.
nestedWraps: This mode will render a hierarchical menu where each level has its onwn wrap.
The wraps for the complete structure, for the menu states (NO and ACT) and for the header of the structure are used in both modes.
The CSS styles for all business units menus are included in the static TS template “STI Organisation CSS”.
The tree mode has some special options for configuring the icons. The option “hierarchieIconMode” configures the behaviour of the icons showing left to the category titles. “hierarchieIconMode” offers the following options:
-1 = display no icons at all
0 = display the default icon (tx_riorganisation_unit.gif)
1 = display image from category record as icon
2 = display the icon which is configured as “hierarchieIconFile”
The icon for the “root” item of the tree (the hierarchie header) can be configured separately (“hierarchieRootIconFile”) or completely disabled by seetting “hierarchieNoRootIcon” to 1.
The sizes for the normal icons in hierarchieIconMode “1” and “2” and for the root icon can be configured separately.
TypoScript setup for a “structure” content element that looks like this:
plugin.tx_riorganisation { displayHierarchie {# select root icon file
hierarchieRootIconFile = EXT:tx_riorganisation/i_staff.gif
# enable root icon
hierarchieNoRootIcon = 0
# disable other icons
hierarchieIconMode = -1
}
}
All other settings are included in the default TS templates (see Section “Reference” for details)
In this mode each level of the "structure" has its own wrap. 1 is the first level.
TypoScript setup for a “structure” in mode “nestedWraps”:
plugin.tx_riorganisation {
displayHierarchie {mode = nestedWraps
# wrap for the complete "menu"
unitNestedMenu_stdWrap.wrap = <div class="nested-menu">|</div>
# wraps for active or inactive category links in the tree
unitNestedMenuItem_ACT_stdWrap.wrap = <img src="tslib/media/bullets/bullet1_h.gif" />|
unitNestedMenuItem_NO_stdWrap.wrap = <img src="tslib/media/bullets/bullet1_n.gif" />|
# wrap for level "n"
unitNestedMenuLevel1_stdWrap.wrap = <div class="level1">|</div>
unitNestedMenuLevel2_stdWrap.wrap = <div class="level2">|</div>
unitNestedMenuLevel3_stdWrap.wrap = <div class="level3">|</div>
unitNestedMenuLevel4_stdWrap.wrap = <div class="level4">|</div>
}
}
After adding CSS styles to your website the structure menu could look like this:
If the STI Organisation extension doesn't display anything (not even an error message) check the following:
did you set a “static template (from Extensions)” in your TS-template?
is the header of the content element displayed on the website? If this is the case then the STI Organisation content element seems to be configured correctly
Are there any staff records in the folder where the "Starting point" field points to?
If you typed the path to the html-template directly in the TS setup-field: is the html-template located in the correct path? (path is case sensitive)
Enable the admin panel (config.adminPanel=1) in your TS setup and look for error messages in the “TypoScript” section: (to see the possible TS errors set the checkboxes as shown in the screen shot below)
clear all TYPO3 caches, clear your Browser cache.
Q: Is the singlePid required?A: yes, it is not possible to see the single view on the f.e. LIST page when no singlePid was defined.
Q: What means this error message: "Attempt to insert record on page '[root-level]' (0) where this table, xxx, is not allowed"?A: That means, that you didn't define a "General Records Storage page" (-> see next question) and so TYPO3 tries to create the staf xxx record in the rootpage (page id=0).
Q: what is the "General Records Storage page" (GRSP) and where do I have to set it?A: If you set “use StoragePid” in the extension manager, the "GRSP" points to the page, where to look for categories that are displayed in forms in the BackEnd. The “GRSP” has to be set in the page properties of your websites rootpage (the page with “is root of the website” flag) Remember: The "General Records Storage page" (or “StoragePid”) is not the “Starting Point”





























