From: Ben Sturmfels Date: Thu, 30 Apr 2020 01:38:44 +0000 (+1000) Subject: subtitles: Add documentation, limit uploads to *.vtt files, only show for video ... X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=a9b7bd60b21afc9235a598d38e7ca6f22c4c79ee;p=mediagoblin.git subtitles: Add documentation, limit uploads to *.vtt files, only show for video [#5589]. --- diff --git a/docs/source/index.rst b/docs/source/index.rst index fbc57154..b13968a5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -55,14 +55,15 @@ Part 2: Core plugin documentation .. toctree:: :maxdepth: 1 - plugindocs/flatpagesfile - plugindocs/sampleplugin - plugindocs/trim_whitespace - plugindocs/raven plugindocs/basic_auth + plugindocs/flatpagesfile + plugindocs/ldap plugindocs/openid plugindocs/persona - plugindocs/ldap + plugindocs/raven + plugindocs/sampleplugin + plugindocs/subtitles + plugindocs/trim_whitespace Part 3: Plugin Writer's Guide diff --git a/mediagoblin/plugins/subtitles/README.rst b/mediagoblin/plugins/subtitles/README.rst new file mode 100644 index 00000000..c45b6c20 --- /dev/null +++ b/mediagoblin/plugins/subtitles/README.rst @@ -0,0 +1,25 @@ +================ +Subtitles plugin +================ + +This plugin enables text captioning of videos (though not yet audio). Once the +plugin is enabled, you'll see a link to upload subtitles in `WebVTT format`_ as +supported by the Video.js `Text Tracks`_ feature. + +.. _WebVTT format: https://en.wikipedia.org/wiki/WebVTT +.. _Text Tracks: https://docs.videojs.com/docs/guides/text-tracks.html + +.. _subtitles-setup: + +Enabling the subtitles plugin +============================= + +1. Add the following to your MediaGoblin .ini file in the ``[plugins]`` section:: + + [[mediagoblin.plugins.subtitles]] + +2. Run:: + + $ ./bin/gmg dbupdate + +3. Restart your MediaGoblin process. diff --git a/mediagoblin/plugins/subtitles/forms.py b/mediagoblin/plugins/subtitles/forms.py index de8ffbcd..acf2af31 100644 --- a/mediagoblin/plugins/subtitles/forms.py +++ b/mediagoblin/plugins/subtitles/forms.py @@ -16,14 +16,17 @@ import wtforms +from mediagoblin.tools.translate import lazy_pass_to_ugettext as _ + class CustomizeSubtitlesForm(wtforms.Form): subtitle = wtforms.TextAreaField( ('Subtitle'), [wtforms.validators.Optional()], - description=("")) + description=_('Subtitles in WebVTT format')) class EditSubtitlesForm(wtforms.Form): subtitle_language = wtforms.StringField( 'Language') subtitle_file = wtforms.FileField( - 'File') + 'File', + description=_('Subtitles in WebVTT format')) diff --git a/mediagoblin/plugins/subtitles/templates/mediagoblin/plugins/subtitles/subtitle_media_block.html b/mediagoblin/plugins/subtitles/templates/mediagoblin/plugins/subtitles/subtitle_media_block.html index 7426c971..4d4a203b 100644 --- a/mediagoblin/plugins/subtitles/templates/mediagoblin/plugins/subtitles/subtitle_media_block.html +++ b/mediagoblin/plugins/subtitles/templates/mediagoblin/plugins/subtitles/subtitle_media_block.html @@ -17,7 +17,7 @@ #} {% block subtitle_block %} -{% if "video.html" in media.media_manager.display_template or "audio.html" in media.media_manager.display_template %} +{% if "video.html" in media.media_manager.display_template %} {%- if media.subtitle_files|count %}

{% trans %}Subtitles{% endtrans %}