Changeset 2fef46 in indico

Timestamp:

04/19/11 15:49:58 (2 years ago)

Author:

Jose Benito <jose.benito.gonzalez@…>

Branches:

master, hello-world-walkthrough, ipv6, v0.98-series, v0.98.2, v0.98.3, v0.98b2, v0.99, 051b2622c51afb171a1dedb46a0df4fbb0cbd02e, 0da0c1403bae8e51d8229f460181c71b9e6dda72

Children:

2afff5

Parents:

9264b3

Message:

[REF] Moved indico.core.api.conference into events

Location:

indico

Files:

• MaKaC/plugins/InstantMessaging/XMPP/components.py (modified) (1 diff)
• MaKaC/plugins/InstantMessaging/pages.py (modified) (1 diff)
• core/extpoint/conference.py (deleted)
• core/extpoint/events.py (modified) (2 diffs)
• ext/importer/components.py (modified) (1 diff)

indico/MaKaC/plugins/InstantMessaging/XMPP/components.py

@@ -38 +38 @@
 
 from indico.core.extpoint import Component
-from indico.core.extpoint.conference import INavigationContributor
+from indico.core.extpoint.events import INavigationContributor
 
 

indico/MaKaC/plugins/InstantMessaging/pages.py

@@ -35 +35 @@
 import zope.interface
 from indico.core.extpoint import Component
-from indico.core.extpoint.conference import IEventDisplayContributor
+from indico.core.extpoint.events import IEventDisplayContributor
 
 

indico/core/extpoint/events.py

@@ -19 +19 @@
 ## 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 
-from indico.core.extpoint import IListener
+from indico.core.extpoint import IListener, IContributor
 
 
@@ -106 +106 @@
         pass
 
+
+class ITimetableContributor(IContributor):
+    """
+    Encapsulates extension points concerning event timetable.
+    """
+
+    def includeTimetableJSFiles(self, obj, params = {}):
+        """
+        Includes additional JS files.
+        """
+
+    def includeTimetableCSSFiles(self, obj, params = {}):
+        """
+        Includes additional Css files.
+        """
+
+    def customTimetableLinks(self, obj, params = {}):
+        """
+        Inserts additional links inside the timetable's header.
+        """
+
+
+class INavigationContributor(IContributor):
+    """
+    Events that fill the sidemenu of a conference with the activated plugins.
+    You may want a reference to know how to implement these methods.
+    You can check the components file for XMPP (MaKaC.plugins.InstantMessaging.XMPP)
+    """
+
+    #Conference management related
+    def fillManagementSideMenu(self, obj, params):
+        """
+        Inserts an element in the conference management's side menu
+        """
+
+    #Conference display related
+    def confDisplaySMFillDict(self, obj, params):
+        """
+        Conference Display Side Menu Fill Dictionary.
+        This dictionary is used to store all your new items on the side menu of the conference display.
+        In the core, there is a dictionary called self._linkData in which the elements to be showed
+        in the conference display side menu are inserted.
+        """
+
+    #Conference display related
+    def confDisplaySMFillOrderedKeys(self, obj, list):
+        """
+        Conference Display Side Menu Fill Ordered Keys.
+        Right next to the dictionary there is a list with the ordered keys,
+        we need to include them also
+        """
+
+    #Conference display related
+    def confDisplaySMShow(self, obj, params):
+        """
+        Adds our element to the list of elements to be showed in the side menu of the
+        conference main page
+        """
+
+    #Meetings and lectures display related
+    def meetingAndLectureDisplay(self, obj, params):
+        """
+        Adds our element to the list of elements to be showed in the main menu of a
+        meeting or a lecture
+        """
+
+    #Event cloning related
+    def addCheckBox2CloneConf(self, obj, list):
+        """
+        Adds a checkbox in the page to clone an event. When an event is cloned,
+        you may want to clone part of your plugin data. In this method you will
+        add a checkbox to the list in case it's necessary
+        """
+
+    #Event cloning related
+    def fillCloneDict(self, obj, params):
+        """
+        Fills a dictionary with the checkboxes to be checked when cloning an event
+        """
+
+    #Event cloning related
+    def cloneEvent(self, confToClone, conf):
+        """
+        Performs the operations needed while cloning an event
+        """
+
+    def getActiveNavigationItem(self, obj, params):
+        pass
+
+
+class IEventDisplayContributor(IContributor):
+
+    """
+    Aggregates extension points that relate to event display pages
+    """
+
+    def injectCSSFiles(self, obj):
+        """
+        Observers should contribute with CSS files they wish to add to the
+        <head></head> block
+        """

indico/ext/importer/components.py

@@ -21 +21 @@
 
 from indico.core.extpoint import Component
-from indico.core.extpoint.conference import ITimetableContributor
+from indico.core.extpoint.events import ITimetableContributor
 from MaKaC.plugins.base import Observable
 import zope.interface