.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ===================== EXT: STI Organisation ===================== :Author: Rupert Germann :Created: 2004-07-31T12:12:38 :Changed by: Samuel Weiss :Changed: 2006-12-30T08:31:50 :Author: Samuel Weiss :Email: sw@rineco.ch :Info 3: :Info 4: .. _EXT-STI-Organisation: EXT: STI Organisation ===================== Extension Key: **tx\_riorganisation** Copyright 2005, Samuel Weiss, This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml The content of this document is related to TYPO3 \- a GNU/GPL CMS/Framework available from www.typo3.com .. _Table-of-Contents: Table of Contents ----------------- **EXT: STI Organisation 1** **Introduction 1** What does it do? 1 Screenshots 2 **Users manual 5** Installation 5 Quick start: 7 The STI Organisation content element 9 The STI Organisation database-records 14 The business structure (STRUCTURE) 15 Troubleshooting 16 **Adminstration 17** User TSconfig 17 Page TSconfig 17 The Rich-Text-Editor 17 Rights & Permissions 17 Caching 17 **Configuration 18** Reference 19 TypoScript Examples: 25 Realurl config example 26 Multilanguage STI Organisation 28 **Tutorial 30** **Sponsoring tx\_riorganisation development 30** **Known problems 30** **To-Do list 30** **Changelog 30** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ Extension for displaying and managing staff and business units. The plugin is mostly based on tt\_news and therefore it can be configured / used almost in the same way. Therefore I adapted also the perfect tt\_news manual. Therefore all your thanks for this plugin should go to `Rupert Germann. `_ **Features:** - 2 types of displaying business structure: treeview and nested wraps. - Full multi language support. - Business units can be related to each other. A business unit may have multiple parents. - The view of the complete staff (single view) can be splitted to multiple pages. Page breaks can be inserted manually by a user defined “pagebreak token” or after a certain amount of words. - Very flexible content-element with the following functions: List, Single-view, Search, Teaser Headof, Teaser staff and a special kind of view: the “structure of business units”. - The appearance of the STI Organisation plugin on the website can easily be changed by editing the html-template. - Html template and style sheet included. - Business units, can be assigned to staff (multiple selections possible). - Business unit images and unit titles can act as link to a specific page or function as selector. - Internal search function with configurable “search fields” (can be combined with the business unit and location selector function to filter results by categories). - Supports caching and indexing: If caching is enabled everything will be indexed by the extension “indexed search”. .. _Compatibility: 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. .. _Screenshots: Screenshots ^^^^^^^^^^^ **List View :** Staff list with integrated search. |img-1| - **TEASER Head Of:** - |img-2| **Teaser Staff:** |img-3| **Search-Form:** |img-4| **Single View:** The single view shows the full staff record with related departements. |img-5| **The structure menu (STRUCTURE)** The structure offers two different render modes.The left image shows the catmenu in mode “nestedWraps”, the middle and rightcatmenu are working in mode “tree”. The right one uses userdefined icons (See section “The category menu”) |img-6| **Staff Database record in BackEnd:** The editing form is divided in four sections (Tabs) “Personal”, and “Business”. Here you see all possible fields, including the secondary options. Of course it is possible to hide some fields. So the editors see only e.g. “description”, "title" and "email". |img-7| |img-8| .. _Users-manual: Users manual ------------ .. _Installation: Installation ^^^^^^^^^^^^ 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). .. _Handling-of-Categories: Handling of Categories """""""""""""""""""""" You can configure the handling of business units with a checkbox in the extension manager: |img-9| 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: 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. |img-10| .. _Localization-settings: 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. |img-11| **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. |img-12| **Hide new localizations** |img-13| .. _Prepend-at-copy: **Prepend at copy** """"""""""""""""""" Here you can disable adding of the text "(copy [#])" to titles of copied records. |img-14| .. _Category-form-fields: 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. |img-15| **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. |img-16| .. _Quick-start: Quick start: ^^^^^^^^^^^^ 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. .. _Include-static-extension-templates: 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. |img-17| The HTML-template is CSS-based, so you should include the “default CSS-styles” template too, because it contains all the formating information. |img-18| Save your TS-template and open or create a page, where you want the staff to appear. .. _Creating-a-STI-Organisation-content-element: 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”. |img-19| |img-20| 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: |img-21| A form will show up looking almost like this: |img-22| 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: 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. |img-23| |img-24| A form opens, showing a staff database record: |img-25| 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. .. _The-STI-Organisation-content-element: The STI Organisation content element ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. .. _Sheet-General-Settings: 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: .. ### BEGIN~OF~TABLE ### .. _LIST: LIST ~~~~ .. container:: table-row FIELD What to display LIST Description Displays a list of staff (i.e. phone list). .. _TEASER-HEADOF: TEASER HEADOF ~~~~~~~~~~~~~ .. container:: table-row FIELD What to display TEASER HEADOF Description Displays the Leader and his deputy of a business unit as teaser. .. _TEASER-STAFF: TEASER STAFF ~~~~~~~~~~~~ .. container:: table-row FIELD What to display TEASER STAFF Description Displays a list of staff as teaser. .. _SINGLE: SINGLE ~~~~~~ .. container:: table-row FIELD What to display SINGLE Description Displays a single staff item. See section “The SINGLE view”. .. _SEARCH: SEARCH ~~~~~~ .. container:: table-row FIELD What to display SEARCH Description Displays a search box and result listing for searching staff. See section “The Search”. .. _HIERARCHIE: **HIERARCHIE** ~~~~~~~~~~~~~~ .. container:: table-row FIELD What to display **HIERARCHIE** Description Displays a business unit selector which shows nested units in a hierarchical menu. See section “The unit selector”. .. ###### END~OF~TABLE ###### 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. |img-26| **"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”. |img-27| **"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. |img-28| 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. |img-29| 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). |img-30| 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: .. ### BEGIN~OF~TABLE ### .. _Show-all: Show all ~~~~~~~~ .. container:: table-row FIELD Category mode Show all Description 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: Show staff from selected units and sub units ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Category mode Show staff from selected units and sub units Description 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: Show staff ONLY from selected units ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Category mode Show staff ONLY from selected units Description Shows staff which are members of at least one of the selected business unit (FIELD: Hierarchie selection). .. ###### END~OF~TABLE ###### |img-31| **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: .. ### BEGIN~OF~TABLE ### .. _Show-all: Show all ~~~~~~~~ .. container:: table-row FIELD Category mode Show all Description Displays all staff no matter which workspace is assigned. .. _Show-items-with-selected-workspaces: Show items with selected workspaces ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Category mode Show items with selected workspaces Description 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: Don't show items with selected workspaces ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Category mode Don't show items with selected workspaces Description Staff which are members of at least one of the selected workspaces will **not** be displayed. .. ###### END~OF~TABLE ###### |img-32| **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. .. _Sheet-Template: 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. |img-33| **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: Sheet: Unit settings """""""""""""""""""" The sheet “Unit settings” offers a range of options regarding how to display unit-texts (titles) and unit-images. |img-34| The default setting is “Use the settings from TS” which is “Display but no link” for images and texts. .. ### BEGIN~OF~TABLE ### .. _FIELD-Unit-Image-Link-Mode: FIELD: Unit Image Link Mode, ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Unit Image Link Mode,Unit Text Link Mode FIELD: Unit Image Link Mode, Unit Text Link Mode Description Description: .. _Use-the-settings-from-TypoScript: Use the settings from TypoScript ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Unit Image Link Mode,Unit Text Link Mode Use the settings from TypoScript Description 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: Don't display at all ~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Unit Image Link Mode,Unit Text Link Mode Don't display at all Description No unit images/texts will be displayed .. _Display-but-no-link: Display but no link ~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Unit Image Link Mode,Unit Text Link Mode Display but no link Description Unit images/texts will be displayed but not linked .. _Act-as-link-to-unit-shortcut: **Act as link to unit shortcut** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Unit Image Link Mode,Unit Text Link Mode **Act as link to unit shortcut** Description Unit images/texts will be displayed and function as a link to the page given as unit shortcut. .. _Act-as-unit-selector: **Act as unit selector** ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Unit Image Link Mode,Unit Text Link Mode **Act as unit selector** Description Unit images/texts will be displayed and functionas category selector. -> useful for filtering search results .. ###### END~OF~TABLE ###### Other Unit settings: .. ### BEGIN~OF~TABLE ### .. _Max-width-of-unit-image: Max width of unit image ~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Max width of unit image Description 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: Max height of unit image ~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Max height of unit image Description See above .. _Max-number-of-unit-images: Max number of unit images ~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD Max number of unit images Description here you can limit the number of displayed unit images .. _Max-number-of-units-texts: **Max number of units texts** ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row FIELD **Max number of units texts** Description Same for unit texts .. ###### END~OF~TABLE ###### .. _Sheet-Other-settings: 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 `_ ” |img-35| **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-STI-Organisationdatabase-records: **The STI Organisationdatabase-records** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |img-36| The workspace db-record looks like this: The business unit db-record looks like this: |img-37| .. _The-business-structure-STRUCTURE: The business structure **(STRUCTURE)** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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”. .. _mode-tree: 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. .. _Example: Example: ~~~~~~~~ |img-38| TypoScript setup for a “structure” content element that looks like this: |img-39| :: 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) .. _mode-nestedWraps: mode “ **nestedWraps** ” """""""""""""""""""""""" In this mode each level of the "structure" has its own wrap. 1 is the first level. .. _Example: Example: ~~~~~~~~ TypoScript setup for a “structure” in mode “nestedWraps”: :: plugin.tx_riorganisation { displayHierarchie { mode = nestedWraps # wrap for the complete "menu" unitNestedMenu_stdWrap.wrap =
|
# wraps for active or inactive category links in the tree unitNestedMenuItem_ACT_stdWrap.wrap = | unitNestedMenuItem_NO_stdWrap.wrap = | # wrap for level "n" unitNestedMenuLevel1_stdWrap.wrap =
|
unitNestedMenuLevel2_stdWrap.wrap =
|
unitNestedMenuLevel3_stdWrap.wrap =
|
unitNestedMenuLevel4_stdWrap.wrap =
|
} } After adding CSS styles to your website the structure menu could look like this: |img-40| .. _Troubleshooting: Troubleshooting ^^^^^^^^^^^^^^^ 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. .. _FAQ: 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” .. _Adminstration: Adminstration ------------- .. _User-TSconfig: User TSconfig ^^^^^^^^^^^^^ You can configure many options of the tx\_riorganisation BE-form by editing the TSconfig field of the BE-user or the BE-Group this user is a member of. .. _generated: ((generated)) """"""""""""" .. _Examples: Examples: ~~~~~~~~~ This will add a "Save & New" button to staff and business unit BE- forms :: options.saveDocNew.tx_riorganisation_staff = 1 options.saveDocNew.tx_riorganisation_business_unit = 1 This will remove the "Delete" button from the business unit form. :: options.disableDelete.tx_riorganisation_business_unit = 1 This will set the field “hidden” in new created news staff to 0 (=visible) :: TCAdefaults.tx_riorganisation_staff.hidden = 0 If you click on the "TS" button in the right of the textarea you'll see all possible options in a pop-up window. More information about “User TSconfig” can be found here: `http://typo3.org/documentation/document- library/doc\_core\_tsconfig/OPTIONS/ `_ .. _Page-TSconfig: Page TSconfig ^^^^^^^^^^^^^ It's possible to open a staff in the SINGLE view when clicking the “save & preview” button in the staff record in the BackEnd. The “singlePid” for the page who should open the SINGLE view has to be configured in the Page TSconfig of the folder with the staff records. This page can be the normal SINGLE view page for your website it could also point to another page which contains a STI Organisation content element with code SINGLE. .. _generated: ((generated)) """"""""""""" .. _Example: Example ~~~~~~~ This will open the page with id 64 when clicking on the “save & preview” button in a staff record: :: tx_riorganisation_pi.singlePid = 64 If you, e.g. want to hide only certain options of some fields for BE- Users, you can do this by editing the Page-TSconfig of the folder where your STI Organisation db-records are stored. (these settings will affect all BE users including those with admin rights) .. _The-Rich-Text-Editor: The Rich-Text-Editor ^^^^^^^^^^^^^^^^^^^^ I recommend to use the extension “ `htmlarea RTE `_ ” (extkey: rtehtmlarea). .. _Rights-Permissions: Rights & Permissions ^^^^^^^^^^^^^^^^^^^^ The basics about the Rights & Permissions concepts of TYPO3 can be found in the "getting started" document: `http://typo3.org/documentation/document- library/doc\_tut\_quickstart/Setting\_up\_user\_perm/ `_ for some advanced options see: `http://typo3.org/documentation /document-library/doc\_core\_tsconfig/MOD/ `_ .. _Caching: Caching ^^^^^^^ STI Organisation supports caching and thus indexing by the indexed\_search extension. Now the problem appears that you'll have to clear the cache for the e.g. “Homepage” to see the changes you made in staff that is located in the STI Organisation sysfolder. This can be done automatically. .. _Configuration: Configuration ------------- If you want to modify some global values of the TypoScript configuration, used for the staff display, take a look at the "Constant Editor". To open it, click on "Web/Template" in the left- frame menu, choose the page with the root-template in the pagetree and select "Constant Editor" from the menu in the upper right corner. |img-41| To change any options you don't find there, take a look at the "TypoScript Object Browser" (TSOB): |img-42| More information about the TSOB can be found here: `http://typo3.org/documentation/document- library/doc\_tut\_quickstart/The\_Object\_Browser/ `_ The default values for the tx\_riorganisation TypoScript configuration are stored in the file setup.txt in one of the “static” folders in the extension directory. For a list of all possible options see the table "Reference" below. Some options e.g. for "stdWrap" or "typolink" are explained in the Typo-Script Reference (TSref) which can be found here: `http://typo3.org/documentation/document-library/doc\_core\_tsref/ `_ .. _Reference: Reference ^^^^^^^^^ You can find examples for constants, setup and html-template inside the plugin folder. **plugin.tx\_riorganisation properties: TS configuration.** .. ### BEGIN~OF~TABLE ### .. _templateFile: templateFile """""""""""" .. container:: table-row Property templateFile Data type resource Description The HTML-template. (See example: "pi/ri\_organisation\_template.html” in the ext/tx\_riorganisation folder). You can define a template for a complete pagetree, a certain page or even a single content element in your TS setup, in the Constant Editor or in the content.element. **Example:** :: plugin.tx_riorganisation { templateFile = fileadmin/templates/ri_organisation.html } Default .. _pid-list: pid\_list """"""""" .. container:: table-row Property pid\_list Data type string / stdWrap Description The page id (pid), or list of pids of the folder(s), where your records are stored in (also known as “Starting point”). If this value is not set, and the “Starting point” field in the STI Organisation content-element is also empty, the current page is used.Accepts multiple pids comma separated! **Example:** :: # 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 **Note:** “Starting Point / pid\_list” has nothing to do with the “Storage Pid” (General Record Storage page). Default .. _recursive: recursive """"""""" .. container:: table-row Property recursive Data type Int / stdWrap Description If this is given, the “pid\_list” is extended by the number of recursive levels. **Example:** :: plugin.tx_riorganisation_pi.recursive = 3 Default .. _code: code """" .. container:: table-row Property code Data type string / stdWrap Description Code to define, what the script does. **Example:** :: plugin.tx_riorganisation_pi.code = LIST Default .. _singlePid: singlePid """"""""" .. container:: table-row Property singlePid Data type int+ Description Page id of the page where single staff are displayed. Here you can define a page to be used for display of a staff record with the “SINGLE” template-part. This setting can also be done in the constant editor or directly in the content element. (the settings done directly in the content element will override settings you made by TS, but they will only affect these certain content element.) **Example:** :: # singlePid for a staff element inserted by TS plugin.tx_riorganisation_pi.singlePid = 590 **Notice:** setting at least one page with a SINGLE staff content element as “singlePid” is **required** -> if there's no “singlePid” defined the links that should point to the single view don't work. Default .. _listPid: listPid """"""" .. container:: table-row Property listPid Data type int+ Description Page id of the page where staff lists are displayed. Here you can define a page to be used for display of staff with the “LIST” template-part. This setting can also be done in the constant editor or directly in the content element. (the settings done directly in the content element will override settings you made by TS, but they will only affect these certain content element.) **Example:** :: # listPid for a staff element inserted by TS plugin.tx_riorganisation_pi.listPid = 591 **Notice:** setting at least one page with a LIST content element as “listPid” is **required** -> if there's no “listPid” defined the links that should point to the list view don't work. Default .. _limit: limit """"" .. container:: table-row Property limit Data type Int+ Description The maximum number of staff-records showing in “LIST” view. Default 25 .. _alternatingLayouts: alternatingLayouts """""""""""""""""" .. container:: table-row Property alternatingLayouts Data type Int+ Description Indicates how many alternating designs the ri\_organisation-script should expect in the html-template. **Example:** If you define a subpart like:" ... "this is used all the time. If you define a similar subpart: " ... " which might show another set of colors, this is used every second time instead of the default! This is because "alternateLayouts" is set to 2. If you define a similar subpart " ... " ... this will be used every third time IF (!) "alternateLayouts" is set to 3. If you do not set it to 3, the first two aternating designs will be used only. Default 0 .. _backPid: backPid """"""" .. container:: table-row Property backPid Data type int+ Description Here you can set the page id of the staff list to which to return after looking at a single item. If you don't set a “backPid” the “Back” link in SINGLE view points to the last LIST or LATEST view. Usually the page that linked to the “SINGLE” view. If you have clicked to another related item, the “Back” link will still point to the last LIST page. You can override this behaviour by setting the parameter “backPid” in TS. This lets all “Back” links point to the page you configured there. Default 0 .. _dontUseBackPid: dontUseBackPid """""""""""""" .. container:: table-row Property dontUseBackPid Data type boolean Description If you enable this, you can prevent the use of the variables for dynamic “back-links” in links that point to the single-view. The advantage is, that all those links will look the same, what will f.e. prevent multiple indexing by the indexed search. (RealUrl Links will also look nicer without a “backPid”). The “back-link” in the SINGLE view will still work, but it will only point to a global “backPid” (f.e. the list view). See section "RealUrl and SimulateStaticDocuments" in this manual for more information. Default 1 .. _Global-Wraps-As-the-plugin-uses-css-based-html-template-you-don-t: **Global Wraps:** As the plugin uses css-based html-template you don't """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. container:: table-row Property **Global Wraps:** As the plugin uses css-based html-template you don't need to define “Global Wraps” and “Global Colors” because the complete visual formating is done with CSS-tyless. .. _searchPid: searchPid """"""""" .. container:: table-row Property searchPid Data type int+ Description Page id where searchresults are displayed. If you want all staff searches to go to a specific page, enter the PID here! NOTE: If you set this PID, all searchqueries will (must) be handled with a list content element with the code "SEARCH" on that page. Default .. _emptySearchAtStart: emptySearchAtStart """""""""""""""""" .. container:: table-row Property emptySearchAtStart Data type boolean Description If this is set the “SEARCH” content element will show an empty list at start. Otherwise the full list of items is shown. Default 1 .. _searchFieldList: searchFieldList """"""""""""""" .. container:: table-row Property searchFieldList Data type string Description Set the fields where it should search in the db-table. Default firstname, lastname .. _searchEmptyMsg-stdWrap: searchEmptyMsg\_stdWrap """"""""""""""""""""""" .. container:: table-row Property searchEmptyMsg\_stdWrap Data type ->stdWrap Description stdWrap for the messages from the staff-search: “no results” . Default .. _noPageBrowser: noPageBrowser """"""""""""" .. container:: table-row Property noPageBrowser Data type boolean Description Set this to “1” to completely disable the pagebrowser for all staff content elements in a page (can also be set directly in a content element to disable the pagebrowser only for this content element). Useful in combination with “excludeLatestFromList” or “listStartId”, set from the content element. Default 0 .. _latestWithPagebrowser: latestWithPagebrowser """"""""""""""""""""" .. container:: table-row Property latestWithPagebrowser Data type boolean Description If this is set, the LATEST template can also contain a pagebrowser (you'll have to add one to your template first). If this is not set (default) the contents of LATEST are not influenced by the pagebrowser. Default 0 .. _pageBrowser: pageBrowser """"""""""" .. container:: table-row Property pageBrowser Data type pageBrowser configuration array Description Configuration array for the pagebrowser. All properties of the pagebrowser are configured in this array. Default .. _pageBrowser-options: **-> pageBrowser.[options]** """""""""""""""""""""""""""" .. container:: table-row Property **-> pageBrowser.[options]** This is the configuration array for the pagebrowser. All settings here start with “pageBrowser.”. The formating of the pagebrowser is done by CSS. See \_CSS\_DEFAULT\_STYLE at the end of this list for an example. .. _maxPages: maxPages """""""" .. container:: table-row Property maxPages Data type int+ Description The maximum number of pages that are shown in the pagebrowser Default 7 .. _showPBrowserText: showPBrowserText """""""""""""""" .. container:: table-row Property showPBrowserText Data type boolean Description Here you can choose if the pagebrowser should show texts like “page 1, page...” in the pagelinks or if it should show only numbers. Default 1 .. _dontLinkActivePage: dontLinkActivePage """""""""""""""""" .. container:: table-row Property dontLinkActivePage Data type boolean Description If this is set to 1 the current page is not linkedlinked in the pagebowser Default 1 .. _tableParams: tableParams """"""""""" .. container:: table-row Property tableParams Data type string Description If you didn't set a “browseLinksWrap” you can add parameters for the table that wraps the pagebrowser here. **Example:** (default setting) :: plugin.tx_riorganisation { pageBrowser { maxPages = 10 showPBrowserText = 1 tableParams = cellpadding=2 showResultCount = 1 } } **Hint:** If you want to change the default texts like “previous” to something else, you can do this with the TS var “\_LOCAL\_LANG” (see example at the end of this table). For the names of the language markers see: `FILE:pi/locallang `_ but don't change the values in this file – they will be overwriiten when you update the plugin. Default .. _showResultCount: showResultCount """"""""""""""" .. container:: table-row Property showResultCount Data type 0,1,2 Description In TYPO3 below 3.8.0 this configures if the result count (e.g.: “Displaying results 1 to 4 out of 22”) should be shown above the pagebrowser. In TYPO3 version 3.8.0 this var can have 3 values: - 0: only the result-browser will be shown - 1: (default) the text "Displaying results..." and the result-browser will be shown. - 2: only the text "Displaying results..." will be shown Default 1 .. _alwaysPrev: alwaysPrev """""""""" .. container:: table-row Property alwaysPrev Data type boolean Description If this is enabled the “previous” link will always be visible even when the first page is displayed. Default 0 .. _showFirstLast: showFirstLast """"""""""""" .. container:: table-row Property showFirstLast Data type boolean Description This is used as switch if the two links named "<< First" and "Last >>" will be shown and point to the first or last page. If “showFirstLast” is enabled “alwaysPrev” will be overwritten (set to 1). Default 0 .. _hscText: hscText """"""" .. container:: table-row Property hscText Data type boolean Description Here you can choose if the texts for the pagebrowser (eg: “next”, “Displaying reaults...”) will be parsed through the PHP function htmlspecialchars() or not. Disable this if you want to use HTML in the texts f.e. for graphical “next” and “previous” links. Default 1 .. _pagefloat: pagefloat """"""""" .. container:: table-row Property pagefloat Data type int / keyword Description This defines were the current page is shown in the list of pages in the pagebrowser. If this var is an integer it will be interpreted as position in the list of pages. If its value is the keyword **"center"** the current page will be shown in the middle of the browse links. Default 0 .. _showRange: showRange """"""""" .. container:: table-row Property showRange Data type boolean Description This var switches the display of the pagelinks from numbers to ranges f.e.: 1-5 6-10 11-15... instead of 1 2 3... Default 0 .. _browseBoxWrap: browseBoxWrap """"""""""""" .. container:: table-row Property browseBoxWrap Data type stdWrap Description This is the wrap for the complete pagebowser (results and browse links). This wrap and the following ones are only available in TYPO3 3.8.0 or higher. **Example:** :: plugin.tx_riorganisation_pi.pageBrowser { browseBoxWrap.wrap =
|
showResultsWrap.wrap =
|
browseLinksWrap.wrap =
|
showResultsNumbersWrap.wrap = | disabledLinkWrap.wrap = | inactiveLinkWrap.wrap = | activeLinkWrap.wrap = | } Default .. _showResultsWrap: showResultsWrap """"""""""""""" .. container:: table-row Property showResultsWrap Data type stdWrap Description This wraps the text “Displaying results...”. Default .. _browseLinksWrap: browseLinksWrap """"""""""""""" .. container:: table-row Property browseLinksWrap Data type stdWrap Description Wrap for the browse links. Default .. _showResultsNumbersWrap: showResultsNumbersWrap """""""""""""""""""""" .. container:: table-row Property showResultsNumbersWrap Data type stdWrap Description wrap for the numbers in the text: “Displaying results 1 to 4 out of 22 ”. Default .. _disabledLinkWrap: disabledLinkWrap """""""""""""""" .. container:: table-row Property disabledLinkWrap Data type stdWrap Description wrap for disabled links (f.e the “Last >>” link on the last page). Default .. _inactiveLinkWrap: inactiveLinkWrap """""""""""""""" .. container:: table-row Property inactiveLinkWrap Data type stdWrap Description wrap for inactive links (normal links). Default .. _activeLinkWrap: activeLinkWrap """""""""""""" .. container:: table-row Property activeLinkWrap Data type stdWrap Description wrap for active links. Default .. _listOrderBy: listOrderBy """"""""""" .. container:: table-row Property listOrderBy Data type string Description Here you can set the “ORDER BY” part of the query for LIST view.The special keyword **”random”** will trigger randomized ordering. **Use this with care:** The query parts, given from TS are only trimmed and not further validated -> if the field don't exist, you'll get a mysql-error **Example:** this will order the records by firstname, beginning with Z: :: plugin.tx_riorganisation_pi.listOrderBy = firstname desc This will order the staff by random: :: plugin.tx_riorganisation_pi.listOrderBy = random Default lastname, firstname .. _listGroupBy: listGroupBy """"""""""" .. container:: table-row Property listGroupBy Data type string Description The “GROUP BY” part of the query. See Plugin in backend Default .. _substitutePagetitle: substitutePagetitle """"""""""""""""""" .. container:: table-row Property substitutePagetitle Data type boolean Description if this is set, the pagetitle and the title for the page that is indexed by the indexed\_search are substituted with the firstname and lastname of the person. (works only in the “SINGLE”-view). **Example:** :: plugin.tx_riorganisation_pi.substitutePagetitle = 1 Default .. _listStartId: listStartId """"""""""" .. container:: table-row Property listStartId Data type int+ Description Here you can set the number of the staff item which will be displayed as first item in lists. **Example:** This will display a list of 3 employees starting from the 5 :sup:`th` record, found in the db. (counting starts at zero) :: plugin.tx_riorganisation { listStartId = 4 limit = 3 } Default .. _useMultiPageSingleView: useMultiPageSingleView """""""""""""""""""""" .. container:: table-row Property useMultiPageSingleView Data type boolean Description This enables pagebreaks for the SINGLE view or is enabled automaticly when “maxWordsInSingleView” has a value. Pagebreaks are insertedafter a certain amount of words or with the manually inserted “pageBreakToken”'. **Example:** This will enable pagebreaks for the single view if no value for “maxWordsInSingleView” exists. :: plugin.tx_riorganisation { useMultiPageSingleView = 1 } Default 0 .. _pageBreakToken: pageBreakToken """""""""""""" .. container:: table-row Property pageBreakToken Data type string Description This will overwrite the default pagebreak token (<---newpage--->) with a different string. **Example:** This sets the pagebreak token to . :: plugin.tx_riorganisation { pageBreakToken = } Default <---newpage---> .. _maxWordsInSingleView: maxWordsInSingleView """""""""""""""""""" .. container:: table-row Property maxWordsInSingleView Data type int+ Description Insert pagebreaks automatically after a given amount of words. Can be configured globally or for a single content element. This can be disabled for individually by setting “no automatic pagebreaks for this record” . Default 0 .. _useParagraphAsPagebreak: useParagraphAsPagebreak """"""""""""""""""""""" .. container:: table-row Property useParagraphAsPagebreak Data type boolean Description Here you can configure that pagebreaks will be inserted after a paragraph (an empty line in the bodytext field after pressing enter) instead of inserting them after the first dot after “maxWordsInSingleView” was reached. **Hint:** If you enable this and set “maxWordsInSingleView” to a small value (e.g. 3) a paragraph will function as pagebreak token. Default 0 .. _image: image """"" .. container:: table-row Property image Data type ->imgResource ->stdWrap Description Configurates the image in staff. **Example:** :: plugin.tx_riorganisation_pi.displayList.image { file.maxW = 120 file.maxH = 90 stdWrap.spaceAfter=5 } see: `http://typo3.org/documentation/document- library/doc\_core\_tsref/imgResource/ `_ Default .. _useSubUnits: useSubUnits """"""""""" .. container:: table-row Property useSubUnits Data type boolean Description This enables the use of subunits. Default .. _displaySubUnits: displaySubUnits """"""""""""""" .. container:: table-row Property displaySubUnits Data type boolean Description This enables the display of subunits in the FrontEnd. **Example:** :: plugin.tx_riorganisation { useSubUnits = 1 displaySubUnits = 1 } Default .. _unitMode: unitMode """""""" .. container:: table-row Property unitMode Data type int Description Use this, if you want to configure the conetent element, inserted by TS to display staff by their categories (this value will be overwritten by values set directly in the content-element). - 0 = don't care about category selections - 1 = display selected categories - -1 = display deselected categories **Example:** :: plugin.tx_riorganisation_pi.unitMode = -1 This will only display staff with categories NOT selected in "categorySelection" Default .. _unitSelection: unitSelection """"""""""""" .. container:: table-row Property unitSelection Data type Int+ / list / ->stdWrap Description If you want to display only staff with certain business units in a staff list element that is inserted by TS, set the selection with “unit Selection”. **Note:** To make this work you'll also have to set the categoryMode to 1 (=show selected) **Example:** :: # this will only show items with category 2 or 3 plugin.tx_riorganisation { unitSelection = 2,3 # show only selected categories unitMode = 1 } Default .. _unitImageMode: unitImageMode """"""""""""" .. container:: table-row Property unitImageMode Data type int Description Display mode for unit images. - 0 – No business unit images will be displayed - 1 – Business unit will be displayed but not linked - 2 – Business unit will be displayed and function as shortcut link. - 3 – Business unit be displayed and function as category selector **Example:** :: # don't display any unit images plugin.tx_riorganisation_pi.unitImageMode = 0 Default 2 .. _unitTextMode: unitTextMode """""""""""" .. container:: table-row Property unitTextMode Data type int Description Display mode for category texts (titles). - 0 – No category texts will be displayed - 1 – Category texts will be displayed but not linked - 2 – Category texts will be displayed and function as shortcut link. - 3 – Category texts will be displayed and function as category selector **Example:** :: # don't display any category titles plugin.tx_riorganisation_pi.unitTextMode = 0 Default 1 .. _listPid: listPid """"""" .. container:: table-row Property listPid Data type Int+ Description See page 20. Default .. _unitImageMaxWidth: unitImageMaxWidth """"""""""""""""" .. container:: table-row Property unitImageMaxWidth Data type int+ Description Maximum width of category images. Default 20 .. _unitImageMaxHeight: unitImageMaxHeight """""""""""""""""" .. container:: table-row Property unitImageMaxHeight Data type int+ Description Maximum height of category images. Default 20 .. _unitTextLength: unitTextLength """""""""""""" .. container:: table-row Property unitTextLength Data type int+ Description Maximum length in characters of all business unit titles. Default .. _maxUnitImages: maxUnitImages """"""""""""" .. container:: table-row Property maxUnitImages Data type int+ Description Maximum number of displayed unit images. Default .. _maxUnitTexts: maxUnitTexts """""""""""" .. container:: table-row Property maxUnitTexts Data type int+ Description Maximum number of displayed unit texts. Default .. _Setting-for-the-STRUCTURE-displayHierarchie-options: **Setting for the STRUCTURE -> displayHierarchie.[options]** """""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. container:: table-row Property **Setting for the STRUCTURE -> displayHierarchie.[options]** This is the configuration array for the content element “STRUCTURE”. All settings here start with “displayHierarchie.” .. _mode: mode """" .. container:: table-row Property mode Data type string Description The “render mode” for the catmenu. Currently the following modes are supported: - **tree** (default): The category menu will be rendered like the categories in BE fields. The shown “tree” is build by images and can show userdefinded icons. - **nestedWraps** : This mode will render a category menu where each level has its onwn wrap. **Example:** :: plugin.tx_riorganisation { displayHierarchie { mode = nestedWraps } } Default tree .. _hierarchieIconMode: hierarchieIconMode """""""""""""""""" .. container:: table-row Property hierarchieIconMode Data type int Description The “catmenuIconMode” defines how icons in the catmenu will be displayed: - -1 = display no icons at all - 0 = display the default icon (i\_businessunit.gif) - 1 = display image from category record as icon - 2 = display the icon which is configured as “hierarchieIconFile” Default 0 .. _hierarchieIconPath: hierarchieIconPath """""""""""""""""" .. container:: table-row Property hierarchieIconPath Data type string Description The icon files will be prepended by this path Default .. _hierarchieIconFile: hierarchieIconFile """""""""""""""""" .. container:: table-row Property hierarchieIconFile Data type imgResource Description This configures the userdefined icons in “catmenuIconMode” set to 1 or 2 **Example:** :: plugin.tx_riorganisation { displayHierarchie { hierarchieIconMode = 2 hierarchieIconFile = EXT:tx_riorganisation/res/icon.gif hierarchieIconFile { width = 18 height = 16 } } } For “catmenuIconMode” 1 no file is needed only width and height Default .. _hierarchieNoRootIcon: hierarchieNoRootIcon """""""""""""""""""" .. container:: table-row Property hierarchieNoRootIcon Data type boolean Description disables the “root” icon in mode“tree”. Default 1 .. _insertShortAfterName: insertShortAfterName """""""""""""""""""" .. container:: table-row Property insertShortAfterName Data type boolean Description Adds the “short” field of the record to the menu after the “name” Default 1 .. _hierarchieRootIconFile: hierarchieRootIconFile """""""""""""""""""""" .. container:: table-row Property hierarchieRootIconFile Data type imgResource Description Imagefile for the root icon (see “hierarchieIconFile”) Default .. _hierarchie-stdWrap: hierarchie\_stdWrap """"""""""""""""""" .. container:: table-row Property hierarchie\_stdWrap Data type ->stdWrap Description stdWrap for the complete STRUCTURE. **Example:** :: plugin.tx_riorganisation { displayHierarchie { catmenu_stdWrap.wrap =
|
} } Default .. _hierarchieHeader-stdWrap: hierarchieHeader\_stdWrap """"""""""""""""""""""""" .. container:: table-row Property hierarchieHeader\_stdWrap Data type ->stdWrap Description stdWrap for the header of the STRUCTURE. **Example:** :: plugin.tx_riorganisation { displayHierarchie { catmenuHeader_stdWrap.wrap =

|

} } Default .. _unitMenuItem-ACT-stdWrap: unitMenuItem\_ACT\_stdWrap """""""""""""""""""""""""" .. container:: table-row Property unitMenuItem\_ACT\_stdWrap Data type ->stdWrap Description stdWrap for an active link in the STRUCTURE. **Example:** :: plugin.tx_riorganisation { displayHierarchie { unitMenuItem_ACT_stdWrap.wrap = | unitMenuItem_NO_stdWrap.wrap = | } } Default .. _unitMenuItem-NO-stdWrap: unitMenuItem\_NO\_stdWrap """"""""""""""""""""""""" .. container:: table-row Property unitMenuItem\_NO\_stdWrap Data type ->stdWrap Description stdWrap for a normal link in the STRUCTURE. Default .. _unitMenuItem-stdWrap: unitMenuItem[#]\_stdWrap """""""""""""""""""""""" .. container:: table-row Property unitMenuItem[#]\_stdWrap Data type ->stdWrap Description stdWrap for a certain level in the STRUCTURE in mode “nestedWraps”. Substitute “[#]” with the number of the level (1 is first level). **Example:** :: plugin.tx_riorganisation { displayHierarchie { unitMenuItem_ACT_stdWrap.wrap =
|
unitMenuItem_NO_stdWrap.wrap =
|
unitNestedMenuLevel1_stdWrap.wrap =
|
unitNestedMenuLevel2_stdWrap.wrap =
|
unitNestedMenuLevel3_stdWrap.wrap =
|
unitNestedMenuLevel4_stdWrap.wrap =
|
unitNestedMenuLevel5_stdWrap.wrap =
|
} } Default .. _defaultCode: defaultCode """"""""""" .. container:: table-row Property defaultCode Data type string Description If “code” (see above) is empty the value of defaultCode is taken instead. By default it's not set and a help screen will appear if “code” is also empty. Default .. _displayCurrentRecord: displayCurrentRecord """""""""""""""""""" .. container:: table-row Property displayCurrentRecord Data type boolean Description If set, certain settings are manipulated in order to let the script render one or more single items as an "insert records" content- element. You can change between the SINGLE and the LIST view to display the items by setting the "defaultCode". The default template for this is a slightly changed version of the SINGLE template called "TEMPLATE\_SINGLE\_RECORDINSERT". Default .. _LOCAL-LANG: \_LOCAL\_LANG """"""""""""" .. container:: table-row Property \_LOCAL\_LANG Data type string Description Here you can overwrite values from the language file. See ext/tx\_riorganisation/pi/locallang.php for a list of all translated words. Default .. _CSS-DEFAULT-STYLE: \_CSS\_DEFAULT\_STYLE """"""""""""""""""""" .. container:: table-row Property \_CSS\_DEFAULT\_STYLE Data type string Description Default CSS-styles. **Example:** :: plugin.tx_riorganisation { _CSS_DEFAULT_STYLE ( .staff-list-name { font-size: 10px; } ) } Default .. _sys-language-mode: sys\_language\_mode """"""""""""""""""" .. container:: table-row Property sys\_language\_mode Data type string Description This configures how not-translated records are handled. possible values: “strict”. Default is to display the record in the default language (sys\_language\_uid=0) if there is no translation available. Setting the “sys\_language\_mode” to “strict” will only display records in the choosen language. **Example:** :: plugin.tx_riorganisation_pi.sys_language_mode = strict see: `http://typo3.org/documentation/document- library/doc\_core\_tsref/quot\_CONFIG\_quot/ `_ -> search: “sys\_language\_mode” Default .. ###### END~OF~TABLE ###### [tsref:plugin.tx\_riorganisation] .. _FAQ: 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). .. _TypoScript-Examples: TypoScript Examples: ^^^^^^^^^^^^^^^^^^^^ .. _generated: ((generated)) """"""""""""" .. _Render-staff-with-graphical-header-in-SINGLE-view: Render staff with graphical header in SINGLE view: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :: ### 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 } } } .. _RealUrl: RealUrl ~~~~~~~ Since STI Organisationonly uses standard "typolink" functions to build its links, it works with “RealUrl”. A RealUrl configuration example is included. See file: EXT:tx\_riorganisation/res/realurl\_example.txtCopy the contents of this file to your /typo3conf/localconf.php. See comments in file for needed changes. The only thing which is needed change should be the id of the rootpage. For detailed information about the configuration of this extension see: “ `realUrl manual `_ ”. STI Organisationoffers several ways to optimize RealUrls that include STI Organisationparameters. By default all links to a staff single view will contain all GETvars that are needed to build the “back to List”-link. In case a link points from a LIST showing an archive period to the SINGLE view its realUrl would look like this: http://www.example.com/about-us/detail/staff/samuel-weiss.html Which means: [domain name]/[pagetitle]/[pagetitle]/[label for staff]/[firstname and lastname of the staf record] .. _Realurl-config-example: Realurl config example ^^^^^^^^^^^^^^^^^^^^^^ 'postVarSets' => array( '\_DEFAULT' => array( // units 'unit' => array ( array( 'GETvar' => 'tx\_riorganisation\_pi[unitUid]', 'lookUpTable' => array( 'table' => 'tx\_riorganisation\_businessunit', 'id\_field' => 'uid', 'alias\_field' => 'name', 'addWhereClause' => ' AND NOT deleted', 'useUniqueCache' => 1, 'useUniqueCache\_conf' => array( 'strtolower' => 1, 'spaceCharacter' => '-', ), ), ), ), // ri\_organisation pagebrowser 'browse' => array( array( 'GETvar' => 'tx\_riorganisation\_pi[pointer]', ), ), // staff and searchwords 'staff' => array( array( 'GETvar' => 'tx\_riorganisation\_pi[backPid]', 'lookUpTable' => array( 'table' => 'pages', 'id\_field' => 'uid', 'alias\_field' => 'uid', 'addWhereClause' => ' AND NOT deleted', 'useUniqueCache' => 1, 'useUniqueCache\_conf' => array( 'strtolower' => 1, 'spaceCharacter' => '-', ), ), ), array( 'GETvar' => 'tx\_riorganisation\_pi[staffUid]', 'lookUpTable' => array( 'table' => 'tx\_riorganisation\_staff', 'id\_field' => 'uid', 'alias\_field' => 'concat(firstname,\'-\',lastname)', 'addWhereClause' => ' AND NOT deleted', 'useUniqueCache' => 1, 'useUniqueCache\_conf' => array( 'strtolower' => 1, 'spaceCharacter' => '-', ), ), ), array( 'GETvar' => 'tx\_riorganisation\_pi[swords]', ), ), ), .. _Multilanguage-STI-Organisation: Multilanguage STI Organisation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ STI Organisation supports the localization features introduced with TYPO3 3.7.0. To integrate STI Organisation in a multilanguage site, follow the steps described below. Environment for this example: a working multilanguage site for normal content with STI Organisation 0.1.0 installed and some staff. Open the sysfolder where your records are located (in web/list view) and create an “Alternative Page Language” for each desired translation. |img-43| Now activate the “localization view”: |img-44| If you assigned flag-images to your website languages you should see something like this in your browser: |img-45| Click on a flag icon (or the language label) to “localize” a staff db- record in a certain language. Now the flag-icon is moved to the “localization” column to show that this staff record is translated. **Language = all** if you set the language in a staff record to “all” ths record will be displayed in all available languages. |img-46| Now let's see what else changed in a “localized” staff record: |img-47| |img-48| You see, that some fields are “missing” in the translated version. Those fields are taken from to the original-language (f.e.: type, phone number, email address). Business units are always copied from the record in the default language. **Hint:** 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 for translated staff by setting "l10n\_mode\_imageExclude" to “0” in the extension configuration. All fields are showing the value of their original-language below the input field. .. _Sys-language-mode: **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 .. _Example: **Example:** ~~~~~~~~~~~~ :: plugin.tx_riorganisation_pi.sys_language_mode = strict .. _Tutorial: Tutorial -------- As of November 2005 the tx\_riorganisation tutorial is still in development, thank you for your patience. Some help with this would be greatly appreciated. :-) .. _Sponsoring-tx-riorganisation-development: Sponsoring tx\_riorganisation development ----------------------------------------- If you want to donate money, sponsor the development of tx\_riorganisation or want to hire me as freelancer for a TYPO3 project, feel free to contact me: (Samuel Weiss, sw(at)rineco.ch). .. _Known-problems: Known problems -------------- Do **not** install this extension on TYPO3 prior to version 3.6.2 because it requires the flexform features. - “direct preview” with the save&preview button doesn't work in editforms of non-public versions of staff -> use normal “version preview” instead. - UnitImageMode switch is not working. If you find problems, that are not listed here, please post them at the bugtracker ( `http://bugs.typo3.org `_ ) or send me an email. .. _To-Do-list: To-Do list ---------- Complete the tx\_riorganisation tutorial - extend the “web/page” BackEnd-module to work with localized hierarchie-tree. - If you have a feature request. please post it at the bugtracker ( `http://bugs.typo3.org `_ ) or send me an email. .. _Changelog: Changelog --------- changes in tx\_riorganisation 0.1.2 - removed code overhead - removed some little bugs changes in tx\_riorganisation 0.1.0 first public version |img-49| EXT: STI Organisation - 29 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 469 .. :id: Graphic16 .. :name: Graphic16 .. :width: 487 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 137 .. :id: Graphic30 .. :name: Graphic30 .. :width: 158 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 262 .. :id: Graphic31 .. :name: Graphic31 .. :width: 159 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 25 .. :id: Graphic18 .. :name: Graphic18 .. :width: 363 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :id: Graphic17 .. :name: Graphic17 .. :width: 83% .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 367 .. :id: Graphic19 .. :name: Graphic19 .. :width: 453 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 440 .. :id: Graphic20 .. :name: Graphic20 .. :width: 329 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 314 .. :id: Graphic21 .. :name: Graphic21 .. :width: 327 .. |img-9| image:: img-9.png .. :align: left .. :border: 0 .. :height: 72 .. :id: Graphic4 .. :name: Graphic4 .. :width: 603 .. |img-10| image:: img-10.png .. :align: left .. :border: 0 .. :height: 62 .. :id: Graphic5 .. :name: Graphic5 .. :width: 602 .. |img-11| image:: img-11.png .. :align: left .. :border: 0 .. :height: 85 .. :id: Graphic6 .. :name: Graphic6 .. :width: 602 .. |img-12| image:: img-12.png .. :align: left .. :border: 0 .. :height: 73 .. :id: Graphic7 .. :name: Graphic7 .. :width: 602 .. |img-13| image:: img-13.png .. :align: left .. :border: 0 .. :height: 62 .. :id: Graphic8 .. :name: Graphic8 .. :width: 603 .. |img-14| image:: img-14.png .. :align: left .. :border: 0 .. :height: 50 .. :id: Graphic9 .. :name: Graphic9 .. :width: 604 .. |img-15| image:: img-15.png .. :align: left .. :border: 0 .. :height: 65 .. :id: Graphic10 .. :name: Graphic10 .. :width: 601 .. |img-16| image:: img-16.png .. :align: left .. :border: 0 .. :height: 91 .. :id: Graphic11 .. :name: Graphic11 .. :width: 604 .. |img-17| image:: img-17.png .. :align: left .. :border: 0 .. :height: 155 .. :id: Graphic12 .. :name: Graphic12 .. :width: 546 .. |img-18| image:: img-18.png .. :align: left .. :border: 0 .. :height: 154 .. :id: Graphic13 .. :name: Graphic13 .. :width: 543 .. |img-19| image:: img-19.png .. :align: left .. :border: 0 .. :height: 125 .. :id: Grafik3 .. :name: Grafik3 .. :width: 362 .. |img-20| image:: img-20.png .. :align: left .. :border: 0 .. :height: 108 .. :id: Graphic14 .. :name: Graphic14 .. :width: 470 .. |img-21| image:: img-21.png .. :align: left .. :border: 0 .. :height: 109 .. :id: Grafik4 .. :name: Grafik4 .. :width: 409 .. |img-22| image:: img-22.png .. :align: left .. :border: 0 .. :height: 615 .. :id: Graphic15 .. :name: Graphic15 .. :width: 548 .. |img-23| image:: img-23.png .. :align: left .. :border: 0 .. :height: 76 .. :id: Grafik12 .. :name: Grafik12 .. :width: 154 .. |img-24| image:: img-24.png .. :align: left .. :border: 0 .. :height: 82 .. :id: Graphic2 .. :name: Graphic2 .. :width: 246 .. |img-25| image:: img-25.jpeg .. :align: left .. :border: 0 .. :height: 217 .. :id: Graphic3 .. :name: Graphic3 .. :width: 470 .. |img-26| image:: img-26.png .. :align: left .. :border: 0 .. :height: 155 .. :id: Graphic38 .. :name: Graphic38 .. :width: 350 .. |img-27| image:: img-27.png .. :align: left .. :border: 0 .. :height: 59 .. :id: Graphic37 .. :name: Graphic37 .. :width: 310 .. |img-28| image:: img-28.png .. :align: left .. :border: 0 .. :height: 66 .. :id: Graphic35 .. :name: Graphic35 .. :width: 348 .. |img-29| image:: img-29.png .. :align: left .. :border: 0 .. :height: 79 .. :id: Graphic36 .. :name: Graphic36 .. :width: 345 .. |img-30| image:: img-30.png .. :align: left .. :border: 0 .. :height: 79 .. :id: Graphic22 .. :name: Graphic22 .. :width: 619 .. |img-31| image:: img-31.png .. :align: left .. :border: 0 .. :height: 59 .. :id: Graphic40 .. :name: Graphic40 .. :width: 466 .. |img-32| image:: img-32.png .. :align: left .. :border: 0 .. :height: 59 .. :id: Graphic41 .. :name: Graphic41 .. :width: 454 .. |img-33| image:: img-33.png .. :align: left .. :border: 0 .. :height: 194 .. :id: Graphic39 .. :name: Graphic39 .. :width: 669 .. |img-34| image:: img-34.png .. :align: left .. :border: 0 .. :height: 218 .. :id: Graphic42 .. :name: Graphic42 .. :width: 669 .. |img-35| image:: img-35.png .. :align: left .. :border: 0 .. :height: 239 .. :id: Graphic43 .. :name: Graphic43 .. :width: 669 .. |img-36| image:: img-36.png .. :align: left .. :border: 0 .. :height: 233 .. :id: Graphic44 .. :name: Graphic44 .. :width: 485 .. |img-37| image:: img-37.png .. :align: left .. :border: 0 .. :height: 481 .. :id: Graphic23 .. :name: Graphic23 .. :width: 483 .. |img-38| image:: img-38.png .. :align: left .. :border: 0 .. :height: 18 .. :id: Graphic34 .. :name: Graphic34 .. :width: 19 .. |img-39| image:: img-39.png .. :align: left .. :border: 0 .. :height: 158 .. :id: Graphic33 .. :name: Graphic33 .. :width: 234 .. |img-40| image:: img-40.png .. :align: left .. :border: 0 .. :height: 102 .. :id: Graphic32 .. :name: Graphic32 .. :width: 559 .. |img-41| image:: img-41.png .. :align: left .. :border: 0 .. :height: 128 .. :id: Graphic45 .. :name: Graphic45 .. :width: 475 .. |img-42| image:: img-42.png .. :align: left .. :border: 0 .. :height: 484 .. :id: Graphic46 .. :name: Graphic46 .. :width: 528 .. |img-43| image:: img-43.png .. :align: left .. :border: 0 .. :height: 65 .. :id: Graphic24 .. :name: Graphic24 .. :width: 377 .. |img-44| image:: img-44.png .. :align: left .. :border: 0 .. :height: 45 .. :id: Graphic25 .. :name: Graphic25 .. :width: 129 .. |img-45| image:: img-45.png .. :align: left .. :border: 0 .. :height: 127 .. :id: Graphic26 .. :name: Graphic26 .. :width: 496 .. |img-46| image:: img-46.png .. :align: left .. :border: 0 .. :height: 20 .. :id: Graphic29 .. :name: Graphic29 .. :width: 485 .. |img-47| image:: img-47.png .. :align: left .. :border: 0 .. :height: 561 .. :id: Graphic27 .. :name: Graphic27 .. :width: 506 .. |img-48| image:: img-48.png .. :align: left .. :border: 0 .. :height: 205 .. :id: Graphic28 .. :name: Graphic28 .. :width: 449 .. |img-49| image:: img-49.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102