jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Jackrabbit Wiki] Update of "NodeNamingConventions" by BertrandDelacretaz
Date Fri, 17 Aug 2012 13:58:40 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Jackrabbit Wiki" for change notification.

The "NodeNamingConventions" page has been changed by BertrandDelacretaz:

New page:
= Overview =
Here are some recommendations for naming nodes, that have worked well for us in the context
of Sling and other JCR-based applications.

The main goal is to ''keep the transparency of JCR'' - good node names will help make your
content structure obvious.

= Node naming recommendations =

Use all lower case for node names.

Separate words using hyphen (-) instead of underscore (_), e.g. `funky-content`.

Use camel``Case for property names, e.g. `lastModifiedBy`.

Use namespaces with care, they are usually only required for infrastructure code. The `sling:resourceType`
property name is a good example, it's a Sling-specific thing and you don't want collisions
with a user-defined `resourceType` property.

Do not use the reserved namespaces and prefixes (jcr:, nt:, mix: etc.) for node names that
are not predefined by the spec.

Short unixish names work well, especially at the top of the hierachy, and the http://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard
is good inspiration for a JCR content hierarchy.

Short but clearly understandable property names are good, don't be too cryptic here. Property
names are always the last element of a path, so it's not that bad if they are a bit longer.

If several nodes share a common prefix or suffix, it might be a sign that they belong in a
folder with a descriptive name. If you have `business-rule-foo` and `business-rule-bar` for
example, `business-rule/foo` and `business-rule/bar` probably makes sense, with an additional
hierarchy level.

View raw message