Main Page

From OpenCms Wiki
(Difference between revisions)
Jump to: navigation, search
(changed the link to synchronization from the displayed text to RFS_Synchronization)
 
(348 intermediate revisions by 100 users not shown)
Line 1: Line 1:
<div style="margin:0; margin-right:10px; border:1px solid #63ff63; padding: 1em 1em 1em 1em; background-color:#f2fff2;"><big>'''Welcome to the OpenCms Wiki'''</big>
+
{|width="100%"
 +
|-valign="top"
 +
|style="vertical-align: top"|
 +
 
 +
<div style="margin:0; margin-right:10px; border:1px solid #63ff63; padding: 1em 1em 1em 1em; background-color:#f2fff2;">
 +
<big>'''Welcome to the OpenCms user wiki'''</big>
 +
 
 
OpenCms is a professional level Open Source Website Content Management System.
 
OpenCms is a professional level Open Source Website Content Management System.
You can find more information about OpenCms on the [http://opencms.org project homepage].
+
You can find more information on the [http://opencms.org OpenCms homepage].
The current version of OpenCms is 6.2.2.
+
 
 +
The current stable version of OpenCms is '''11.0.0'''. Read the [http://www.opencms.org/en/news/190430-opencms-v1100.html release notes] for more details.
 +
 
 +
This wiki is for all OpenCms users to contribute and share their experiences.
 +
 
 +
'''Please note:''' ''The information in this wiki is community contributed and often does not represent the latest OpenCms version.''
 +
''Refer to the [http://documentation.opencms.org official OpenCms documentation website] for the latest version documentation.''
 +
 
 +
If you are unfamiliar with wikis in general you should take a look at the [[FAQ|FAQ page]].
 +
 
 
</div>
 
</div>
  
 +
|width="50%" style="vertical-align:top"|
  
== [[image:icon.gif]] Getting OpenCms Up and Running ==
+
__TOC__
*[[Installation]]
+
** [[Hardware requirements]]
+
** [[Finding and installing the prerequisites]]
+
** [[Database Setup]]
+
** [[App server related topics]]
+
** [[Post-installation checkout]]
+
  
*[[Configuration]]
+
|}
**[[xml-system-configs explained]]
+
**[[Creating a new site]]
+
**[[Removing /opencms/opencms from site url]]
+
**[[MultiSite configuration instructions]]
+
**[[Securing the site - implementing your security policy]]
+
**[[Removing OpenCMS documents and non-essential components - What to keep]]
+
  
*[[Performance Tuning]]
+
{|width="100%"
**[[Load Balancing with Alkacon Clustering OCEE]]
+
|-valign="top"
**[[Static Export configuration]]
+
|style="vertical-align: top"|
**[[Flex Cache tuning]]
+
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #fff8f2;">
**[http://www.pomegranate.de/en/OpenSource/OpenCMS/OpenCMS_Cluster.html Clustering without hardware load balancing]
+
  
== [[image:icon.gif]] What Can OpenCms Do ==
+
==OpenCms HowTos ===
*[[Overview]]
+
*[[A short introduction]]
**[[OpenCms philosophy]]
+
**[[OpenCms terminology]]
+
**[[Introduction to the OpenCms application structure and tools]]
+
**[[Alternative site structures]]
+
**[[Planning and documenting your site]]
+
**[[Best Practices]]
+
**[[Other Overview Guides]]
+
  
 +
==== OpenCms Tutorials ====
 +
*[[Configuration of OpenCms Sitemap Properties]]
 +
*[[Using formatters in OpenCms]]
 +
*[[Creating OpenCms Container Templates]]
 +
*[[Upgrading from OpenCms 7.x]]
 +
*[[Creating Mobile Templates with OpenCms]]
 +
*[[Creating Plug and Play Modules for OpenCms|Creating Plug & Play Modules for OpenCms]]
 +
*[[The OpenCms Content Subscription Engine]]
  
*[[Template Development]]
+
==== PDF downloads ====
**[[basics and overview]]
+
*[[OpenCms content manager user manual]]
**[[lessons learned]]
+
**[[common and frequent mistakes, NPEs]]
+
**[[oc-taglibrary specifics]]
+
**[[Building from Scratch]]
+
**[[Using existing Template One]]
+
**[[Other example templates]]
+
  
*[[Search]]
+
</div>
**[[Configuration]]
+
**[[Sample search results pages]]
+
**[[common mistakes]]
+
**[[writing only specific xml-element-data to the lucene index]]
+
**[[lucene related: writing custom analyzers, stemmers, documents]]
+
  
*[[Other Major Features]]
+
<div style="margin: 0; margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #c6c9ff; color: #000; background-color: #f0f0ff">
**[[XMLContent]]
+
  
== [[image:icon.gif]] Using / Maintaining an installation of OpenCms ==
+
===  Getting OpenCms Up and Running ===
*[[Using the Workplace]]
+
'''Installation'''
**[[Boy Howdy on this one.  good luck.]]
+
* [[OpenCms in the Cloud]]
 +
* [[Hardware requirements]]
 +
* [[Finding and installing the prerequisites]]
 +
* [[Database Setup]]
 +
* [[Installing on Oracle 9]]
 +
* [[Installing on PostgreSQL]]
 +
* [[App server related topics]]
 +
* [[OS related topics]]
 +
* [[Post-installation checkout]]
  
 +
'''Configuration'''
 +
*[[Important Configuration Files]]
 +
*[[Importing Existing Data]]
 +
*[[Defining OpenCMS structured XML content]]
 +
*[[Removing /opencms/opencms from site url]]
 +
*[[MultiSite configuration instructions | MultiSite configuration instructions  (apache + mod_proxy)]]
 +
*[[Avoiding /opencms/opencms in the URL (apache + mod_proxy)]]
 +
*[[MultiSite configuration instructions (apache + mod_jk)]]
 +
*[[Securing the site - implementing your security policy]]
 +
*[[Removing OpenCMS documents and non-essential components - What to keep]]
 +
*[[Changing the default request encoding]]
 +
*[[Changing from Servlet 2.3 to Servlet 2.4 (JSP 2.0)]] - out of date
 +
*[[Disable structured content]]
 +
*[[Disallow creation of resource types]]
 +
*[[Workplace: Custom footer]]
 +
*[[Workplace - Explorer View: Hide Advanced property button]]
  
*[[Workflow]]
+
'''Performance Tuning'''
**[[anyone used this]]
+
*[[Load Balancing with Alkacon Clustering OCEE]]
 +
*[[Static Export configuration]]
 +
*[[Clustering OpenCms]]
 +
*[[Performance Tuning Example]]
  
 +
'''OpenCms Versions'''
 +
*[[New/Different Features in OpenCms 7]]
  
*[[Admin Tools/Maintenance Tools]]
+
'''OpenCms Bundles'''
**[[Project Management]]
+
*[[OpenCms 7.0.5 Web Site Framework]]
**[[Account Management]]
+
**[[Database Management]]
+
**[[Module Management]]
+
**[[File History]]
+
**[[Link Validation]]
+
**[[Gallery Overview]]
+
**[[Search Management]]
+
**[[Scheduled Jobs Management]]
+
**[[Flex Cache Administration]]
+
**[[Content Tools]]
+
**[[Workplace Tools]]
+
  
  
*[[Security]]
+
</div>
**[[Authentication per Page]]
+
**[[Https/SSL]]
+
  
== [[image:icon.gif]] Writing Jsp and developing in OpenCms ==
+
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #fff8f2;">
*[[Jsp Basics]]
+
**[[Basic Steps to writing JSPs]]
+
**[[Including your template elements within your JSPs]]
+
**[[Using Direct Edit with JSP]]
+
**[[OpenCms features available via taglibs]]
+
**[[OpenCms features javadoc]]
+
**[http://www.opencms.org/opencms/en/download/documentation.html OpenCms downloadable sample modules]
+
**[[How Opencms Handles jsp - Advanced]]
+
  
 +
===  Using / Maintaining an installation of OpenCms ===
  
*[[Development Process-Best Practices]]
+
*[[Backing up OpenCms]]
**[[Transferring an existing website to a different server]]
+
  
== [[image:icon.gif]] Help ==
+
====Using the Workplace====
 +
*[[Explorer view]]
 +
*[[Administration view]]
 +
*'''Editors'''
 +
**[[FCKEditor]]
 +
**[[HTML cleanup control]]
 +
 
 +
====Workflow====
 +
*[[Workflow in core OpenCms]]
 +
*[[Workflow using third party workflow engines]]
 +
 
 +
====Admin Tools/Maintenance Tools====
 +
*[[Project Management]]
 +
*[[Account Management]]
 +
*[[Database Management]]
 +
*[[Module Management]]
 +
*[[File History]]
 +
*[[Link Validation]]
 +
*[[Gallery Overview]]
 +
*[[Search Management]]
 +
*[[Scheduled Jobs Management]]
 +
*[[Content Tools]]
 +
*[[Workplace Tools]]
 +
*[[CMS Shell]]
 +
 
 +
====User Management====
 +
* [[How to create a restricted area on your homepage]]
 +
* [[How OpenCms Permissions work]]
 +
 
 +
====Security====
 +
*[[Authentication per Page]]
 +
*[[Https/SSL]]
 +
*[[External password authentication]]
 +
 
 +
</div>
 +
 
 +
<div style="margin: 0; margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #e4dede; background-color: #f9f9f9;">
 +
 
 +
===  Help ===
 +
'''  Official Website '''
 
*[http://www.opencms.org OpenCms Website]
 
*[http://www.opencms.org OpenCms Website]
*[http://www.opencms-forum.de/opencms-forum/index OpenCms Forums ]
 
*[http://www.opencms.org/opencms/en/development/mailinglist-archive.html Mailing List Archives]
 
*[http://www.packtpub.com/OpenCMS6-admin/book Managing and Customizing OpenCMS 6 - the book]
 
  
Additional sites with OpenCms dokumentation:
+
''' Bug reports '''
*[http://cms.galway.net:8080/OpenCmsWiki/ an older Wiki about OpenCms]
+
*[https://github.com/alkacon/opencms-core/issues OpenCms Issue Tracker on GitHub]
*[http://sourceforge.net/projects/opencmshowto/ OpenCms documentation project at sourceforge]
+
*[http://www.pomegranate.de:9000/cms/forum/listthreads?forum=3 another forum on OpenCms]
+
*[http://www.erzbistum-koeln.de/medien/internet/support/dokumentation.html German documentation for OpenCms Users]
+
*[http://www.opencms-forum.de/opencms-forum/index another forum on OpenCms]
+
*[http://www.opencmsforum.de/ another forum in german]
+
  
 +
'''Forums'''
 +
*[http://www.opencms.org/opencms/en/development/mailinglist-archive.html Official Mailing List Archives]
 +
*[http://www.nabble.com/OpenCMS---Dev-f654.html Mailing List Archive at Nabble.com] (Good search function and threaded display)
 +
*[http://www.opencmshispano.com:8080/mvnforum/mvnforum/index  The first OpenCms forum in Spanish]
 +
*[http://www.facebook.com/pages/OpenCms/19694541520 OpenCms Facebook Page]
 +
*[http://www.facebook.com/group.php?gid=7264892441 OpenCms Facebook Group]
 +
*[https://www.xing.com/net/opencmsusergroup/ OpenCms User Group on Xing.com (German)]
 +
*[http://www.opencmsforum.de/ German OpenCms forum] DEAD
  
*[[Development tips]]
+
''' Books '''
**[[Eclipse integration]]
+
*[http://www.packtpub.com/OpenCMS6-admin/book Managing and Customizing OpenCMS 6] A book about OpenCms administration and usage
**[[Ftpd module]]
+
*[http://www.packtpub.com/opencms-7-development/book OpenCms 7 Development] A developers guide for new and experienced users extending and customizing OpenCms 7 through its Java API
**[[RFS_Synchronization|Synchronization with external directories]]
+
  
 +
'''Demo'''
 +
*[http://demo.opencms.org German or english test-drive of latest OpenCms version ]
 +
*[http://www.demo-opencms.de/ German Demo of OpenCms 8]
  
*[[Hints & tips]]
+
'''Additional sites with OpenCms documentation:'''
 +
*[http://www.erzbistum-koeln.de/medien/internet/ German documentation for OpenCms Users]
 +
*[http://opencms.org/en/development/documentation.html Javadoc and browsable source code]
 +
*[http://www.opencmshispano.com OpenCmsHispano the first Spanish Community]
 +
*[http://www.solutioncms.com The first OpenCMS Brazilian Community for Developer and Support]
 +
*[http://www.comundus.com/produkte/opencms/OpenCms-8.5/ German User Guide for / Deutsches Handbuch für OpenCms 8.5.1]
 +
 
 +
'''Companies offering OpenCms support
 +
*[[OpenCms_Reference_Sites#IT_Consultancy.2FSolution_provider|IT consultancy/Solution provider]]
 +
 
 +
 
 +
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #fff8f2;">
 +
 
 +
===  Third Party Integration and Modules ===
 +
*[[Integration HOWTOs]] (Struts, Spring, JSF, etc.)
 +
*[[Available Modules | Available Modules and Extensions]]
 +
 
 +
</div>
 +
 
 +
<div style="margin: 0; margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #e4dede; background-color: #f9f9f9;">
 +
 
 +
===  The future development of OpenCms ===
 
*[[Wishlist]]
 
*[[Wishlist]]
 +
</div>
  
== [[image:icon.gif]] Extending OpenCms ==
 
*[[Advanced Customization]]
 
**[[Advanced module config]]
 
**[[Action classes]]
 
  
 +
|width="50%" style="vertical-align:top"|
 +
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #fff8f2;">
  
*Admin Tools
+
===  What Can OpenCms Do ===
**[[Adding Admin Tools]]
+
'''Overview'''
 +
*[[OpenCms Administration Guide]]
 +
*[[OpenCms philosophy]]
 +
*[[OpenCms terminology]]
 +
*[[Introduction to the OpenCms application structure and tools]]
 +
*[[Best Practices]]
  
 +
*[[OpenCms Reference Sites]]
  
*[[Third Party Integration]]
+
'''Template Development'''
**[[spring]]
+
*[[example template with tree menu]]
**[[hibernate]]
+
*[[common and frequent mistakes, NPEs]]
**[[struts]]
+
*[[Building from Scratch]]
**[[jbpm]]
+
*[[Using existing Template One]]
**[[mvnForum]]
+
*[[Using existing Template Two]]
**[[other j2ee stuff]]
+
*[[Available Modules]]
**[[jmx]]
+
  
 +
'''Search'''
 +
*[[Configuration]]
 +
*[[Sample search results pages]]
 +
*[[writing only specific xml-element-data to the lucene index]]
 +
*[[lucene related: writing custom analyzers, stemmers, documents]]
 +
*[[Solr - configuration for Chinese and correct results for german umlauts]]
  
*[[Advanced development topics]]
+
'''Other Major Features'''
**[[core stuff]]
+
*[[XMLContent]]
**[[event handling]]
+
*[[Localization]] / Multilanguage / I18N
 +
*[[Categories]]
 +
*[[Customizability for Several Clients]]
 +
*[[XMLPage]]
  
 +
</div>
  
*[[Common HowTos]]
+
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #fff8f2;">
**[[RSS]]
+
 
 +
===  Troubleshooting ===
 +
* [[HTTP 404 with OpenCms URLs]]
 +
* [[Installing OpenCMS to an existing database|Installing OpenCms to an existing database]]
 +
* [[Log Settings]]
 +
* [[Getting Static Export working properly]]
 +
* [[OpenCms won't start!]]
 +
* [[Direct edit mode moves page elements around]]
 +
* [[Running OpenCms on JRun 4.0]]
 +
* [[No WYSIWYG-Editor (FCKeditor) after Firefox-Update (3.6)]]
 +
* [[No WYSIWYG-Editor (FCKeditor) after IE-Update (IE9)]]
 +
* [[Deleting broken resources via SQL]]
 +
* [[FAQ about Alkacon's OCEE modules]]
 +
* [[Workaround for: Unable to unlock resources, because root folder is locked]]
 +
</div>
 +
 
 +
<div style="margin: 0; margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #e4dede; background-color: #f9f9f9;">
 +
 
 +
===  Writing JSP and developing in OpenCms ===
 +
 
 +
'''Building OpenCms'''
 +
*[[Building Opencms 9.5.x from the sources]]
 +
 
 +
'''Jsp Basics'''
 +
*[[Including your template elements within your JSPs]]
 +
*[[Using Direct Edit with JSP]]
 +
*[[OpenCms features available via taglibs]]
 +
*[http://opencms.org/en/development/documentation.html OpenCms features javadoc]
 +
*[http://www.opencms.org/opencms/en/download/documentation.html OpenCms downloadable sample modules]
 +
*[[How Opencms Handles JSP- Advanced]]
 +
*[[Scriptlets]]
 +
*[[Creating Navigation]]
 +
 
 +
'''Using the OpenCms API'''
 +
*[[Adding and modifying users]]
 +
*[[Creating and editing files]]
 +
*[[Working with users and groups]]
 +
*[[Working with projects]]
 +
*[[Getting server information]]
 +
*[[Using OpenCms's Database connection pool]]
 +
*[[Listing OpenCms's scheduled jobs]]
 +
 
 +
'''IDE Integration'''
 +
*[[Developing OpenCms with Eclipse]]
 +
*[[Developing OpenCms with Maven (incl. Eclipse)]]
 +
*[[Eclipse integration]]
 +
*[[Eclipse Integration on the MAC]]
 +
 
 +
'''Development Environment Setup'''
 +
*[[Development Environment Setup Options]]
 +
*[[Synchronizing with Ant]]
 +
*[[Debugging]]
 +
*[[Remote debugging OpenCms with Eclipse and Netbeans]]
 +
*[[WebDAV access to the OpenCms VFS|OpenCms 7: WebDAV access to the OpenCms VFS]]
 +
*[[Fully_automated_builds_with_the_OpenCms-Maven-Plugin|Automated builds with OpenCms-Maven]]
 +
*[https://bitbucket.org/shimberger/opencms-gradle/ Gradle OpenCms Build Script]
 +
 
 +
'''Development tips'''
 +
*[[RFS_Synchronization|Synchronization with external directories]]
 +
*[[ManifestBuilder Task]]
 +
*[[StructuredContentTips|Structured Content Tips and Tricks]]
 +
 
 +
 
 +
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #fff8f2;">
 +
 
 +
===  Updating ===
 +
'''Migration of content'''
 +
*[[Export/Import site while keeping the 'unpublished' flags]]
 +
</div>
 +
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #f2f8ff;">
 +
 
 +
===  Extending OpenCms ===
 +
'''Module Development'''
 +
*'''[[Available Modules]]'''
 +
*[[Development Lifecycle]]
 +
*[[Action classes]] (e.g. do something when a resource was published or changed)
 +
*[[Create Module HowTo]]
 +
*[[Adding Jar Files]]
 +
*[[List of Resourcetype IDs]]
 +
 
 +
'''Advanced Customization'''
 +
*[[Custom Login Page]]
 +
*[[Custom File and Folder Types]]
 +
*[[Custom Views]]
 +
*[[Custom Widgets]]
 +
*[[Custom XML Content Validation]]
 +
*[[Custom XML Content Mapping]]
 +
*[[Create a Custom Scheduled Job]]
 +
*[[Configure the Structured Content Editor]]
 +
*[[Custom Content Parser]]
 +
 
 +
'''Admin Tools'''
 +
*[[Adding Admin Tools]]
 +
 
 +
'''Advanced development topics'''
 +
*[[OpenCms startup]]
 +
 
 +
'''Common HowTos'''
 +
*[[RSS]]
 +
*[[Send email]]
 +
*[[Google Sitemap.xml]]
 +
 
 +
'''Miscellaneous'''
 +
*[[Scripting language integration (Groovy/PHP)]]
 +
</div>

Latest revision as of 09:13, 30 April 2019

Welcome to the OpenCms user wiki

OpenCms is a professional level Open Source Website Content Management System. You can find more information on the OpenCms homepage.

The current stable version of OpenCms is 11.0.0. Read the release notes for more details.

This wiki is for all OpenCms users to contribute and share their experiences.

Please note: The information in this wiki is community contributed and often does not represent the latest OpenCms version. Refer to the official OpenCms documentation website for the latest version documentation.

If you are unfamiliar with wikis in general you should take a look at the FAQ page.

Contents


Getting OpenCms Up and Running

Installation

Configuration

Performance Tuning

OpenCms Versions

OpenCms Bundles


Help

Official Website

Bug reports

Forums

Books

Demo

Additional sites with OpenCms documentation:

Companies offering OpenCms support


Third Party Integration and Modules

The future development of OpenCms


Writing JSP and developing in OpenCms

Building OpenCms

Jsp Basics

Using the OpenCms API

IDE Integration

Development Environment Setup

Development tips


Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox