Propertiesdoc - Liferay's Properties Files in HTML
General Blogs September 23, 2013 By James Hinkey Staff
Have you wanted to find a listing of the properties available to you via Liferay Portal's properties files? Have you wanted to view the property definitions in a nicer format, instead of as plain text ? Good news! Liferay Portal's property file properties are now available online and offline in HTML for easy lookup.
We now provide Propertiesdoc--marked up versions of our properties files--along with our normal set of Javadocs, Taglibs, and definitions (DTDs) that you've come to know and love.
For your online reading pleasure, you'll find a propertiesdoc directory for the 6.1 and 6.2 (beta) version of Liferay Portal CE on http://docs.liferay.com. It has links to the portal.properties and system.properties files containing Portal's default properties, and it has links to the liferay-plugin-package-<version>.properties file(s) giving you definitions for the properties you can use in your plugins.
For your offline reading pleasure, you'll find the equivalent propertiesdoc directory and files in the liferay-portal-doc-<version>.zip file you download for Liferal Portal EE or CE.
Let's take the nickel tour of Portal's Propertiesdocs. For example, let's find out what Liferay Portal 6.2 (beta) uses for ORM persistence defaults and what options we can specify.
Start by opening your browser to the http://docs.liferay.com/portal/6.2/propertiesdoc directory or propertiesdoc folder of the liferay-portal-doc-<version>.zip file you extracted. The propertiesdoc folder lists the following Liferay Portal properties files as shown in the figure below:
Click on the portal.properties link to see it's Table of Contents. You'll find there's a Persistence section listed as shown circled in the picture below.
Click on the Persistence section link so we can look at the persistence properties. In this section to find the persistence.provider property listed. It has a description that mentions the options you can specify for your portal's persistence provider. Below the description, notice the property's default value highlighted in gray. And an example value for the property is highlighted in light green. See the picture below.
When you're done looking at this property and want to look up some more Portal props, simply click the Top of Page link and you're brought back to the Table of Contents.
We hope providing you with this Propertiesdocs help you learn about and use Liferay Portal's properties more easily.