Adding additional new products to Cyn.in 3.1.3

Leonardo J. Caballero G. — Wed, 11 Apr 2012 22:31:24 +0000

Overview

The objective of this wiki is guide about the process of adding additional new products to the Cyn.in 3.1.3

For this task I selected the example.archetype product that is "an example package for learning how to develop an Archetypes-based content type".

Although this product is available to install from two resources like:

I opted to install it from it's SVN repository:

http://svn.plone.org/svn/collective/example.archetype/trunk/

Step by step

Download the Cyn.in Community Edition Source - v3.1.3 and install as said on the Wiki. When you finish the installation edit the file buildout configuration

cd ~/cynin313-source-snapshot/

nano ~/cynin313-source-snapshot/buildout.cfg

and add the lines bellow:

[buildout]
...
extends = versions.cfg
versions = versions

# This extension will dump a list of unpinned versions
# each time you run buildout.
extensions =
    buildout.dumppickedversions
    mr.developer

dump-picked-versions-file = dumped-versions.cfg
overwrite-picked-versions-file = True

always-check = true
auto-checkout =
    example.archetype

# Reference any eggs you are developing here, one per line
# e.g.: develop = src/my.package
develop =
   ...
    src/example.archetype

...

[cyninbase]
# Add additional eggs here
# elementtree is required by Plone
eggs =
    ...
    example.archetype

zcml =
    ...
    example.archetype

...
#
# specific source checkouts
#
[sources]
example.archetype = svn http://svn.plone.org/svn/collective/example.archetype/trunk/

Later go to edit the configuration file that contains constants used by default during setup handler of ubify.policy

nano ./src/ubify.policy/ubify/policy/config.py

Locate the bellow sections and add the new configuration

PRODUCT_DEPENDENCIES = ('Calendaring',
                        ...
                        'example.archetype',

spacesdefaultaddablenonfolderishtypes = ('Document',
                                         ...
                                         'InstantMessage',
                                        )

Then edit ContentRoot.xml file from default profile of ubify.coretypes products and add the bellow configuration:

nano ./src/ubify.coretypes/ubify/coretypes/profiles/default/types/ContentRoot.xml

...
<element value="Image"/>
<element value="InstantMessage"/>
<element value="Link"/>,
...

Also you need repeat the last past with ContentSpace.xml files from default profile of ubify.coretypes product and add the bellow configuration:

nano ./src/ubify.coretypes/ubify/coretypes/profiles/default/types/ContentSpace.xml

...
<element value="Image"/>
<element value="InstantMessage"/>
<element value="Link"/>,
...

Then re-run buildout

./bin/buildout -vNc user.cfg

When your buildout is complete, you can start the zope server by typing:

./bin/instance fg

This will start the Zope server in foreground mode (so that you can easily kill it by pressing Ctrl + C). Read the scrolling output, if all goes well you will see something like the following when the scrolling stops:

"2008-07-14 13:58:25 INFO Zope Ready to handle requests"

Congratulations, you've managed to get over the difficult parts. Now for the easy / fun stuff:

Open up your favorite browser (Everybody say together with me: Firefox!) :)

Navigate to http://localhost:8080 (if you use the same computer as desktop) or substitute the localhost with the hostname (or even the IP address) of the computer that zope/cyn.in is running on.

You should see the "Zope quick start screen". Cool, you can access your newly built Zope server. Next, navigate to http://localhost:8080/manage . This will give you an HTTP basic authentication request. Use the following credentials to get in: username: admin and password: secret

You will see the standard Zope management interface. On the left you will see a frame when the Id of your previous cyn.in website created. The go to clic on Id and Now, scroll down, and find the item called portal_quickinstaller (Allows to install/uninstall products) and click on that.

You'll get a list of previous products installed, among these check the check-box next to the item labeled "Ubify Site Policy" and hit the Reinstall

button. Do NOT check any other item.

Again, this will take some time and you can watch the scrolling progress in your fg command line window. When it completes, the list will refresh where most of the items will have moved down to the "Installed Products" section.

Great, you don't know it yet, but you've managed to get a working cyn.in installation built out of source! :)

Let's get to proving that: In your browser, type up the following address:

http://localhost:8080/cynin

If you don't like doing as recommended and chose a different ID during Plone Site creation, substitue your ID in place of cyin in the above URL, of course.

After some moments of tense waiting, the familiar cyn.in login screen should greet you and you can get in by using the following standard credentials: username: siteadmin and password: secret

Later when you are logged go the Root space and click to New button and there will show the new archetype called "Example AT - InstantMessage".

TODO

Write how integrate with meta data block
Write how create a new site updates portlet for new content type
Write how create a new apps view for new content type
Write how integrate my new content type to site stats and content types distribution pie chart
Create a Policy product for these configuration

Mario Nathan — Thu, 26 May 2011 13:04:48 +0000

Great tutorial! Worked for me from the first time.
Can you tell how to enable commenting, rating and all the usual stuff that comes after the content display in view mode?

Noe Nieto — Fri, 01 Apr 2011 00:09:05 +0000

Thanks for writing this. That saved me hours of code browsing.

Kim Nylander — Mon, 20 Dec 2010 15:45:02 +0000

Thank you for the suggestion! I"ll try it and let you know what happens.

Leonardo J. Caballero G. — Wed, 15 Dec 2010 17:32:28 +0000

Hi @knylander my apologies for my late response
Create a new buidlout file called plonesoftwarecenter.cfg and copy the bellow instructions:

# Buildout Configuration File for PloneSoftwareCenter products
[buildout]

extends = user.cfg

############################################
# Eggs
#
eggs +=
    Products.PloneSoftwareCenter == 1.5.5
    Products.ArchAddOn == 0.1
    Products.AddRemoveWidget == 1.4.4
    Products.DataGridField == 1.6

############################################
# ZCML Slugs
#
zcml +=
    Products.PloneSoftwareCenter
    Products.ArchAddOn
    Products.AddRemoveWidget
    Products.DataGridField

And later rebuildout like this:

./bin/buildout -vNc plonesoftwarecenter.cfg

With this you can install PloneSoftwareCenter Plone 3.3.5 and later try again with this manual to integrate PloneSoftwareCenter on Cyn.in

Kim Nylander — Sat, 20 Nov 2010 00:53:50 +0000

No luck using the instructions. I was able to see the Plone Help Center and the additional types in the ZIM. Added the content types manually per tmaysiak's suggestion. Unfortunately, when I restarted and logged in to Cyn.in, none of the content types appeared (only an error message when I pressed "Add new").

After a full day trying to get it to work, I finally gave up.

Kim Nylander — Thu, 11 Nov 2010 14:53:18 +0000

Thank you for the heads up! I'll try your instructions. If they work, I'll write an instruction set for Plone Help Center.

Tino Matysiak — Wed, 10 Nov 2010 19:30:19 +0000

Hi knylander,
I saw that happening installing plonepopoll.
I named the content types in the contentroot and contentspace like they appear in the zope management interface under portal_types.

You have to add them via the zope interface under contentroot and contentspace in portal_types.
Have a look at this ->
http://www.cynapse.com/[…]/?searchterm=poll

Kim Nylander — Wed, 10 Nov 2010 19:21:52 +0000

Greetings.

I'm trying to get Plone Help Center to work with Cyn.in. I tried the steps in this process and did not have any luck getting the buildout to complete. Instead, I used the process for Zope-2 products without buildout described here: http://plone.org/documentation/kb/add-ons/installing

Plone Help Center appeared in the Zope management interface and installed using the portal_quickinstaller. Everything seems to be active. Unfortunately, the content types are not appear within Cyn.in.

When adding Plone components, is it a hit or miss as to whether the items will appear as new content types?

Thanks.

Kim N.

Tino Matysiak — Mon, 01 Nov 2010 19:00:02 +0000

hi macagua,

great tutorial!!

inspired me to mess around with some plone eggs...

Get the plone.survey to work but i'm not able to use every function of it. there surely need to be changes in the ui.

What we would love to use is a poll utility and a small project-management tool where we can keep track of projects and its progress neatly illustrated in a progress-bar or so.

do you have any idea how we can get this things to work or is it not as trivial as i think? ;)

best regards and keep up the great work

Tino

Leonardo J. Caballero G. — Sun, 05 Sep 2010 16:12:16 +0000

Thanks @dhiraj for you comments

Leonardo J. Caballero G. — Sun, 05 Sep 2010 16:11:30 +0000

You know that from my initial contribution on i18n with cyn.in, I readed several source code lines and I thought that is possible to add other content type like are you doing with the Blog content type (formally called Scrawl) for that, me and other guys like @samuraib and @oswaldolo we are working to integrate new addons for cyn.in 3.1.3

For that we create this knowledge it's possible to build it on community, As you said "It's quite a complex and non-trivial task to do this successfully" and it's that is a real scenario for to do.

Because all these task, we are think that all comments and contributions are welcome!!!

Dhiraj Gupta — Fri, 03 Sep 2010 10:06:52 +0000

Nice work on this, @macagua, a lot of people are interested in doing this in the community. It's quite a complex and non-trivial task to do this successfully, and this is the main reason it's not been documented well - but you are proceeding admirably on this. :)

Keep it up!

Huy Bonds — Wed, 01 Sep 2010 20:47:46 +0000

Also perform the same step for Space and you should be able to add these new types. Sometimes, it does not put the object into the same space and I am trying to figure out why.

Leonardo J. Caballero G. — Tue, 31 Aug 2010 13:47:59 +0000

The news steps were not on the tutorial before yesterday ;)