Plugin inheritance about django-cms

[heiho1]

I'd be interesting in helping out on this feature. What's the status? Has any discussion taken place?

[digi604]

nope... but there is some template inheritance but never tried out myself

[heiho1]

yeah, i saw that in the admin interface. I'll take a look at the code and report back.

[heiho1]

I was wondering if it might make more sense to implement the feature as a "master page" which sub pages could choose to extend on a per-placeholder basis?

What I'm evisioning is that a page can be set up in the nav tree. Another page, not necessarily a child page, can be created. In the admin interface for a page, each place holder could have, for example, a checkbox saying "use master page" which could enable a foreign key relation to another page. The sub page would then pull the plugins assigned to the indicated placeholder, if any, from the master page.

Make sense? Pros or cons?

[digi604]

a inherit-plugin would make more sense... where you could choose the page you want to inherit and then it pulls in all plugins from this page that are on the same placeholder as the inherit-plugin.

[heiho1]

that's actually a much better approach. i'll start putting together such a plugin. thx!

[heiho1]

i have a preliminary inherit plugins that working for my home grown plugins. I'm still testing it but it's ready for some review and commentary.

[digi604]

push to github and i will have a look

[heiho1]

i published it

http://github.com/heiho1/django-cms-inherit-plugin

I'm still a github newb so let me know if I should publish it to a specific repo. I'll be testing and updating this tomorrow as I know of at least one bug that I ran into.

[digi604]

looks good. I would have forked the django-cms repository and put it in there directly so i can merge directly the changes in as soon as we have 2.0 final released.

the plugin render function can be used from the PlaceholderNode... so both should call the same function.

Maybe it should be possible to prefill the parent_page field with the parent?

Could you imagine a possibility to say... inherit all plugins except the Picture Plugins? Or something in the way of: only inherit all TextPlugins... but I think this feature can be implemented by someone who needs it.

But otherwise looks good

[heiho1]

"""the plugin render function can be used from the PlaceholderNode... so both should call the same function."""

I'm not entirely sure what this means. I know there are PlaceholderNode objects being passed around. Is this related to cms_tags.py at all? I know that I ran into a bug testing inheritance of a menu implementation. I'll take a closer look today.

"""Maybe it should be possible to prefill the parent_page field with the parent?"""

I decided against this because they may want to, for example, have a separate set of CMS pages which are not in the nav tree and maintain those as "master template pages". I think this is a more likely scenario for usage.

[digi604]

PlaceholderNode in cms_tags.py renders the plugins. Maybe it would be wise to extract that portion of code and pack it in a function. Then the inherit plugin can call the same function and we don't have to worry that if someone changes it on one place the other does not get forgotten.

[heiho1]

I see. I'll refactor the code along these lines.

[heiho1]

OK, I created a local "inheritance" branch of cms trunk:

"""
(sf-env)[14:26][~/dev/django-cms-2.0(inheritance)]$ git branch

• inheritance
  master
  """

I have coded the plugin, added a cms.utils.plugin.py with a "render_plugins_for_context()" function and refactored cms_tags.py to use that function. I ran into a problem in the inheritance plugin where calling the render_plugins_for_context() was causing output to be escaped somewhere down the line so I commented out the refactored inherit plugin to use the old way for now. Definitely a "TODO" item. I have a local branch but I'm not sure how to push that or if I should use a CMS fork on github.

[heiho1]

Disregard the problem I was having with the output escaping, I was using the "safe" on list items but needed to use "safeseq" coupled with "join" instead. Plugin should be good for another review.

[digi604]

you can push with 'git push inheritance'

[heiho1]

I think I got it:
"""
(sf-env)[17:39][~/dev/django-cms-2.0(inheritance)]$ git push [email protected]:heiho1/django-cms-2.0.git inheritance
Counting objects: 30, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (18/18), done.
Writing objects: 100% (24/24), 3.37 KiB, done.
Total 24 (delta 11), reused 0 (delta 0)
To [email protected]:heiho1/django-cms-2.0.git

• [new branch] inheritance -> inheritance
  """

[heiho1]

btw pushing to digi604 failed:
"""
(sf-env)[17:39][~/dev/django-cms-2.0(inheritance)]$ git push [email protected]:digi604/django-cms-2.0.git inheritance
ERROR: Permission to digi604/django-cms-2.0 denied to heiho1.
fatal: The remote end hung up unexpectedly
"""

[digi604]

follow the instructions here:

http://www.django-cms.org/en/documentation/2.0/contribution/

you don't have to push to my repo... you have to push to your cloned repo

[digi604]

ah i see it now in the network... seams to be ok

[digi604]

could clean up the code a little bit and remove all unused comments?

[heiho1]

i cleaned up the code and pushed. Plz take a look

[digi604]

is integrated into new frontedit branch

[heiho1]

Awesome, I'll upgrade soon. Thanks for your time.