Main Page

From OpenCms Wiki
(Difference between revisions)
Jump to: navigation, search
 
(75 intermediate revisions by 12 users not shown)
Line 4: Line 4:
  
 
<div style="margin:0; margin-right:10px; border:1px solid #63ff63; padding: 1em 1em 1em 1em; background-color:#f2fff2;">
 
<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>
+
<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 '''8.0.1'''. Read the [http://www.opencms.org/en/news/110629-opencms-v801-releasenotes.html release notes] for more details.
+
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.
  
'''If you are new to this wiki you should take a look at the [[FAQ|FAQ page]].'''
+
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>
Line 29: Line 34:
 
*[[A short introduction]]
 
*[[A short introduction]]
  
==== Common HowTos ====
+
==== OpenCms Tutorials ====
 
*[[Configuration of OpenCms Sitemap Properties]]
 
*[[Configuration of OpenCms Sitemap Properties]]
*[[Using formatters in OpenCms 8]]
+
*[[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]]
  
==== OpenCms 8 Tutorials ====
+
==== PDF downloads ====
*[[Creating OpenCms 8 Container Templates]]
+
*[[OpenCms content manager user manual]]
*[[Upgrading from OpenCms 7.x to OpenCms 8]]
+
*[[Creating Mobile Templates with OpenCms 8]]
+
*[[Creating Plug and Play Modules for OpenCms 8|Creating Plug & Play Modules for OpenCms 8]]
+
*[[The OpenCms 8 Demo Template Modules in Detail]]
+
*[[The OpenCms 8 Content Subscription Engine]]
+
  
 
</div>
 
</div>
Line 47: Line 52:
 
===  Getting OpenCms Up and Running ===
 
===  Getting OpenCms Up and Running ===
 
'''Installation'''
 
'''Installation'''
 +
* [[OpenCms in the Cloud]]
 
* [[Hardware requirements]]
 
* [[Hardware requirements]]
 
* [[Finding and installing the prerequisites]]
 
* [[Finding and installing the prerequisites]]
 
* [[Database Setup]]
 
* [[Database Setup]]
 
* [[Installing on Oracle 9]]
 
* [[Installing on Oracle 9]]
 +
* [[Installing on PostgreSQL]]
 
* [[App server related topics]]
 
* [[App server related topics]]
 
* [[OS related topics]]
 
* [[OS related topics]]
Line 75: Line 82:
 
*[[Load Balancing with Alkacon Clustering OCEE]]
 
*[[Load Balancing with Alkacon Clustering OCEE]]
 
*[[Static Export configuration]]
 
*[[Static Export configuration]]
*[[Flex Cache tuning]]
 
 
*[[Clustering OpenCms]]
 
*[[Clustering OpenCms]]
 
*[[Performance Tuning Example]]
 
*[[Performance Tuning Example]]
Line 115: Line 121:
 
*[[Search Management]]
 
*[[Search Management]]
 
*[[Scheduled Jobs Management]]
 
*[[Scheduled Jobs Management]]
*[[Flex Cache Administration]]
 
 
*[[Content Tools]]
 
*[[Content Tools]]
 
*[[Workplace Tools]]
 
*[[Workplace Tools]]
Line 134: Line 139:
  
 
===  Help ===
 
===  Help ===
 +
'''  Official Website '''
 
*[http://www.opencms.org OpenCms Website]
 
*[http://www.opencms.org OpenCms Website]
 +
 +
''' Bug reports '''
 +
*[https://github.com/alkacon/opencms-core/issues OpenCms Issue Tracker on GitHub]
 +
 +
'''Forums'''
 
*[http://www.opencms.org/opencms/en/development/mailinglist-archive.html Official Mailing List Archives]
 
*[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.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
 +
 +
''' Books '''
 
*[http://www.packtpub.com/OpenCMS6-admin/book Managing and Customizing OpenCMS 6] A book about OpenCms administration and usage
 
*[http://www.packtpub.com/OpenCMS6-admin/book Managing and Customizing OpenCMS 6] A book about OpenCms administration and usage
 
*[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
 
*[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
  
 
'''Demo'''
 
'''Demo'''
*[http://demo.opencms.org German or english test-drive of OpenCms 7 ]
+
*[http://demo.opencms.org German or english test-drive of latest OpenCms version ]
 
*[http://www.demo-opencms.de/ German Demo of OpenCms 8]
 
*[http://www.demo-opencms.de/ German Demo of OpenCms 8]
 
'''Forums'''
 
*[http://www.opencms-forum.de/opencms-forum/index OpenCms Forum ]
 
*[http://www.opencmsforum.de/ German OpenCms forum]
 
*[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]
 
  
 
'''Additional sites with OpenCms documentation:'''
 
'''Additional sites with OpenCms documentation:'''
*[http://sourceforge.net/projects/opencmshowto/ OpenCms documentation project at sourceforge] - out of date
 
 
*[http://www.erzbistum-koeln.de/medien/internet/ German documentation for OpenCms Users]
 
*[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://opencms.org/en/development/documentation.html Javadoc and browsable source code]
 
*[http://www.opencmshispano.com OpenCmsHispano the first Spanish Community]
 
*[http://www.opencmshispano.com OpenCmsHispano the first Spanish Community]
 
*[http://www.solutioncms.com The first OpenCMS Brazilian Community for Developer and Support]
 
*[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
 
'''Companies offering OpenCms support
 
*[[OpenCms_Reference_Sites#IT_Consultancy.2FSolution_provider|IT consultancy/Solution provider]]
 
*[[OpenCms_Reference_Sites#IT_Consultancy.2FSolution_provider|IT consultancy/Solution provider]]
  
</div>
 
  
 
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #fff8f2;">
 
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #fff8f2;">
Line 176: Line 185:
 
===  The future development of OpenCms ===
 
===  The future development of OpenCms ===
 
*[[Wishlist]]
 
*[[Wishlist]]
*[http://www.opencms-days.org/export/sites/opencmsdays/en/program/slides/keynote_k1.pdf Development Roadmap for OpenCMS V8.5]
 
 
 
</div>
 
</div>
  
Line 190: Line 197:
 
*[[OpenCms terminology]]
 
*[[OpenCms terminology]]
 
*[[Introduction to the OpenCms application structure and tools]]
 
*[[Introduction to the OpenCms application structure and tools]]
*[[Alternative site structures]]
 
*[[Planning and documenting your site]]
 
 
*[[Best Practices]]
 
*[[Best Practices]]
*[[Other Overview Guides]]
 
  
 
*[[OpenCms Reference Sites]]
 
*[[OpenCms Reference Sites]]
  
 
'''Template Development'''
 
'''Template Development'''
*[[basics and overview]]
 
 
*[[example template with tree menu]]
 
*[[example template with tree menu]]
 
*[[common and frequent mistakes, NPEs]]
 
*[[common and frequent mistakes, NPEs]]
*[[oc-taglibrary specifics]]
 
 
*[[Building from Scratch]]
 
*[[Building from Scratch]]
 
*[[Using existing Template One]]
 
*[[Using existing Template One]]
 
*[[Using existing Template Two]]
 
*[[Using existing Template Two]]
*[[Other example templates]]
+
*[[Available Modules]]
*[[Available Modules |  The Ubuntu Framework for a kickstart into template development]]
+
*[http://stackoverflow.com/questions/2192186/adding-a-tag-cloud-to-an-opencms-website/2363994#2363994 Tags cloud for blog]
+
  
 
'''Search'''
 
'''Search'''
 
*[[Configuration]]
 
*[[Configuration]]
 
*[[Sample search results pages]]
 
*[[Sample search results pages]]
*[[common mistakes]]
 
 
*[[writing only specific xml-element-data to the lucene index]]
 
*[[writing only specific xml-element-data to the lucene index]]
 
*[[lucene related: writing custom analyzers, stemmers, documents]]
 
*[[lucene related: writing custom analyzers, stemmers, documents]]
 +
*[[Solr - configuration for Chinese and correct results for german umlauts]]
  
 
'''Other Major Features'''
 
'''Other Major Features'''
Line 236: Line 236:
 
* [[Running OpenCms on JRun 4.0]]
 
* [[Running OpenCms on JRun 4.0]]
 
* [[No WYSIWYG-Editor (FCKeditor) after Firefox-Update (3.6)]]
 
* [[No WYSIWYG-Editor (FCKeditor) after Firefox-Update (3.6)]]
 +
* [[No WYSIWYG-Editor (FCKeditor) after IE-Update (IE9)]]
 
* [[Deleting broken resources via SQL]]
 
* [[Deleting broken resources via SQL]]
 +
* [[FAQ about Alkacon's OCEE modules]]
 +
* [[Workaround for: Unable to unlock resources, because root folder is locked]]
 
</div>
 
</div>
  
Line 242: Line 245:
  
 
===  Writing JSP and developing in OpenCms ===
 
===  Writing JSP and developing in OpenCms ===
 +
 +
'''Building OpenCms'''
 +
*[[Building Opencms 9.5.x from the sources]]
 +
 
'''Jsp Basics'''
 
'''Jsp Basics'''
*[[Basic Steps to writing JSPs]]
 
 
*[[Including your template elements within your JSPs]]
 
*[[Including your template elements within your JSPs]]
 
*[[Using Direct Edit with JSP]]
 
*[[Using Direct Edit with JSP]]
Line 252: Line 258:
 
*[[Scriptlets]]
 
*[[Scriptlets]]
 
*[[Creating Navigation]]
 
*[[Creating Navigation]]
*[[Using Cookies]], e.g. for [[CSS-Switching]]
 
*[[Developing OpenCms with Eclipse]]
 
*[[Developing OpenCms with Maven (inkl. Eclipse)]]
 
  
 
'''Using the OpenCms API'''
 
'''Using the OpenCms API'''
Line 265: Line 268:
 
*[[Listing OpenCms's scheduled jobs]]
 
*[[Listing OpenCms's scheduled jobs]]
  
'''Development Process-Best Practices'''
+
'''IDE Integration'''
*[[Transferring an existing website to a different server]]
+
*[[Developing OpenCms with Eclipse]]
 +
*[[Developing OpenCms with Maven (incl. Eclipse)]]
 +
*[[Eclipse integration]]
 +
*[[Eclipse Integration on the MAC]]
  
 
'''Development Environment Setup'''
 
'''Development Environment Setup'''
Line 272: Line 278:
 
*[[Synchronizing with Ant]]
 
*[[Synchronizing with Ant]]
 
*[[Debugging]]
 
*[[Debugging]]
 +
*[[Remote debugging OpenCms with Eclipse and Netbeans]]
 
*[[WebDAV access to the OpenCms VFS|OpenCms 7: WebDAV access to the OpenCms VFS]]
 
*[[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]]
 
*[[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'''
 
'''Development tips'''
*[[Eclipse integration]]
 
*[[Eclipse Integration on the MAC]]
 
*[[Ftpd module]]
 
 
*[[RFS_Synchronization|Synchronization with external directories]]
 
*[[RFS_Synchronization|Synchronization with external directories]]
*[[Remote debugging OpenCms with Eclipse and Netbeans]]
 
 
*[[ManifestBuilder Task]]
 
*[[ManifestBuilder Task]]
 
*[[StructuredContentTips|Structured Content Tips and Tricks]]
 
*[[StructuredContentTips|Structured Content Tips and Tricks]]
  
</div>
 
  
 
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #fff8f2;">
 
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #fff8f2;">
Line 295: Line 299:
 
===  Extending OpenCms ===
 
===  Extending OpenCms ===
 
'''Module Development'''
 
'''Module Development'''
 +
*'''[[Available Modules]]'''
 
*[[Development Lifecycle]]
 
*[[Development Lifecycle]]
 
*[[Action classes]] (e.g. do something when a resource was published or changed)
 
*[[Action classes]] (e.g. do something when a resource was published or changed)
 
*[[Create Module HowTo]]
 
*[[Create Module HowTo]]
 
*[[Adding Jar Files]]
 
*[[Adding Jar Files]]
*[[Advanced module config]]
+
*[[List of Resourcetype IDs]]  
*[[Available Open Source Modules]]
+
*[[Available Commercial Modules]]
+
  
 
'''Advanced Customization'''
 
'''Advanced Customization'''
Line 309: Line 312:
 
*[[Custom Widgets]]
 
*[[Custom Widgets]]
 
*[[Custom XML Content Validation]]
 
*[[Custom XML Content Validation]]
 +
*[[Custom XML Content Mapping]]
 
*[[Create a Custom Scheduled Job]]
 
*[[Create a Custom Scheduled Job]]
 
*[[Configure the Structured Content Editor]]
 
*[[Configure the Structured Content Editor]]
Line 317: Line 321:
  
 
'''Advanced development topics'''
 
'''Advanced development topics'''
*[[core stuff]]
 
*[[event handling]]
 
*[[acegi integration]]
 
 
*[[OpenCms startup]]
 
*[[OpenCms startup]]
  
Line 326: Line 327:
 
*[[Send email]]
 
*[[Send email]]
 
*[[Google Sitemap.xml]]
 
*[[Google Sitemap.xml]]
 +
 +
'''Miscellaneous'''
 +
*[[Scripting language integration (Groovy/PHP)]]
 
</div>
 
</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