Ticket #8832 (closed Bug: fixed)

Opened 3 years ago

Last modified 3 years ago

Document PLIP #232: Resource Registries Improvements

Reported by: dukebody Owned by: anneb
Priority: minor Milestone: 3.3
Component: Documentation Keywords: plip, TuneUp13
Cc: anneb

Description (last modified by vedawms) (diff)

Allow Resource Registries to use conditional comments for CSS to bring the IEFixes.css into the registry and allow external references to resources for all registries.

 http://plone.org/products/plone/roadmap/232

Change History

comment:1 Changed 3 years ago by dukebody

  • Keywords plip added

comment:2 Changed 3 years ago by dukebody

  • Description modified (diff)
  • Summary changed from PLIP #232: Resource Registries Improvements to Document PLIP #232: Resource Registries Improvements

comment:3 Changed 3 years ago by dukebody

  • Owner set to vedawms

comment:4 Changed 3 years ago by vedawms

  • Owner changed from vedawms to limi

I may be way off here, but my understanding is that resource registries were going away in the future. Is this the case, or is this PLIP still valid? Limi?

comment:5 Changed 3 years ago by anneb

I've incorporated the Using Resource Registries Tutorial into the Theme Reference Manual and included references to the CSS and JS Registry additions in Plone 3 at the same time.

 http://plone.org/documentation/manual/theme-reference/page/css/resource-registries/

Needs review.

I'm leaving this open as we probably need to review any IE fixes documentation as well and mention the use of the resource registries.

comment:6 Changed 3 years ago by dukebody

Not related to this ticket, but my first impression was that the folding depth of the theme manual is scary. I hadn't noticed that before. Isn't there any way to flatten it a bit?

Now about the ticket:  http://plone.org/documentation/manual/theme-reference/page/css/overview has a broken link and duplicates info from the Resource Registries Tutorial.

I spotted some "layout typos" but don't have time now to correct them, sorry.

Is how are resource registries pulled from the Plone rendering machinery explained, technically speaking? I asked Florian and he told me the ResourceRegistries package registers a viewlet into a top viewlet manager (could be plone.head?). I think this info should be included into the manual, but may I open another ticket for that?

comment:7 Changed 3 years ago by dukebody

  • Cc anneb added

comment:8 Changed 3 years ago by dukebody

Anne, I've noticed the two first sections of the Resource Registries manual have been swapped. Was that intentional or is it a mistake?

I think it makes more sense to describe briefly what are Resource Registries and then introduce a working example.

comment:9 Changed 3 years ago by vedawms

  • Owner changed from limi to anneb
  • Description modified (diff)

Anne, I agree that the ordering of this is a little weird. Does it make sense to put both practicals at the end? I've altered it in this fashion and changed a notation on the first page of this about debug mode (see bottom of the page -- it now refers to section 2, not 4).

Looks good to me otherwise.

comment:10 Changed 3 years ago by dukebody

  • Keywords plip, TuneUp12 added; plip removed

Please review that.

comment:11 Changed 3 years ago by gabriellehp

  • Keywords TuneUp13 added; TuneUp12 removed

comment:12 Changed 3 years ago by dukebody

  • Status changed from new to closed
  • Resolution set to fixed

Verified in Plone 3.3rc1.

comment:13 Changed 3 years ago by dunlapm

  • Status changed from closed to reopened
  • Resolution fixed deleted

comment:14 Changed 3 years ago by dukebody

It will be moved to  http://plone.org/documentation/manual/theme-reference/page/css/resource-registries/ , which is in draft state now but updated.

Right, Anne?

comment:15 Changed 3 years ago by dunlapm

Can I get permission to check that page out? I did write the PLIP after all.

comment:16 Changed 3 years ago by dukebody

Sure! I've shared it with you. The relevant page is  this one.

I'm sorry for the inconveniences.

comment:17 Changed 3 years ago by dunlapm

Whom should I talk to about making corrections to the documentation?

comment:18 Changed 3 years ago by dukebody

Anne Botwell is the current asignee of this ticket, but I will be happy of making any corrections you feel neccessary.

comment:19 Changed 3 years ago by dunlapm

The following page  http://plone.org/documentation/manual/theme-reference/page/css/resource-registries/parameters includes information about condtional comments that is slightly out of date. Both the CSS and JavaScript registries may make use of conditional comments.

Useless geek factoid: The KSS registry is the only registry that does not have full support for conditional comments.

comment:20 Changed 3 years ago by dukebody

  • Status changed from reopened to closed
  • Resolution set to fixed

I've updated that page according to your comments. Thanks a lot!

In the future we should look for a tighter coordination between PLIP implementors and the documentation team. :)

Note: See TracTickets for help on using tickets.