Re: theme doc

andyv <[email protected]> Mon, 31 Jan 2005 18:53:55 +0000
Newsgroups gmane.comp.cms.xaraya.documentation
Organization xaraya
Message-ID <[email protected]>
andyv wrote:
> linoj wrote:
>> another thought, what if every template had a <div 
>> class="templatename"> </div> at begin and end so one could get as 
>> specific as needed with styles?
>>
> Are you sure you're writing just Docs and not Specs? :)

I realized that my previous answering with the "question" hasn't 
probably achieved the desired effect ;-) So here goes a more detailed one...

We cannot and should not use unnecessary template inner 'wrappers' because

1. A xaraya template does not always represent a block-level structure, 
as you might have mistakenly deducted from the BL (block layout) name. 
It could be anything, from a single (indeterminable from template POV) 
variable like #$content#, to an single (or series of) inline element(s) 
like <select>...</select> which are going to be preceded or followed by 
other inline elements upon compilation and final assembly into a 
document level structure.

2. Even if all cases as in 1) are to be eliminated by ourselves somehow 
and every template indeed represented a block-level xhtml (xml) 
structure, we most certainly would not be able to utilize a template 
name as a class wrapper structure, because in different modules 
similarly named templates are not always or necessarily containing 
similar or same purpose markup.

My previous question-answer was aimed at determining the 'technical' 
level you want/need to posses in order to write the documentation about 
xaraya templates/themes.. as well as the level of 
description/explanation we may or may not need to reach in order for the 
users to understand and use the documentation we eventually produce.

Regards,
Andy.