diff --git a/.render/README.md b/.render/README.md new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/.render/README.md @@ -0,0 +1 @@ + diff --git a/.render/_local/_includes/specs_by_theme_table.html b/.render/_local/_includes/specs_by_theme_table.html new file mode 100644 index 0000000..1bce489 --- /dev/null +++ b/.render/_local/_includes/specs_by_theme_table.html @@ -0,0 +1,32 @@ + + + + + + + {% if include.show_releases %} + + {% endif %} + + + + {% assign specs_to_show = site.data.specs | where_exp:"spec", "spec.themes contains include.filter_theme" | where: "show_in_index", true %} + {% for spec in specs_to_show %} + + + + + {% if include.show_releases %} + + {% endif %} + + {% endfor %} + +
IdNameSpec StatusRelease(s)
{{ spec.amwa_id }}{{ spec.name }}{{ spec.status }} + {% for release in spec.releases %} +
+ {{ release }} + +
+ {% endfor %} +
diff --git a/.render/_local/_includes/themes_table.html b/.render/_local/_includes/themes_table.html new file mode 100644 index 0000000..dba568a --- /dev/null +++ b/.render/_local/_includes/themes_table.html @@ -0,0 +1,27 @@ + + + + + + + + + + {% for theme in site.data.themes %} + + + + + + + {% endfor %} + +
ThemeDescriptionMembers
{{ theme.name }}{{ theme.description }} + {% for member in theme.members %} +
+ + {{ member }} + {{ site.data.specs[0].amwa_id }} +
+ {% endfor %} +
diff --git a/.render/themes.json b/.render/themes.json new file mode 100644 index 0000000..0e46448 --- /dev/null +++ b/.render/themes.json @@ -0,0 +1,4 @@ +--- +--- + +{{ site.data.specs | jsonify }} diff --git a/.render/themes.md b/.render/themes.md new file mode 100644 index 0000000..869ac62 --- /dev/null +++ b/.render/themes.md @@ -0,0 +1,13 @@ +# NMOS Specifications by Theme + +The tables below are organised by theme. To see them organised by id, click [here](.) + +{% for theme in site.data.themes %} + +### {{ theme.name }} + +{{ theme.description}} + +{% include specs_by_theme_table.html filter_theme=theme.id show_releases=true %} + +{% endfor %} diff --git a/README.md b/README.md index 4c9cbec..81ab6f2 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,9 @@ The tables below list the current specifications and provide links to their docu The [NMOS API Testing Tool](https://specs.amwa.tv/nmos-testing) supports the majority of these specifications. +The tables below are organised by specification type. To see them organised by themes, click [here](themes.md) + + ### [NMOS Interface Specifications (IS)](is/) These specify NMOS APIs using RAML, JSON Schema and normative text, supported by examples and other text: diff --git a/themes.md b/themes.md new file mode 100644 index 0000000..869ac62 --- /dev/null +++ b/themes.md @@ -0,0 +1,13 @@ +# NMOS Specifications by Theme + +The tables below are organised by theme. To see them organised by id, click [here](.) + +{% for theme in site.data.themes %} + +### {{ theme.name }} + +{{ theme.description}} + +{% include specs_by_theme_table.html filter_theme=theme.id show_releases=true %} + +{% endfor %} diff --git a/themes.yml b/themes.yml new file mode 100644 index 0000000..ffaa553 --- /dev/null +++ b/themes.yml @@ -0,0 +1,54 @@ +- id: RESOURCE + name: Resource Management + description: Specifications, recommendations and guidance concerning registration, discovery and labelling of NMOS resources + members: + - IS-04 + - IS-09 + - IS-13 + - BCP-002-01 + - BCP-002-02 + - INFO-004 + - INFO-005 + +- id: CONNECTION + name: Connection Management + description: Specifications, recommendations and guidance concerning connection of devices, audio channel mapping and compressed streams + members: + - IS-05 + - IS-08 + - BCP-004-01 + - BCP-006-01 + - BCP-006-02 + - BCP-006-03 + - BCP-007-01 + - INFO-003 + - INFO-005 + +- id: CONTROL + name: Device Control & Monitoring + description: Specifications, recommendations and guidance concerning device control and status monitoring + members: + - IS-07 + - IS-12 + - MS-05-01 + - MS-05-02 + - BCP-008-01 + - INFO-006 + +- id: CONFIGURATION + name: Device Configuration + description: Specifications, recommendations and guidance concerning device and media parameter configuration + members: + - IS-11 + - IS-14 + +- id: SECURITY + name: Security Recommendatations + description: Specifications, recommendations and guidance concerning encryption, authorisation and certificate provisioning + members: + - IS-10 + - BCP-003-01 + - BCP-003-02 + - BCP-003-03 + - INFO-002 + - INFO-005