From 23e31df4e2689f2713c6c7d98e8df7977e2d7965 Mon Sep 17 00:00:00 2001 From: Matt Mascarenhas Date: Wed, 28 Feb 2018 01:40:02 +0000 Subject: [PATCH] README.md: Update --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4c8cb2d..03ca4c3 100644 --- a/README.md +++ b/README.md @@ -60,11 +60,6 @@ directory. Typical operation will involve setting these flags: Valid tags: -- `` _the project's full name_ -- `` _the day / episode name, intended to be used - inside your own `` element, but may be used wherever and as many times - as you want on your page_ - *Index Template* - `<!-- __CINERA_INCLUDES__ -->` _the necessary `.css` and `.js` files_ - `<!-- __CINERA_INDEX__ -->` _the table of contents, and search functionality_ @@ -79,7 +74,9 @@ Valid tags: must come after both the MENUS and PLAYER tags_ *Optional tags available for use in your Player Template* -- `<!-- __CINERA_TITLE__ -->` _the title of the video, excluding numbering_ +- `<!-- __CINERA_TITLE__ -->` _the day / episode name, intended to be used + inside your own `<title>` element, but may be used wherever and as many times + as you want on your page_ - `<!-- __CINERA_VIDEO_ID__ -->` _the unique identifer of the video as provided by the VoD platform_ @@ -90,12 +87,12 @@ Valid tags: - `<!-- __CINERA_CUSTOM0__ -->` - `<!-- __CINERA_CUSTOM1__ -->` - `<!-- __CINERA_CUSTOM2__ -->` - ⋮ +- ⋮ - `<!-- __CINERA_CUSTOM15__ -->` _Freeform buffers for small snippets of localised information, e.g. a single - <a> element or perhaps a <!-- comment --> They correspond to the custom0 to - custom15 attributes in the [video] node in your .hmml files 0 to 11 may hold - up to 255 characters 12 to 15 may hold up to 1023 characters_ + `<a>` element or perhaps a `<!-- comment -->` They correspond to the custom0 + to custom15 attributes in the [video] node in your .hmml files 0 to 11 may + hold up to 255 characters 12 to 15 may hold up to 1023 characters_ Feel free to play with templates to your heart's content. If you do anything invalid, `cinera` will tell you what's wrong.