theme function documentation (rephrased froward from dev and doc)
I'm giving up. Adrian nagged me (nearly to death) to join the list and forward this :) Documentation. Is anyone interested in helping me prepare a theming reference. The reference from the apis is not good for designers. Ultimately I would like to be able to automatically produce the html snippets, for each theme function, regardless of what is the template engine. My plan is to: 1. catalogue all available theme_ functions in core (for all practical purposes this is done, might need tweaking, but the code is there) 2. go through the theme_ functions and construct dummy(lorem ipsum) style calls to extract a formatted html. 3. look into producing a drupaldocs like description. This suggestion is closely related to testing as well. How would you approach it? Any ideas? There are a few catches. At the moment I will try and target 4.7. If everything works, we can have a look at setting up a website with this. Cheers, Vlado
Vlado, Stay tuned with what's going on with the "Base Theme" movement. I'm not sure how much this will change things in Drupal themeing, but it's something to keep an eye on for sure. It will need MUCH documentation when we launch it. Trae On 5/11/06, Vladimir Zlatanov <vlado@dikini.net> wrote:
I'm giving up. Adrian nagged me (nearly to death) to join the list and forward this :)
Documentation. Is anyone interested in helping me prepare a theming reference. The reference from the apis is not good for designers.
Ultimately I would like to be able to automatically produce the html snippets, for each theme function, regardless of what is the template engine.
My plan is to:
1. catalogue all available theme_ functions in core (for all practical purposes this is done, might need tweaking, but the code is there)
2. go through the theme_ functions and construct dummy(lorem ipsum) style calls to extract a formatted html.
3. look into producing a drupaldocs like description.
This suggestion is closely related to testing as well. How would you approach it? Any ideas?
There are a few catches. At the moment I will try and target 4.7. If everything works, we can have a look at setting up a website with this.
Cheers, Vlado
_______________________________________________ themes mailing list themes@drupal.org http://lists.drupal.org/mailman/listinfo/themes
-- Trae McCombs || http://occy.net/ Founder - Themes.org // Linux.com CivicSpaceLabs - http://civicspacelabs.org/
On 11 May 2006, at 2:44 PM, Trae McCombs wrote:
Stay tuned with what's going on with the "Base Theme" movement. I'm not sure how much this will change things in Drupal themeing, but it's something to keep an eye on for sure. It will need MUCH documentation when we launch it.
Maybe you don't understand. This can run concurrently with going through the base html. Vlado and me are in the process of splitting out all the html in core and making it documentable. -- Adrian Rossouw Drupal developer and Bryght Guy http://drupal.org | http://bryght.com
Ok, sorry. Again, "I just make things pretty"[tm] :) Thanks Adrian. Trae On 5/11/06, Adrian Rossouw <adrian@bryght.com> wrote:
On 11 May 2006, at 2:44 PM, Trae McCombs wrote:
Stay tuned with what's going on with the "Base Theme" movement. I'm not sure how much this will change things in Drupal themeing, but it's something to keep an eye on for sure. It will need MUCH documentation when we launch it.
Maybe you don't understand. This can run concurrently with going through the base html. Vlado and me are in the process of splitting out all the html in core and making it documentable.
-- Adrian Rossouw Drupal developer and Bryght Guy http://drupal.org | http://bryght.com
_______________________________________________ themes mailing list themes@drupal.org http://lists.drupal.org/mailman/listinfo/themes
-- Trae McCombs || http://occy.net/ Founder - Themes.org // Linux.com CivicSpaceLabs - http://civicspacelabs.org/
On Thu, 2006-05-11 at 08:44 -0400, Trae McCombs wrote:
Vlado,
Stay tuned with what's going on with the "Base Theme" movement. I'm not sure how much this will change things in Drupal themeing, but it's something to keep an eye on for sure. It will need MUCH documentation when we launch it. OK, let me rephrase it, again.
With the split-up scripts, I can essentially generate 'visual' or 'designer' clues, i.e. html snippets. That can be done automatically, as long as I can tell the script what argument in a particular theme function is of what type. The base idea is to make something like "unit" html snippets for each function. It can't be 100% automated - I need the descriptions. I'll prepare the code, but I might need help to add to the argument descriptions if this is to be done quicker. So that's why I'm asking for ideas, and later on for help. The code, I suppose is not going to change (a lot) between 4.7 and HEAD, and if it does I'll maintain it. But the descriptions? It is too much for one person, who is lazy, and doesn't want to go (more) insane. Think of this as a first stage for 'unit tests' for templates ;) Cheers Vlado
On 11 May 2006, at 3:05 PM, drupal wrote:
Think of this as a first stage for 'unit tests' for templates ;)
Remember the mollio template with everything on one page, to be able to theme. That's what we are talking about. Having it automatically generated. We need to have dummy info though. This could also be seen as a pre-requisite for any serious refactoring of drupal's default markup. It gives us a complete overview of everything. -- Adrian Rossouw Drupal developer and Bryght Guy http://drupal.org | http://bryght.com
The base idea is to make something like "unit" html snippets for each function. It can't be 100% automated - I need the descriptions. I'll prepare the code, but I might need help to add to the argument descriptions if this is to be done quicker. Although, having said that, if each module was exposing information about the defined theme_ elements in an _info() fashion, this can be automated like a breeze.
participants (4)
-
Adrian Rossouw -
drupal -
Trae McCombs -
Vladimir Zlatanov