Building Websites With Opencms

by Butcher, Matt

• ISBN13: 9781904811046
• ISBN10: 1904811043
• Format: Paperback
• Copyright: 2004-05-31
• Publisher: Lightning Source Inc

Table of Contents

Introduction	1	(5)
Introduction to OpenCms	5	(8)
What Is a Content Management System?	5	(1)
Three Essential Components	5	(1)
What Is OpenCms?	6	(3)
Features	7	(1)
History	8	(1)
The OpenCms Community	8	(1)
The Purpose of This Book	9	(1)
Technical Overview	9	(2)
The Web Server and Java Servlets	10	(1)
The Database	10	(1)
Pages, Templates, and Java Server Pages	10	(1)
Bringing it Together	11	(1)
Summary	11	(2)
Installing OpenCms	13	(24)
Prerequisites	13	(7)
Configuring the MySQL Database	14	(1)
MySQL on Linux	14	(1)
MySQL on Windows	15	(1)
Finishing the MySQL Setup	15	(1)
Configuring the Tomcat Servlet Engine	16	(1)
Linux Configuration	17	(1)
Windows Configuration	18	(1)
Configuring Encoding	19	(1)
Tuning the JVM	20	(1)
Installing the OpenCms WAR File	20	(13)
Configuring OpenCms to Use UTF-8	21	(1)
Running the Install Wizard	21	(3)
Advanced Setup Screens	24	(5)
Basic Setup Screens	29	(3)
Manually Configuring Settings	32	(1)
Configuring the Client	33	(1)
Mozilla-Based Browsers	33	(1)
Internet Explorer	34	(1)
Installation Troubleshooting	34	(2)
Character-Set Issues	35	(1)
Temp File Project ID Error	35	(1)
Restarting Tomcat versus Reloading OpenCms	35	(1)
Importing Workplace Screen Freezes	36	(1)
MySQL User/Password Changes	36	(1)
Finding More Installation Help	36	(1)
Summary	36	(1)
The OpenCms Workplace	37	(44)
A Tour of the OpenCms Workplace	37	(5)
The Toolbar	39	(3)
The Explorer View	42	(5)
Creating and Editing Content	47	(4)
Creating a Folder	47	(3)
The WYSIWYG Editor	50	(1)
The Sourcecode Editor	50	(1)
Publishing Your Changes	51	(2)
Versioning	53	(1)
Administration	53	(16)
Project Management	54	(2)
User Management	56	(3)
Database Management	59	(1)
Static Export	60	(1)
Clear Element Cache	60	(1)
Resource Type Management	61	(1)
Properties Management	62	(1)
Gallery Management Tools	62	(2)
Link Checking	64	(1)
Module Management	65	(1)
Synchronization Management	65	(2)
Scheduled Tasks	67	(1)
Log File Viewer	67	(1)
Channels	67	(1)
Flex Cache Administration	67	(2)
Workflow	69	(7)
Creating and Managing Tasks	69	(4)
Workflow Management Strategies	73	(1)
Use Projects to Manage Content Areas	73	(1)
Use Group Hierarchies for Inherited Permissions	74	(1)
Track Work with Tasks	75	(1)
Keeping a Trail	75	(1)
Modules	76	(4)
Obtaining Official OpenCms Modules	76	(1)
The Help System Modules	77	(1)
Importing OpenCms Modules	77	(1)
Where Did All that Module Data Go?	78	(1)
Online Documentation Modules	79	(1)
Other Modules	80	(1)
Summary	80	(1)
Customizing the Site	81	(44)
Overview of Creating a Site	81	(1)
Working with Templates and Tags	82	(9)
Creating a Site Module for Templates	82	(2)
Creating a New Template	84	(3)
The JSP Template	87	(3)
Associating a Page with the New Template	90	(1)
JSP Tag Libraries and Scriptlets	91	(23)
JSP Tag Libraries	92	(1)
The OpenCms Tag Library	93	(1)
The JSP Template	93	(2)
Creating a JSP Document	95	(3)
JSP Scriptlets	98	(1)
Basic Scriptlets	99	(1)
The CmsJspActionElement Object	100	(1)
OpenCms Navigation	101	(3)
Getting the Contents of Other Files	104	(3)
Advanced Scriptlet Programming	107	(4)
A Few Things to Watch Out For	111	(1)
The File System	111	(1)
Redirecting and Forwarding	112	(1)
Java Synchronization	112	(1)
Dynamic Content and Publishing	113	(1)
Structuring Code and Content	113	(1)
The FlexCache	114	(6)
Tuning the FlexCache	114	(2)
FlexCache JSP Directives	116	(1)
Absolute Directives	117	(1)
User Directives	117	(1)
Time-Sensitive Directives	118	(1)
URL Directives	118	(1)
Controlling the Cache with URL Parameters	119	(1)
Using FlexCache	120	(1)
Internationalization	120	(4)
Modules	120	(1)
Creating ResourceBundles	121	(1)
JSPs and ResourceBundles	122	(2)
Summary	124	(1)
The OpenCms System Architecture	125	(28)
Resource Types	125	(10)
Coding a New Resource Type	126	(2)
Building the Resource Type	128	(2)
Editing the Properties Files	130	(1)
Adding a Restype	130	(1)
Menu Items	131	(2)
Adding Properties for the Resource Type	133	(1)
Editing the OpenCms Registry	133	(1)
Using the New Resource Type	134	(1)
Content Definitions	135	(3)
The Steps for Creating a Content Definition	135	(1)
Important Methods	136	(2)
The Virtual File System	138	(9)
How Page Types Are Stored in the VFS	140	(2)
Resource Names and the VFS	142	(1)
Reading from and Writing to the VFS	143	(4)
Class Structure	147	(5)
com.opencms.boot	148	(1)
com.opencms.core	148	(1)
com.opencms.dbpool	148	(1)
com.opencms.defaults	148	(1)
com.opencms.defaults.master	149	(1)
com.opencms.file	149	(1)
com.opencms.file.<database>	149	(1)
com.opencms.file.utils	150	(1)
com.opencms.flex	150	(1)
com.opencms.flex.cache	150	(1)
com.opencms.flex.jsp	150	(1)
com.opencms.flex.util	150	(1)
com.opencms.htmlconverter	151	(1)
com.opencms.launcher	151	(1)
com.opencms.linkmanagement	151	(1)
com.opencms.report	151	(1)
com.opencms.template	151	(1)
com.opencms.template.cache	152	(1)
com.opencms.util	152	(1)
com.opencms.workplace	152	(1)
Summary	152	(1)
Creating an OpenCms Module	153	(30)
Using Modules	153	(1)
The Site Module	154	(1)
Creating a Module	154	(6)
Navigating the New Module	158	(2)
Custom Classes and Libraries	160	(3)
Adding Libraries	163	(1)
Adding Content	163	(4)
Creating a Simple XML Document	164	(1)
A Place for XSLT Templates	164	(2)
JSP Elements	166	(1)
Adding a Scheduled Task	167	(7)
The Batch Transformer Class	168	(2)
The CronBatch Transformer Class	170	(2)
Scheduling a Task	172	(1)
How an I_CmsCronJob Is Executed	173	(1)
Managing the Module	174	(6)
Administrate	175	(1)
The Dependency Screen	175	(1)
The Module Properties Screen	176	(1)
Properties	177	(2)
Accessing Module Parameters from JSP Pages	179	(1)
Exporting and Deploying the Module	180	(1)
Summary	180	(3)
Advanced Modules	183	(22)
Adding an Administration Point	183	(3)
Creating Icons	184	(1)
Adding a Properties File	184	(1)
Creating Administration Point Folders	185	(1)
Adding Additional Properties	186	(1)
Creating an Administration JSP	186	(4)
The JSP Code	187	(2)
The Administration Point in Action	189	(1)
XML Templates	190	(4)
How XML Templates Work	190	(1)
Editing XML Templates	191	(1)
The Structure of the Workplace XML Templates	192	(1)
The action Folder	192	(1)
The administration Folder	192	(1)
The help and locales Folders	193	(1)
The resources Folder	193	(1)
The restypes Folder	193	(1)
The scripts Folder	193	(1)
The templates Folder	193	(1)
The /system/login Folder	193	(1)
Creating a Custom Launcher	194	(8)
The Basic Idea	194	(1)
Implementing a Launcher	195	(3)
Editing the Registry	198	(1)
Testing the Launcher	199	(2)
Other Considerations	201	(1)
Creating XML-Template-Based Launchers	201	(1)
Creating Resource Loaders	201	(1)
Master Modules	202	(1)
Summary	203	(2)
Deploying an OpenCms Solution	205	(26)
Serving Static versus Dynamic Content	205	(4)
Published Resources	206	(1)
Static Serving	206	(1)
Dynamic Serving	207	(1)
The Export Property	207	(1)
Changing Export Settings	208	(1)
Static Export	209	(3)
Configuring for Static Export	209	(1)
Export Path Settings	209	(1)
Export URL Settings	210	(1)
Using Relative Links	210	(1)
Running a Static Export	210	(1)
Touching All Files in the VFS	211	(1)
Web User Authentication and Management	212	(8)
How OpenCms Handles Authentication	213	(1)
The Guest User	213	(1)
CMS Users	213	(1)
Web Users	213	(1)
Creating Web Users	214	(1)
The create_webuser.jsp Scriptlet	215	(2)
Authenticating Web Users	217	(1)
Using the Authentication JSP	218	(1)
Restricting Access through a Template	219	(1)
Backup and Recovery	220	(5)
Backing Up the Database	220	(1)
Backups from Within OpenCms	221	(1)
Performing an OpenCms Database Export	222	(1)
Backing Up Large Sites	223	(1)
The Backup Files	223	(1)
Importing an Export Zip File	224	(1)
Users and Groups	224	(1)
Resources	224	(1)
Performance Tuning	225	(3)
Database Tuning	225	(1)
MySQL	225	(1)
Oracle	226	(1)
SQL Server	226	(1)
OpenCms Tuning	227	(1)
FlexCache	227	(1)
Page Streaming	227	(1)
Efficient Coding	228	(1)
Other Resources	228	(1)
Summary	229	(2)
Appendix A: Building OpenCms from Source	231	(6)
What You Will Need	231	(1)
Getting the OpenCms Source	232	(1)
Checking Out the Source from CVS	232	(2)
Building OpenCms with Ant	234	(1)
Generating Javadocs	234	(1)
Summary	235	(2)
Appendix B: Using the OpenCms Lucene Search Module	237	(16)
Searching Technologies and OpenCms	237	(1)
About the OpenCms Lucene Module	238	(1)
Obtaining and Installing the Module	239	(10)
Configuring the Registry	239	(2)
Global Parameters	241	(1)
Document Factories	242	(2)
Content Definitions	244	(2)
Directories	246	(1)
Finishing the Registry	246	(1)
Running the Index Manager	246	(3)
Searching with Lucene	249	(2)
Hacking the OpenCms Lucene Module	251	(1)
Summary	252	(1)
Index	253