Forums / Suggestions / Idea: Standard Usage Notes/Tips/Help Attached to Classes (not objects)

Idea: Standard Usage Notes/Tips/Help Attached to Classes (not objects)

Author Message

Eric Weik

Monday 28 June 2004 1:21:27 pm

Hi all,

This may be a half-baked idea (so be kind), but how about a way to attach some "help text" to content classes (not objects) describing their intended use (i.e. "help", "usage notes", "tips" or something similar). Then the admin interface could output this text whenever the user begins to a create a new content object using that class (or perhaps only if they click on a "tips for using this class" button).

It seems to me that this would go a long way towards helping site developers communicate day-to-day usage notes/tips to editors on how exactly to use a given content class.

Example usage: a short set of instructions and a list of allowed XML tags could be added to the Article class "usage notes". The particulars of which XML tags are allowed, and the level of instructional detail would vary from site to site (so editing this text should be easily done via the admin interface).

Obviously this idea could grow much more complicated in a hurry (i.e. allow different text for different user classes, attach the "usage tips" to the attribute level, not the class level, etc.), but I think a single property added at the class level would be a simple way to help end users, particularly on sites where complex custom classes are being created.

Any thoughts?

-Eric

eZ debug

Timing: Jan 18 2025 10:53:03
Script start
Timing: Jan 18 2025 10:53:03
Module start 'content'
Timing: Jan 18 2025 10:53:03
Module end 'content'
Timing: Jan 18 2025 10:53:03
Script end

Main resources:

Total runtime0.0196 sec
Peak memory usage2,048.0000 KB
Database Queries4

Timing points:

CheckpointStart (sec)Duration (sec)Memory at start (KB)Memory used (KB)
Script start 0.00000.0084 589.3203180.7969
Module start 'content' 0.00840.0055 770.117293.8828
Module end 'content' 0.01390.0056 864.000070.7031
Script end 0.0196  934.7031 

Time accumulators:

 Accumulator Duration (sec) Duration (%) Count Average (sec)
Ini load
Load cache0.003417.4529120.0003
Check MTime0.00157.4833120.0001
Mysql Total
Database connection0.00136.516710.0013
Mysqli_queries0.003015.096740.0007
Looping result0.00000.086320.0000
Template Total0.004623.510.0046
Template load0.00094.406110.0009
Template processing0.003719.107610.0037
Override
Cache load0.00062.900910.0006
General
dbfile0.00021.0164100.0000
String conversion0.00000.030430.0000
Note: percentages do not add up to 100% because some accumulators overlap

Templates used to render the page:

UsageRequested templateTemplateTemplate loadedEditOverride
1pagelayout.tpl<No override>extension/sevenx/design/simple/templates/pagelayout.tplEdit templateOverride template
 Number of times templates used: 1
 Number of unique templates used: 1

Time used to render debug report: 0.0001 secs