.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ======================================= 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: Mozilla/Firefox Search Plugin Generator ======================================= Extension Key: **mozsearch** Copyright 2000-2002, 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: 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: Introduction ------------ .. _What-does-it-do: 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: Screenshots ^^^^^^^^^^^ This plugin will generate a link, which will allow the visitor to install an additional search plugin in their browsers: |img-1| Once they have accepted the plugin, it will be available on their search engine list, as in the screenshot below: |img-2| .. _Users-manual: Users manual ------------ .. _Installation: 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. |img-3| 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: 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: Placing the plugin on a page ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ On a page, create a new content element anc choose «Mozilla/Firefox search plugin» from the list. |img-4| 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. |img-5| 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. |img-6| .. _Placing-the-plugin-through-TypoScript: 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: Administration -------------- The whole configuration of the plugin is available through the constant editor. Please see the configuration section for more details about each option. |img-7| .. _Configuration: Configuration ------------- .. _Reference: 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. .. ### BEGIN~OF~TABLE ### .. _version: version """"""" .. container:: table-row 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: name """" .. container:: table-row Property name Data type string Description The name of the plugin. Default Typo3 Search Plugin .. _description: description """"""""""" .. container:: table-row Property description Data type string Description The description of the plugin. Default Mozilla/Firefox search plugin for Typo3 sites .. _searchPid: searchPid """"""""" .. container:: table-row Property searchPid Data type int+ Description The PID of the Typo3 page containing the search form. Default .. _method: method """""" .. container:: table-row Property method Data type string Description The method for the search (only get is supported at the moment) Default get .. _sourceid: sourceid """""""" .. container:: table-row 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: sword """"" .. container:: table-row 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: linkText """""""" .. container:: table-row Property linkText Data type string Description The download text to display in the frontend. Default Download Mozilla/Firefox search plugin .. _icon: icon """" .. container:: table-row Property icon Data type string Description An optionnal icon to include with the search plugin (PNG, 16x16). Default EXT:mozsearch/res/icon.png .. _cat: cat """ .. container:: table-row Property cat Data type string Description The category of the plugin. Default General .. _pluginFileName: pluginFileName """""""""""""" .. container:: table-row Property pluginFileName Data type string Description The file name for the plugin (no space, and without extension). Default t3search .. _queryCharset: queryCharset """""""""""" .. container:: table-row Property queryCharset Data type string Description The charset used for the query. Default UTF-8 .. ###### END~OF~TABLE ###### [tsref:plugin.tx\_mozsearch\_pi1.] .. _Known-problems: Known problems -------------- None at the time. Just contact me if you find some. .. _To-Do-list: To-Do list ---------- Add support for OpenSearch standard .. _Changelog: Changelog --------- .. _generated: ((generated)) ^^^^^^^^^^^^^ .. _0-1-0-1-sup-st-public-release: 0.1.0: 1 :sup:`st` public release """"""""""""""""""""""""""""""""" |img-8| Mozilla/Firefox Search Plugin Generator - 5 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.jpeg .. :align: left .. :border: 0 .. :height: 149 .. :id: graphics2 .. :name: graphics2 .. :width: 537 .. |img-2| image:: img-2.jpeg .. :align: left .. :border: 0 .. :height: 320 .. :id: graphics6 .. :name: graphics6 .. :width: 263 .. |img-3| image:: img-3.jpeg .. :align: left .. :border: 0 .. :height: 200 .. :id: graphics3 .. :name: graphics3 .. :width: 562 .. |img-4| image:: img-4.jpeg .. :align: left .. :border: 0 .. :height: 117 .. :id: graphics4 .. :name: graphics4 .. :width: 372 .. |img-5| image:: img-5.jpeg .. :align: left .. :border: 0 .. :height: 296 .. :id: graphics5 .. :name: graphics5 .. :width: 519 .. |img-6| image:: img-6.jpeg .. :align: left .. :border: 0 .. :height: 247 .. :id: graphics7 .. :name: graphics7 .. :width: 519 .. |img-7| image:: img-7.jpeg .. :align: left .. :border: 0 .. :height: 468 .. :id: graphics1 .. :name: graphics1 .. :width: 194 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102