Merge pull request #61 from bbc/philipn-rdd6-xml-creator-link

Add bmx doc / code references to RDD 6 XML creator app
bbc · Mar 15, 2024 · 0a6a015 · 0a6a015
2 parents c6fed6e + fb96fc0
commit 0a6a015
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/meta/rdd6_xml_creator/README.md b/meta/rdd6_xml_creator/README.md
@@ -2,9 +2,9 @@
 
 The [SMPTE RDD 6](https://ieeexplore.ieee.org/document/7290141) (Dolby E Audio Metadata) XML Creator is a basic HTML web page application that creates an XML file suitable for `bmxtranswrap` to embed a static RDD 6 serial bitstream in an MXF file.
 
-Copy the [index.html](./index.html) and supporting directories ([css](./css) and [js](./js)) to a local file system, or use a clone of this Git repository.
+The [RDD 6 XML Creator](https://bbc.github.io/bmx/meta/rdd6_xml_creator/) can be found online in github.io. It can also be run locally by coping the [index.html](./index.html) and supporting directories ([css](./css) and [js](./js)) to a local file system, or by using a clone of this Git repository.
 
-Open `index.html` in a web browser and fill-in the RDD 6 metadata. Select "Save XML" to export to a local file.
+Open [RDD 6 XML Creator](https://bbc.github.io/bmx/meta/rdd6_xml_creator/) or `index.html` in a web browser and fill-in the RDD 6 metadata. Select "Save XML" to export to a local file.
 
 >The file name includes a hash of the file contents (`var filename = "dpp_rdd6_" + hash_djb2(rdd6_xml) + ".xml"`) and therefore files will have a different name if the contents are different.
 

diff --git a/meta/rdd6_xml_creator/css/custom.css b/meta/rdd6_xml_creator/css/custom.css
@@ -6,3 +6,6 @@
   width:auto;
 }
 
+.doc-references {
+  font-size: small;
+}
diff --git a/meta/rdd6_xml_creator/index.html b/meta/rdd6_xml_creator/index.html
@@ -6,7 +6,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
 
-    <title>RDD 6 XML Creator</title>
+    <title>bmx RDD 6 XML Creator</title>
 
     <link href="css/bootstrap.min.css" rel="stylesheet">
     <link href="css/custom.css" rel="stylesheet">
@@ -17,7 +17,11 @@
     <div class="container">
 
      <div class="page-header">
-      <h1>RDD 6 XML Creator</h1>
+      <h1><a href="https://github.com/bbc/bmx">bmx</a> RDD 6 XML Creator</h1>
+      <div class="doc-references">The <a href="https://github.com/bbc/bmx/blob/main/meta/rdd6/rdd6.xsd">RDD 6 XML Schema</a>
+        and <a href="https://github.com/bbc/bmx/tree/main/meta/rdd6_xml_creator">documentation</a>
+        can be found in <a href="https://github.com/bbc/bmx">bmx</a>.
+      </div>
      </div>
 
      <div class="row">