Search the documentation
 Show GitHub edit links  Hide GitHub edit links
Documented since: 9.5 Latest revision for: 9.5 Valid for OpenCms: 10.5.2

Here you find information about licence, purpose and structure of this documentation.

Aim of the documentation

The documentation aims to help developers from getting started with OpenCms up to getting familiar with advanced development topics regarding OpenCms. Some topics are also interesting for content managers, but most of the documentation is focused on template development, content design, configuration options and user management.

Using the documentation

The documentation is mainly topic based. Each page can be your first page when reading it. And dependent on your pre-knowledge and your current question, each page can be the perfect place to start. If you get lost, links may bring you quickly to the missing information. Some pages just provide overviews on topics to help you getting the "big picture".

The documentation provides some interactive demos. Some features are best explained by seeing them in action and playing with them. The topics placed in the section "Demo" provide such demos. To use them you must read the documentation in your local OpenCms installation. It is shipped with the standard OpenCms installation.

Searching in the documentation

The documentation provides various ways to navigate:

  • Site navigation: At the left-hand side of each page of the documentation you find a site navigation. It may be a good way to just browse the documentation or to search for something you cannot name exactly enough to search it directly.
  • Integrated search: The OpenCms demo pages contain a site-wide search that is perfectly suitable to search inside the documentation. Use the magnifier in the right-hand side of the main navigation at the top of each page to start searching. You should restrict the results to the documentation subsite and to container pages for optimal search results.
  • (Related) links: Each topic itself is richly linked. Use these links to find related topics, read more details or get a more abstract view on a topic.
  • Overview topics: Overview topics provide an alternative to the site navigation. Some of these topics link also to external resources. Watch out for overview topics if you want the "big picture" of some concept, task or feature. Starting from an overview topic you can easily move on to various special topics.

Contributing to the documentation

This documentation is maintained by Alkacon. But we like the whole community to be involved when improving the documentation. Choose one of the following options to participate.

Corrections via GitHub

You can edit the documentation source on GitHub. Click "Show GitHub edit links" to get links for each content element. The links will appear as edit symbols at the upper-right corner for each content snippet. Clicking the symbol, the GitHub edit page for the content snippet opens in a new tab.

Once you edited the content, send us a pull request for your change.

You must be signed in at GitHub to edit content.
Fig. [github_links]: Show GitHub edit links

Suggestions on the OpenCms wiki

If you like to see a topic of the documentation improved or extended, or you have any hints on it. Then, the OpenCms wiki is the correct place for your suggestions. At the end of each page, you find a link to a wiki page that is dedicated only for suggestions for that documentation page.

You must be logged in at the wiki to create or edit pages there.
Fig. [wiki_links]: Go to the OpenCms wiki
Be aware that the wiki is not the support. For support choose the OpenCms mailing list or go for professional support.

Licence

This documentation has been developed by Alkacon Software - The OpenCms Experts. We offer standard service and support packages for OpenCms, providing an optional layer of security and convenience often required for mission critical OpenCms projects. For more information about our services, please contact us at info@alkacon.com.

This documentation is published under theĀ GNU FDL Free Documentation License by Alkacon Software GmbH. We certainly welcome all contributions and feedback to this documentation.

You can improve this page

Please contribute your suggestions or comments regarding this topic on our wiki. For support questions, please use the OpenCms mailing list or go for professional support.