From: Victor S. <fou...@gm...> - 2008-10-31 18:16:30
|
I'm thinking about the following as a first pass outline for the dev docs - does seem about right? Am I missing some elephant(s) in the room? Overview ------------------- 0. How to Debug 1. How to Hook Events 1a Data filter events (how to hack data before it's displayed) 1b Page events (how to hack pages before they are rendered) 1c Form events (how to hack forms before display and after post) 2. How URLs are mapped to code 3. How strings work 4. Extending Admin/Config Features 4a. Reading and Saving Configuration Settings 4b. Adding Admin Options to the Settings Menus Architecture ------------------ These subsystems all work together so it barely matters what order you learn about them. You have to understand all of them to have a deep understanding of the system. We will explain each one and then tie them all together in the Query Engine. 1. File Properties 2. Dataviews 3. Templates 3a. TPL Parser 3a1. '%' Macros 3a2. PHP Hacking 3a3. File/path resolution 3b. Template Snippets (aka 'formats') 3c. Skins 3c1. Profiles 3c2. 'commons' and 'plain' 3c3. 'shared' 3d. Pages 3e. Sidebar extras 3f. Other files (strings, colors, font, layouts, etc.) 4. The Query Engine 4a. How to call the QE from code 4b. What's happening inside a query 4c. How to extend the QE (hacking queries) |
From: Ben W. <be...@re...> - 2008-10-31 22:45:09
|
Hi, Victor Stone wrote: > I'm thinking about the following as a first pass outline for the dev > docs - does seem about right? Am I missing some elephant(s) in the > room? > I wonder if there should be guidance on what the capabilities of a skin are. I've been unable to work out whether what I wanted to achieve was close to what the system was intended to do. Otherwise: I look forward to reading... Cheers, Ben |
From: Victor S. <fou...@gm...> - 2008-11-01 08:38:23
|
On Fri, Oct 31, 2008 at 11:44 PM, Ben Weiner <be...@re...> wrote: > Victor Stone wrote: >> I'm thinking about the following as a first pass outline for the dev >> docs - does seem about right? Am I missing some elephant(s) in the >> room? >> > I wonder if there should be guidance on what the capabilities of a skin > are. I've been unable to work out whether what I wanted to achieve was > close to what the system was intended to do. That's great feedback although I have to admit I'm not sure what actionable item I can draw from it. I'm desperate to organize the dev docs in a way that is most helpful but without understanding what you want to achieve I'm left guessing how to do that. VS |
From: Ben W. <be...@re...> - 2008-11-01 10:19:56
|
Hi, Victor Stone wrote: >> I wonder if there should be guidance on what the capabilities of a skin >> are. I've been unable to work out whether what I wanted to achieve was >> close to what the system was intended to do. >> > > That's great feedback although I have to admit I'm not sure what > actionable item I can draw from it. I'm desperate to organize the dev > docs in a way that is most helpful but without understanding what you > want to achieve I'm left guessing how to do that. > The doc outline looked great but there was nothing in your list that addressed the concept of customisation. I initially thought I'd have to hack through ccHost, changing the codebase. It was a boon to discover that, like Drupal, there were 'hooks' into the system so that again like Drupal a second tier of developers could take the mechanism and selectively replace functionality without losing the core and the ability to stay up to date with developments within it. Where is that explained, though? In summary, it's not a question of satisfying me, it's whether you can express the potential that ccHost possesses to a future audience. Hope that's fair. Having made such a capable system it would be sad to underexplain and hence undersell it. Cheers, Ben |
From: Victor S. <fou...@gm...> - 2008-11-01 11:10:28
|
On Sat, Nov 1, 2008 at 11:19 AM, Ben Weiner <be...@re...> wrote: > The doc outline looked great but there was nothing in your list that > addressed the concept of customisation. actually the entire section temporarily called 'overview' was intended to be 100% about hooking/customization. And what that triggers is the now obvious need for a separate document that spells what customizations are possible at every skill level from non-coding admin to hyper-aggressive php developer and everything in between, including a level for what is "easy" to change with a "few lines of code" - which I think is what you meant by "system intent" That should be posted in the wiki by the end of the day. VS |
From: Victor S. <fou...@gm...> - 2008-11-01 12:39:36
|
On Sat, Nov 1, 2008 at 12:10 PM, Victor Stone <fou...@gm...> wrote: > And what that triggers is the now obvious need for a separate document > that spells what customizations are possible at every skill level from > non-coding admin to hyper-aggressive php developer and everything in > between, including a level for what is "easy" to change with a "few > lines of code" - which I think is what you meant by "system intent" > > That should be posted in the wiki by the end of the day. here it is: http://wiki.creativecommons.org/Cchost/customize Obviously, at some point all those bullet points should be links to corresponding pages. If you have some notion of what those pages might look like feel free to fill them in. VS |
From: Ben W. <be...@re...> - 2008-11-01 16:25:55
|
Hi, Victor Stone wrote: > On Sat, Nov 1, 2008 at 12:10 PM, Victor Stone <fou...@gm...> wrote: > > here it is: > > http://wiki.creativecommons.org/Cchost/customize > > Obviously, at some point all those bullet points should be links to > corresponding pages. If you have some notion of what those pages might > look like feel free to fill them in. > ;-) I think this is superb. Thank you. Ben |