TechSpec Kaltura v6 NEW

Embed Size (px)

Citation preview

  • 8/3/2019 TechSpec Kaltura v6 NEW

    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

  • 8/3/2019 TechSpec Kaltura v6 NEW

    2/36

    echnical Specification for Kaltura Resources

    Feature: Kaltura Resources (kaltura_res)....................................4Feature: Kaltura Tag Cloud (kaltura_res_tag_cloud)......................4Feature: Kaltura Search (kaltura_res_search)..............................4

    User Role: Anonymous user........................................................6User Role: Authenticated user....................................................6User Role: Admin.......................................................................6Contributed modules: ...............................................................6Custom modules: ......................................................................7Defined in hook_menu: .............................................................8Defined via configuration (organized by menu): .........................8Defined via views: ..................................................................10Defined via hook_perm: ...........................................................11Content Type: Resource (resource)...........................................12Content Type: Video resource (video_resource).........................13

    Content Type: FAQ (Machine name: faq).....................................13Content Type: Ticker (Machine name: ticker)..............................14Content Type: External resources (Machine name:external_resources)..................................................................14Taxonomy: Category.................................................................15Taxonomy: Tags........................................................................15Taxonomy: Audience / Tech expertise.........................................15Taxonomy: Video Type..............................................................15Taxonomy: FAQ Type.................................................................15View Name: kr_latest_webinar...................................................16View Name: kr_latest_training_video..........................................16

    View Name: kr_latest_resources................................................16View Name: kr_ticker_admin......................................................17View Name: ticker....................................................................17View Name: kr_related_videos_webinars....................................17View Name: kr_related_guides...................................................18View Name: kr_common_questions............................................18View Name: kr_related_content.................................................18Block Name: kr_faq_type...........................................................20Block Name: kr_related_vidoes..................................................21Block Name: kr_common_questions...........................................21Block Name: kr_getting_started.................................................21

    Block Name: kr_integration_help...............................................21Block Name: kr_getting_started.................................................22Block Name: kr_video_thumbs...................................................22Block Name: kr_stay_updated....................................................22Block Name: kr_subscribe_newsletter........................................23Block Name: kr_node_category..................................................23Block Name: kr_node_expertise.................................................23

  • 8/3/2019 TechSpec Kaltura v6 NEW

    3/36

    echnical Specification for Kaltura ResourcesBlock Name: kr_node_tags.........................................................24Block Name: kr_node_questions_answered.................................24Block Name: kr_node_related....................................................24Block Name: Show Results From................................................24

    Block Name: kr_related_vidoes_video_node................................25Webform Name: Couldnt find what youre looking or?...............26Contributed modules: .............................................................27Custom modules: ....................................................................27Block Name: Tags in Tags..........................................................27Contributed modules: .............................................................28Custom modules: ....................................................................28View Name: kr_main.................................................................28Block Name: kr_sort_by.............................................................30

    Block Name: kr_footer_search............................................31Functionality.......................................................................31Block Name: kr_sort_by......................................................31

    Functionality.......................................................................32Module Name: Kaltura Resources(kaltura_res)...........................33Functionality............................................................................33Block Name: kr_faq_type...........................................................33Block Name: kr_common_questions...........................................33Block Name: kr_getting_started.................................................33Block Name: kr_integration_help...............................................33Block Name: kr_developers.......................................................33Block Name: kr_stay_updated....................................................33Block Name: kr_node_category..................................................33Block Name: kr_node_expertise.................................................33

    Name: kr_node_tags.................................................................33Block Name: kr_node_questions_answered.................................33Block Name: kr_node_related....................................................33Block Name: kr_subscribe_newsletter........................................33Module Name: Menu Click Counter(menu_counter).....................34Functionality:...........................................................................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.

  • 8/3/2019 TechSpec Kaltura v6 NEW

    4/36

    echnical Specification for Kaltura Resources

    Features

    Notes: All the functionality for the phase 1 of the phase Kaltura will be split intofeatures that make sense, to make future functionality changes and productionpushes 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 aswell. 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.

  • 8/3/2019 TechSpec Kaltura v6 NEW

    5/36

    echnical Specification for Kaltura ResourcesThe 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.

  • 8/3/2019 TechSpec Kaltura v6 NEW

    6/36

    echnical Specification for Kaltura Resources

    Kaltura Resources : User Roles & Profiles

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

    User Role: Authenticated userNotes: Not in use, but is supplied OOB (Out of Box)

    User Role: AdminNotes: 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 administrativecallbacks and/or form definitions.

    Contributed modules:1. Hidden_captcha

    2. views

    3. path

    4. image

    5. block

    6. ctools7. 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

  • 8/3/2019 TechSpec Kaltura v6 NEW

    7/36

    echnical Specification for Kaltura ResourcesCustom 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 alldefined 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 withcategory:[category-name] to redirect to the taxonomy listing page

    b. Uses pre-process functions to make taxonomy pages and search-results 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 standalone

    c. Module install file should create a table in Drupal using hook_schemato create a table that stores each click of a menu item. mid should bestored, 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 6Module, kaltura_extra, into a new Drupal 7 module

    b. This module should make and send a LeadRecord object to marketousing the code snippets in the kaltura_extra module

    c. This module should provide a newsletter signup block for placementonto the frontpage as per wireframe p2. More details regarding the UXof this process to follow from Kaltura.

    d.

  • 8/3/2019 TechSpec Kaltura v6 NEW

    8/36

    echnical Specification for Kaltura Resources

    Kaltura Resources : Menus, Pages and Menucallbacks

    Defined in hook_menu:

    Title Path Page Callback Access Module

    Homepage front standard accesscontent

    kaltura_res

    KalturaResourcesAdministration

    admin/kaltura-resources

    system_admin_menu_block_page administerkalturaresources

    kaltura_res

    KalturaFooterAdministration

    admin/kaltura-resources/footer

    drupal_get_form(custom_form) administerkalturafooter

    kaltura_res_footer

    KalturaQ&AAdministration

    admin/kaltura-resources/Q-A

    drupal_get_form(faq_order_settings_form)

    administer faqorder

    faq

    Defined via configuration (organized by menu):

    MenuTitle

    Path Menu PageTitle

    GettingStarted

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

    Main GettingStarted

    IntegrationHelp

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

    Main Integration

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

    Main Developers

    Questions& Answers

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

    Main GeneralQ&A

    Video &Webinars

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

    Main VideoLibrary

  • 8/3/2019 TechSpec Kaltura v6 NEW

    9/36

    echnical Specification for Kaltura Resources

    Menu

    Title

    Path Menu Page

    TitleGeneralQ&A

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

    Category

    GeneralQ&A

    IntegrationFAQ

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

    Category

    Integration

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

    Category

    Developers

    Menu Title Path Menu PageTitle

    Download & Install KalturaCE

    TBD Footer-top

    TBD

    Start Free Trial TBD Footer-top

    TBD

    Contact Sales TBD Footer-top

    TBD

    Menu Title Path Menu PageTitle

    All kr-main ShowResultsFrom

    ResultsCount

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

    ShowResultsFrom

    ResultsCount

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

    ShowResultsFrom

    ResultsCount

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

    ShowResultsFrom

    ResultsCount

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

    ShowResults

    Results

  • 8/3/2019 TechSpec Kaltura v6 NEW

    10/36

    echnical Specification for Kaltura ResourcesFrom Count

    Questions &Answers

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

    ShowResults

    From

    Results

    CountKaltura.orgResults

    TBD ShowResultsFrom

    ResultsCount

    Kaltura.comResults

    TBD ShowResultsFrom

    ResultsCount

    HTML5Video.orgResults

    TBD ShowResultsFrom

    ResultsCount

    Defined via views:

    Title Path View | Display Access

    KalturaTickerAdministration

    admin/kaltura-resources/ticker

    kr_ticker_admin | page_1 administerkalturaticker

  • 8/3/2019 TechSpec Kaltura v6 NEW

    11/36

    echnical Specification for Kaltura Resources

    Kaltura Resources : Permissions and Access Callbacks

    Defined via hook_perm:

    Permission Module

    administerkalturaresources

    kaltura_res

    administerkaltura footer

    kaltura_res_footer

    administerkaltura tickerkaltura_res_ticker

    assign kalturaresource tag

    kaltura_res

  • 8/3/2019 TechSpec Kaltura v6 NEW

    12/36

    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 visitthe Kaltura Resources site.

    Notes: Generic non-video content, with sharebar enabled

    Field Name Description Field Type Widget andNotes

    Title Used as the title of the page for this

    resource

    Standard Text field

    Body The actual HTMLcontent for theresource page

    Full HTML withTinyMCE

    Text Area withsummary override

    RecommendedNodes(recommended_nodes)

    A list of contentnodes that the useris recommended toread beforereading this article

    Node reference Auto-complete,unlimited values,

    FAQ and Resourcecontent types

    QuestionsAnswered

    (questions_answered)

    Please choose thequestions that this

    resource may helpaddress.

    Node reference Auto-complete,unlimited values,

    FAQ content type

    Category Taxonomy Single value

    Tags Taxonomy Free tagging

    Files (resource_file) Please upload anyfiles that should beavailable for aviewer of thiscontent todownload, such asa PDF of the

    content.

    File Allowed fileextensions: pdf, gif,png, jpeg

    Unlimited values

    File directory:resource_files

  • 8/3/2019 TechSpec Kaltura v6 NEW

    13/36

    echnical Specification for Kaltura Resources

    Content Type: Video resource (video_resource)Description: Video content, organized by the Video Type vocabulary that serves as aresource for users who visit the Kaltura Resources site.

    Notes: Video content, with sharebar enabledDELAYED, 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 tohide the category field from the node_form and have the node automatically havethe Appropriate Category term assigned to it automatically.

    Field Name Description Field Type Widget andNotes

    Question (title) The Question beinganswered

    Standard Text field

    Question details Detailed_question Text area Longer question

    text. This will bedisplayed in alllayouts where theanswer appears, inaddition to theshorter questiontext.

    Body The actual HTMLcontent for thequestion page

    Full HTML withTinyMCE

    Text Area withsummary override

    Category Taxonomy Single value

    Tags Taxonomy Free taggingFAQ Type Taxonomy

    Files Please upload anyfiles that should beavailable for aviewer of thiscontent todownload, such asa PDF of thecontent.

    File Allowed fileextensions: pdf, gif,png, jpeg

    Unlimited values

    File directory:faq_files

  • 8/3/2019 TechSpec Kaltura v6 NEW

    14/36

    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 Description Field Type Widget and

    NotesTitle Standard Text field

    Body Standart 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 Description Field Type Widget andNotes

    Title Standard Text field

    Body Standart Text area

    url field_url Text Field Text field withreference tothe resource

  • 8/3/2019 TechSpec Kaltura v6 NEW

    15/36

    echnical Specification for Kaltura Resources

    Taxonomy Vocabularies

    Taxonomy: CategoryNotes: Single value, applies to any node, ALL FAQ content needs the acategory of Questions and Answers

    Wireframe Reference:Just about every page

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

    Taxonomy: TagsNotes: Free tagging (tied to the assign kaltura resource tag permission),applies to any node, tied to the kaltura_tag_cloudfeaure

    Wireframe Reference: In the Tag Cloud

    Purpose/Use: Allows administrators to assign relevant tags tocontent accessible by the kr_tag_cloudblock (TODO: add link to thisblock here)

    Taxonomy: Audience / Tech expertiseNotes: 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 havethe category of Videos and Webinars assigned to it

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

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

    Taxonomy: FAQ TypeNotes: Single value, applies only to the FAQ content type

    Wireframe Reference: p4

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

  • 8/3/2019 TechSpec Kaltura v6 NEW

    16/36

    echnical Specification for Kaltura Resources

    Kaltura Resources : Views

    View Name: kr_latest_webinar

    View Goal: Show latest video_resource with the Webinarterm fromthe 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 termfrom 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 orresource content types)

    View Types: default, block_1 (no overrides of default)

    Wireframe Reference: p2

  • 8/3/2019 TechSpec Kaltura v6 NEW

    17/36

    echnical Specification for Kaltura ResourcesFields to Include: title, title (for non-registerable nodes), date (if thenode had one), custom link (to node, unless the node is enabled forregistration 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_accessargument

    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 listingpage) this block appears on

  • 8/3/2019 TechSpec Kaltura v6 NEW

    18/36

    echnical Specification for Kaltura ResourcesView Types: default(3 results), block_1 (no overrides of default),block_2 (with 5 results override and different default argument forpulling the term(s) to base the related links on; terms are pulled fromthe 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 thisdocument but the logic will change based on if the landing page is alisting 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_guidesDELAYED, 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 amountof 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 thisdocument

    Sort by: Content statistics: Total views, descending

    Tag: kaltura_resource

    View Name: kr_related_content

  • 8/3/2019 TechSpec Kaltura v6 NEW

    19/36

    echnical Specification for Kaltura ResourcesView Goal: Content related to the node (or listing page) this blockappears 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 thisdocument but the logic will change based on if the landing page is alisting page or a node-page (see block visibility functions)

    Sort by: publishing date, descending

  • 8/3/2019 TechSpec Kaltura v6 NEW

    20/36

    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 providelinks to re-sort the FAQ list Wireframe Reference: p4

  • 8/3/2019 TechSpec Kaltura v6 NEW

    21/36

    echnical Specification for Kaltura ResourcesVisibilty:_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 thefrontpage

    Content: Full HTML configurable bodies, with default markup definedin kaltura_resource.module (taken from comps)

    Wireframe Reference: p2

    Visibilty:

    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 thefrontpage

  • 8/3/2019 TechSpec Kaltura v6 NEW

    22/36

    echnical Specification for Kaltura ResourcesContent: Full HTML configurable bodies, with default markup definedin kaltura_resource.module (taken from comps)

    Wireframe Reference: p2

    Visibilty:

    Defined by:hook_menu in kaltura_resource.module

    Block Name: kr_getting_started

    Visible Title: Developers [>]

    Block Purpose: Static Configurable block that appears on thefrontpage

    Content: Full HTML configurable bodies, with default markup definedin kaltura_resource.module (taken from comps)

    Wireframe Reference: p2Visibilty:

    Defined by:hook_menu in kaltura_resource.module

    Block Name: kr_video_thumbs

    Visible Title: None

    Block Purpose: Displays 2 thumbs; the latest Webinarand the latestTraining 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:

    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 Webinarand the latestTraining Video

    Content: Use theme(links) to generate a sharebar for the website ingeneral (as opposed to a piece of content on the site)

  • 8/3/2019 TechSpec Kaltura v6 NEW

    23/36

    echnical Specification for Kaltura ResourcesWireframe Reference: p2

    Visibilty:

    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:

    Defined by:hook_menu in kaltura_resource.module

    Block Name: kr_node_category

    Visible Title: Category of the document

    Block Purpose: Displays the Categoryterm of the node

    Content: Use [custom] theme(kr_node_block, vocabulary, $vid) topresent 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 theAudience / Tech Expertise term of thenode

    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

  • 8/3/2019 TechSpec Kaltura v6 NEW

    24/36

    echnical Specification for Kaltura Resources

    Block Name: kr_node_tags

    Visible Title: TagsBlock Purpose: Displays the Tags term of the node

    Content: Use [custom] theme(node_block, vocabulary, $vid) topresent 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 nodesnode_reference field

    Content: use theme(list) display to all the question nodes in thenodes 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

  • 8/3/2019 TechSpec Kaltura v6 NEW

    25/36

    echnical Specification for Kaltura ResourcesBlock Purpose: displays menu items from the Show Results Frommenu

    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

  • 8/3/2019 TechSpec Kaltura v6 NEW

    26/36

    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 seenotes for the custom kaltura_res_marketo module

    Webform Structure:

    Field Name Field Type

    First name TextfieldLast name Textfiled

    Email Standard

    What were you looking for? Combo box (type text)

  • 8/3/2019 TechSpec Kaltura v6 NEW

    27/36

    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 (asneeded) specific to the Kaltura Resources Drupal build

    Wireframe Reference: all pages except p2

    Visibilty: all pages but the page (type 2)Defined by:hook_menu in tagadelic.module

  • 8/3/2019 TechSpec Kaltura v6 NEW

    28/36

    echnical Specification for Kaltura Resources

    Kaltura Search : Modules

    Contributed modules:1. Search Api

    2. Search facets

    3. Search pages

    4. Search views

    5. 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 siteaccording to relevancy based on search keys and/or facet filtering

    View Types : default, page_1 (identical to default), page_2, page_3,

    page_4Wireframe 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:

  • 8/3/2019 TechSpec Kaltura v6 NEW

    29/36

    echnical Specification for Kaltura Resourcesdefault(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.

  • 8/3/2019 TechSpec Kaltura v6 NEW

    30/36

    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 thesolr_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

  • 8/3/2019 TechSpec Kaltura v6 NEW

    31/36

    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 twofunctions 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.

  • 8/3/2019 TechSpec Kaltura v6 NEW

    32/36

    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.

  • 8/3/2019 TechSpec Kaltura v6 NEW

    33/36

    echnical Specification for Kaltura ResourcesModule 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

  • 8/3/2019 TechSpec Kaltura v6 NEW

    34/36

    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.

  • 8/3/2019 TechSpec Kaltura v6 NEW

    35/36

    echnical Specification for Kaltura Resources

    Versions and Compatibility

    Drupal: 7.8

    Browser/OS Compatibility

    Firefox Chrome IE Safari

    MSWindows

    3+ 4+ 7, 8 4

    Mac OS X 3+ 4+ X 4

    Mobile Support via HTML5

  • 8/3/2019 TechSpec Kaltura v6 NEW

    36/36

    echnical Specification for Kaltura Resources

    Appendix

    Related Content Method #1

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

    1. Create view (block)

    2. Add fields (title, a small image, date, whatever you like). Or teasers, what works as

    well.

    3. "Arguments" is from now on called "Contextual filters", so go there.

    4. Add the filter: "Content: Has taxonomy term ID"

    5. 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. Now you need to add the second filter in order to exclude the current node from the

    list. Click [+] button of the contextual filters section.

    7. Select Content: Nid

    8. Set the 'when argument is not present' to 'Provide default argument'

    9. Set the 'Default argument type' to 'Content ID from URL'

    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