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.

EXT: WebGrabber

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed by:Christoph Möller
Changed:2003-02-17T13:30:32
Author:Christoph Moeller
Email:chris@byters.de
Info 3:
Info 4:

EXT: WebGrabber

Extension Key: cm_webgrab

Copyright 2000-2002, Christoph Moeller, <chris@byters.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.com

Table of Contents

EXT: WebGrabber 1

Introduction 1

What does it do? 1

Screenshots 1

Users manual 2

FAQ 2

Adminstration 2

FAQ 2

Configuration 3

FAQ 3

Reference 3

Tutorial 3

Known problems 4

To-Do list 4

Changelog 4

Introduction

What does it do?

WebGrabber is a small “proof of concept” extension that can be used to include external content into a regular T3 page.

At its current state, it can be successfully used to include any external static content or dynamic scripts that don't make use of FORMs.

It makes use of a GPL'ed PHP script named webGrab by Michael Brauchl (available at http://www.phpcms.de ). The WebGrabber extension is built as a frontend plugin and it is partly configurable via TS SETUP.

As stated above, this is a proof of concept that needs some more work – for example, it doesn't yet work really well with HTML <FORM> fields. If you have any further ideas concerning this extension, feel free to email me at chris@byters.de .

Screenshots

Sorry, not yet!

Users manual

This extension is not meant to be “used” in a classic way – it's supposed to include external content with its own useability and interface design.

FAQ

Not yet :-)

Adminstration

This extension is not meant to be administered in any way – it's supposed to just work ;)

FAQ

Not yet :-)

Configuration

See below at the “Reference” and “Tutorial” sections!

FAQ

Not yet :-)

Reference

SETUP:

t3_root

Property

t3_root

Data type

string

Description

The main absolute URL path of your Typo3 installation – no trailing slash!

Example:

if your page is accessible at http://www.you.tld/your_t3_root_utl , put:

plugin.tx_cmwebgrab_pi1.t3_root = /your_t3_root_url

Default

webgrab_path

Property

webgrab_path

Data type

string

Description

The full URL of the script to be included.

Example:

You want to include http://www.you.tld/some_script/index.php , then put:

plugin.tx_cmwebgrab_pi1.webgrab_path = http://www.you.tld/some_script/index.php

Default

wg_path

Property

wg_path

Data type

string

Description

The full URL of the helper script wg.php.

Example:

You want to include http://www.you.tld/some_script/ , then put wg.php into this directory on the webserver and add this SETUP line:

plugin.tx_cmwebgrab_pi1.wg_path = http://www.you.tld/some_script/wg.php

Default

((generated))
Example

Put this into your template's SETUP field:

# cm_webgrab
# short HOWTO:
# -> put included webgrab/wg.php to the main dir of the script to be included
# -> change $webgrab_path in wg.php to suit your full absolute path to webgrab_typo3.php
# -> put included webgrab/wg_config.php to the main dir of the script to be included
# -> change all appropriate settings in wg_config.php (parsing strings, etc.) - see documentation!
# -> change the settings below to suit your needs
# -> add a new content element on any T3 page of type "Insert Plugin", choose plugin "WebGrabber"
# -> save, view and test your page :-)
#
# see included documentation for more info!

# t3_root: root URL path to this T3 site - no trailing slash...
plugin.tx_cmwebgrab_pi1.t3_root = /your_t3_root_url

# webgrab_path: what to grab...
plugin.tx_cmwebgrab_pi1.webgrab_path = http://your.host.tld/script_path/mainpage.php

# wg_path: where is wg.php installed...
plugin.tx_cmwebgrab_pi1.wg_path = http://your.host.tld/script_path/wg.php

Tutorial

This is just a short “walk-through” on how to configure this extension:

  • have a look inside the files included in your typo3conf/ext/cm_webgrab/ directory!!
  • put included webgrab/wg.php to the main dir of the script to be included
  • change $webgrab_path in wg.php to suit your full absolute path to webgrab_typo3.php
  • put included webgrab/wg_config.php to the main dir of the script to be included
  • change all appropriate settings in wg_config.php (parsing strings, etc.) - see documentation in the file or on its author's homepage ( http://www.phpcms.de )!
  • change the settings below to suit your needs
  • add a new content element on any T3 page of type "Insert Plugin", choose plugin "WebGrabber"
  • save, view and test your page :-)

Known problems

  • Some variable passing between Typo3, this plugin and the external scripts included on our pages doesn't work yet.For example, HTML-FORMS are not working the way they should. I didn't have the time to investigate any further why. I suppose the included webgrab_typo3.php file needs some more tweaking (make use of more HIDDEN form fields to get variables passed, etc.). Feel free to add in your dev-power ;)
  • At the time of this writing, there is no way known to me to include more than one instance of this plugin.

To-Do list

  • add full support for HTML-FORMS, hidden-field transfer
  • better configuration options via TS
  • add the ability to run this extension more than once
  • much more testing!!

Changelog

0.0.1: first available public version. I need feedback on how/if it works at all with your installation! Please email me at chris@byters.de .

img-1 EXT: WebGrabber - 4