Commit e934034f authored by Seb's avatar Seb
Browse files

doc updates

parent 70ece934
......@@ -9,26 +9,63 @@ wagtailvideos
Based on wagtailimages. The aim was to have feature parity with images but for html5 videos.
Must have have ffmpeg installed with the correct codecs *(todo: put codec requirements here )* to be able to use the transcoding feature.
It works with Wagtail 1.4 and upwards.
Installing
==========
**This package is not on PyPI yet**
It works with Wagtail 1.4 and upwards.
Using
=====
On a page model:
//TODO
################
Implement as a ForeinKey relation, same as wagtailimages.
::
from django.db import models
from wagtail.wagtailadmin.edit_handlers import FieldPanel
from wagtail.wagtailcore.fields import RichTextField
from wagtail.wagtailcore.models import Page
from wagtailvideos.edit_handlers import VideoChooserPanel
class HomePage(Page):
body = RichtextField()
header_video = models.ForeignKey('wagtailvideos.Video',
related_name='+',
null=True,
on_delete=models.SET_NULL)
content_panels = Page.content_panels + [
FieldPanel('body'),
VideoChooserPanel('header_video'),
]
In template:
############
The video template tag takes one required postitional argument, a video field. All extra
attributes are added to the surrounding <video> tag. The original video and all
extra transcodes are added as <source> tags.
.. code-block:: django
{% load wagtailvideos_tags %}
{% video self.header_video autoplay controls width=256 %}
How to transcode using ffmpeg:
##############################
In template
//TODO
Using the video collection manager from the left hand menu. In the video editing
section you can see the available transcodes and a form that can be used to create
new transcodes. It is assumed that your compiled version of ffmpeg has the matching
codec libraries required for the transcode.
How to transcode using ffmpeg
//TODO
Future features
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment