[TYPO3-doc] A few DocBook questions

[Thomas Schraitle]

Hi François,

Tuesday 21 December 2010
> [...]
> > Hmn, do you have an example of such a relation? I have an idea, but
> > before I go public I would like to see if it works. :)
> 
> Let's take a simple object (but not the simplest, because it might not
> be enough to demonstrate) for rendering an image. The object is called
> IMAGE. It is fed some pointer to an image and renders an <img> tag. The
> reference can be found here:
> 
> http://typo3.org/documentation/document-library/core-documentation/doc_core
> _tsref/4.3.2/view/1/7/#id2519074
> 
> As you can see, the IMAGE object has a number of properties. It's
> important that these properties can be strictly related to the IMAGE
> object, especially since many properties have the same name (i.e. most
> objects have a "wrap" or "stdWrap" property). I'm not sure if this is
> explicit enough. Would you need more details?

I think, I'm beginning to understand what you mean. :)

I see your point, but I'm not completely sure why it's so important to be 
"strictly related". Let's say you have a refentry for this IMAGE object. 
Whatever you put inside this refentry, this is already strictly related to 
this object. If you need this information for indexing reasons, this could be 
taken into account in the stylesheets.

This method uses some kind of "inheritance". If you need this information in a 
more "atomar" fashion, you could use some of the common attributes directly. 
Let's say, you want describe a property "foo" which relates to the IMAGE 
object. This *could* be described as:

  <property role="parent:IMAGE">foo</property>

Whatever attribute you use is not that important (it could also be a condition 
attribute). It's the content which declares "I belong to IMAGE". However, this 
is tedious so the first method would be probably a bit easier to type. 

Does this answer your question?


Cheers,
  Tom