Skip to content

Commit c4d0dc4

Browse files
lisicaselisicase
authored
Improve page structure (#331)
* Updated headers hierarchy in documentation * Removed header status from link to skip to main content * Defined landmarks for main content and footer
1 parent a53694b commit c4d0dc4

19 files changed

+498
-500
lines changed

‎_includes/footer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<footer class="content-info" role="contentinfo">
22

3-
<div class="container" style=" text-align: center">
3+
<div class="container" style=" text-align: center" aria-label="content-info">
44
<p>&copy; 2015-{{ 'now' | date: "%Y" }} OData – The Protocol for REST APIs </p>
55
</div>
66

‎_includes/navbar.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<div role="banner">
22
<a class="sr-only sr-only-focusable" href="#main-content">
3-
<h4 role="presentation">Skip to main content</h4>
3+
<p role="presentation">Skip to main content</p>
44
</a>
55
<nav class="navbar navbar-default" role="navigation" aria-label="Main Navigation">
66
<div class="container container-fluid">

‎_layouts/default.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
<body data-spy="scroll" data-target="nav">
77

88
{% include navbar.html %}
9-
<div id="main-content">
9+
<main id="main-content">
1010
{{ content }}
11-
</div>
11+
</main>
1212
{% include scripts.html %}
1313

1414
</body>

‎pages/documentation/abnf.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
date: 2014-02-20 08:09:31.000000000 +08:00
55
permalink: /documentation/odata-version-3-0/abnf/
66
---
7-
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0.
7+
<p class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0.
88
<br><br>
9-
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
10-
<h1 id="abnfforodata">ABNF for OData</h1>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></p>
10+
<h2 id="abnfforodata">ABNF for OData</h2>
1111
<p>Current Revision: 4/27/2012</p>
1212
<p>The following Augmented BackusNaur Form (ABNF) details the construction rules for OData Uris that target OData services that follow the Uri Conventions specified in this document.<br />
1313
WSP = ; core to ABNF, see [RFC5234]</p>

‎pages/documentation/atom-format-v2.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
date: 2014-02-28 03:35:17.000000000 +08:00
55
permalink: /documentation/odata-version-2-0/atom-format/
66
---
7-
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0.
7+
<p class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0.
88
<br><br>
9-
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></p>
1010
<h2>Introduction</h2>
1111
<p>OData supports two formats for representing the resources (Collections, Entries, Links, etc) it exposes: the XML-based Atom format and the JSON format. This document describes how OData resources are represented in Atom (plus additional elements defined in AtomPub) and <a href="../json-format">[OData-JSON]</a> describes the JSON representation. The <a href="../operations#RepresentationFormatAndContentTypeNegotiation"> content type negotiation</a> section of the <a href="../operations">[OData-Operations]</a> document describes how clients can use standard HTTP content type negotiation to tell an OData service which format it wants to use.</p>
1212
<h2>1. Background</h2>

‎pages/documentation/atom-format-v3.html

Lines changed: 88 additions & 88 deletions
Large diffs are not rendered by default.

‎pages/documentation/batch-processing-v2.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
date: 2014-02-28 03:34:09.000000000 +08:00
55
permalink: /documentation/odata-version-2-0/batch-processing/
66
---
7-
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0.
7+
<p class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 2.0.
88
<br><br>
9-
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></p>
1010
<h2>Introduction</h2>
1111
<p>The OData protocol exposes a uniform service interface to operate on collections of structured and unstructured data. <a href="../operations">[OData-Operations]</a> enumerates the set of operations supported by the uniform interface and describes a means to send one operation per HTTP request.</p>
1212
<p>This document builds on the <a href="../operations">[OData-Operations]</a> document and describes how an OData implementation can optionally support executing multiple operations sent in a single HTTP request through the use of Batching. This document covers both how Batch operations are represented and processed.</p>

‎pages/documentation/batch-processing-v3.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
date: 2014-02-20 08:11:24.000000000 +08:00
55
permalink: /documentation/odata-version-3-0/batch-processing/
66
---
7-
<h5 class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0.
7+
<p class="alert alert-success">OData Version 4.0 is the current recommended version of OData. OData V4 has been standardized by OASIS and has many features not included in OData Version 3.0.
88
<br><br>
9-
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></h5>
9+
<a href="/documentation/" class="alert-link" title=""><span class="glyphicon glyphicon-arrow-right"></span> Go to OData Version 4.0</a></p>
1010
<h1 id="opendataprotocolodatabatchprocessing"></h1>
1111
<h1 id="introduction">1. Introduction</h1>
1212
<p>The OData protocol defines a way to query and manipulate data (described using an EDM model) using a simple set of operations. This document builds on the ‘Interaction Semantics’ section of the core OData specification document and describes how an OData implementation MAY support executing multiple operations sent in a single HTTP request through the use of Batching. This document covers both how Batch operations are represented and processed.</p>

0 commit comments

Comments
 (0)