opensearch-docs-cn/_layouts/default.html

258 lines
12 KiB
HTML
Raw Normal View History

2021-05-05 13:09:47 -04:00
---
layout: table_wrappers
---
<!DOCTYPE html>
<html lang="{{ site.lang | default: 'en-US' }}">
{% include head.html %}
<body>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-link" viewBox="0 0 24 24">
<title>Link</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
<path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
</svg>
</symbol>
<symbol id="svg-search" viewBox="0 0 24 24">
<title>Search</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
<circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-doc" viewBox="0 0 24 24">
<title>Document</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
<path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
</svg>
</symbol>
<symbol id="svg-grid" viewBox="0 0 24 24">
<title>Documentation Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather feather-grid">
<rect x="3" y="3" width="7" height="7"></rect><rect x="14" y="3" width="7" height="7"></rect><rect x="14" y="14" width="7" height="7"></rect><rect x="3" y="14" width="7" height="7"></rect>
</svg>
</symbol>
2021-05-05 13:09:47 -04:00
</svg>
{% include header.html %}
<main>
<div id="main-header"></div>
<div class="side-bar">
<div class="site-header">
<a href="/docs/latest/" id="menu-button" class="site-button">
Documentation <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-grid"></use></svg>
</a>
</div>
<nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
<div class="version-wrapper">
{% if page.section == "opensearch" %}
<a href="{{site.url}}{{site.baseurl}}/about/" class="site-category">{{ page.section-name }}</a>
{% else %}
<a href="{{site.url}}{{site.baseurl}}/{{ page.section}}/" class="site-category">{{ page.section-name }}</a>
{% endif %}
<a href="{{site.url}}/docs/latest/" class="back-link">&#x2190; Back to docs home</a>
{% if page.section == "opensearch" %}
<version-selector selected="{{ site.data.versions.current }}"></version-selector>
{% endif %}
</div>
{% assign pages_top_size = site.html_pages
| where_exp:"item", "item.title != nil"
| where_exp:"item", "item.parent == nil"
| where_exp:"item", "item.nav_exclude != true"
| size %}
{% if pages_top_size > 0 %}
{% include nav.html pages=site.html_pages key=nil expanded=true %}
{% endif %}
{% if page.section == "opensearch" %}
{% assign section = site.opensearch_collection.collections %}
{% elsif page.section == "data-prepper" %}
{% assign section = site.data_prepper_collection.collections %}
{% elsif page.section == "clients" %}
{% assign section = site.clients_collection.collections %}
{% elsif page.section == "benchmark" %}
{% assign section = site.benchmark_collection.collections %}
{% endif %}
{% if section %}
{% assign collections_size = section | size %}
{% for collection_entry in section %}
{% assign collection_key = collection_entry[0] %}
{% assign collection_value = collection_entry[1] %}
{% assign collection = site[collection_key] %}
{% if collection_value.nav_exclude != true %}
{% assign owned_tree_id = collection_key | append: "_" | append: forloop.index | append: "_navitems" | replace: " ", "_" %}
{% if collections_size > 1 or pages_top_size > 0 %}
{% if collection_value.nav_fold == true %}
<ul
role="tree"
class="nav-list nav-category-list"
>
<li role="none" class="nav-list-item{% if page.collection == collection_key %} active{% endif %}">
{% assign collection_url_path = collection_key | append: "/" %}
{% assign category_comparison_url = "/" | append: collection_url_path %}
{%- if collection.size > 0 -%}
Toc keyboard navigation (#4497) * Adds keyboard navigation to table of content links Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds table of contents scroll and item focus management to the current page or the first toc item Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Add space key capture to the toc expand/collapse arrows Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds escape key support for expand/collapse of toc categories on the category label Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds missing aria-role and aria-current attributes to toc affordances Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Changes the function of the space bar to navigate to a toc parent category item instead of only expand its children Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds arrow up/down key support to toc navigation Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds missing accessibility attribute handling to the toc Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects arrow key handling of keyboard navigation of the toc Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds padding to allow for the keyboard focus rectangle Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes explicit tabindex values for the toc navigation Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes auto focus of toc navigation items on page load; refactors navigation panel scroll into view logic to account for the sticky version selector Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes keyboard focus trap on search field for the tab key Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Unifies navigation item focus state for top level items and sub navigation items Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes the expand/collapse navigation buttons from being tab focusable Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects navigation item spacing to permit visible focus rectangles Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Implements full arrow navigation for the toc items according to the w3c tree view navigation pattern Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds reference link to the w3c documentation about the tree view navigation to the arrow key toc navigation javascript Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Account for the difference between the navigation panel height, and the viewport height when auto scrolling the toc item of the current page Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects keyboard navigation focus rectangles from being slightly obscured on the bottom Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects aria and role attributes according to the navigation tree pattern as opposed to the disclosure pattern Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects Jekyll include parameter assignment syntax error Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes aria-expanded setting from the templates since it is unrealiable to determine without iterating through the entire tree to determine if one of its children of children is the current page Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Moves setting of aria-expanded attributes to a runtime behavior, and corrects arrow left/right behavior on navigation tree items Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Ensures unique navigation menu element ids; conditionally sets aira-owns and aria-current attributes Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes JavaScript that is unused following refactoring tree view navigation; adds comments explaining choices Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> --------- Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>
2023-07-17 13:11:42 -04:00
<a
role="treeitem"
aria-owns="{{ owned_tree_id }}"
aria-current="{% if page.collection == collection_key %}page{% endif %}"
href="#"
class="nav-list-expander"
><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
{%- endif -%}
<a
role="treeitem"
aria-owns="{{ owned_tree_id }}"
aria-current="{% if page.collection == collection_key %}page{% endif %}"
class="nav-category{% if category_comparison_url == page.url %} active{% endif %}"
href="{{ collection_url_path | relative_url }}"
>{{ collection_value.name }}</a>
{% include nav.html pages=collection key=collection_key owned_tree_id=owned_tree_id %}
</li>
</ul>
{% else %}
{% assign collection_url_path = collection_key | append: "/" %}
<a
role="treeitem"
aria-owns="{{ owned_tree_id }}"
aria-current="{% if page.collection == collection_key %}page{% endif %}"
class="nav-category{% if category_comparison_url == page.url %} active{% endif %}"
href="{{ collection_url_path | relative_url }}"
>{{ collection_value.name }}</a>
Toc keyboard navigation (#4497) * Adds keyboard navigation to table of content links Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds table of contents scroll and item focus management to the current page or the first toc item Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Add space key capture to the toc expand/collapse arrows Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds escape key support for expand/collapse of toc categories on the category label Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds missing aria-role and aria-current attributes to toc affordances Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Changes the function of the space bar to navigate to a toc parent category item instead of only expand its children Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds arrow up/down key support to toc navigation Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds missing accessibility attribute handling to the toc Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects arrow key handling of keyboard navigation of the toc Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds padding to allow for the keyboard focus rectangle Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes explicit tabindex values for the toc navigation Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes auto focus of toc navigation items on page load; refactors navigation panel scroll into view logic to account for the sticky version selector Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes keyboard focus trap on search field for the tab key Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Unifies navigation item focus state for top level items and sub navigation items Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes the expand/collapse navigation buttons from being tab focusable Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects navigation item spacing to permit visible focus rectangles Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Implements full arrow navigation for the toc items according to the w3c tree view navigation pattern Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds reference link to the w3c documentation about the tree view navigation to the arrow key toc navigation javascript Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Account for the difference between the navigation panel height, and the viewport height when auto scrolling the toc item of the current page Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects keyboard navigation focus rectangles from being slightly obscured on the bottom Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects aria and role attributes according to the navigation tree pattern as opposed to the disclosure pattern Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects Jekyll include parameter assignment syntax error Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes aria-expanded setting from the templates since it is unrealiable to determine without iterating through the entire tree to determine if one of its children of children is the current page Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Moves setting of aria-expanded attributes to a runtime behavior, and corrects arrow left/right behavior on navigation tree items Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Ensures unique navigation menu element ids; conditionally sets aira-owns and aria-current attributes Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes JavaScript that is unused following refactoring tree view navigation; adds comments explaining choices Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> --------- Signed-off-by: Aaron Stephanus <taoist.futility@pm.me>
2023-07-17 13:11:42 -04:00
{% include nav.html pages=collection key=collection_key owned_tree_id=owned_tree_id %}
{% endif %}
{% else %}
{% include nav.html pages=collection key=collection_key owned_tree_id=owned_tree_id %}
2021-05-28 13:48:19 -04:00
{% endif %}
Redesigned top nav and footer (#5113) * Ports over redesigned top banner header navigation, and footer Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds style overrides for search functionality Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds Font Awesome for menu icons Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds style overrides and updated menu item configurations Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds whitespace to fix SASS style rule causing Github action failure Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds dynamic navigation submenu height determination for smooth expand/collapse transitions instead of hardcoded values potentiating effortless change management Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes outdated message about old version release Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects padding, positioning, typography for the site footer Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds new footer logo Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Sets footer legal copy right padding on mobile to that of the scroll-to-top button Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds footer link styles Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adjusts page layout to fit the new container width requirements Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Fixes mobile layout with new header and footer Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Fixes mobile navigation menu errors Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adjusts padding Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes commented out code Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Updates top navigation menu items with latest from project site Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> --------- Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> Signed-off-by: astephanus <124592019+astephanus@users.noreply.github.com>
2023-11-07 18:17:05 -05:00
{% endif %}
{% endfor %}
{% endif %}
</nav>
</div>
<div class="main">
<div id="main-content-wrap" class="main-content-wrap">
{% unless page.url == "/" %}
{% if page.parent %}
<nav aria-label="Breadcrumb" class="breadcrumb-nav">
<ol class="breadcrumb-nav-list">
{% if page.grand_parent %}
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.grand_parent }}</a></li>
<li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.parent }}</a></li>
{% else %}
<li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.parent }}</a></li>
{% endif %}
<li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
</ol>
</nav>
{% endif %}
{% endunless %}
<div id="main-content" class="main-content" role="main">
{% if site.heading_anchors != false %}
{% include vendor/anchor_headings.html html=content beforeHeading="true" anchorBody="<svg viewBox=\"0 0 16 16\" aria-hidden=\"true\"><use xlink:href=\"#svg-link\"></use></svg>" anchorClass="anchor-heading" anchorAttrs="aria-labelledby=\"%html_id%\"" %}
{% else %}
{{ content }}
{% endif %}
<a class="top-link" href="#top">
<svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg>
</a>
2021-05-05 13:09:47 -04:00
{% if page.has_children == true and page.has_toc != false %}
<hr>
<h2>Related articles</h2>
<ul>
{% for child in toc_list %}
<li>
<a href="{{ child.url | absolute_url }}">{{ child.title }}</a>{% if child.summary %} - {{ child.summary }}{% endif %}
</li>
{% endfor %}
</ul>
{% endif %}
{% capture footer_custom %}
{%- include footer_custom.html -%}
{% endcapture %}
{% if footer_custom != "" or site.last_edit_timestamp or site.gh_edit_link %}
<hr>
<footer>
{% if site.back_to_top %}
<p><a href="#top" id="back-to-top">{{ site.back_to_top_text }}</a></p>
{% endif %}
2021-05-05 13:09:47 -04:00
{{ footer_custom }}
2021-05-05 13:09:47 -04:00
{% if site.last_edit_timestamp or site.gh_edit_link %}
<div class="d-flex mt-2">
{% if site.last_edit_timestamp and site.last_edit_time_format and page.last_modified_date %}
<p class="text-small text-grey-dk-000 mb-0 mr-2">
Page last modified: <span class="d-inline-block">{{ page.last_modified_date | date: site.last_edit_time_format }}</span>.
</p>
{% endif %}
{% if
site.gh_edit_link and
site.gh_edit_link_text and
site.gh_edit_repository and
site.gh_edit_branch and
site.gh_edit_view_mode
%}
<p class="text-small text-grey-dk-000 mb-0">
<a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}{% if site.gh_edit_source %}/{{ site.gh_edit_source }}{% endif %}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
</p>
{% endif %}
</div>
{% endif %}
</footer>
{% endif %}
2021-05-05 13:09:47 -04:00
</div>
</div>
<div class="toc-wrap">
<div class="sticky-wrap">
<div class="toc">
{% include toc.html html=content h_min=2 h_max=3 class="toc-list" item_class="toc-item" sanitize=true %}
</div>
{% include feedback.html %}
</div>
Redesigned top nav and footer (#5113) * Ports over redesigned top banner header navigation, and footer Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds style overrides for search functionality Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds Font Awesome for menu icons Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds style overrides and updated menu item configurations Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds whitespace to fix SASS style rule causing Github action failure Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds dynamic navigation submenu height determination for smooth expand/collapse transitions instead of hardcoded values potentiating effortless change management Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes outdated message about old version release Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Corrects padding, positioning, typography for the site footer Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds new footer logo Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Sets footer legal copy right padding on mobile to that of the scroll-to-top button Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adds footer link styles Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adjusts page layout to fit the new container width requirements Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Fixes mobile layout with new header and footer Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Fixes mobile navigation menu errors Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Adjusts padding Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Removes commented out code Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> * Updates top navigation menu items with latest from project site Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> --------- Signed-off-by: Aaron Stephanus <taoist.futility@pm.me> Signed-off-by: astephanus <124592019+astephanus@users.noreply.github.com>
2023-11-07 18:17:05 -05:00
</div>
{% if site.search_enabled != false %}
{% if site.search.button %}
<a href="#" id="search-button" class="search-button">
<svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-search"></use></svg>
</a>
{% endif %}
{% endif %}
</div>
</main>
2021-05-05 13:09:47 -04:00
{% include footer.html %}
2021-05-05 13:09:47 -04:00
{% if site.anchor_links != nil %}
<script>
anchors.add().remove('.subfooter h1, .subfooter h2');
2021-05-05 13:09:47 -04:00
</script>
{% endif %}
{% if site.search_enabled == false and site.use_custom_search == true %}
<script src="{{ '/assets/js/search.js' | relative_url }}"></script>
{% endif %}
<script src="{{ '/assets/js/copy-button.js' | relative_url }}"></script>
<script src="{{ '/assets/js/nav-scroll.js' | relative_url }}"></script>
<script src="{{ '/assets/js/listener.js' | relative_url }}"></script>
2021-05-05 13:09:47 -04:00
</body>
</html>