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.
Mozilla/Firefox Search Plugin Generator¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed by: | Jean-David Gadina |
Changed: | 2006-06-14T10:37:52 |
Email: | macmade@gadlab.net |
Mozilla/Firefox Search Plugin Generator¶
Extension Key: mozsearch
Copyright 2000-2002, macmade@gadlab.net, <macmade@gadlab.net>
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¶
Mozilla/Firefox Search Plugin Generator 1
Introduction 1
What does it do? 1
Screenshots 2
Users manual 2
Installation 2
IndexedSearch 3
Placing the plugin on a page 3
Placing the plugin through TypoScript 4
Administration 4
Configuration 5
Reference 5
Known problems 5
To-Do list 5
Changelog 5
Introduction¶
What does it do?¶
This extension provides a dynamic search plugin generator for Mozilla/Firefox browsers. It will allow your visitors to search on your website directly from the toolbar of their browser.
Screenshots¶
This plugin will generate a link, which will allow the visitor to install an additional search plugin in their browsers:
Once they have accepted the plugin, it will be available on their search engine list, as in the screenshot below:
Users manual¶
Installation¶
The installation of this extension is very simple. Just connect to the Typo3 Extension Repository and download «Mozilla/Firefox Search Plugin Generator» (mozsearch), located in the frontend plugin section. Note that you will also need to download version 2.6 (at least) of the «Developer API» extension (api_macmade), as it will be needed by the plugin.
When you install the extension, you'll notice a field called TypeNum.
This is the typeNum of the page wich will generate the search plugin. You only have to care about this if you already have an extension which uses the same typeNum. Otherwise, just leave the default one.
IndexedSearch¶
This extension is configured by default to work with the IndexedSearch extension, but it can be configured in order to work with other extensions as well.
Placing the plugin on a page¶
On a page, create a new content element anc choose «Mozilla/Firefox search plugin» from the list.
You'll now be able to configure the instance of the plugin through Typo3 flexforms. On the first tab, you'll see the basic options of the plugin. Basically, you just need to add the page with the search form. For the other options, please see the configuration section of this manual.
The second tab contains additional options relative to the plugin. Here again, please refer to the configuration section of this manual for more informations about those options.
Placing the plugin through TypoScript¶
The plugin can also be placed on the website through TypoScript. It will allow your visitors to download it from every page.
Basically, you just need to give the ID of the page containing the search form. For example:
plugin.tx_mozsearch_pi1.searchPid = 52
All available options are listed in the configuration section of this manual.
You will then need to place the plugin in you TypoScript template.
If you're using TemplaVoilà, just map an area of your HTML template with a TS object called, for instance, lib.mozsearch. Then, on your TS template:
lib.mozsearch < plugin.tx_mozsearch_pi1
If you're using the old autoparser method, just add the plugin on a subpart of your HTML template. For instance:
temp.mainTemplate {
template =< plugin.tx_automaketemplate_pi1
workOnSubpart = DOCUMENT_BODY
subparts.mozsearch < plugin.tx_mozsearch_pi1
Administration¶
The whole configuration of the plugin is available through the constant editor. Please see the configuration section for more details about each option.
Configuration¶
Reference¶
Here's the complete reference of the TypoScript options for the plugin. Remember that you can set each one through the constant editor, or through each instance of the plugin through flexforms.
version¶
Property
version
Data type
string
Description
The plugin version (in fact, the latest version of Netscape that the plugin was supposedly tested against).
Default
7.1
name¶
Property
name
Data type
string
Description
The name of the plugin.
Default
Typo3 Search Plugin
description¶
Property
description
Data type
string
Description
The description of the plugin.
Default
Mozilla/Firefox search plugin for Typo3 sites
searchPid¶
Property
searchPid
Data type
int+
Description
The PID of the Typo3 page containing the search form.
Default
method¶
Property
method
Data type
string
Description
The method for the search (only get is supported at the moment)
Default
get
sourceid¶
Property
sourceid
Data type
string
Description
The source ID for the search (will let webmasters know that people are using MozillaSearch to search their websites).
Default
mozilla-search
sword¶
Property
sword
Data type
string
Description
The variable to use as the search word. The default value is intended to work with the IndexedSearch extension.
Default
tx_indexedsearch[sword]
linkText¶
Property
linkText
Data type
string
Description
The download text to display in the frontend.
Default
Download Mozilla/Firefox search plugin
icon¶
Property
icon
Data type
string
Description
An optionnal icon to include with the search plugin (PNG, 16x16).
Default
EXT:mozsearch/res/icon.png
cat¶
Property
cat
Data type
string
Description
The category of the plugin.
Default
General
pluginFileName¶
Property
pluginFileName
Data type
string
Description
The file name for the plugin (no space, and without extension).
Default
t3search
queryCharset¶
Property
queryCharset
Data type
string
Description
The charset used for the query.
Default
UTF-8
[tsref:plugin.tx_mozsearch_pi1.]
Known problems¶
None at the time. Just contact me if you find some.
To-Do list¶
Add support for OpenSearch standard