Main Page

From OpenCms Wiki
(Difference between revisions)
Jump to: navigation, search
(→Writing JSP and developing in OpenCms: adding creating and editing files)
 
(218 intermediate revisions by 67 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 '''6.2.3'''. Read the [http://www.opencms.org/opencms/en/shownews.html?id=1063 release notes].
+
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 a newbie or 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 24: Line 29:
 
|-valign="top"
 
|-valign="top"
 
|style="vertical-align: top"|
 
|style="vertical-align: top"|
 +
<div style="margin: 0;  margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #eadcc5; background-color: #fff8f2;">
 +
 +
===  OpenCms HowTos ===
 +
*[[A short introduction]]
 +
 +
==== 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]]
 +
 +
==== PDF downloads ====
 +
*[[OpenCms content manager user manual]]
 +
 +
</div>
  
 
<div style="margin: 0; margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #c6c9ff; color: #000; background-color: #f0f0ff">
 
<div style="margin: 0; margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #c6c9ff; color: #000; background-color: #f0f0ff">
Line 29: 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 PostgreSQL]]
 
* [[App server related topics]]
 
* [[App server related topics]]
 +
* [[OS related topics]]
 
* [[Post-installation checkout]]
 
* [[Post-installation checkout]]
  
Line 41: Line 68:
 
*[[Removing /opencms/opencms from site url]]
 
*[[Removing /opencms/opencms from site url]]
 
*[[MultiSite configuration instructions | MultiSite configuration instructions  (apache + mod_proxy)]]
 
*[[MultiSite configuration instructions | MultiSite configuration instructions  (apache + mod_proxy)]]
 +
*[[Avoiding /opencms/opencms in the URL (apache + mod_proxy)]]
 
*[[MultiSite configuration instructions (apache + mod_jk)]]
 
*[[MultiSite configuration instructions (apache + mod_jk)]]
 
*[[Securing the site - implementing your security policy]]
 
*[[Securing the site - implementing your security policy]]
 
*[[Removing OpenCMS documents and non-essential components - What to keep]]
 
*[[Removing OpenCMS documents and non-essential components - What to keep]]
 
*[[Changing the default request encoding]]
 
*[[Changing the default request encoding]]
−
*[[Changing from Servlet 2.3 to Servlet 2.4 (JSP 2.0)]]
+
*[[Changing from Servlet 2.3 to Servlet 2.4 (JSP 2.0)]] - out of date
 
*[[Disable structured content]]
 
*[[Disable structured content]]
−
 
+
*[[Disallow creation of resource types]]
 +
*[[Workplace: Custom footer]]
 +
*[[Workplace - Explorer View: Hide Advanced property button]]
  
 
'''Performance Tuning'''
 
'''Performance Tuning'''
 
*[[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]]
 +
 +
'''OpenCms Versions'''
 +
*[[New/Different Features in OpenCms 7]]
 +
 +
'''OpenCms Bundles'''
 +
*[[OpenCms 7.0.5 Web Site Framework]]
 +
  
 
</div>
 
</div>
Line 63: Line 100:
 
*[[Backing up OpenCms]]
 
*[[Backing up OpenCms]]
  
−
'''Using the Workplace'''
+
====Using the Workplace====
 
*[[Explorer view]]
 
*[[Explorer view]]
−
*[[FCKEditor]]
 
 
*[[Administration view]]
 
*[[Administration view]]
 +
*'''Editors'''
 +
**[[FCKEditor]]
 +
**[[HTML cleanup control]]
  
−
'''Workflow'''
+
====Workflow====
 
*[[Workflow in core OpenCms]]
 
*[[Workflow in core OpenCms]]
 
*[[Workflow using third party workflow engines]]
 
*[[Workflow using third party workflow engines]]
  
−
'''Admin Tools/Maintenance Tools'''
+
====Admin Tools/Maintenance Tools====
 
*[[Project Management]]
 
*[[Project Management]]
 
*[[Account Management]]
 
*[[Account Management]]
Line 82: Line 121:
 
*[[Search Management]]
 
*[[Search Management]]
 
*[[Scheduled Jobs Management]]
 
*[[Scheduled Jobs Management]]
−
*[[Flex Cache Administration]]
 
 
*[[Content Tools]]
 
*[[Content Tools]]
 
*[[Workplace Tools]]
 
*[[Workplace Tools]]
 +
*[[CMS Shell]]
  
−
'''User Management'''
+
====User Management====
 
* [[How to create a restricted area on your homepage]]
 
* [[How to create a restricted area on your homepage]]
 
* [[How OpenCms Permissions work]]
 
* [[How OpenCms Permissions work]]
  
−
'''Security'''
+
====Security====
 
*[[Authentication per Page]]
 
*[[Authentication per Page]]
 
*[[Https/SSL]]
 
*[[Https/SSL]]
 +
*[[External password authentication]]
  
 
</div>
 
</div>
Line 99: 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
  
 
'''Demo'''
 
'''Demo'''
−
*[http://www.opencmsdemo.de/ german Demo of OpenCms 6.2 ]
+
*[http://demo.opencms.org German or english test-drive of latest OpenCms version ]
−
*[http://www.IQplay.net/ A demo of OpenCms 6.2 provide Flash games from China]
+
*[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.pomegranate.de:9000/cms/forum/listthreads?forum=3 another forum on OpenCms]
+
−
*[http://www.opencmshispano.com:8080/mvnforum/mvnforum/index  The first OpenCms forum in Spanish]
+
  
 
'''Additional sites with OpenCms documentation:'''
 
'''Additional sites with OpenCms documentation:'''
−
*[http://cms.galway.net:8080/OpenCmsWiki/ an older Wiki about OpenCms]
+
*[http://www.erzbistum-koeln.de/medien/internet/ German documentation for OpenCms Users]
−
*[http://sourceforge.net/projects/opencmshowto/ OpenCms documentation project at sourceforge]
+
*[http://opencms.org/en/development/documentation.html Javadoc and browsable source code]
−
*[http://www.erzbistum-koeln.de/medien/internet/support/dokumentation.html German documentation for OpenCms Users]
+
−
*[http://jsourcery.com/library?id=151 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.pomegranate.de/en/chat.html OpenCms Developer and Support Chat Room]
+
*[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>
 
  
 
<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;">
  
 
===  Third Party Integration and Modules ===
 
===  Third Party Integration and Modules ===
−
*[[Integration HOWTOs]]
+
*[[Integration HOWTOs]] (Struts, Spring, JSF, etc.)
 
*[[Available Modules | Available Modules and Extensions]]
 
*[[Available Modules | Available Modules and Extensions]]
  
 
</div>
 
</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]]
 +
</div>
 +
  
 
|width="50%" style="vertical-align:top"|
 
|width="50%" style="vertical-align:top"|
Line 138: Line 193:
 
===  What Can OpenCms Do ===
 
===  What Can OpenCms Do ===
 
'''Overview'''
 
'''Overview'''
 +
*[[OpenCms Administration Guide]]
 
*[[OpenCms philosophy]]
 
*[[OpenCms philosophy]]
 
*[[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]]
−
*[[lessons learned]]
+
 
*[[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]]
−
*[[Other example templates]]
+
*[[Using existing Template Two]]
−
*[[Available Modules |  The Ubuntu Framework for a kickstart into template development]]
+
*[[Available Modules]]
  
 
'''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'''
 
*[[XMLContent]]
 
*[[XMLContent]]
 
*[[Localization]] / Multilanguage / I18N
 
*[[Localization]] / Multilanguage / I18N
 +
*[[Categories]]
 +
*[[Customizability for Several Clients]]
 +
*[[XMLPage]]
  
 
</div>
 
</div>
Line 173: Line 227:
 
<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;">
  
−
===  Trouble Shooting ===
+
===  Troubleshooting ===
 
* [[HTTP 404 with OpenCms URLs]]
 
* [[HTTP 404 with OpenCms URLs]]
 +
* [[Installing OpenCMS to an existing database|Installing OpenCms to an existing database]]
 
* [[Log Settings]]
 
* [[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>
  
Line 181: 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]]
 
*[[OpenCms features available via taglibs]]
 
*[[OpenCms features available via taglibs]]
−
*[[OpenCms features javadoc]]
+
*[http://opencms.org/en/development/documentation.html OpenCms features javadoc]
 
*[http://www.opencms.org/opencms/en/download/documentation.html OpenCms downloadable sample modules]
 
*[http://www.opencms.org/opencms/en/download/documentation.html OpenCms downloadable sample modules]
−
*[[How Opencms Handles jsp - Advanced]]
+
*[[How Opencms Handles JSP- Advanced]]
 
*[[Scriptlets]]
 
*[[Scriptlets]]
 +
*[[Creating Navigation]]
  
 
'''Using the OpenCms API'''
 
'''Using the OpenCms API'''
 
*[[Adding and modifying users]]
 
*[[Adding and modifying users]]
 
*[[Creating and editing files]]
 
*[[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]]
  
−
'''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'''
 +
*[[Development Environment Setup Options]]
 
*[[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]]
 +
*[[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]]
 
−
*[[Ftpd module]]
 
 
*[[RFS_Synchronization|Synchronization with external directories]]
 
*[[RFS_Synchronization|Synchronization with external directories]]
−
*[[Remote debugging OpenCms with Eclipse and Netbeans]]
+
*[[ManifestBuilder Task]]
 +
*[[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;">
 +
 +
===  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 ===
 
===  Extending OpenCms ===
 
'''Module Development'''
 
'''Module Development'''
 +
*'''[[Available Modules]]'''
 
*[[Development Lifecycle]]
 
*[[Development Lifecycle]]
−
*[[Action classes]]
+
*[[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 228: Line 312:
 
*[[Custom Widgets]]
 
*[[Custom Widgets]]
 
*[[Custom XML Content Validation]]
 
*[[Custom XML Content Validation]]
 +
*[[Custom XML Content Mapping]]
 +
*[[Create a Custom Scheduled Job]]
 +
*[[Configure the Structured Content Editor]]
 +
*[[Custom Content Parser]]
  
 
'''Admin Tools'''
 
'''Admin Tools'''
Line 233: Line 321:
  
 
'''Advanced development topics'''
 
'''Advanced development topics'''
−
*[[core stuff]]
+
*[[OpenCms startup]]
−
*[[event handling]]
+
−
*[[acegi integration]]
+
  
 
'''Common HowTos'''
 
'''Common HowTos'''
 
*[[RSS]]
 
*[[RSS]]
−
</div>
+
*[[Send email]]
−
 
+
*[[Google Sitemap.xml]]
−
<div style="margin: 0; margin-bottom: 5px; padding: .5em 1em .5em; border: 1px solid #e4dede; background-color: #f9f9f9;">
+
−
 
+
−
===  The future development of OpenCms ===
+
−
*[[Wishlist]]
+
−
*[[Development Roadmap]]
+
  
 +
'''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


Retrieved from "http://www.opencms-wiki.org/index.php?title=Main_Page&oldid=6141"
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox