Вы находитесь на странице: 1из 36

echnical Specification for Kaltura Resources

Technical Specification for Kaltura Resources

Architect: Antonio Estevez Delivery Manager: Frank Cefalu Version: 1.0 Date: 9/1/2011

echnical Specification for Kaltura Resources Feature: Kaltura Resources (kaltura_res)....................................4 Feature: Kaltura Tag Cloud (kaltura_res_tag_cloud)......................4 Feature: Kaltura Search (kaltura_res_search)..............................4 User Role: Anonymous user........................................................6 User Role: Authenticated user....................................................6 User Role: Admin.......................................................................6 Contributed modules: ...............................................................6 Custom modules: ......................................................................7 Defined in hook_menu: .............................................................8 Defined via configuration (organized by menu): .........................8 Defined via views: ..................................................................10 Defined via hook_perm: ...........................................................11 Content Type: Resource (resource)...........................................12 Content Type: Video resource (video_resource).........................13 Content Type: FAQ (Machine name: faq).....................................13 Content Type: Ticker (Machine name: ticker)..............................14 Content Type: External resources (Machine name: external_resources)..................................................................14 Taxonomy: Category.................................................................15 Taxonomy: Tags........................................................................15 Taxonomy: Audience / Tech expertise.........................................15 Taxonomy: Video Type..............................................................15 Taxonomy: FAQ Type.................................................................15 View Name: kr_latest_webinar...................................................16 View Name: kr_latest_training_video..........................................16 View Name: kr_latest_resources................................................16 View Name: kr_ticker_admin......................................................17 View Name: ticker....................................................................17 View Name: kr_related_videos_webinars....................................17 View Name: kr_related_guides...................................................18 View Name: kr_common_questions............................................18 View Name: kr_related_content.................................................18 Block Name: kr_faq_type...........................................................20 Block Name: kr_related_vidoes..................................................21 Block Name: kr_common_questions...........................................21 Block Name: kr_getting_started.................................................21 Block Name: kr_integration_help...............................................21 Block Name: kr_getting_started.................................................22 Block Name: kr_video_thumbs...................................................22 Block Name: kr_stay_updated....................................................22 Block Name: kr_subscribe_newsletter........................................23 Block Name: kr_node_category..................................................23 Block Name: kr_node_expertise.................................................23

echnical Specification for Kaltura Resources Block Name: kr_node_tags.........................................................24 Block Name: kr_node_questions_answered.................................24 Block Name: kr_node_related....................................................24 Block Name: Show Results From................................................24 Block Name: kr_related_vidoes_video_node................................25 Webform Name: Couldnt find what youre looking or?...............26 Contributed modules: .............................................................27 Custom modules: ....................................................................27 Block Name: Tags in Tags..........................................................27 Contributed modules: .............................................................28 Custom modules: ....................................................................28 View Name: kr_main.................................................................28 Block Name: kr_sort_by.............................................................30
Block Name: kr_footer_search............................................31 Functionality.......................................................................31 Block Name: kr_sort_by......................................................31 Functionality.......................................................................32

Module Name: Kaltura Resources(kaltura_res)...........................33 Functionality............................................................................33 Block Name: kr_faq_type...........................................................33 Block Name: kr_common_questions...........................................33 Block Name: kr_getting_started.................................................33 Block Name: kr_integration_help...............................................33 Block Name: kr_developers.......................................................33 Block Name: kr_stay_updated....................................................33 Block Name: kr_node_category..................................................33 Block Name: kr_node_expertise.................................................33 Name: kr_node_tags.................................................................33 Block Name: kr_node_questions_answered.................................33 Block Name: kr_node_related....................................................33 Block Name: kr_subscribe_newsletter........................................33 Module Name: Menu Click Counter(menu_counter).....................34 Functionality:...........................................................................34 Note: Items highlighted in grey are to be held off until the end of the development phase. It will be determined later if videos will be in this phase or not.

echnical Specification for Kaltura Resources

Features
Notes: All the functionality for the phase 1 of the phase Kaltura will be split into features that make sense, to make future functionality changes and production pushes easier.

Feature: Kaltura Resources (kaltura_res)


Kaltura Resources is the core feature that will wrap up all the modules, views, taxonomy and customizations needed to run the website at the very minimum. Note that the given the sites unique search-facet based navigation, Kaltura Search (kaltura_res_search) will needed to run the site as well. The search-based functionality was not included in the spec for the core Kaltura Resources module to make it easier to replace the custom searching later without having to re-factor the core feature. Since there is no public facing authenticated role, all user interactions with the site must go through the invisible CAPTCHA process All node fields with HTML capabilities must employ the TinyMCE WYISIWYG tool. All images and files to be CDN enabled (as many as possible) should have a www in its src path. Excluding the www will disable CDN. More details to follow.

Feature: Kaltura Tag Cloud (kaltura_res_tag_cloud)


Kaltura Tag Cloud implements the Tag cloud called for in the comps.

Feature: Kaltura Search (kaltura_res_search)


Kaltura Search utilizes Drupals Menu system and the Search API project to provide search-based navigation to the Kaltura Resources Drupal site.

echnical Specification for Kaltura Resources The basic implementation of search will be to use Search API combined with its views integration module. Most, if not all, of the listing pages will use the same page, using facet filtering to constrain the results and a relevancy rating as needed. Navigation will be accomplished by leveraging the facet filtering functionality and the menu system.

echnical Specification for Kaltura Resources

Kaltura Resources : User Roles & Profiles


User Role: Anonymous user
Everyone using the site except the administrators will anonymous users.

User Role: Authenticated user


Notes: Not in use, but is supplied OOB (Out of Box)

User Role: Admin


Notes: Will have access to all areas of the Kaltura Resources Drupal build

Kaltura Resources : Modules


Notes: Each module will have a module_name.admin.inc file for any administrative callbacks and/or form definitions.

Contributed modules:
1. Hidden_captcha 2. views 3. path 4. image 5. block 6. ctools 7. kaltura 8. search (using drupal core search) 9. service_links (sharebar) 10. taxonomy 11. wysiwyg 12. views_jqfx (for the ticker) 13. FAQ (for Q & A) 14. Webform 15. views_bulk_operations 16. entity 17. statistics 18. references 19. google_analytics

echnical Specification for Kaltura Resources

Custom modules:
1. Kaltura Resources (machine name: kaltura_res) 2. Kaltura Resources Footer (machine name: kaltura_res_footer) a. Administration and display of footer content b. Leverages menu system hierarchy to create columns of static pages all
defined via configuration

3. Kaltura Resources Ticker (machine name: kaltura_res_ticker) a. Administration and display of Ticker b. Uses a simple content type that has either an node-reference or link c. Leverages views_jqfx for the display 4. Kaltura Resources Navigation (machine name: kaltura_navigation a. Overrides drupal core search to allow search terms preceded with
category:[category-name] to redirect to the taxonomy listing page

b. Uses pre-process functions to make taxonomy pages and searchresults pages use the same TPLs

5. Menu Click Counter (menu_counter) a. Simple modules that stores each click of a menu link b. Not specific to Kaltura Resources, so it should be designed to stand
alone

c. Module install file should create a table in Drupal using hook_schema


to create a table that stores each click of a menu item. mid should be stored, the path, as well as a timestamp and the uid of the clicker (which for this phase will most likely be 0 all the time)

d. Module uninstall file should remove the table 6. Kaltura Resources Marketo (kaltura_res_marketo) a. Leverage the code and libraries found in the client supplied, Drupal 6
Module, kaltura_extra, into a new Drupal 7 module

b. This module should make and send a LeadRecord object to marketo


using the code snippets in the kaltura_extra module

c. This module should provide a newsletter signup block for placement


onto the frontpage as per wireframe p2. More details regarding the UX of this process to follow from Kaltura.

d.

echnical Specification for Kaltura Resources

Kaltura Resources : Menus, Pages and Menucallbacks


Defined in hook_menu:
Title Homepage Path front Page Callback standard system_admin_menu_block_page Access access content adminis ter kaltura resourc es adminis ter kaltura footer adminis ter faq order Modu le
kaltura _res kaltura _res

Kaltura admin/kaltur Resources a-resources Administrat ion Kaltura Footer Administrat ion Kaltura Q&A Administrat ion admin/kaltur aresources/fo oter admin/kaltur aresources/QA

drupal_get_form(custom_form)

kaltura _res_fo oter faq

drupal_get_form(faq_order_settin gs_form)

Defined via configuration (organized by menu):


Menu Title Getting Started Integration Help Developers Questions & Answers Video & Webinars Path kr-main?filter[field_category] [0]=[category-tid] kr-main?filter[field_category] [0]=[category-tid] kr-main?filter[field_category] [0]=[category-tid] kr-main?filter[field_category] [0]=[category-tid] kr-main?filter[field_category] [0]=[category-tid] Menu Main Main Main Main Main Page Title Getting Started Integrati on Develop ers General Q&A Video Library

echnical Specification for Kaltura Resources

Menu Title General Q&A Integration FAQ Developers

Path kr-main?filter[field_category] [0]=[category-tid] kr-main?filter[field_category] [0]=[category-tid] kr-main?filter[field_category] [0]=[category-tid]

Menu Categor y Categor y Categor y

Page Title General Q&A Integrati on Develop ers

Menu Title Download & Install Kaltura CE Start Free Trial Contact Sales

Path TBD TBD TBD

Menu Footertop Footertop Footertop Menu Show Results From Show Results From Show Results From Show Results From Show Results

Page Title TBD TBD TBD

Menu Title All

Path kr-main

Videos

kr-main?filter[field_category] [0]=[category-tid] kr-main?filter[field_category] [0]=[category-tid]

Getting Started

Integration Help kr-main?filter[field_category] [0]=[category-tid] Developers kr-main?filter[field_category] [0]=[category-tid]

Page Title Result s Count Result s Count Result s Count Result s Count Result s

echnical Specification for Kaltura Resources From Questions & Answers Kaltura.org Results Kaltura.com Results kr-main?filter[field_category] [0]=[category-tid] TBD Show Results From Show Results From Show Results From Show Results From Count Result s Count Result s Count Result s Count Result s Count

TBD

HTML5Video.org TBD Results

Defined via views:


Title Kaltura Ticker Administrat ion Path admin/kaltur aresources/tic ker View | Display kr_ticker_admin | page_1 Access adminis ter kaltura ticker

echnical Specification for Kaltura Resources

Kaltura Resources : Permissions and Access Callbacks


Defined via hook_perm:
Permission administer kaltura resources administer kaltura footer administer kaltura ticker assign kaltura resource tag Module
kaltura_res

kaltura_res_foo ter kaltura_res_tic ker kaltura_res

echnical Specification for Kaltura Resources

Kaltura Resources : Content Types and Fields


Content Type: Resource (resource)
Description: Generic non-video content that serves as a resource for users who visit the Kaltura Resources site. Notes: Generic non-video content, with sharebar enabled Field Name Title Description Used as the title of the page for this resource The actual HTML content for the resource page A list of content nodes that the user is recommended to read before reading this article Please choose the questions that this resource may help address. Field Type Standard Widget and Notes Text field

Body

Full HTML with TinyMCE Node reference

Text Area with summary override Auto-complete, unlimited values, FAQ and Resource content types

Recommended Nodes (recommended_no des)

Questions Answered (questions_answe red)


Category Tags Files (resource_file)

Node reference

Auto-complete, unlimited values, FAQ content type

Taxonomy Taxonomy
Please upload any files that should be available for a viewer of this content to download, such as a PDF of the content.

Single value Free tagging Allowed file extensions: pdf, gif, png, jpeg Unlimited values File directory: resource_files

File

echnical Specification for Kaltura Resources

Content Type: Video resource (video_resource)


Description: Video content, organized by the Video Type vocabulary that serves as a resource for users who visit the Kaltura Resources site. Notes: Video content, with sharebar enabled DELAYED, MAY NOT BE IN SCOPE FOR THIS PHASE OF DEVELOPMENT

Content Type: FAQ (Machine name: faq)


Notes: Assigned via the faq module. This content type should be customized to hide the category field from the node_form and have the node automatically have the Appropriate Category term assigned to it automatically. Field Name Question (title) Question details Description The Question being answered Detailed_question Field Type Standard Text area Widget and Notes Text field Longer question text. This will be displayed in all layouts where the answer appears, in addition to the shorter question text. Text Area with summary override Single value Free tagging Allowed file extensions: pdf, gif, png, jpeg Unlimited values File directory: faq_files

Body Category Tags FAQ Type Files

The actual HTML content for the question page

Full HTML with TinyMCE

Taxonomy Taxonomy Taxonomy


Please upload any files that should be available for a viewer of this content to download, such as a PDF of the content.

File

echnical Specification for Kaltura Resources

Content Type: Ticker (Machine name: ticker)


Notes: This content type is designed to announce the news on the home page. Field Name Title Body Description Field Type Standard Standart Widget and Notes Text field Text area

Content Type: External resources (Machine name: external_resources)


Notes: This content type is designed to display news from other sites in the block 'Latest' and refers to it. Field Name Title Body Description Field Type Standard Standart Widget and Notes Text field Text area

url

field_url

Text Field

Text field with reference to the resource

echnical Specification for Kaltura Resources

Taxonomy Vocabularies
Taxonomy: Category
Notes: Single value, applies to any node, ALL FAQ content needs the a category of Questions and Answers Wireframe Reference: Just about every page

Purpose/Use: Assigns nodes to the main navigation landing pages

Taxonomy: Tags
Notes: Free tagging (tied to the assign kaltura resource tag permission), applies to any node, tied to the kaltura_tag_cloud feaure Wireframe Reference: In the Tag Cloud

Purpose/Use: Allows administrators to assign relevant tags to content accessible by the kr_tag_cloud block (TODO: add link to this block here)

Taxonomy: Audience / Tech expertise


Notes: Single value, applies to any node Wireframe Reference: On the node-page (p3)

Purpose/Use: Lets users know who the target of this content is

Taxonomy: Video Type


Notes: Multi value, applies to any node, ALL content with this tag must have the category of Videos and Webinars assigned to it

Purpose/Use: Allows Videos to be filtered when browsing the Video Library Page
DELAYED, MAY NOT BE IN SCOPE FOR THIS PHASE OF DEVELOPMENT

Taxonomy: FAQ Type


Notes: Single value, applies only to the FAQ content type Wireframe Reference: p4

Purpose/Use: Allows Videos to be filtered when browsing the Video Library Page

echnical Specification for Kaltura Resources

Kaltura Resources : Views


View Name: kr_latest_webinar
View Goal: Show latest video_resource with the Webinar term from the Video Type vocabulary View Types : default (for use on the custom block, kr_video_thumbs) Wireframe Reference: p2 Fields to Include: video thumbnail linking to node page, View Notes: This will make up the block, kr_video_thumbs Arguments: none Sort by: publishing date, descending Tag: kaltura_res
DELAYED, MAY NOT BE IN SCOPE FOR THIS PHASE OF DEVELOPMENT

View Name: kr_latest_training_video


View Goal: Show latest video_resource with the Training Video term from the Video Type vocabulary View Types: default (for use on the custom block, kr_video_thumbs) Wireframe Reference: p2 Fields to Include: video thumbnail linking to node page, View Notes: This will make up the block, kr_video_thumbs Arguments: none Sort by: publishing date, descending Tag: kaltura_res
DELAYED, MAY NOT BE IN SCOPE FOR THIS PHASE OF DEVELOPMENT

View Name: kr_latest_resources


View Goal: Show last 3 published nodes from (video_resource or resource content types) View Types: default, block_1 (no overrides of default) Wireframe Reference: p2

echnical Specification for Kaltura Resources Fields to Include: title, title (for non-registerable nodes), date (if the node had one), custom link (to node, unless the node is enabled for registration in which case the link goes to the registration page) Fields to Include: title, body, php field(choose links) View Notes: Will be placed on the frontpage Arguments: none Sort by: publishing date, descending Tag: kaltura_res

View Name: kr_ticker_admin


View Goal: Drag and drop administration of all the ticker items View Types: default, page_1 (no overrides of default, path: admin/kaltura-resources/ticker) Wireframe Reference: none (admin area) Fields to Include: title, edit, weight View Notes: needs the administer kaltura ticker user_access argument Arguments: none Sort by: weight Tag: kaltura_res

View Name: ticker


View Goal: tickers on homepage View Types: default, page_1 (no overrides of default, path: admin/kaltura-resources/ticker) Wireframe Reference: none (admin area) Fields to Include: title, link Arguments: none Sort by: weight Tag: kaltura_res

View Name: kr_related_videos_webinars


View Goal: Latest webinars that are related to the node (or listing page) this block appears on

echnical Specification for Kaltura Resources View Types: default(3 results), block_1 (no overrides of default), block_2 (with 5 results override and different default argument for pulling the term(s) to base the related links on; terms are pulled from the term related to the listing as opposed to the nodes terms if the block is on a listing page as opposed to a node-page) Wireframe Reference: p1 Fields to Include: title with link to node-page View Notes: Arguments: see notes on Related Content from the start of this document but the logic will change based on if the landing page is a listing page or a node-page (see block visibility functions) Sort by: publishing date, descending Tag: kaltura_res
DELAYED, MAY NOT BE IN SCOPE FOR THIS PHASE OF DEVELOPMENT

View Name: kr_related_guides


DELAYED, MAY NOT BE IN SCOPE FOR THIS PHASE OF DEVELOPMENT

View Name: kr_common_questions


View Goal: the 5 Questions (faq content type) with the most amount of page views View Types: default, block_1 (no overrides of default) Wireframe Reference: p1 (on search results (including taxonomy) pages) Fields to Include: title with link to node View Notes: Arguments: see notes on Related Content from the start of this document Sort by: Content statistics: Total views, descending Tag: kaltura_resource

View Name: kr_related_content

echnical Specification for Kaltura Resources View Goal: Content related to the node (or listing page) this block appears on View Types: default(10 results), block_1 (no overrides of default) Wireframe Reference: p1 Fields to Include: title with link to node-page View Notes: Arguments: see notes on Related Content from the start of this document but the logic will change based on if the landing page is a listing page or a node-page (see block visibility functions) Sort by: publishing date, descending

echnical Specification for Kaltura Resources

Kaltura Resources : visibility helper functions


_kaltura_resource_is_listing_page()
Logic: Any listing page (basically any page thats not the frontpage, node-page, or admin page )

_kaltura_resource_is_search_result_page()
Logic: return TRUE if user in on faq type.

_kaltura_resource_is_search_page()
Logic: Any listing page (basically any page thats not the frontpage, taxonomy,node-page, or admin page )

_kaltura_resource_is_search_faq_page()
Logic: Block displayed when searching to introduce not only category.

_kaltura_resource_is_main_listing_page()
Logic: Any listing page that has a link to it from the main nav

_kaltura_resource_is_faq_page()
Logic: returns TRUE if the user is on an FAQ page

_kaltura_resource_is_node_page()
Logic: returns TRUE if the user is on a node page (e.g. node/nid)

_kaltura_resource_is_webform()
Logic: returns TRUE if the user is on a webform

_kaltura_resource_is_video_node()
Logic: returns TRUE if the user is on a video_resource node

Kaltura Resources : Blocks


Block Name: kr_faq_type
Visible Title: Categories Block Purpose: Provides left nav constraining FAQ results Content: uses theme(links) and taxonomy_get_tree() to provide links to re-sort the FAQ list Wireframe Reference: p4

echnical Specification for Kaltura Resources Visibilty: _kaltura_resource_is_faq_page() Defined by: hook_menu in kaltura_resource.module

Block Name: kr_related_vidoes


Visible Title: Related Videos and Webinars Block Purpose: Provides left nav block for related content Wireframe Reference: p1 Visibilty: _kaltura_resource_is_listing_page() || _kaltura_resource_is_faq_page() Defined by: view: kr_related_videos_webinars: block_2
DELAYED, MAY NOT BE IN SCOPE FOR THIS PHASE OF DEVELOPMENT

Block Name: kr_common_questions


Visible Title: Common Users Questions Block Purpose: Provides left nav block for FAQ content Wireframe Reference: p1 Visibilty: _kaltura_resource_is_listing_page() || _kaltura_resource_is_faq_page() Defined by: view: kr_common_questions: block_1

Block Name: kr_getting_started


Visible Title: Getting Started [>] Block Purpose: Static configurable block that appears on the frontpage Content: Full HTML configurable bodies, with default markup defined in kaltura_resource.module (taken from comps) Wireframe Reference: p2 Visibilty: <front> Defined by: hook_menu in kaltura_resource.module

Block Name: kr_integration_help


Visible Title: Integration Help [>] Block Purpose: Static configurable block that appears on the frontpage

echnical Specification for Kaltura Resources Content: Full HTML configurable bodies, with default markup defined in kaltura_resource.module (taken from comps) Wireframe Reference: p2 Visibilty: <front> Defined by: hook_menu in kaltura_resource.module

Block Name: kr_getting_started


Visible Title: Developers [>] Block Purpose: Static Configurable block that appears on the frontpage Content: Full HTML configurable bodies, with default markup defined in kaltura_resource.module (taken from comps) Wireframe Reference: p2 Visibilty: <front> Defined by: hook_menu in kaltura_resource.module

Block Name: kr_video_thumbs


Visible Title: None Block Purpose: Displays 2 thumbs; the latest Webinar and the latest Training Video Content: Use views_embed_view() to combine 2 views into one (kr_latest_webinar: default, kr_latest_training_video: default) Wireframe Reference: p2 Visibilty: <front> Defined by: hook_menu in kaltura_resource.module
DELAYED, MAY NOT BE IN SCOPE FOR THIS PHASE OF DEVELOPMENT

Block Name: kr_stay_updated


Visible Title: Stay Updated, join the Kaltura Community Block Purpose: Displays 2 thumbs; the latest Webinar and the latest Training Video Content: Use theme(links) to generate a sharebar for the website in general (as opposed to a piece of content on the site)

echnical Specification for Kaltura Resources Wireframe Reference: p2 Visibilty: <front> Defined by: hook_menu in kaltura_resource.module

Block Name: kr_subscribe_newsletter


Visible Title: None Block Purpose: Provide a way for users to subscribe to a newsletter Content: TBD Wireframe Reference: p2 Visibilty: <front> Defined by: hook_menu in kaltura_resource.module

Block Name: kr_node_category


Visible Title: Category of the document Block Purpose: Displays the Category term of the node Content: Use [custom] theme(kr_node_block, vocabulary, $vid) to present a theme-able list of terms (note: may only be one term) Wireframe Reference: p3 Visibilty: _kaltura_resource_is_node_page() Defined by: hook_menu in kaltura_resource.module

Block Name: kr_node_expertise


Visible Title: Audience / Tech Expertise Block Purpose: Displays the Audience / Tech Expertise term of the node Content: Use [custom] theme(node_block, vocabulary, $vid) to present a theme-able list of terms (note: may only be one term) Wireframe Reference: p3 Visibilty: _kaltura_resource_is_node_page() Defined by: hook_menu in kaltura_resource.module

echnical Specification for Kaltura Resources

Block Name: kr_node_tags


Visible Title: Tags Block Purpose: Displays the Tags term of the node Content: Use [custom] theme(node_block, vocabulary, $vid) to present a theme-able list of terms (note: may only be one term) Wireframe Reference: p3 Visibilty: _kaltura_resource_is_node_page() Defined by: hook_menu in kaltura_resource.module

Block Name: kr_node_questions_answered


Visible Title: Questions answered Block Purpose: Displays the all the question nodes in the nodes node_reference field Content: use theme(list) display to all the question nodes in the nodes node_reference field Wireframe Reference: p3 Visibilty: _kaltura_resource_is_node_page() Defined by: hook_menu in kaltura_resource.module

Block Name: kr_node_related


Visible Title: Related Block Purpose: Displays related content of the node Content: view kr_related_content: default Wireframe Reference: p3 Visibilty: _kaltura_resource_is_node_page() Defined by: hook_menu in kaltura_resource.module

Block Name: Show Results From


Visible Title: Show Results From

echnical Specification for Kaltura Resources Block Purpose: displays menu items from the Show Results From menu Content: generated automatically by Drupals menu system, Wireframe Reference: p6 Visibilty: _kaltura_resource_is_search_result_page() Defined by: Drupal OOB menu system

Block Name: kr_related_vidoes_video_node


Visible Title: Related Videos and Webinars Block Purpose: Provides content area block for related videos Wireframe Reference: p7 Visibilty: _kaltura_resource_is_video_node_page() Defined by: view: kr_related_videos_webinars: block_1
DELAYED, MAY NOT BE IN SCOPE FOR THIS PHASE OF DEVELOPMENT

echnical Specification for Kaltura Resources

Kaltura Resources : Webforms


Webform Name: Couldnt find what youre looking or?
Webform Purpose: Allow users to contact us. Wireframe References: p5 Webform Notes: This webform needs to integrate with marketo see notes for the custom kaltura_res_marketo module Webform Structure: Field Name First name Last name Email What were you looking for? Field Type Textfield Textfiled Standard Combo box (type text)

echnical Specification for Kaltura Resources

Kaltura Tag Cloud : Modules


Contributed modules:
1. tagadelic

Custom modules:
1. Kaltura Resources Tag Cloud (machine name: Kaltura_res_tag_cloud)

Kaltura Tag Cloud: Blocks


Block Name: Tags in Tags
Visible Title: Tag Cloud Block Purpose: Provides left nav with size-weighted tag links Content: provided by the tagadelic module with customizations (as needed) specific to the Kaltura Resources Drupal build Wireframe Reference: all pages except p2 Visibilty: all pages but the <front> page (type 2) Defined by: hook_menu in tagadelic.module

echnical Specification for Kaltura Resources

Kaltura Search : Modules


Contributed modules:
1. 2. 3. 4. 5. Search Api Search facets Search pages Search views Solr search

Custom modules:
1. Kaltura Resources Search (machine name: Kaltura_res_search)

Kaltura Search : Views


View Name: kr_main
View Goal: Display all the content of the Kaltura Resources site according to relevancy based on search keys and/or facet filtering View Types : default, page_1 (identical to default), page_2, page_3, page_4 Wireframe Reference: p1, 4, 6 Fields to Include: nid (hidden), node title, body text View Notes: Filter crtieris must be set to search: Fulltext search(= ), Node: Category (= ), Node: FAQ Type (= ), Node: Content type (Is one of Article, Basic page, ), Node: Published (= 1), 16 items Arguments: none Sort by: default: (1)relevancy, (2)publishing date, descending page_1: (1)relevancy, (2)publishing date, descending page_2: Last Modified page_3: Title

page_4: Content Type Tag: kaltura_res_search Path:

echnical Specification for Kaltura Resources default(page_1): kr-search-by-publishing-data page_2: kr-search-by-last-modified page_3: kr-search-by-title, page_4: kr-search-by-type.

echnical Specification for Kaltura Resources

Kaltura Search : Blocks


Block Name: kr_sort_by
Block Purpose: Changes the sorting of a views-based page Content: uses theme(links) to provide links to re-sorting the solr_results Wireframe Reference: title with link to node Visibilty: _kaltura_resource_is_search_page() (all search results) Defined by: hook_block() in kaltura_search.module

echnical Specification for Kaltura Resources

Kaltura Module : kaltura_navigation


Block Name: kr_footer_search
Form for searching at the footer region. Contains form with edit element and submit button.

Functionality
Function kaltura_navigation_footersearch_form generated this form. Function kaltura_navigation_search takes search text and recognize normal search and search for category. At the views not consist sort for title and category name, so its implemented two functions kaltura_navigation_sort_criteria_title and kaltura_navigation_sort_criteria_type.

Kaltura Module : kaltura_res_search


Block Name: kr_sort_by
Block contains url links for re-sort search results.

echnical Specification for Kaltura Resources

Kaltura Module : kaltura_res_marketo


Functionality
Add administrative page with main settings marketo access key and secret key. And additional setting with ckeckbox showing the message when user subscribed or happend error. And texts of messages. Function kaltura_res_marketo_is_mail check correct email which entered form. Function registerWebinarNotifications and api for subscribe marketo.

echnical Specification for Kaltura Resources

Module Name: Kaltura Resources(kaltura_res)


This module creates blocks and helper functions.

Functionality
Create helper functions:
_kaltura_resource_is_listing_page(), _kaltura_resource_is_search_result_page(), _kaltura_resource_is_search_page(), _kaltura_resource_is_search_faq_page(), _kaltura_resource_is_main_listing_page(), _kaltura_resource_is_faq_page(), _kaltura_resource_is_node_page(), _kaltura_resource_is_webform(), _kaltura_resource_is_video_node().

Create blocks:
Block Name: kr_faq_type Block Name: kr_common_questions Block Name: kr_getting_started Block Name: kr_integration_help Block Name: kr_developers Block Name: kr_stay_updated Block Name: kr_node_category Block Name: kr_node_expertise Name: kr_node_tags Block Name: kr_node_questions_answered Block Name: kr_node_related Block Name: kr_subscribe_newsletter

echnical Specification for Kaltura Resources

Module Name: Menu Click Counter(menu_counter)


This module creates table and and writes there data about click.

Functionality:
Function menu_counter_menu() create menu link. Function menu_counter_insert() enters data into a table. Function menu_counter_page() displays a table with data. Function menu_counter_schema() create table in database.

echnical Specification for Kaltura Resources

Versions and Compatibility


Drupal: 7.8 Browser/OS Compatibility Firefox MS Windows Mac OS X 3+ 3+ Chrome 4+ 4+ IE 7, 8 X Safari 4 4

Mobile Support via HTML5

echnical Specification for Kaltura Resources

Appendix Related Content Method #1


We are using the following Drupal 7 views 3 method for related content.

1. 2. well. 3. 4. 5.

Create view (block) Add fields (title, a small image, date, whatever you like). Or teasers, what works as "Arguments" is from now on called "Contextual filters", so go there. Add the filter: "Content: Has taxonomy term ID" Configuration on this filter: -> When the filter value is NOT in the URL: -> Provide

default value -> Type: Taxonomy Term ID from URL -> under that, check the box "Load default filter from node page, that's good for related taxonomy blocks." -> now check the boxes of the taxonomies you want involved here 6. 7. 8. 9. Now you need to add the second filter in order to exclude the current node from the Select Content: Nid Set the 'when argument is not present' to 'Provide default argument' Set the 'Default argument type' to 'Content ID from URL' list. Click [+] button of the contextual filters section.

10. Go to "MORE" , and check the "Exclude" box. 11. Add a block to your view and embed the block on your node pages 12. Save your view

Related Content Method #2


Work with Search API module to produce weighted related content blocks