GGuuiiddee ttoo CCrreeaattiinngg MMaaxxtthhoonn PPlluuggiinnss For Maxthon Browser v1.5 (and newer) September 2006 Revision 0.21 Legal Notice Information in this documentation is subject to change without notice and does not represent a commitment on part of Maxthon (Asia) Ltd. The software described in this document is subject to the End-User License Agreement ("EULA") that is included with the product, which specifies the permitted and prohibited uses of the product. Any unauthorized duplication or use of this documentation, in whole or in part, in print, or in any other storage or retrieval system is prohibited. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language in any form by any means for any purpose other than the purchaser’s personal use without the permission of Maxthon (Asia) Ltd. © 2006 Maxthon (Asia) Ltd. All rights reserved. Company and brand products and service names are trademarks or registered trademarks of their respective holders. Unless otherwise noted, all names of companies, products, street addresses, and persons contained herein are completely fictitious and are designed solely to document the use of Maxthon (Asia) Ltd. products. Corporate Headquarters: Flat D, BLK 1,9/F Sky Tower, Tower 1 38 Sung Wong Toi Road To Kwa Wan, KL Hong Kong Tel: +852 9187 0526 Fax: +852 3542 7425 E-mail (customer relations): [email protected] E-mail (technical support): [email protected] Visit us at: http://www.maxthon.com Revision 0.21 Table of contents 1. About this guide ............................................................. 5 1.1 Intended audience ............................................................ 5 1.2 Purpose of this guide ........................................................ 5 1.3 Organization of the guide .................................................. 5 1.4 Acronyms and abbreviations .............................................. 6 2. Understanding Maxthon plugins ..................................... 7 2.1 What is a Maxthon plugin?................................................. 7 2.1.1 Examples of existing plugins ........................................ 7 2.2 Why create a Maxthon plugin? ........................................... 8 2.2.1 To add Maxthon support to your service ........................ 8 2.2.2 To reduce time spent on repetitive tasks ....................... 9 2.2.3 To pass information to local applications........................ 9 2.2.4 To control local applications from within the browser ...... 9 2.2.5 To change the appearance and functionality of a page .... 9 2.3 What are the differences between Maxthon and IE? ............ 10 3. Types of Maxthon plugin............................................... 11 3.1 Script, COM and EXE....................................................... 11 3.2 Sidebar, button, and toolbar ............................................ 12 4. Developing a Maxthon plugin from an existing IE plugin13 4.1 Create a new plugin or adapt an existing one? ................... 13 4.2 Core elements of every Maxthon plugin............................. 13 4.3 The plugin.ini file............................................................ 14 4.4 Installing a Maxthon plugin .............................................. 15 4.5 Using button plugins ....................................................... 15 4.6 Using sidebar plugins ...................................................... 17 4.7 Troubleshooting ............................................................. 19 4.8 Further reading .............................................................. 19 Guide to Creating Maxthon Plugins Page 3 of 33 Revision 0.21 Appendix A: Example of a script button plugin ...................... 20 Appendix B: Example of a script sidebar plugin..................... 24 Appendix C: Example of a COM toolbar plugin ....................... 27 Appendix D: Maxthon plugin commands................................ 31 Index .................................................................................... 33 Guide to Creating Maxthon Plugins Page 4 of 33 Revision 0.21 1. About this guide In this chapter Intended audience ............................................................................................. 5 Purpose of this guide ......................................................................................... 5 Organization of the guide .................................................................................. 5 Acronyms and abbreviations ............................................................................. 6 1.1 Intended audience The Guide to Creating Maxthon Plugins is intended for anyone wishing to develop or adapt a plugin for the Maxthon tabbed Internet browser. This includes: • Organizations with an existing plugin for Microsoft’s Internet Explorer • Organizations with an application that would benefit from tighter integration with a browser • Individuals who have some programming knowledge and want to enhance their browsing experience It is assumed that all readers have at least a basic understanding of HTML and some previous experience with the Maxthon browser. 1.2 Purpose of this guide The intention of this guide is to explain all aspects of creating Maxthon plugins. After reading this guide you should have a thorough knowledge of the potential available from Maxthon plugins. The guide also aims to explain the differences between Maxthon plugins and plugins for Internet Explorer. 1.3 Organization of the guide Information about Maxthon plugins is contained in the following three chapters: Chapter 2: Understanding Maxthon plugins (on page 7) - Addresses the background of Maxthon plugins and the ways that plugin support in Maxthon differs from that of Internet Explorer. Chapter 3: Types of Maxthon plugin (on page 11 ) - Explains the different types of Maxthon plugins including script, COM, EXE, sidebar, button, and toolbar. Chapter 4: Developing a Maxthon plugin from an existing IE plugin (on page 13) - This chapter examines the question of whether developers with existing IE plugins should create a new plugin for Maxthon or adapt their current one. Also covered are testing and troubleshooting a new plugin. Three appendices provide example plugins with code and screenshots: Appendix A: Example of a script button plugin (on page 20) Guide to Creating Maxthon Plugins Page 5 of 33 Revision 0.21 Appendix B: Example of a script sidebar plugin (on page 24) Appendix C: Example of a COM toolbar plugin (on page 27) The fourth appendix gives details of the Maxthon plugin commands. Appendix D: Maxthon plugin commands (on page 31) 1.4 Acronyms and abbreviations Acronyms and glossary terms that appear in Maxthon documentation include: Table 1: Acronyms and Glossary Terms Abbreviation Description COM Component Object Model - a Microsoft platform for software componentry introduced by Microsoft in 1993. COM is used to enable interprocess communication and dynamic object creation in any programming language that supports the technology. CSS Cascading Style Sheets - style sheets comprise external style rules that tell a browser how to present a document. DHTML Dynamic HTML - a term used for a collection of technologies, used together to create interactive web sites by using a combination of a static markup language (such as HTML), a client-side scripting language (such as JavaScript), a presentation definition language (Cascading Style Sheets), and the Document Object Model. DOM Document Object Model - the tree structure of HTML documents. DOM provides an object oriented interface that allows parsing HTML into a well defined tree structure and operating on its contents. Maxthon plugins can then manipulate contents of HTML pages based on this defined structure. HTML HyperText Markup Language - a language designed for the creation of web pages with hypertext and other information to be displayed in a web browser. Guide to Creating Maxthon Plugins Page 6 of 33 Revision 0.21 2. Understanding Maxthon plugins In this chapter What is a Maxthon plugin? ................................................................................ 7 Why create a Maxthon plugin? .......................................................................... 8 What are the differences between Maxthon and IE? ........................................ 10 2.1 What is a Maxthon plugin? Maxthon plugins add functionality to the Maxthon Internet Browser. A plugin aims to enhance the browsing experience by displaying a new page in the browser, affecting something on an existing page, or launching an external tool. Typically, plugins are used for the following purposes: • To integrate an existing web service (such as a search engine, email service, or blog site) with the browser • To integrate an existing local application with the browser • To manipulate the display, elements, and features of a page already displayed in the browser 2.1.1 Examples of existing plugins An enormous variety of Maxthon plugins have been created. To get an idea of the range of functionality available with Maxthon plugins, see the sample below. Table 2: Sample list of plugins available for Maxthon 1.5.x Plugin Name Description GoogleSearch GoogleSearch is a bundle of seventeen search plugins accessible from a single button on the Maxthon toolbar. These scripts provide access to the following Google searches: Web, Images, Groups, News, Blog, Froogle, Directory, Microsoft, Glossary, Maps, Print, Video, I’m Feeling Lucky, and to site