Updated documentation with opcode support status draft.

This commit is contained in:
redtide 2019-10-03 22:49:01 +02:00
parent 26c2093d77
commit f2d1a2ced8
5 changed files with 1461 additions and 1333 deletions

View file

@ -22,23 +22,6 @@ pre {
border: 2px solid rgba($black, .2);
border-radius: 0.50rem;
}
table {
width:100%;
border-collapse: collapse;
margin-bottom: 1em;
}
th, td {
text-align: left;
padding: 5px 10px;
border: 1px solid #e5e5e5;
}
th {
color: #f8f9fA;
background-color: #222;
}
tr:nth-child(even) {
background-color: #f2f2f2;
}
#scrollButton {
display: none;
position: fixed;

View file

@ -49,6 +49,12 @@ navigation:
type: normal
url: /contacts
#- title: Status
# icon_type: tasks
# icon_category: fas
# type: normal
# url: /status
- title: Downloads
type: normal
icon_type: download

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,79 @@
<h2>Supported Operating Systems</h2>
<ul>
{%-for os in site.data.sfz.support.os-%}
<li>{{ os.name }}</li>
{%-endfor-%}
</ul>
<h2>Supported Headers</h2>
<table class="table table-sm table-hover table-striped table-responsive">
<thead class="thead-dark">
<tr>
<th scope="col">Header</th>
<th scope="col" style="text-align:center">Version</th>
<th scope="col" style="text-align:center">Supported</th>
</tr>
</thead>
<tbody>
{%-for header in site.data.sfz.support.headers-%}
{%-assign header_url = "<a href='https://sfzformat.com/headers/" |
append: header.name | append: "'>" | append: header.name | append: "</a>"-%}
{%-if header.support == nil or header.support == 'x'-%}
{%-assign header_support = ":x:"-%}
{%-elsif header.support == 'v'-%}
{%-assign header_support = ":heavy_check_mark:"-%}
{%-else-%}
{%-assign header_support = header.support-%}
{%-endif-%}
<tr>
<td>{{ header_url }}</td>
<td style="text-align:center">{{ header.version }}</td>
<td style="text-align:center">{{ header_support }}</td>
</tr>
{%-endfor-%}
</tbody>
</table>
<h2>Supported Opcodes</h2>
{%-for category in site.data.sfz.support.categories-%}
<h3>{{ category.name }}</h3>
<table class="table table-sm table-hover table-striped table-responsive">
<thead class="thead-dark">
<tr>
<th scope="col">Opcode</th>
<th scope="col" style="text-align:center">Version</th>
<th scope="col" style="text-align:center">Supported</th>
<th scope="col" style="text-align:center">Tested</th>
</tr>
</thead>
<tbody>
{%-for opcode in category.opcodes-%}
{%-assign opcode_name = opcode.name | replace: '#', ''-%}
{%-assign opcode_url = "<a href='https://sfzformat.com/opcodes/" |
append: opcode_name | append: "'>" | append: opcode.name | append: "</a>" -%}
{%-if opcode.support == nil or opcode.support == 'x'-%}
{%-assign opcode_support = ":x:"-%}
{%-elsif opcode.support == 'v'-%}
{%-assign opcode_support = ":heavy_check_mark:"-%}
{%-else-%}
{%-assign opcode_support = opcode.support-%}
{%-endif-%}
{%-if opcode.tested == nil or opcode.tested == 'x'-%}
{%-assign opcode_tested = ":x:"-%}
{%-elsif opcode.tested == 'v'-%}
{%-assign opcode_tested = ":heavy_check_mark:"-%}
{%-else-%}
{%-assign opcode_tested = opcode.tested-%}
{%-endif-%}
<tr>
<td>{{ opcode_url }}</td>
<td style="text-align:center">{{ opcode.version }}</td>
<td style="text-align:center">{{ opcode_support }}</td>
<td style="text-align:center">{{ opcode_tested }}</td>
</tr>
{%-endfor-%}
</tbody>
</table>
{%-endfor-%}

10
docs/status.md Normal file
View file

@ -0,0 +1,10 @@
---
title: "Opcodes Support Status"
lang: "en"
published: false
---
Here is the list of currently supported headers and opcodes.
The classification follows the list over at <https://sfzformat.com/>.
{%-include sfz/opcodes_support_table_generator.html-%}