Add Static HTML Pages to MiVideo MediaSpace (KMS)

Environment

MiVideo MediaSpace (KMS) Admin Console

The MediaSpace Admin Console allows a KMS administrator to configure settings and user/group management for a specific KMS

Issue

How to create and publish static HTML web pages in MediaSpace (KMS) sites.

Resolution

Accessing the MediaSpace Admin Console

MediaSpace_URL/admin

Using the staticPages module

Before you use staticPages, you must know the following:

  • Basic HTML knowledge and/or an HTML editor to copy HTML code
  • A plan for integrating the page(s) into your MediaSpace site navigation
  • Awareness of built in site URLs to avoid unintentional overriding built-in features
  • Top level built-in slugs:
    • /channel
    • /channels
    • /upload
    • /media
    • /my-media
    • /my-channels
    • /my-playlists
    • /liveentry
    • /youtube
    • /screencapture

Considerations with the staticPages Module

  • The staticPages module allows you to create web pages to convey additional information to your site visitors
  • A static page can be configured as the home page of a MediaSpace site
  • Static pages must be manually linked in the site’s navigation
  • Each page can be secured by site user role as needed (see the About Site Roles and Page Security section for more information)
  • Static pages with the same slug as built-in pages override the built-in pages. For example, a static page with the slug “channels” will override the built-in channels page display

Limitations

  • Only code that can be placed between the <body></body> tags of an HTML page can be used. Including <head> and/or <footer> tags in a static page causes unpredictable results including breaking the module’s functionality in the admin
  • Styling
    • Inline styling is the preferred method for styling your HTML code
    • If you need to include style information, you can use an HTML loophole and place <style></style> tags at the beginning of the page content
    • You can edit/upload custom CSS with the cssUpload module (for this option, please seek assistance from the MiVideo support team by submitting a request to the ITS Service Center)
  • Pasting content from MS Word is not recommended. MS Word deeply embeds page styling that may not display as expected
  • Images in a static page must be hosted externally (e.g. Dropbox account or department website). If your site is set for SSL delivery, your images must also be hosted on SSL to avoid security warnings/blocked display

Enable the staticPages Module

  1. MediaSpace Admin Console > staticpages
  2. Set the enabled drop-down to Yes
  3. Click Save
Tips:
  • You can leave the module enabled without page content
  • You can create static pages even though the module is disabled, but you won’t be able to view them until the module is enabled
  • You can disable the module without losing any pages you may have already created

Create a “Custom Page”

  1. MediaSpace Admin Console > staticpages
  2. Click Add “customPage"
  3. The age title is optional and displays at the top of the page as <h1> styled text
  4. Enter the pageSlug text (no preceding “/”) following standard URL naming practices (e.g. about-us) and avoiding the built-in slugs mentioned above
  5. Set the page’s permissions. In most cases, you can leave this as anonymous (see the About Site Roles and Page Security section)
  6. Type or copy/paste HTML code into the content box. Tip: include only the content between the <body></body> tags, but not the tags themselves, or any other page content
  7. Click Save to submit your changes and clear the cache
  8. To test your page, go to your site URL/slugname (e.g. https://staging.mivdeo.it.umich.edu/about-us)

Repeat steps 1-7 to create and test additional pages.

Link Static Pages in Site Navigation

Site visitors cannot find your static pages unless you communicate the URLs to them or link the pages in your site’s navigation. The following are some ways to link up your pages.

Link Pages to the Main Navigation

The main navigation usually includes your site Gallery categories and may also include other links you’ve added. This is a good place to link up a staticPage that is configured for anonymous access (see the About Site Roles and Page Security section for more information about linking up non-anonymous content).

  1. MediaSpace Admin Console > Navigation
  2. Click add “pre” or add “post” as desired
    • Pre items show up before any included gallery categories in your site navigation.
    • Post items display after the gallery categories. See the special note below for creating a static HTML home page.
  3. Add the following fields

type: Link

name: <clickable text in the navigation> (e.g About Us)

value: the staticPage slug, INCLUDING the preceding / (e.g. /about-us)

sameWindow: YES

  1. Click Save and test on the site

  • If you want to use a static page as the home page for your site, it must be the FIRST “Pre” menu link in the Navigation module
  • If you already have other “Pre” links configured they will have to be deleted and re-created after you add your custom page as the first “Pre” link. Be sure you make careful note of all settings before deleting other “Pre” links

Link Pages to the User Menu Navigation

A staticPage can be added to the user menu, which is the drop-down menu in the top right corner of the site header labeled as “Guest”; or the logged in user’s name. Keep in mind that this positioning is less obvious to the average site visitor. This is a good place to link pages that are site role restricted (see the About Site Roles and Page Security section).

  1. MediaSpace Admin Console > Headermenu
    1. Note: There are probably some items already in this list, such as My Media. You can leave these as they are
  2. Click add “menu”
  3. Add the following fields

type: URL

label: <clickable text in the navigation> (e.g About Us)

link: the staticPage slug, INCLUDING the preceding / (e.g. /about-us)

sameWindow: Yes

linkLocation: User Drop Down (use a Header menu if you’ve configured your site to use this navigation element).

  1. Click Save and test

Link Static Pages to Each Other

You can build an internal navigation between your pages by adding HTML <a href> navigation links as desired to each staticPage’s content.

About Site Roles and Page Security

  • If the entire site requires login before users can see anything, then the page is still secured even when it is set to anonymous.
  • If you want to limit staticPage access to logged-in users in MediaSpace who have a specific role, you should consider how this will appear to users who have a role lower than the one designated.

The site roles in order of least access to greatest access are:

  • anonymous
  • viewerOnly
  • privateOnlyRole
  • adminRole
  • unmoderatedAdminRole

Anonymous users who access a non-anonymous static page link are prompted to log in. If they don’t have a login, they are stuck.

Users with a role lower than the page requires will receive a generic “access denied” message which may leave them frustrated and confused.

Additional Information

Details

Article ID: 4727
Created
Mon 3/29/21 10:21 AM
Modified
Fri 9/10/21 4:24 PM