textpattern / textpattern.github.io

Textpattern CMS user documentation.
https://docs.textpattern.com
GNU General Public License v2.0
15 stars 17 forks source link

Callbacks list tables: first column -- what is it? #37

Closed wion closed 9 years ago

wion commented 9 years ago

@Bloke,

I'm working on what is the last page needing finished in the plugin dev docs, the callbacks list... http://docs.textpattern.io/development/core-callbacks-reference (and here's the old page

I'm turning the definition lists into more compact tables for each callback type. And I'm editing the cell data descriptions a bit to better correspond with the column headers. You can see the progress so far in the first few tables.

But I'm a little confused by the first column stuff, so some questions, if I may...

  1. What is "event" and "step" called? I.e., what is the actual PHP name for those things; constant, variable, attribute, thingamabob?
  2. Likewise, what is the other side of those called (e.g., admin_side and body_end)?
  3. Should those look more like code somehow? For example, if I consider this: register_callback($func, $event, $step=''", $pre=0), and assuming that's correct (I just took it from other plugin doc info), then wouldn't those column data values actually be $event="admin_side" and $step="body_end"?

Here's what I'm aiming to do with the tables, if it makes sense to you. I want to make the tables have headings like this:

|_. Event |_. Step |_. When it occurs |_. What it allows/does |

And then data would be:

|_. Event |_. Step |_. When it occurs |_. What it allows/does |
| admin_side | body_end | once the theme has rendered its footer | tacks on any extra admin-wide information immediately before the closing @</body>@ tag |

And if there were any empty cells, they would get a hyphen:

|_. Event |_. Step |_. When it occurs |_. What it allows/does |
| admin_side | body_end | once the theme has rendered its footer | tacks on any extra admin-wide information immediately before the closing @</body>@ tag |
| data | - | data | - |

But I want to make sure the first two columns are clearly showing what they are in terms of code, so if they mean to suggest $event and $step, then that's how I want the headings to appear. Likewise the data values(?) for those columns (e.g,, admin_side and body_end) should be formatted as code too, if they are in fact code.

|_. @$event@ |_. @$step@ |_. When it occurs |_. What it allows/does |
| @admin_side@ | @body_end@ | once the theme has rendered its footer | tacks on any extra admin-wide information immediately before the closing @</body>@ tag |

Does that make sense? Can you advise?

wion commented 9 years ago

I finished a first pass through this long page. I sure hope it's on the right track, but no worries if not. I'd rather get it right than half-arsed.

wion commented 9 years ago

I think I'm going to have some other questions on this, so I'll direct it to the forum.