SDL Tridion TOM.NET documentation

6
votes

SDL Tridion's TOM.NET API replaced the deprecated TOM (Tridion Object Model) starting in, I believe, version R5.3.

Aside from asking Stack Overflow (Exchange) questions, which documentation should we refer to when working with and learning the TOM.NET API?

So far, I've found (logins required):

I see these (plus questions on the forum), but can't tell which is better. What do you use most when working with TOM.NET?

3
tridion

3 Answers

6
votes

Good Question and Probably most of the Tridion new developers might be wondering the same when to to use which. I would say both the documents has a different purpose and go side-by-side. API Documentation does provide information on methods and usage, SDL Live Content docs provide information is more of understanding what to use for your scenario. We do get these kind of questions when we are on boarding any new developer "Which document provides me the most information".

I refer to these simple examples to explain the differences on when to use which documentation.

  1. what variables are available in package (vs) What API method to use when reading variables from package ?

Referring Live Docs for the first and API doc for second

  1. How do I loop through the embedded fields (vs) what method I use to loop through embedded value fields ?

Referring Live Docs for the first and API doc for second. I see this question with different variation keep popping up almost every month.

I know I used simple use cases, but sometimes keeping it simple is better. Hope this information helps.

5
votes

Also according to this page in the documentation the TOM.NET API should be only used in Templating and Event Handlers. For third party applications you should use the Core Service API.

4
votes

I use the API documentation, and when I really want to know more use Reflector. But that's not really advisable(?).