[TYPO3-doc] A few DocBook questions

[François Suter]

Hi,

As always, thanks for your answers.

> This _could_ be marked with funcsynopsis:
> http://www.docbook.org/tdg5/en/html/funcsynopsis.html
> (There are some quite nice examples, although it's for the C language.)
>
> However, even the DocBookers don't seem to use it much. Some consider it as
> legacy thing from the old days of UNIX manpages, some think it's quite useful.
>
> I don't know if this works for TypoScript. Probably you have to adjust the
> DocBook XSL stylesheet to adhere to the special notation of that language.

It could, I guess. Worth a try at least. I suppose this thing with our 
references will take some experimenting.

> This could be done with one of the common effectivity attributes that DocBook
> provides:
>
>   http://www.docbook.org/tdg5/en/html/ref-
> elements.html#common.effectivity.attributes
>
> I think, conformance could be a good match. Combine it with paramdef, for
> example:

I had already thought about attributes indeed.

> Of course, this is only _one_ part of the story. The other part, the DocBook
> stylesheets, does nothing special with it. You have to implement the different
> typography (bold, with logo, etc.) in your customization layer.

Yes.

> 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?

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch