HLRD RSMIL

From MediaWiki.org
Jump to navigation Jump to search

HLRD RSMIL (High Level Resource Description, Reduced SMIL), is the sequence interchange format used for working collaborative sequences within MediaWiki.

This specification is under active development

Also see Media Projects Overview

Overview: Resource Description vs Presentation XML[edit]

The core High level resource sequence description is what is stored in the wiki. This representation can be thought about as the wiki-text of a Wikipedia article. Once you want to play or edit a sequence the high level resource description is transformed by the wiki engine to resolve all the paths to the given resources and render out any templates or sub sequences. This presentation XML retains its high level resource names so that when you save back the sequence a high level wiki-text like resource description can be saved in the database.

Basic HLRD RSMIL Skeleton[edit]

This is basic XML skeleton the possible tags are explained below. The basic structure pres

<smil>
    <head>
        <Meta Tags/>
        <Transition Tags/>
    </head>
    <body>
    <seq>
        <Media Object> 
    </seq>
    </body>
</smil>


Meta Tags[edit]

Invocation:

<meta name="title" content="Title Value"/>

Currently supported Meta Names:[edit]

  • title the title of sequence displayed at the top of the sequence
  • interface_url the base interface URL provides a link to the API entry point of MediaWiki
  • linkback a link to the source page of the sequence. (useful when remote embedding to link back to the sequence page)
  • mTitle the wiki resource title of the sequence.
  • mTalk a link to the discussion page for this sequence.

Would be cool to add[edit]

  • <link type="application/rss+xml" a link back to video RSS representation of the sequence

Transition Tags[edit]

Transition tags define any transitions used in the sequence. More complete information about the eventual targeted functionality and representation can be viewed in the SMIL transition documentation.

What we currently support:

  • id the transition id to be targeted with media elements transIn and transOut.
  • type the type of the transition
    • currently supported: fade
  • subtype the subtype of the transition
    • currently supported: fadeFromColor and crossfade
  • subtype specific attributes fadeColor= #color
  • dur the duration of the cross fade in smil time.

Media Object[edit]

Analogous to: SMIL media Object Supported Media tags:

  • ref Generic media reference

In addition to the ref element, You can use other synonyms:

  • audio Audio clip
  • img Still image, such as PNG or JPEG
  • video Video clip

Currently Supported Media Object Attributes[edit]

HLRD specific attributes[edit]

  • uri is a HLRD specific tag. It specifies the unique resource identifier within the mediaWiki system. This is generally the title of the asset or title of the template.
  • poster a image thumbnail to be displayed for the video (to better support inline html preview without loading lots of video files.

SMIL supported attributes[edit]

  • src the resolved src of the asset. This tag is discarded as we save the asset to the server since the URI will resolve to this src path anyway.
  • title is the human readable title of the asset. This is also presently discarded as we save the asset since it should mirror the assets "title". Perhaps we keep this in the future for doing table of contents type things we will see.
  • transIn a targeted transition In (defined in the transitions tag section)
  • transOut a targeted transition Out
  • dur the duration of the asset in SMIL time.
    • CHILD NODES
    • <![CDATA if type is text/html this CDATA is directly rendered out as an html asset for the specified duration
    • <param name="myTemplateVar">wikitext to pass to the template</param> if your parent asset URI is in the Template Namespace these underling child node will be passes as wikitext to the targeted template before its rendered out.