DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

Browser for Civserv

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed:2010-04-28T19:32:39
Classification:browser_civserv
Description:List views and single views for the extension Virtual Civil Services (civserv) . It supersedes smarty and enables SEO - search engine optimisation -, real URL and the TYPO3 cache management. It is out of the box. It You can edit the views by TypoScript. You can add fields and whole views. You need the frontend engine Browser.
Keywords:forAdmins, forDevelopers, forBeginners, forIntermediates, forAdvanced, browser, civserv, virtual civil services, frontend, frontend-engine, engine
Author:Dirk Wildt, Die Netzmacher
Email:http://wildt.at.die-netzmacher.de
Website:http://die-netzmacher.de
Language:en

img-1 img-2 Browser for Civserv (extKey: browser_civserv) img-3

Browser for Civserv

img-4

Version: 3.0.4, 2010-04-28

Extension Key: browser_civserv

Language: en

Keywords: forAdmins, forDevelopers, forBeginners, forIntermediates, forAdvanced, browser, civserv, virtual civil services, frontend, frontend-engine, engine

Copyright 2009-2010, Dirk Wildt, Die Netzmacher, <http://wildt.at.die- netzmacher.de>

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

Screenshots

Frame1 Frame1

Frame1 Frame1

Introduction

Functional Schematic

The common way - with Smarty

Frame1

If you are using civserv in the common way, you will have the following work flow:

  • The civserv plugin (the backend in the illustration above) sends a query to the database.
  • The database sends the result to the template engine Smarty.
  • Smarty sends a completely rendered HTML result back to the civserv plugin.
  • The civserv plugin sends the HTML result as content to the HTML body.

The TYPO3 API (the backend in the illustration above) hasn't any chance to process data for Real URL or the HTML head. SEO - Search Engine Optimisation - and the TYPO3 cache management are impossible.

The better way - with the Browser

Frame1

You can use civserv with the frontend engine Browser:

  • The Browser plugin sends a query to the database.
  • The database sends the result back to the plugin.
  • The Browser plugin process the data for Real URL, for the HTML head and the HTML body.

SEO - Search Engine Optimisation - and the TYPO3 cache management is available and you can use Real URL.

Cost-Benefit Equation

Position Civserv/Smarty Civserv/Browser

Extensions img-6 img-7 img-6 img-8 |img-9| civserv civservsmarty browserbrowser_civserv

Search Engine Optimisation no yes Real URL no yes TYPO3 Cache Management no yes

What does the Browser for Civserv do?

  • The Browser for Civserv connects Virtual Civil Services (civserv) with the Browser - the Frontend Engine.
  • If your are using the Browser for Civserv, the following features are included:
    • SEO - Search Engine Optimisation.
    • Real URL
    • TYPO3 cache management
    • Spam protection for emails
    • Multiple views
    • Filters - select boxes for filtering the list by categories
    • Extended Search with colorized results
    • And there are more features
  • Browser for Civserv is out of the box.
  • It enables you, to configure the list and single views with TypoScript.
  • It uses only the database of Virtual Civil Services.
  • So it is completely independent of the frontend plugins of Virtual Civil Services and Smarty.
Prepared Views

You can do a lot with Virtual Civil Services.

The Browser for Civserv has prepared three views:

  • forms,

  • img-10 Illustration 7: Tutorial in PDF format

    organisations and

  • services.

You can add further views with TypoScript.

Version

The version of Browser for Civserv is corresponding with the version of the extension Browser.

The Browser supports Browser for Civserv from version 3.0.0.

Further Information

This tutorial in PDF format

You find this tutorial as a PDF file at

Installation

Extension Manager

  • Install this extension img-11 (browser_civserv).
  • Browser for Civserv will suggest to install the extension img-8 Browser - The Frontend Engine (extKey: browser). Please install it.
  • The Browser will suggest to install tutorials. You should install them.

Frame1

Virtual Civil Services

Please setup the datas for Virtual Civil Services. If you need help, please see the manual of Virtual Civil Services

http://typo3.org/documentation/document-library/extension- manuals/civserv/current/

Frame1

Page Tree

Insert pages for the views:

  • forms,
  • organisations and
  • services

Extension Template

On every page - forms, organisations and services - add an extension template.

Example for the Page Services
  • We recommend to use for the name of the template this syntax:
    • +type_page_templateID
    • We call it: +page_services_081
  • Include the static templates from extensions:
    • Browser (browser)
    • Browser for Civserv - Services (browser_civserv)

Frame1

Please configure some constants.

Frame1

  • Modul: Web > Template
  • Page: Services
  • Constant Editor: Category PLUGIN.BROWSER_CIVSERV
  • Edit some Constants like
    • The Community Id, which will delivered by civserv.
    • The page ids of the pages forms, organisations and services.

Plugin

On every page - forms, organisations and services - insert the Browser plugin.

Example for the Page Services
  • Insert the plugin "Browser"

  • Select the tab [General]

    Call the plugin "Services" and set the header type to "hidden".

  • Select the tab [Plugin]

    • Choose as the startingpoint the root directory with your civserv data.
    • Set the value recursive to "Infinite".
    • Select in the area "Plugin Options:" the tab [Lists]
      • Set the Title to "Services"
      • If you like, configure the display. Set it to "configured".

Frame1

That's all! Your installation is finished.

Real URL

Virtual Civil Services needs for every page a different Real URL configuration. The Browser supports you.

Configure pages differently

If you have a detail view of a service like a dog license fee there is a link to the appropriate agency like the city finance department. Real URL generates a proper link to that agency if you are using the fixedPostVars array.

The fixedPostVars array enables a real URL configuration depending on the current page.

TypoScript in Depth

If you like to investigate the templates of the Browser for Civserv, take a look in the files in the path static/. See illustration below.

Frame1

Recursive TypoScript

The Browser for Civserv is a very good example for recursive TypoScript.

Frame1

Recursive TypoScript is supported by the Browser. It enables to configure parents (1 in the illustration above) and their children (2, 3) with TypoScript only.

TT_CONTAINER and TT_COA are deprecated

The extension Browser for Civserv is using the objects TT_CONTAINER and TT_COA. Both objects are exclusive. They are known by the Browser only. Be aware, that both are deprecated. You can have the same result with the TYPO3 default object COA.

Example with COA

The extension Browser for BZD Staff Directory (browser_bzdstaffdirectory) has a very good example for a recursivley TypoScript with COA. See

Further Information

About the Plugin Icon

img-4

The concept of the icon:

  • The black and white image is the icon of civserv.
  • The background color orange is the color of the corporate design of Die Netzmacher, the company which created the extension Browser for Civserv.

Virtual Civil Services

Manual: Virtual Civil Services has it's own manual. If you are using the Browser for Civserv backend capabilities are relevant only.

http://typo3.org/documentation/document-library/extension- manuals/civserv/current/

Other extensions published by Die Netzmacher

img-8 Browser - The Frontend Engine. It displays content from related tables. You need one line typoscript for a result list with a search form, a record browser and an a-z browser. Images are wrapped self-acting. SEO, Search Engine Optimisation is integrated. DRS - Development Supporting System - supports Bugfixing and Development. http://typo3.org/extensions/repository/view/browser/current/

About the Author

img-20 Illustration 15:The Author - a little bit blurred

Dirk Wildt (* 1963 Hamburg/Germany) Founder of Die Netzmacher (Erfurt/Weimar)

Founder of TYPO3 Usergroup Thuringia

Member of TYPO3 Usergroup Leipzig

2003: Founding think visually! It is Die Netzmacher since 2009.

2000 - 2002: Financial Controller, G.E.B.B

1999 - 2000: Financial Controller, G|M|Z - Tagesspiegel-Gruppe

1997 - 1999: Spokesman, Senatsverwaltung für Finanzen, Berlin

1989 - 1997: Editor and Financial Controller, taz, die tageszeitung

1982 - 1989: Freelancing Press Photographer

Credits

Thanks the City Council of Weimar for

  • initiating the extension Browser for Civserv and
  • a lot of patience.

Frame1

To-Do List

Nothing to do.

Changelog

3.0.4

Update

  • Update TypoScript for Browser 3.2.1
  • pageBrowser.results_at_a_time is removed and is replaced by a value in the plugin

3.0.2

  • Improvement: Enabling sorting by the sorting field of mm tables
  • Development: Update for the Browser 3.1.0

3.0.1

Initial release

Illustration Index

Illustration 1: Hierarchical Order 3

Illustration 2: Synonyms 3

Illustration 3: Search Engine Optimisation and Real URL 3

Illustration 4: The Browser Plugin 3

Illustration 5: Workflow with civserv and the template engine Smarty 4

Illustration 6: Workflow with civserv and with the frontend engine Browser 4

Illustration 7: Tutorial in PDF format 5

Illustration 8: Extension Manager with the Browser, the Browser for Civserv and civserv 6

Illustration 9: Civserv with exemplary records. 6

Illustration 10: Include the static templates Browser and Browser for Civserv - Services 7

Illustration 11: The Constant Editor 7

Illustration 12: The plugin Browser 8

Illustration 13: Files with TypoScript 10

Illustration 14: Parent record and child records 10

Illustration 15:The Author - a little bit blurred 12

Illustration 16: Stadtverwaltung Weimar, City Council of Weimar 13

16