EXT: STI Organisation¶

Compatibility¶

STI Organisation requires at least TYPO3 3.6.2 to run.

WARNING !! Do not install this tx_riorganisation version on TYPO3 prior to version 3.6.0 because it requires features that are not present in older TYPO3 versions. Don't even try it, because it will break your TYPO3 installation!

Some features like “localization”, the categorie trees in the BackEnd or versioning (and others) will only work in TYPO3 3.7.0 and higher which is recommended to use. The only feature that is only available in TYPO3 3.8.0 is the extended pagebrowser.

PHP version: tx_riorganisation should work on all PHP versions that are also supported by TYPO3 (from 4.1.2 to 5.0.x).

MySQL version: 3.23, 4.0.x and 4.1.x.

Handling of Categories¶

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”.

Tab-Dividers¶

“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 settings¶

Localization mode for text fields By 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 images The 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

Prepend at copy¶

Here you can disable adding of the text "(copy [#])" to titles of copied records.

Category form fields¶

Width of the left category field This 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 field This 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.

Include static extension templates¶

*** 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.

Creating a “STI Organisation” content-element:¶

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.

Creating a staff database record:¶

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.

Sheet: General 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:

Sheet: Template¶

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.

Hint The 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)

Sheet: Unit settings¶

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.

Sheet: Other settings¶

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.

mode “tree”¶

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.

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
  }
}

mode “ nestedWraps ”¶

In this mode each level of the "structure" has its own wrap. 1 is the first level.

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>
  }
}

FAQ¶

• 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”

((generated))¶

options.saveDocNew.tx_riorganisation_staff = 1
options.saveDocNew.tx_riorganisation_business_unit = 1

options.disableDelete.tx_riorganisation_business_unit = 1

TCAdefaults.tx_riorganisation_staff.hidden = 0

((generated))¶

tx_riorganisation_pi.singlePid = 64

templateFile¶

plugin.tx_riorganisation {
  templateFile = fileadmin/templates/ri_organisation.html
}

pid_list¶

# clear the value
plugin.tx_riorganisation_pi.pid_list >
# display staff records located in page 58 & 84
plugin.tx_riorganisation_pi.pid_list = 58,84

recursive¶

plugin.tx_riorganisation_pi.recursive = 3

code¶

plugin.tx_riorganisation_pi.code = LIST

singlePid¶

# singlePid for a staff element inserted by TS
plugin.tx_riorganisation_pi.singlePid = 590

listPid¶

# listPid for a staff element inserted by TS
plugin.tx_riorganisation_pi.listPid = 591

limit¶

alternatingLayouts¶

backPid¶

dontUseBackPid¶

Global Wraps: As the plugin uses css-based html-template you don't¶

searchPid¶

emptySearchAtStart¶

searchFieldList¶

searchEmptyMsg_stdWrap¶

noPageBrowser¶

latestWithPagebrowser¶

pageBrowser¶

-> pageBrowser.[options]¶

maxPages¶

showPBrowserText¶

dontLinkActivePage¶

tableParams¶

plugin.tx_riorganisation {
  pageBrowser {
    maxPages = 10
    showPBrowserText = 1
    tableParams = cellpadding=2
    showResultCount = 1
  }
}

showResultCount¶

alwaysPrev¶

showFirstLast¶

hscText¶

pagefloat¶

showRange¶

browseBoxWrap¶

plugin.tx_riorganisation_pi.pageBrowser {
  browseBoxWrap.wrap = <div class="browseBoxWrap">|</div>
  showResultsWrap.wrap = <div class="showResultsWrap">|</div>
  browseLinksWrap.wrap = <div class="browseLinksWrap">|</div>
  showResultsNumbersWrap.wrap = <span class="showResultsNumbersWrap">|</span>
  disabledLinkWrap.wrap = <span class="disabledLinkWrap">|</span>
  inactiveLinkWrap.wrap = <span class="inactiveLinkWrap">|</span>
  activeLinkWrap.wrap = <span class="activeLinkWrap">|</span>
}

showResultsWrap¶

browseLinksWrap¶

showResultsNumbersWrap¶

disabledLinkWrap¶

inactiveLinkWrap¶

activeLinkWrap¶

listOrderBy¶

plugin.tx_riorganisation_pi.listOrderBy = firstname desc

plugin.tx_riorganisation_pi.listOrderBy = random

listGroupBy¶

substitutePagetitle¶

plugin.tx_riorganisation_pi.substitutePagetitle = 1

listStartId¶

plugin.tx_riorganisation {
  listStartId = 4
  limit = 3
}

useMultiPageSingleView¶

plugin.tx_riorganisation {
  useMultiPageSingleView = 1
}

pageBreakToken¶

plugin.tx_riorganisation {
  pageBreakToken = <break>
}

maxWordsInSingleView¶

useParagraphAsPagebreak¶

image¶

plugin.tx_riorganisation_pi.displayList.image {
    file.maxW = 120
    file.maxH = 90
    stdWrap.spaceAfter=5
}

useSubUnits¶

displaySubUnits¶

plugin.tx_riorganisation {
  useSubUnits = 1
  displaySubUnits = 1
}

unitMode¶

plugin.tx_riorganisation_pi.unitMode = -1

unitSelection¶

# this will only show  items with category 2 or 3
plugin.tx_riorganisation {
  unitSelection = 2,3
  # show only selected categories
  unitMode = 1
}

unitImageMode¶

# don't display any unit images
plugin.tx_riorganisation_pi.unitImageMode = 0

unitTextMode¶

# don't display any category titles
plugin.tx_riorganisation_pi.unitTextMode = 0

listPid¶

unitImageMaxWidth¶

unitImageMaxHeight¶

unitTextLength¶

maxUnitImages¶

maxUnitTexts¶

Setting for the STRUCTURE -> displayHierarchie.[options]¶

mode¶

plugin.tx_riorganisation {
  displayHierarchie {
    mode = nestedWraps
  }
}

hierarchieIconMode¶

hierarchieIconPath¶

hierarchieIconFile¶

plugin.tx_riorganisation {
  displayHierarchie {
    hierarchieIconMode = 2
    hierarchieIconFile = EXT:tx_riorganisation/res/icon.gif
    hierarchieIconFile {
      width = 18
      height = 16
    }
  }
}

hierarchieNoRootIcon¶

insertShortAfterName¶

hierarchieRootIconFile¶

hierarchie_stdWrap¶

plugin.tx_riorganisation {
  displayHierarchie {
    catmenu_stdWrap.wrap =<div id="staff-hierarchie">|</div>
  }
}

hierarchieHeader_stdWrap¶

plugin.tx_riorganisation {
  displayHierarchie {
    catmenuHeader_stdWrap.wrap = <p id="staff-hierarchie-header">|</p>
  }
}

unitMenuItem_ACT_stdWrap¶

plugin.tx_riorganisation {
  displayHierarchie {
    unitMenuItem_ACT_stdWrap.wrap = <strong>|</strong>
    unitMenuItem_NO_stdWrap.wrap = |
  }
}

unitMenuItem_NO_stdWrap¶

unitMenuItem[#]_stdWrap¶

plugin.tx_riorganisation {
  displayHierarchie {
    unitMenuItem_ACT_stdWrap.wrap = <div id="staff-nestedmenu-ACT">|</div>
    unitMenuItem_NO_stdWrap.wrap = <div id="staff-nestedmenu-NO">|</div>
    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>
    unitNestedMenuLevel5_stdWrap.wrap = <div class="level5">|</div>
  }
}

defaultCode¶

displayCurrentRecord¶

_LOCAL_LANG¶

_CSS_DEFAULT_STYLE¶

plugin.tx_riorganisation {
  _CSS_DEFAULT_STYLE (
   .staff-list-name { font-size: 10px; }
  )
}

sys_language_mode¶

plugin.tx_riorganisation_pi.sys_language_mode = strict

[tsref:plugin.tx_riorganisation]

FAQ¶

Q: There are 3 ways (constants, setup and flexforms) to set a value for the e.g. “SINGLE view” page. If I set all 3, which will win? A: The flexform value from the content element will override values from TypoScript. In TS values set directly in the setup field will override values from the constant editor.To see the current TS settings for a page, click on “Template” in the “Web” menu, choose this page in the pagetree, and open the “TypoScript Object Browser” on this page. (See screenshot at the beginning of this chapter).

((generated))¶

### SINGLE staf with graphical header
plugin.tx_riorganisation {
  displaySingle {
    title_stdWrap.cObject = IMAGE
    title_stdWrap.cObject.file = GIFBUILDER
    title_stdWrap.cObject.file {
      XY = [10.w]+2,30
      backColor = #FFFFFF
      10 = TEXT
      10.text.field = title
      10.text.case = upper
      10.fontSize = 18
      10.fontFile = t3lib/fonts/verdana.ttf
      10.fontColor = #769400
      10.offset = 1,20
      10.antiAlias = 0
      10.niceText = 1
    }
  }
}

Sys_language_mode¶

With the TS-var “sys_language_mode”, you can configure the handling of not translated staff records. The default is to display the article in the default language if there is no translation was found. If you don't want this behaviour you can set “sys_language_mode” to strict

plugin.tx_riorganisation_pi.sys_language_mode = strict