written by Manuel Schnitger, 8. March 2011
There are probably a lot of concepts how to build projects with the Open Text Management Server and there are lots of different requirements which can be met by using totally different approaches but I’d like to write down some ideas regarding naming conventions that have been helpful in the past.
If you start creating your project then you will probably/hopefully think about names for folders, content classes and elements. The following questions can help to figure out if your ideas will work:
Hint: From time to time I saw content classes (authorization packages, publication packages,…) which all had the same prefix. At a first glance this might look professional ….but normally it’s not ;) What would I like to achieve with a prefix? Normally I use prefixes in order to differentiate things at first view. This obviously does not work, when all things (e.g.: content classes within a folder) have the same prefixes such as “mod_” or “con_”. There are possibly specific situations where this approach is meaningful and cannot be reached with other ideas but in the past I saw that other concepts worked better.
Most people use prefixes for elements in order to identify the type of the element at first glance.
Sample: txtArticleTeaser is a text element. Of course you can also put an underscore between the prefix and the name of the element (txt_ArticleTeaser) or even write the name in small letters txtarticleteaser I prefer the Hungarian notation . So the prefix is written in small letters and if a name consists of more than one word (txtArticleText) I use capital letters for each part of the word in order to enhance the readability.
Below you find the list of prefixes that I use in the Best Practice Project.
|Content Element Media Management||cea|
|Content Element Content Server||cel|
|Delivery Server Contraint||dsc|
|Delivery Server Element||dse|
Hint: It’s not necessary to use exactly the naming convention that I use ;) Just make sure that the convention is used consequently and that all people who are involved (also/especially the editors and authors) do have the same understanding of the convention(s).
On the screenshot below you see one option to structure the content classes of your project. Let me just point out some advantages of this number based concept.
Figure 1: SmartTree - Content class folders
As there are a lot of different projects/situations/requirements the ideas described in this article do not meet all requirements and you will possibly feel the need to evolve other concepts and conventions. If so, then make sure to ask the community of SolutionExchange in the forum. Registration is -of course- for free! ….but necessary if you would like to post questions.
Source: First steps – Naming conventions
© copyright 2011 by Manuel Schnitger