Skip to content

Commit

Permalink
cove_ofds/explore.html: Various updates
Browse files Browse the repository at this point in the history 
- Copy-edit text
- Fix repeated ids and references
- Use panel-info for schema version
- Combine external links panels
- Add introductory paragraphs to
  - validation errors
  - additional fields
  - additional checks
  - visualisation
- Use panel-warning for additional fields
- Use panel-info for no additional fields
- Use panel-sucess and panel-danger for visualisation
  • Loading branch information
@duncandewhurst
duncandewhurst committed Nov 7, 2022
1 parent b0458f9 commit 536a951
Showing 1 changed file with 31 additions and 38 deletions.
69 changes: 31 additions & 38 deletions cove_ofds/templates/cove_ofds/explore.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,46 +8,29 @@
{% block explore_content %}

<div class="row">
<div class="panel {% if unknown_schema_version_used or inconsistent_schema_version_used_count %}panel-danger{% else %}panel-success{% endif %}">
<div class="panel {% if unknown_schema_version_used or inconsistent_schema_version_used_count %}panel-danger{% else %}panel-info{% endif %}">
<div id="validation-panel" class="panel-heading pointer" role="region" aria-expanded="true" aria-controls="validationTable" data-toggle="collapse" data-target="#validationTable">
<h4 class="panel-title">
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Schema Version' %}
</h4>
</div>
<div id="validationTable" class="collapse in panel-body">
<p>{% trans 'Schema Version Used' %}: {{ schema_version_used }}</p>
<p>{% trans 'Your data was checked against schema version' %}: {{ schema_version_used }}</p>
</div>
</div>
</div>


{% if has_links_with_external_node_data %}
{% if has_links_with_external_node_data or has_links_with_external_span_data %}
<div class="row">
<div class="panel {% if unknown_schema_version_used or inconsistent_schema_version_used_count %}panel-danger{% else %}panel-success{% endif %}">
<div id="validation-panel" class="panel-heading pointer" role="region" aria-expanded="true" aria-controls="validationTable" data-toggle="collapse" data-target="#validationTable">
<div class="panel panel-warning">
<div id="unchecked-data-panel" class="panel-heading pointer" role="region" aria-expanded="true" aria-controls="unchecked-data" data-toggle="collapse" data-target="#unchecked-data">
<h4 class="panel-title">
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Links to nodes data' %}
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Unchecked data' %}
</h4>
</div>
<div id="validationTable" class="collapse in panel-body">
<p>{% trans 'Your data contains links to API endpoints or bulk files for nodes. The additional data available from the links has not been checked. You can check the data by embedding it in network package and submitting it to CoVE.' %}</p>
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,,links">{% trans 'Schema Documentation' %}</a></p>
</div>
</div>
</div>
{% endif %}

{% if has_links_with_external_span_data %}
<div class="row">
<div class="panel {% if unknown_schema_version_used or inconsistent_schema_version_used_count %}panel-danger{% else %}panel-success{% endif %}">
<div id="validation-panel" class="panel-heading pointer" role="region" aria-expanded="true" aria-controls="validationTable" data-toggle="collapse" data-target="#validationTable">
<h4 class="panel-title">
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Links to spans data' %}
</h4>
</div>
<div id="validationTable" class="collapse in panel-body">
<p>{% trans 'Your data contains links to API endpoints or bulk files for nodes. The additional data available from the links has not been checked. You can check the data by embedding it in network package and submitting it to CoVE.' %}</p>
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,,links">{% trans 'Schema Documentation' %}</a></p>
<div id="unchecked-data" class="collapse in panel-body">
<p>{% trans 'Your data contains links to API endpoints or bulk files. The additional data available from the links has not been checked. You can check the data by embedding it in network package and submitting it to CoVE. For more information, see ' %}<a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,,links"><code>/links</code></a>.</p>
</div>
</div>
</div>
Expand Down Expand Up @@ -131,22 +114,23 @@ <h4 class="panel-title">
<div class="panel panel-danger">
<div id="validation-panel" class="panel-heading pointer" role="region" aria-expanded="true" aria-controls="validationTable" data-toggle="collapse" data-target="#validationTable">
<h4 class="panel-title">
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Validation Errors' %}
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Structure and Format' %}
</h4>
</div>
<div id="validationTable" class="collapse in panel-body">
<p>{% trans 'The structure and format of your data does not conform to the OFDS schema. You should check your mapping and data pipeline for errors. For more information, see the ' %}<a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference">{% trans 'reference documentation' %}</a>.</p>
{% include "cove_ofds/validation_table.html" %}
</div>
</div>
{% else %}
<div class="panel panel-success">
<div id="validation-panel" class="panel-heading pointer" role="region" aria-expanded="true" aria-controls="validationTable" data-toggle="collapse" data-target="#validationTable">
<h4 class="panel-title">
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Validation Errors' %}
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Structure and Format' %}
</h4>
</div>
<div id="validationTable" class="collapse in panel-body">
<p>{% trans 'There were no validation errors!' %}</p>
<p>{% trans 'The structure and format of your data conforms to the OFDS schema.' %}</p>
</div>
</div>
{% endif %}
Expand All @@ -160,25 +144,32 @@ <h4 class="panel-title">
{% if additional_fields_count %}

<a name="additional-fields" class="anchor"></a>
<div class="panel panel-danger">
<div id="validation-panel" class="panel-heading pointer" role="region" aria-expanded="true" aria-controls="validationTable" data-toggle="collapse" data-target="#additionalFieldsTable">
<div class="panel panel-warning">
<div id="additional-fields-panel" class="panel-heading pointer" role="region" aria-expanded="true" aria-controls="additionalFieldsTable" data-toggle="collapse" data-target="#additionalFieldsTable">
<h4 class="panel-title">
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Additional Fields' %}
</h4>
</div>
<div id="additionalFieldsTable" class="collapse in panel-body">
<p>{% trans 'Your data contains additional fields that are not part of the OFDS schema. You should:' %}</p>
<ul>
<li>{% trans 'Check that additional fields are not the result of typos in field names or other errors in your mapping or data pipeline.' %}</li>
<li>{% trans 'Check whether the data in these fields could be provided by using a field in the OFDS schema.' %}</li>
<li>{% trans 'Document the structure, format and meaning of additional fields in your' %}<a href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/guidance/publication.html#how-to-write-a-data-user-guide">{% trans 'data user guide' %}</a>.</li>
</ul>
<p>{% trans 'For more information, see ' %}<a href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/guidance/publication.html#how-to-add-additional-fields">{% trans 'how to add additional fields' %}</a>.</p>
{% include "libcoveweb2/additional_fields_table.html" %}
</div>
</div>
{% else %}
<div class="panel panel-success">
<div id="validation-panel" class="panel-heading pointer" role="region" aria-expanded="true" aria-controls="validationTable" data-toggle="collapse" data-target="#additionalFieldsTable">
<div class="panel panel-info">
<div id="additional-fields-panel" class="panel-heading pointer" role="region" aria-expanded="true" aria-controls="additionalFieldsTable" data-toggle="collapse" data-target="#additionalFieldsTable">
<h4 class="panel-title">
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Additional Fields' %}
</h4>
</div>
<div id="additionalFieldsTable" class="collapse in panel-body">
<p>{% trans 'There were no additional fields!' %}</p>
<p>{% trans 'Your data contains no additional fields. For more information, see ' %}<a href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/guidance/publication.html#how-to-add-additional-fields">{% trans 'how to add additional fields' %}</a>.</p>
</div>
</div>
{% endif %}
Expand All @@ -197,9 +188,10 @@ <h4 class="panel-title">
</div>
<div id="additionalChecksTable" class="collapse in panel-body">
{% if additional_checks_count %}
<p>{% trans 'Your data failed the following additional checks. You should check your mapping and data pipeline for errors.' %}</p>
{% include "cove_ofds/additional_checks_table.html" %}
{% else %}
<p>{% trans 'All checks passed!' %}</p>
<p>{% trans 'Your data passed all additional checks.' %}</p>
{% endif %}

</div>
Expand All @@ -223,19 +215,20 @@ <h4 class="panel-title">
</div>

<div class="row">
<div class="panel panel-success">
<div id="statistics-panel" class="panel-heading pointer" role="region" aria-expanded="true"
<div class="panel {% if can_download_geojson%}panel-success{% else %}panel-danger{% endif %}">
<div id="visualisation-panel" class="panel-heading pointer" role="region" aria-expanded="true"
aria-controls="validationTable" data-toggle="collapse" data-target="#mapVisualisation">
<h4 class="panel-title">
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Map' %}
<span class="glyphicon glyphicon-collapse-up"></span>{% trans 'Visualisation' %}
</h4>
</div>
<div id="mapVisualisation" class="collapse in panel-body">
{% if can_download_geojson %}
<p>{% trans 'The GeoJSON version of your data is visualised on the map below. You should check that nodes and spans appear in the correct location. If not, you may need to ' %}<a href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/guidance/publication.html#how-to-transform-coordinates-to-the-correct-coordinate-reference-system">{% trans 'transform your coordinates to the correct coordinate reference system' %}</a>.</p>
<div id="map" class="map" style="width: 100%; height: 600px;"></div>
{% else %}
<div>
<p>{% trans 'There are no GeoJSON files to visualise!' %}</p>
<p>{% trans 'Your data cannot be visualised because it is not available in GeoJSON format. For more information, see ' %}<a href="#download-panel">{% trans 'data conversion' %}</a>.</p>
</div>
{% endif %}
</div>
Expand Down

0 comments on commit 536a951

Please sign in to comment.