Building Websites with e107 A step-by-step tutorial to getting your e107 website up and running fast Theodore S Boomer BIRMINGHAM - MUMBAI Building Websites with e107 Copyright © 2007 Packt Publishing All rights reserved No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews Every effort has been made in the preparation of this book to ensure the accuracy of the information presented However, the information contained in this book is sold without warranty, either express or implied Neither the author, Packt Publishing, nor its dealers or distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book Packt Publishing has endeavored to provide trademark information about all the companies and products mentioned in this book by the appropriate use of capitals However, Packt Publishing cannot guarantee the accuracy of this information First published: February 2007 Production Reference: 1160207 Published by Packt Publishing Ltd 32 Lincoln Road Olton Birmingham, B27 6PA, UK ISBN 978-1-904811-31-2 www.packtpub.com Cover Image by www.visionwt.com Credits Author Theodore S Boomer Reviewer Eric Vanderfeesten Development Editor Nanda Padmanabhan Technical Editor Viraj Joshi Editorial Manager Dipali Chittar Project Manager Patricia Weir Project Coordinator Abhijeet Deobhakta Indexer Bhushan Pangaonkar Proofreader Chris Smith Layouts and Illustrations Shantanu Zagade Cover Designer Shantanu Zagade About the Author Theodore S Boomer was born in Catskill, NY From an early age he showed a propensity for science and mechanics as well as for art and music When the personal computers became available he knew then that he was going to be working with them in one form or another when he grew up Currently he is running Connetek Business Technologies, http://www.connetek com, his own small business-technology company specializing in consulting, small business-technology assessment, web presence, web design and web hosting with a focus on entrepreneurs, small office/home office, small business, non-profit, and small government contracts His technical knowledge and ability to communicate effectively has garnered him clients from around the world Tad started writing technical manuals and conducting instruction regarding the use of software while employed with the US military and US federal government and has been a technical reviewer for the books—osCommerce Beginners Edition (ISBN-1886), osCommerce Professional Edition (ISBN-1145), Open VPN (ISBN-185X), and cPanel (ISBN-1923) Acknowledgement A huge thanks to Trish Weir, Nanda Padmanabhan, Abhijeet Deobhakta, and Viraj Joshi at Packt Publishing for providing me an opportunity to write my first book and for their guidance, patience, and encouragement I would also like to thank Eric and Cameron at e107.org for not only supporting the book idea but for taking part in the reviewing team To all the plugin developers for the plugins used in this book, thank you so much and please continue your outstanding work I am grateful to Dr Padgett at Cuddle Care Animal Hospital for allowing me to use her business site as test site for this book and to Pets911 and Vetcentric for allowing the use of their banners I would like to thank Roger, Nellie, Jerry, and Rusty for putting up with my working at all hours of the day and night on this project and to Boomer and Judy who sacrificed a summer of hiking and playing while this book was being written My thanks to Gary who rescued me when I was faltering, taught me how to focus, and gave the will to get this project completed and also to my friends Jason, Jeff, Bob, Vladi, and Klara for their support and encouragement Finally my special thanks to my mom who kept telling me over the years that I should write a book Thank you for having faith in me when it seemed like I would never get focused on any one thing longer than a day and for your love and encouragement About the Reviewer Eric Vanderfeesten was born in the Netherlands and currently is one of the main developers for e107 He has been using e107 for about years and started off as an interested user in content management systems He soon discovered the overwhelming possibilities for code enhancements to the system and also found a need to create his own plugins for a number of websites After releasing several plugins he was asked to join the beta test team, for which he contributed ideas to the main developers and delivered fixes and enhancements to the core system Soon after that period he joined the main developers team of which he has been a member for about two and a half years now Although he has been coding for a long time, programming is not his educational skill He is an architect and working in the architectural domain as his main profession Since computer science has been a field of interest to him he has taken this interest into the domain of architectural design and graduated on a project involving generative architecture using a parametric script to produce architectural environments based on favela structures that can be found in Brazil Besides his work as a main developer for e107 he is also the chairperson of an architectural foundation 'Eindhovenseschool.net' and has several freelance activities besides his daytime job Table of Contents Preface Chapter 1: An Introduction to e107 History of Content Management Systems How a Content Management System Works Brief History of e107 The People Who Make e107 Possible Summary Chapter 2: Installing e107 Requirements Operating System Requirements Installing e107 Uploading e107 to Your Server No Command-Line Access Command-Line (Shell) Access Setting File Permissions Core Permissions Plug-in Permissions Content Management Plugin Links Page Statistic Logging Running the Installation Script Stage Stage Root Access No Root Access Stage Stage 10 11 12 12 13 13 14 15 16 16 17 17 19 20 20 21 21 21 21 22 22 24 26 26 Table of Contents Stage Stage Stage Securing Your Installation Upgrading an Existing e107 Installation Database Updates Troubleshooting Common Installation Problems Summary Chapter 3: Setting Site Preferences The e107 Front End Creating a Username and Password Activating Your Registration The User or Member Welcome Page The e107 Back End Setting Site Preferences Site Information Display Information Admin Display Options Date Display Options User Registration/Posting Option Signup Page Options Text Rendering Security & Protection Comments Advanced Features Emoticons Creating the Front Page Creating a Dynamic Front Page Creating a Static Front Page Creating Different Front Pages by User Class Summary Chapter 4: Customizing the Look and Feel of Your Site What is a Theme? Understanding the Theme Layout Psychology of Color Selecting a Theme Core Themes Additional Themes Custom Themes Deleting Themes Customizing Layout The WYSIWYG Editor [ ii ] 27 28 29 31 31 33 33 34 35 35 37 40 41 42 44 46 48 48 48 48 50 51 53 56 57 57 58 58 61 62 64 65 65 66 68 68 68 70 71 72 73 74 Table of Contents The File Upload Manager Creating Menu Items Using the Custom Page/Menu Tool Deleting a Custom Menu Item Changing Views by Membership Level Customizing Our Site Internationalization—Using a Custom Language File Summary Chapter 5: Customizing Your Site for e-Commerce with Plugins Introduction to Plugins How to Install Plugins Core Plugin Installation Installing a Non-Core Plugin Plugin Manager Upload Plugin Option Uninstalling a Plugin Banner Plugin Adding the Banner Shortcode to a Theme Creating a Banner Ad Campaign Activating the Ad Campaign Shopping Cart Plugin Main ZoGo-Shop Settings Manage Store Categories Adding Store Categories Editing and Deleting Categories Manage Store Products 74 75 79 79 82 86 92 93 93 94 94 95 96 97 98 98 103 105 106 107 110 110 110 111 Adding Store Products Editing and Deleting Products Manage Gateways Managing Orders FAQ (Frequently Asked Questions) Plugin Adding Categories Adding Sub-Categories Setting Preferences Entering Sample FAQs Summary Chapter 6: Customizing Your Site for Business with Plugins User Class Creating a User Class Attaching a User Class to a User Deleting a User from a User Class Assigning Admin User Class to a User or Removing It [ iii ] 111 114 114 117 118 118 119 121 122 123 125 125 126 126 127 127 Maintenance, Optimization, and Security Security & Protection Preferences To set security and protection preferences for the site, log in, go to the administrative interface, select the Preferences option, and then click on Security& Protection Now change the settings as shown in the screenshot below except select the Filter profanities? checkbox to filter profanities and then provide a list of words in the Filter Words field For more information on the settings for maintaining security as shown in the screenshot above you can refer to Chapter Summary In this chapter, we examined setting the maintenance flag, checking for database updates, checking database validity, optimizing your SQL database, scanning plugin directories, and making a backup of your core files We also discussed file uploads, password complexity, and setting security and protection preferences [ 234 ] MODx Web Development ISBN: 978-1-847194-90-9 Paperback: 276 pages Building dynamic websites with the PHP application framework and CMS Simple, step-by-step instructions detailing how to install, configure, and customize MODx Covers detailed theory from the basics, to practical implementation Learn the most common web requirements and solutions, and build a site in the process Building Websites with ExpressionEngine 1.6 ISBN: 978-1-847193-79-7 Paperback: 396 pages A clear, concise, and practical guide to creating a professional ExpressionEngine website Carefully explained steps for creating a professional ExpressionEngine website Get set up and running as quickly as possible Customize the look of your site and manage its content and users Please check www.PacktPub.com for information on our titles Resources e107 Resources You only needs to a search in your search engine of choice to find resources Below are just a few of the many resources available that will be of use to you Of course, not forget that one of your best sources for learning is Packt Publishing, which has a continually growing list of titles Official Sites • http://www.e107.org: This is the official e107 Content Management • http://wiki.e107.org: The official WIKI for e107 Here you will find • http://www.e107coders.org: This site is dedicated to the discussion and • http://www.e107themes.com: This site is the official non-commercial • http://www.e107faq.org: This site contains information on frequently • http://www.e107tutorials.org: This site offers step-by-step visual Site Here you will find the latest versions, updates, bug tracking and documentation, and forums additional information not covered in this book, animated tutorials, and more advanced e107 features creation of plugins for the e107 Here you will find common specifications for plugin creation, can request free/fee plugins, and can upload or download existing plugins themes site for e107 Here you will find additional themes for your e107 site asked questions and also has a valuable code snippet library for code writers tutorials to help e107 users to install and configure various plugins Resources Other Sites • http://e107hacks.org: This site offers work-around solutions commonly • http://e107.connetek.com: The author's website offers e107 web hosting, referred to as hacks that are not available as a feature of plugins or core programs FAQs, and downloads to accompany this book World Sites • e107 France: http://e107france.org • e107 UK: http://e107uk.co.uk • e107 Hungary: http://e107hungary.org • e107 Netherlands: http://e107.nl • e107 Denmark: http://e107.dk • e107 Germany: http://www.cms-myway.com • e107 Russia: http://e107.org.ru • e107 Poland: http://e107poland.org • e107 Argentina: http://www.e107.com.ar • e107 Czech: http://www.fox1.cz • e107 Brazil: http://e107brasil.org http://e107brasil.net • e107 Australia: http://australia.hydrouk.com • e107 Israel: http://e107.shishlik.net • e107 Arabic: http://e107.all-patch.org • e107 USA: http://www.e107us.org • e107 Bulgaria: http://e107bg.org • e107 Romania: http://www.e107.ro • e107 Sweden: http://www.e107.se • e107 Slovenia: http://www.e107.se [ 236 ] Appendix A Resources for Running e107 on a Windows OS The following is a partial list of sites that offer a combination of Apache, PHP, and MySQL as a package for installation on computers running the Windows operating system These installations will allow you to install the necessary tools to run e107 on your windows machine without having to install and debug each program individually • XAMPP: http://www.apachefriends.org/en/index.html • Easy PHP: http://easyphp.org • WAMPSERVER: http://www.en.wampserver.com Apache Resources • http://www.apache.org: The Apache Software Foundation provides support for the Apache community of open-source software projects PHP Resources • PHP Net: The http://www.php.net website is the official site for PHP • PHP Freaks: The http://www.phpfreaks.com website provides you with information to use while learning or developing PHP and MySQL Additionally, it offers help for Apache, MySQL, Javascript, CSS, XML, and much more • PHP Builder: The http://www.phpbuilder.com website is a resource for PHP tutorials, templates, PHP manuals, and content management MySQL Resources • MySQL: The http://www.mysql.com website is the official site of MySQL, the world's most popular database application [ 237 ] TYPO3 Extension Development ISBN: 978-1-847192-12-7 Paperback: 232 pages Developer's guide to creating feature rich extensions using the TYPO3 API Covers the complete extension development process from planning and extension generation through development to writing documentation Includes both front-end and back-end development Describes TYPO3 areas not covered in the official documentation (such as using AJAX and eID) Hands on style, lots of examples, and detailed walkthroughs Written by Dmitry Dulepov, TYPO3 core developer and developer of TYPO3 extensions such as RealURL and TemplaVoila Blogger: Beyond the Basics ISBN: 978-1-847193-17-9 Paperback: 356 pages Customize and promote your blog with original templates, analytics, advertising, and SEO Customize your Blogger templates Grow your blog into a professional, feature-rich site Add social bookmarks to your blog Optimize your blog with SEO Integrate analytics and advertising with your Blogger blog Concise, clear, and easy to follow; rich with examples Please check www.PacktPub.com for information on our titles Index A additional themes 70 B back end, e107 admin display options 48 administrative theme, accessing types 42 advanced features 57 comments 56, 57 customizing 42 date display options 48 display information 48 emoticons 57, 58 security & protection 53-56 signup page options 50, 51 site information 46, 47 site preferences, setting 44-57 text rendering 51-53 user registration/posting options 48-50 banner plugin about 98 banner ad campaign, activating 105, 106 banner ad campaign, creating 103-105 banner shortcode, adding to theme 98-102 C CMS See content management systems content creating 171-173 deleting 174 editing 174-176 managing 173-176 content management plug-in about 159 category, changing the order 167-170 category, creating 162 category, deleting 171, 174 category, editing 171, 174, 176 category, managing 170, 174, 176 configuring 161, 162 content, creating 171-173 content, managing 173 features 160 installing 161, 162 PDF creation plugin 176 content management systems about e107 11 history 8, working 10, 11 Coppermine plugin about 177 admin mode 197 block (menu), configuring 202, 203 configuring 179-196 installing 177-179 modes of operation 197 user mode 197 Coppermine plugin, configuring album view settings 184, 185 character settings 183 configuration, saving 196 cookies settings 195 custom fields settings 195, 196 file and thumbnail advanced settings 190-193 file and thumbnail settings 189 general settings 182 image view & comment settings 187, 188 image watermaking 196 language settings 183, 184 miscellaneous settings 195 themes settings 183 thumbnail view settings 185-188 user settings 194 core plugins about 93 banner plugin 98 installing 94 versus non-core plugins 93 core themes about 68 existing theme, selecting 68 previewing 70 Cuddle Care Animal Hospital site customizing 82-92 front page, customizing 84-86 internationalization, custom language file used 86 language, setting 91 multi-lingual feature, activating 86-92 custom themes about 71 precautions 71 selecting 72 D database, e107 backup core, utilities 232 checking updates, utilities 230 checking validity, utilities 231 file uploads, security 232 maintenance, utilities 229, 230 optimizing SQL database, utilities 232 passwords, security 233 protection preferences, security 234 scan plugin directories, utilities 228, 229 search engines 225 security 232-234 security preferences, security 234 utilities 227-232 E e107 Apache resource site 237 back end, customizing 42-57 command line access, uploading on server 17 [ 240 ] content, adding 159 content management plug-in 159 content management plug-in, permissions 20, 21 core permissions, permissions 19, 20 creating menu item, Custom Page/Menu tool used 75-81 Cuddle Care Animal Hospital, project site 82 customizing site, plugins used 93 database, maintaining 227 database, optimizing 227 database upgrades, upgrading 33 database utilities 227 disseminating 205 event calendar plugin 209 file permissions, setting 17-21 file upload manager 74 forum plugin 128 front end, customizing 35-42 history 11, 12 information, disseminating 205 installation, securing 31 installation problems, troubleshooting 33 installation script, running 21 installing 15 links page, content management plug-in 21 MySQL resource site 237 no command line access, uploading on server 16 official sites 235 operating system, requirements 14 people behind e107 12 PHP resource sites 237 plug-in permissions, permissions 20 plugins, about 93 plugins, installing 94 plugins, uninstalling 97 poll plugin 148 requirements 13, 14 RSS plugin 220 shell access, uploading on server 17 site, customizing 82-92 site, customizing with plugins 125 site preferences, setting 35 statistic logging, content management plug-in 21 themes 65 themes, changing 152-156 upgrading 31, 32 uploading on server 16, 17 user class 125 world sites 236 WYSIWYG editor 74 event calendar plugin about 209 categories 212, 214 configuring 210, 211 event, deleting 219 event, editing 219 forthcoming events 214, 215 front end 216, 217 information, entering 217 installing 209 maintenance 215-217 F FAQ plugin about 118 categories, adding 118, 119 preferences, setting 121, 122 sample FAQs, entering 122, 123 sub-categories, adding 119 file upload manager about 74 enabling 74 forum plugin about 128 category order, changing 135 creating 130, 131 forum order, changing 136 forum parents, creating 129 installing 128 moderators 144 preferences, setting 138-141 pruning 142, 143 ranks 143, 144 reported posts 144 rules 144 sub-forum order, changing 136, 138 sub-forums, creating 132, 134 tools 145-148 front end, e107 customizing 35 password, creating 37, 38 registration, activating 40 username, creating 37, 38 welcome page 41, 42 front page creating 58-64 creating, by user class 62-64 dynamic front page, creating 58-60 static front page, creating 61 I installation script, running no root access, stage 24 root access, stage 22 stage 21 stage 22 stage 26 stage 26 stage 27 stage 28 stage 29, 30 M menu items creating 75-78 deleting 79 views, changing 79-81 modes, Coppermine plugin about 197 albums 198 albums, creating 200-202 categories 198 categories, creating 199 group control panel 198 pictures 198 sub-categories, creating 200 modular programming 65 N newsletter plugin about 205 configuring 206 creating 207 installing 205 newsletter, subscribing to 208 [ 241 ] about 106 gateways, managing 114, 115 orders, managing 117 store categories, adding 110, 111 store categories, deleting 110 store categories, editing 110 store categories, managing 110 store products, adding 111, 114 store products, deleting 114 store products, editing 114 store products, managing 111, 113 ZoGo-Shop plugin 106 ZoGo-Shop plugin, settings 107, 108 SoC 65 non-core plugins about 93 installing 95 versus core plugins 93 P PDF creation plugin about 176 installing 176 plugins, e107 about 93 banner plugin 98 core, types 93 core plugins, installing 94 FAQ plugin 118 forum plugin 128 installing 94-97 non-core, types 93 non-core plugins, installing 95 poll plugin 148 shopping cart plugin 106 types 93 uninstalling 97, 98 uploading, plugin manager used 96 poll plugin about 148 configuring 149-152 installing 148 T theme about 65 additional themes, types 70 core themes, types 68, 70 custom themes, types 71, 72 deleting 72 layout, customizing 73 layout, understanding 66, 68 modular programming 65 selecting 68-72 SoC 65 types 68 R U Really Simple Syndication plugin See RSS plugin RSS plugin about 220 activating 224 existing feeds 221 importing 221-223 installing 220 user class about 125 admin, types 125 admin class, assigning 127, 128 admin class, removing 127, 128 creating 126 everyone, types 125 main admin, types 125 no one, types 125 types 125 user, attaching to 126, 127 user, deleting 127 S search engines about 225 meta tags 225 separation of concerns See SoC shopping cart plugin W WYSIWYG editor 74 [ 242 ] Thank you for buying Building Websites with e107 Packt Open Source Project Royalties When we sell a book written on an Open Source project, we pay a royalty directly to that project Therefore by purchasing Building Websites with e107, Packt will have given some of the money received to the e107 project In the long term, we see ourselves and you—customers and readers of our books—as part of the Open Source ecosystem, providing sustainable revenue for the projects we publish on Our aim at Packt is to establish publishing royalties as an essential part of the service and support a business model that sustains Open Source If you're working with an Open Source project that you would like us to publish on, and subsequently pay royalties to, please get in touch with us Writing for Packt We welcome all inquiries from people who are interested in authoring Book proposals should be sent to authors@packtpub.com If your book idea is still at an early stage and you would like to discuss it first before writing a formal book proposal, contact us; one of our commissioning editors will get in touch with you We're not just looking for published authors; if you have strong technical skills but no writing experience, our experienced editors can help you develop a writing career, or simply get some additional reward for your expertise About Packt Publishing Packt, pronounced 'packed', published its first book "Mastering phpMyAdmin for Effective MySQL Management" in April 2004 and subsequently continued to specialize in publishing highly focused books on specific technologies and solutions Our books and publications share the experiences of your fellow IT professionals in adapting and customizing today's systems, applications, and frameworks Our solution-based books give you the knowledge and power to customize the software and technologies you're using to get the job done Packt books are more specific and less general than the IT books you have seen in the past Our unique business model allows us to bring you more focused information, giving you more of what you need to know, and less of what you don't Packt is a modern, yet unique publishing company, which focuses on producing quality, cutting-edge books for communities of developers, administrators, and newbies alike For more information, please visit our website: www.PacktPub.com Community Server Quickly ISBN: 1-847190-87-1 Paperback: 300 pages A Concise and Practical Guide to Installation, Administration, and Customization Get Community Server Express Edition set up and running fast Learn to manage blogs, users, forums, and file and photo galleries How to customize, market, and monetize your site Alfresco Enterprise Content Management Implementation ISBN: 1-904811-11-6 Paperback: 350 pages How to Install, use, and customize this powerful, free, Open Source Java-based Enterprise CMS Manage your business documents: version control, library services, content organization, and search Workflows and business rules: move and manipulate content automatically when events occur Maintain, extend, and customize Alfresco: backups and other admin tasks, customizing and extending the content model, creating your own look and feel Please visit www.PacktPub.com for information on our titles WordPress Complete ISBN: 1-904811-89-2 Paperback: 272 pages A comprehensive, step-by-step guide on how to set up, customize, and market your blog using WordPress Clear practical coverage of all aspects of WordPress Concise, clear, and easy to follow, rich with examples In-depth coverage of installation, themes, syndication, and podcasting Building Websites with Joomla! ISBN: 1-904811-94-9 Paperback: 250 pages A step by step tutorial to getting your Joomla! CMS website up fast Walk through each step in a friendly and accessible way Customize and extend your Joomla! site Get your Joomla! website up fast Please visit www.PacktPub.com for information on our titles .. .Building Websites with e107 A step- by -step tutorial to getting your e107 website up and running fast Theodore S Boomer BIRMINGHAM - MUMBAI Building Websites with e107 Copyright © 2007 Packt... widely and consists of data file and a merge document The data file is a database with names and addresses and other relevant information stored and the merge document is a document that contains... Nanda Padmanabhan Technical Editor Viraj Joshi Editorial Manager Dipali Chittar Project Manager Patricia Weir Project Coordinator Abhijeet Deobhakta Indexer Bhushan Pangaonkar Proofreader Chris