mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-20 19:55:54 +00:00
Move/rename templates
This commit is contained in:
@@ -24,7 +24,8 @@ The XRPL Dev Portal provides comprehensive documentation of the the XRP Ledger,
|
|||||||
- [content/\_img-sources/](content/_img-sources/) - Source files for images used in the documentation. Any `.uxf` files are diagrams made with [Umlet](https://www.umlet.com/).
|
- [content/\_img-sources/](content/_img-sources/) - Source files for images used in the documentation. Any `.uxf` files are diagrams made with [Umlet](https://www.umlet.com/).
|
||||||
- [content/\_snippets/](content/_snippets/) - Reusable chunks of Markdown text that are included in other content files, using the Dactyl preprocessor.
|
- [content/\_snippets/](content/_snippets/) - Reusable chunks of Markdown text that are included in other content files, using the Dactyl preprocessor.
|
||||||
- [img/](img/) - Images used by the documentation contents.
|
- [img/](img/) - Images used by the documentation contents.
|
||||||
- [tool/](tool/) - Templates, style-checker rules, and other scripts.
|
- [template/](template/) - Template files for building the HTML outputs.
|
||||||
|
- [tool/](tool/) - Filters, style-checker rules, and other scripts.
|
||||||
- [styles/](styles/) - Source files (SCSS) to generate the CSS files in the assets folder.
|
- [styles/](styles/) - Source files (SCSS) to generate the CSS files in the assets folder.
|
||||||
- [`dactyl-config.yml`](dactyl-config.yml) - Main config file, which contains the metadata for all the docs. For information on our conventions, see [Config Formatting](#config-formatting).
|
- [`dactyl-config.yml`](dactyl-config.yml) - Main config file, which contains the metadata for all the docs. For information on our conventions, see [Config Formatting](#config-formatting).
|
||||||
|
|
||||||
@@ -87,7 +88,7 @@ The Markdown file itself should start with a frontmatter stanza such as the foll
|
|||||||
---
|
---
|
||||||
html: the-rippled-server.html
|
html: the-rippled-server.html
|
||||||
parent: concepts.html
|
parent: concepts.html
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
blurb: rippled is the core peer-to-peer server that manages the XRP Ledger. This section covers concepts that help you learn the "what" and "why" behind fundamental aspects of the rippled server.
|
blurb: rippled is the core peer-to-peer server that manages the XRP Ledger. This section covers concepts that help you learn the "what" and "why" behind fundamental aspects of the rippled server.
|
||||||
---
|
---
|
||||||
```
|
```
|
||||||
@@ -101,7 +102,7 @@ At a minimum, most pages should have `html`, `parent` and `blurb` fields (plus t
|
|||||||
| `parent` | String | The exact, unique `html` value of this page's "parent" page. Indicates where this page should appear in the navigation. |
|
| `parent` | String | The exact, unique `html` value of this page's "parent" page. Indicates where this page should appear in the navigation. |
|
||||||
| `blurb` | String | Human-readable summary of the page. (Plain text only.) Should be about 1 sentence long. This appears in various places, including landing pages and metadata used in unfurling links on social media. |
|
| `blurb` | String | Human-readable summary of the page. (Plain text only.) Should be about 1 sentence long. This appears in various places, including landing pages and metadata used in unfurling links on social media. |
|
||||||
| `name` | String | Human-readable page name. (Plain text only.) For files with Markdown content, you should omit this so that Dactyl can automatically detect it from a header on the first line of the contents instead. This is usually only provided on landing pages or other special pages with no Markdown source file. |
|
| `name` | String | Human-readable page name. (Plain text only.) For files with Markdown content, you should omit this so that Dactyl can automatically detect it from a header on the first line of the contents instead. This is usually only provided on landing pages or other special pages with no Markdown source file. |
|
||||||
| `template` | String | The filename of a template file to use (in the `tool/` directory) for this page. Most pages should use the default template. The `template-landing-children.html` page shows a list of child pages at the end. Pages with special or particularly unique layouts may need custom templates. |
|
| `template` | String | The filename of a template file to use (in the `template/` directory) for this page. Most pages should use the default template. The `pagetype-category.html.jinja` template shows a list of child pages at the end. Pages with special or particularly unique layouts may need individual templates (conventionally, starting with `page-`). |
|
||||||
| `status` | String | Use the value `not_enabled` on pages relating to an amendment that is not yet enabled on the XRP Ledger mainnet. This displays a "flask" badge with a tooltip next to the page in the navigation. |
|
| `status` | String | Use the value `not_enabled` on pages relating to an amendment that is not yet enabled on the XRP Ledger mainnet. This displays a "flask" badge with a tooltip next to the page in the navigation. |
|
||||||
| `nav_omit` | Boolean | Use `true` to cause this page not to appear in any navigation elements. |
|
| `nav_omit` | Boolean | Use `true` to cause this page not to appear in any navigation elements. |
|
||||||
| `top_nav_omit` | Boolean | Use `true` to cause this page not to appear in the page top dropdown navigation. |
|
| `top_nav_omit` | Boolean | Use `true` to cause this page not to appear in the page top dropdown navigation. |
|
||||||
@@ -109,7 +110,7 @@ At a minimum, most pages should have `html`, `parent` and `blurb` fields (plus t
|
|||||||
| `sidebar` | String | Use `disabled` to hide the left and right sidebars (if the page uses a template derived from the base template) |
|
| `sidebar` | String | Use `disabled` to hide the left and right sidebars (if the page uses a template derived from the base template) |
|
||||||
| `fb_card` | String | Filename of an image (in `assets/img/`) to use when unfurling links to this page on Facebook. |
|
| `fb_card` | String | Filename of an image (in `assets/img/`) to use when unfurling links to this page on Facebook. |
|
||||||
| `twitter_card` | String | Filename of an image (in `assets/img/`) to use when unfurling links to this page on Twitter. |
|
| `twitter_card` | String | Filename of an image (in `assets/img/`) to use when unfurling links to this page on Twitter. |
|
||||||
| `redirect_url` | String | Use with `template: template-redirect.html` only. Automatically redirect the user to the provided URL when they navigate to this page. |
|
| `redirect_url` | String | Use with `template: pagetype-redirect.html.jinja` only. Automatically redirect the user to the provided URL when they navigate to this page. |
|
||||||
| `cta_text` | String | Text to appear in "call to action" buttons that link to this page (on special landings). |
|
| `cta_text` | String | Text to appear in "call to action" buttons that link to this page (on special landings). |
|
||||||
| `curated_anchors` | Array of Objects | A set of anchors in this page to show, similar to child pages, in landings. Each object in the array should have a human-readable `name` field (such as `"Available Modes"`) and an `anchor` field with the HTML ID to link to (such as `"#available-modes"`). |
|
| `curated_anchors` | Array of Objects | A set of anchors in this page to show, similar to child pages, in landings. Each object in the array should have a human-readable `name` field (such as `"Available Modes"`) and an `anchor` field with the HTML ID to link to (such as `"#available-modes"`). |
|
||||||
| `skip_spell_checker` | Boolean | Use `true` to make the Dactyl's style checker skip spell-checking this page. |
|
| `skip_spell_checker` | Boolean | Use `true` to make the Dactyl's style checker skip spell-checking this page. |
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
html: the-rippled-server.html
|
html: the-rippled-server.html
|
||||||
parent: concepts.html
|
parent: concepts.html
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
blurb: rippled is the core peer-to-peer server that manages the XRP Ledger. This section covers concepts that help you learn the "what" and "why" behind fundamental aspects of the rippled server.
|
blurb: rippled is the core peer-to-peer server that manages the XRP Ledger. This section covers concepts that help you learn the "what" and "why" behind fundamental aspects of the rippled server.
|
||||||
labels:
|
labels:
|
||||||
- Core Server
|
- Core Server
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
html: ledger-object-types.html
|
html: ledger-object-types.html
|
||||||
parent: ledger-data-formats.html
|
parent: ledger-data-formats.html
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
labels:
|
labels:
|
||||||
- データ保持
|
- データ保持
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
html: ledger-object-types.html
|
html: ledger-object-types.html
|
||||||
parent: ledger-data-formats.html
|
parent: ledger-data-formats.html
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
labels:
|
labels:
|
||||||
- Data Retention
|
- Data Retention
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
html: pseudo-transaction-types.html
|
html: pseudo-transaction-types.html
|
||||||
parent: transaction-formats.html
|
parent: transaction-formats.html
|
||||||
blurb: バリデータがXRP Ledgerに適用する場合がある疑似トランザクションのフォーマットです。
|
blurb: バリデータがXRP Ledgerに適用する場合がある疑似トランザクションのフォーマットです。
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
labels:
|
labels:
|
||||||
- ブロックチェーン
|
- ブロックチェーン
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
html: pseudo-transaction-types.html
|
html: pseudo-transaction-types.html
|
||||||
parent: transaction-formats.html
|
parent: transaction-formats.html
|
||||||
blurb: Formats of pseudo-transactions that validators sometimes apply to the XRP Ledger.
|
blurb: Formats of pseudo-transactions that validators sometimes apply to the XRP Ledger.
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
labels:
|
labels:
|
||||||
- Blockchain
|
- Blockchain
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
html: transaction-formats.html
|
html: transaction-formats.html
|
||||||
parent: protocol-reference.html
|
parent: protocol-reference.html
|
||||||
blurb: トランザクションは、XRP Ledgerを変更する唯一の方法です。
|
blurb: トランザクションは、XRP Ledgerを変更する唯一の方法です。
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
---
|
---
|
||||||
# トランザクションのフォーマット
|
# トランザクションのフォーマット
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
html: transaction-formats.html
|
html: transaction-formats.html
|
||||||
parent: protocol-reference.html
|
parent: protocol-reference.html
|
||||||
blurb: Transactions are the only way to modify the XRP Ledger. Get details about their required format.
|
blurb: Transactions are the only way to modify the XRP Ledger. Get details about their required format.
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
---
|
---
|
||||||
# Transaction Reference
|
# Transaction Reference
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
html: transaction-types.html
|
html: transaction-types.html
|
||||||
parent: transaction-formats.html
|
parent: transaction-formats.html
|
||||||
blurb: トランザクションのタイプは、どういったタイプの操作を実行することが想定されているのかを示します。
|
blurb: トランザクションのタイプは、どういったタイプの操作を実行することが想定されているのかを示します。
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
labels:
|
labels:
|
||||||
- ブロックチェーン
|
- ブロックチェーン
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
html: transaction-types.html
|
html: transaction-types.html
|
||||||
parent: transaction-formats.html
|
parent: transaction-formats.html
|
||||||
blurb: All the different types of transactions that the XRP Ledger can process.
|
blurb: All the different types of transactions that the XRP Ledger can process.
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
labels:
|
labels:
|
||||||
- Blockchain
|
- Blockchain
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
html: api-conventions.html
|
html: api-conventions.html
|
||||||
parent: rippled-api.html
|
parent: rippled-api.html
|
||||||
blurb: rippled APIのデータ型とフォーマットについて説明します。
|
blurb: rippled APIのデータ型とフォーマットについて説明します。
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
---
|
---
|
||||||
# APIの規則
|
# APIの規則
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
html: api-conventions.html
|
html: api-conventions.html
|
||||||
parent: rippled-api.html
|
parent: rippled-api.html
|
||||||
blurb: Common conventions used across the XRP Ledger's HTTP APIs.
|
blurb: Common conventions used across the XRP Ledger's HTTP APIs.
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
---
|
---
|
||||||
# API Conventions
|
# API Conventions
|
||||||
|
|
||||||
|
|||||||
@@ -2,8 +2,8 @@
|
|||||||
html: xrp-api.html
|
html: xrp-api.html
|
||||||
parent: references.html
|
parent: references.html
|
||||||
blurb: An API server that provides a REST-like interface to the XRP Ledger.
|
blurb: An API server that provides a REST-like interface to the XRP Ledger.
|
||||||
template: template-redirect.html
|
template: pagetype-redirect.html.jinja
|
||||||
redirect_url: https://github.com/xpring-eng/xrp-api # Update to GH Pages ref if possible
|
redirect_url: https://xpring-eng.github.io/xrp-api/
|
||||||
nav_omit: true
|
nav_omit: true
|
||||||
filters:
|
filters:
|
||||||
- xrpapi_readme
|
- xrpapi_readme
|
||||||
|
|||||||
@@ -6,6 +6,8 @@ doc_type: Tutorials
|
|||||||
category: Get Started
|
category: Get Started
|
||||||
blurb: Build a simple Java app that interacts with the XRP Ledger.
|
blurb: Build a simple Java app that interacts with the XRP Ledger.
|
||||||
cta_text: Build an XRP Ledger-connected app
|
cta_text: Build an XRP Ledger-connected app
|
||||||
|
top_nav_name: JavaScript
|
||||||
|
top_nav_grouping: Get Started
|
||||||
filters:
|
filters:
|
||||||
- include_code
|
- include_code
|
||||||
labels:
|
labels:
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
---
|
---
|
||||||
html: get-started.html
|
html: get-started.html
|
||||||
parent: tutorials.html
|
parent: tutorials.html
|
||||||
template: template-doc.html
|
|
||||||
blurb: Get up and running with some of the resources you'll use to work with the XRP Ledger.
|
blurb: Get up and running with some of the resources you'll use to work with the XRP Ledger.
|
||||||
filters:
|
filters:
|
||||||
- js_editor
|
- js_editor
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
html: configure-peering.html
|
html: configure-peering.html
|
||||||
parent: manage-the-rippled-server.html
|
parent: manage-the-rippled-server.html
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
blurb: サーバーをピアツーピアネットワークに接続する方法を設定します。
|
blurb: サーバーをピアツーピアネットワークに接続する方法を設定します。
|
||||||
labels:
|
labels:
|
||||||
- コアサーバー
|
- コアサーバー
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
---
|
---
|
||||||
html: configure-peering.html
|
html: configure-peering.html
|
||||||
parent: manage-the-rippled-server.html
|
parent: manage-the-rippled-server.html
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
blurb: Configure how your server connects to the peer-to-peer network.
|
blurb: Configure how your server connects to the peer-to-peer network.
|
||||||
labels:
|
labels:
|
||||||
- Core Server
|
- Core Server
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
html: use-checks.html
|
html: use-checks.html
|
||||||
parent: use-specialized-payment-types.html
|
parent: use-specialized-payment-types.html
|
||||||
blurb: Checks in the XRP Ledger authorize another account to claim funds later, similar to how personal paper checks work.
|
blurb: Checks in the XRP Ledger authorize another account to claim funds later, similar to how personal paper checks work.
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
labels:
|
labels:
|
||||||
- Checks
|
- Checks
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
html: use-checks.html
|
html: use-checks.html
|
||||||
parent: use-specialized-payment-types.html
|
parent: use-specialized-payment-types.html
|
||||||
blurb: Checks in the XRP Ledger authorize another account to claim funds later, similar to how personal paper checks work.
|
blurb: Checks in the XRP Ledger authorize another account to claim funds later, similar to how personal paper checks work.
|
||||||
template: template-landing-children.html
|
template: pagetype-category.html.jinja
|
||||||
labels:
|
labels:
|
||||||
- Checks
|
- Checks
|
||||||
---
|
---
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
@@ -84,7 +84,7 @@
|
|||||||
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||||
<!-- End Google Tag Manager (noscript) -->
|
<!-- End Google Tag Manager (noscript) -->
|
||||||
|
|
||||||
{% include 'template-top-nav.html' %}
|
{% include 'component-top-nav.html.jinja' %}
|
||||||
|
|
||||||
<div class="container-fluid" role="document" id="main_content_wrapper">
|
<div class="container-fluid" role="document" id="main_content_wrapper">
|
||||||
<div class="row">
|
<div class="row">
|
||||||
@@ -110,14 +110,14 @@
|
|||||||
{% if docs_top.is_ancestor_of(currentpage.html) %}
|
{% if docs_top.is_ancestor_of(currentpage.html) %}
|
||||||
{% set tree_top = docs_top %}
|
{% set tree_top = docs_top %}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% include "tree-nav.html" %}
|
{% include "component-tree-nav.html.jinja" %}
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
</aside>
|
</aside>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
</div><!--/.row (main layout)-->
|
</div><!--/.row (main layout)-->
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
{% include 'template-footer.html' %}
|
{% include 'component-footer.html.jinja' %}
|
||||||
|
|
||||||
|
|
||||||
<!-- Non-blocking resources -->
|
<!-- Non-blocking resources -->
|
||||||
@@ -153,27 +153,6 @@ debug: false
|
|||||||
<script type="application/javascript" src="{{currentpage.prefix}}assets/js/interactive-tutorial.js"></script>
|
<script type="application/javascript" src="{{currentpage.prefix}}assets/js/interactive-tutorial.js"></script>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
<!-- Feedback Widget -->
|
|
||||||
<script src="{{currentpage.prefix}}assets/vendor/custom-widget.js"></script>
|
|
||||||
<div id="feedback-content"></div>
|
|
||||||
<script>
|
|
||||||
const widget = new EmbeddableWidget.default({
|
|
||||||
theme: 'xrpl',
|
|
||||||
opened: false,
|
|
||||||
parentElement: '#feedback-content',
|
|
||||||
currentPath: window.location.pathname,
|
|
||||||
adapter: 'ga',
|
|
||||||
app:'Feedback Widget',
|
|
||||||
adapterConfig:{
|
|
||||||
containerId:"GTM-THHW334",
|
|
||||||
trackingId:"UA-45576805-2"
|
|
||||||
}
|
|
||||||
});
|
|
||||||
setTimeout(() => {
|
|
||||||
widget.open();
|
|
||||||
// EmbeddableWidget.default.unmount();
|
|
||||||
}, 2000);
|
|
||||||
</script>
|
|
||||||
|
|
||||||
{% block endbody %}{% endblock %}
|
{% block endbody %}{% endblock %}
|
||||||
</body>
|
</body>
|
||||||
21
template/component-feedback-widget.html.jinja
Normal file
21
template/component-feedback-widget.html.jinja
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
<!-- Feedback Widget -->
|
||||||
|
<script src="{{currentpage.prefix}}assets/vendor/custom-widget.js"></script>
|
||||||
|
<div id="feedback-content"></div>
|
||||||
|
<script>
|
||||||
|
const widget = new EmbeddableWidget.default({
|
||||||
|
theme: 'xrpl',
|
||||||
|
opened: false,
|
||||||
|
parentElement: '#feedback-content',
|
||||||
|
currentPath: window.location.pathname,
|
||||||
|
adapter: 'ga',
|
||||||
|
app:'Feedback Widget',
|
||||||
|
adapterConfig:{
|
||||||
|
containerId:"GTM-THHW334",
|
||||||
|
trackingId:"UA-45576805-2"
|
||||||
|
}
|
||||||
|
});
|
||||||
|
setTimeout(() => {
|
||||||
|
widget.open();
|
||||||
|
// EmbeddableWidget.default.unmount();
|
||||||
|
}, 2000);
|
||||||
|
</script>
|
||||||
69
template/component-top-nav.html.jinja
Normal file
69
template/component-top-nav.html.jinja
Normal file
@@ -0,0 +1,69 @@
|
|||||||
|
<div class="container-fluid">
|
||||||
|
<nav class="top-nav navbar navbar-expand-lg navbar-dark row">
|
||||||
|
<a href="{% if target.prefix %}{{target.prefix}}{% else %}/{% endif %}" class="navbar-brand"><img src="{{currentpage.prefix}}assets/img/XRPLedger_DevPortal-white.svg" class="logo" height="44" alt="{{target.display_name}}" /></a>
|
||||||
|
<button class="navbar-toggler collapsed" type="button" data-toggle="collapse" data-target="#navbarHolder" aria-controls="navbarHolder" aria-expanded="false" aria-label="Toggle navigation">
|
||||||
|
<span class="navbar-toggler-icon"></span>
|
||||||
|
</button>
|
||||||
|
<div class="collapse navbar-collapse justify-content-center" id="navbarHolder">
|
||||||
|
<ul class="nav navbar-nav">
|
||||||
|
{% macro dropdown(top_page) %}
|
||||||
|
{% set printed_groupings = [] %}
|
||||||
|
{% if top_page.children|selectattr('top_nav_omit', 'undefined_or_ne', True)|list|length %}
|
||||||
|
<li class="nav-item dropdown">
|
||||||
|
<a class="nav-link dropdown-toggle" href="#" id="topnav_{{top_page.html}}" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">{% if top_page.top_nav_name is defined %}{{top_page.top_nav_name}}{% else %}{{top_page.name}}{% endif %}</a>
|
||||||
|
<div class="top-nav-dropdown dropdown-menu" aria-labelledby="topnav_{{top_page.html}}"><div class="row">
|
||||||
|
<!-- TODO: link for the parent page here, handle non -->
|
||||||
|
{% for link in top_page.children if not link.top_nav_omit %}
|
||||||
|
{% if link.top_nav_grouping is defined and link.top_nav_grouping not in printed_groupings %}
|
||||||
|
<h5>{{link.top_nav_grouping}}</h5>
|
||||||
|
{% set _ = printed_groupings.append(link.top_nav_grouping) %}
|
||||||
|
{% endif %}
|
||||||
|
<a class="dropdown-item {% if currentpage == link %} active{% endif %}" href="{{link.html}}">{% if link.top_nav_name is defined %}{{link.top_nav_name}}{% else %}{{link.name}}{% endif %}</a>
|
||||||
|
{% endfor %}
|
||||||
|
</div></div>
|
||||||
|
</li>
|
||||||
|
{% elif not top_page.top_nav_omit %}
|
||||||
|
<li class="nav-item">
|
||||||
|
<a class="nav-link" href="{{top_page.html}}">{{top_page.name}}</a>
|
||||||
|
</li>
|
||||||
|
{% endif %}
|
||||||
|
{% endmacro %}
|
||||||
|
|
||||||
|
{% for page in (pages|first).children %}
|
||||||
|
{{ dropdown(page) }}
|
||||||
|
{% endfor %}
|
||||||
|
|
||||||
|
{% include 'component-github-edit.html.jinja' %}
|
||||||
|
|
||||||
|
<li class="nav-item" id="navbar-search">
|
||||||
|
<form class="navbar-form navbar-right" role="search">
|
||||||
|
<div class="form-inline">
|
||||||
|
<div class="input-group">
|
||||||
|
<label class="input-group-prepend" for="topsearchbar"><i class="fa fa-search input-group-text"></i><span class="sr-only">{% trans %}Search site...{% endtrans %}</span></label>
|
||||||
|
<input id="topsearchbox" name="q" type="text" class="form-control" placeholder="{% trans %}Search site...{% endtrans %}">
|
||||||
|
<div class="input-group-append d-none d-lg-flex">
|
||||||
|
<button type="button" class="btn btn-default" data-toggle="dropdown" data-target="topnav-search-dropdown-toggle"><i class="fa fa-times"></i><span class="sr-only">{% trans %}Close Search{% endtrans %}</span></button>
|
||||||
|
</div>
|
||||||
|
</div><!--/.input-group-->
|
||||||
|
</div>
|
||||||
|
</form>
|
||||||
|
</li><!--/#navbar-search-->
|
||||||
|
|
||||||
|
|
||||||
|
</ul><!-- /.navbar-nav -->
|
||||||
|
|
||||||
|
<div class="nav navbar-nav language-selector">
|
||||||
|
<div class="dropdown">
|
||||||
|
<a class="nav-link dropdown-toggle with-caret" id="language_selector_header_btn" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
||||||
|
{{(config.languages|selectattr('code', 'eq', target.lang)|first).display_name}}
|
||||||
|
</a>
|
||||||
|
<div class="dropdown-menu smaller-dropdown" aria-labelledby="language_selector_header_btn">
|
||||||
|
{% for lang in config.languages %}
|
||||||
|
<a class="dropdown-item" href="{{lang.prefix}}{{currentpage.html}}">{{lang.display_name}}</a>
|
||||||
|
{% endfor %}
|
||||||
|
</div><!--/.dropdown-menu-->
|
||||||
|
</div><!--/.dropdown-->
|
||||||
|
</div><!--/.language-selector-->
|
||||||
|
</div><!--/#navbarHolder-->
|
||||||
|
</nav>
|
||||||
|
</div>
|
||||||
@@ -13,18 +13,18 @@
|
|||||||
<div class="nav-item {% if currentpage == pg %}active{% elif active_parent%}active-parent{% endif %}">
|
<div class="nav-item {% if currentpage == pg %}active{% elif active_parent%}active-parent{% endif %}">
|
||||||
{% if not pg.children %}
|
{% if not pg.children %}
|
||||||
{% if "//" in pg.html %}
|
{% if "//" in pg.html %}
|
||||||
<a class="nav-link nav-leaf external-link" target="_blank" href="{% if "//" not in pg.html %}{{currentpage.prefix}}{% endif %}{{pg.html}}">{{ pg.name }}{% if pg.status is defined %} {% include 'template-status_'+pg.status+'.html' %}{% endif %} <i aria-hidden="true" class="fa fa-external-link"></i></a>
|
<a class="nav-link nav-leaf external-link" target="_blank" href="{% if "//" not in pg.html %}{{currentpage.prefix}}{% endif %}{{pg.html}}">{{ pg.name }}{% if pg.status is defined %} {% include 'component-status_'+pg.status+'.html.jinja' %}{% endif %} <i aria-hidden="true" class="fa fa-external-link"></i></a>
|
||||||
{% else %}
|
{% else %}
|
||||||
<a class="nav-link nav-leaf" href="{% if "//" not in pg.html %}{{currentpage.prefix}}{% endif %}{{pg.html}}">{{ pg.name }}{% if pg.status is defined %} {% include 'template-status_'+pg.status+'.html' %}{% endif %}</a>
|
<a class="nav-link nav-leaf" href="{% if "//" not in pg.html %}{{currentpage.prefix}}{% endif %}{{pg.html}}">{{ pg.name }}{% if pg.status is defined %} {% include 'component-status_'+pg.status+'.html.jinja' %}{% endif %}</a>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{% else %}
|
{% else %}
|
||||||
|
|
||||||
<a class="nav-toggler {% if not active_parent and currentpage != pg %}collapsed{% endif %}" role="button" data-toggle="collapse" href="#tree_nav_group_{{n}}" aria-expanded="{% if active_parent or currentpage == pg %}true{% else %}false{% endif %}" aria-controls="tree_nav_group_{{n}}"></a>
|
<a class="nav-toggler {% if not active_parent and currentpage != pg %}collapsed{% endif %}" role="button" data-toggle="collapse" href="#tree_nav_group_{{n}}" aria-expanded="{% if active_parent or currentpage == pg %}true{% else %}false{% endif %}" aria-controls="tree_nav_group_{{n}}"></a>
|
||||||
|
|
||||||
{% if "//" in pg.html %}
|
{% if "//" in pg.html %}
|
||||||
<a class="nav-link external-link" target="_blank" href="{% if "//" not in pg.html %}{{currentpage.prefix}}{% endif %}{{pg.html}}">{{ pg.name }}{% if pg.status is defined %} {% include 'template-status_'+pg.status+'.html' %}{% endif %} <i aria-hidden="true" class="fa fa-external-link"></i></a>
|
<a class="nav-link external-link" target="_blank" href="{% if "//" not in pg.html %}{{currentpage.prefix}}{% endif %}{{pg.html}}">{{ pg.name }}{% if pg.status is defined %} {% include 'component-status_'+pg.status+'.html.jinja' %}{% endif %} <i aria-hidden="true" class="fa fa-external-link"></i></a>
|
||||||
{% else %}
|
{% else %}
|
||||||
<a class="nav-link" href="{% if "//" not in pg.html %}{{currentpage.prefix}}{% endif %}{{pg.html}}">{{ pg.name }}{% if pg.status is defined %} {% include 'template-status_'+pg.status+'.html' %}{% endif %}</a>
|
<a class="nav-link" href="{% if "//" not in pg.html %}{{currentpage.prefix}}{% endif %}{{pg.html}}">{{ pg.name }}{% if pg.status is defined %} {% include 'component-status_'+pg.status+'.html.jinja' %}{% endif %}</a>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
<nav class="nav flex-column {% if active_parent or pg == currentpage %}show {% else %}collapse{% endif %}" id="tree_nav_group_{{n}}">
|
<nav class="nav flex-column {% if active_parent or pg == currentpage %}show {% else %}collapse{% endif %}" id="tree_nav_group_{{n}}">
|
||||||
@@ -40,7 +40,7 @@
|
|||||||
|
|
||||||
<nav class="nav flex-column dactyl-tree-nav">
|
<nav class="nav flex-column dactyl-tree-nav">
|
||||||
<div class="nav-item nav-parent">
|
<div class="nav-item nav-parent">
|
||||||
<a class="nav-link" href="{% if "//" not in tree_top.html %}{{currentpage.prefix}}{% endif %}{{tree_top.html}}">{{tree_top.name}}{% if tree_top.status is defined %} {% include 'template-status_'+tree_top.status+'.html' %}{% endif %}</a>
|
<a class="nav-link" href="{% if "//" not in tree_top.html %}{{currentpage.prefix}}{% endif %}{{tree_top.html}}">{{tree_top.name}}{% if tree_top.status is defined %} {% include 'component-status_'+tree_top.status+'.html.jinja' %}{% endif %}</a>
|
||||||
</div>
|
</div>
|
||||||
{% for child in tree_top.children %}
|
{% for child in tree_top.children %}
|
||||||
{{ page_w_children(child, loop.index) }}
|
{{ page_w_children(child, loop.index) }}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block main %}
|
{% block main %}
|
||||||
<article class="pt-3 p-md-3">
|
<article class="pt-3 p-md-3">
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block main %}
|
{% block main %}
|
||||||
<section class="content">
|
<section class="content">
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block mainclasses %}landing padded-landing page-docs-index{% endblock %}
|
{% block mainclasses %}landing padded-landing page-docs-index{% endblock %}
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block mainclasses %}landing padded-landing{% endblock %}
|
{% block mainclasses %}landing padded-landing{% endblock %}
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block bodyclasses %}rpc-tool{% endblock %}
|
{% block bodyclasses %}rpc-tool{% endblock %}
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block main %}
|
{% block main %}
|
||||||
<section class="container-fluid p-3">
|
<section class="container-fluid p-3">
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block bodyclasses %}page-tx-sender{% endblock %}
|
{% block bodyclasses %}page-tx-sender{% endblock %}
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block main %}
|
{% block main %}
|
||||||
<section class="container-fluid p-3">
|
<section class="container-fluid p-3">
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block right_sidebar %}
|
{% block right_sidebar %}
|
||||||
<div class="command-list-wrapper">
|
<div class="command-list-wrapper">
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block bodyclasses %}page-test-net{% endblock %}
|
{% block bodyclasses %}page-test-net{% endblock %}
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block mainclasses %}landing landing-children padded-main{% endblock %}
|
{% block mainclasses %}landing landing-children padded-main{% endblock %}
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
|
|
||||||
@@ -31,7 +31,7 @@
|
|||||||
|
|
||||||
{% block right_sidebar %}
|
{% block right_sidebar %}
|
||||||
<div id="page-toc-wrapper">
|
<div id="page-toc-wrapper">
|
||||||
{% include 'template-label-list.html' %}
|
{% include 'component-label-list.html.jinja' %}
|
||||||
<div class="toc-header">
|
<div class="toc-header">
|
||||||
<h4>{% trans %}In this document{% endtrans %}</h4>
|
<h4>{% trans %}In this document{% endtrans %}</h4>
|
||||||
</div>
|
</div>
|
||||||
@@ -47,4 +47,6 @@
|
|||||||
<script type="application/javascript">
|
<script type="application/javascript">
|
||||||
gtag('config', 'UA-157720658-3', {'content_group1': 'Content Docs'});
|
gtag('config', 'UA-157720658-3', {'content_group1': 'Content Docs'});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
|
{% include 'component-feedback-widget.html.jinja' %}
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
|
|
||||||
{% block mainclasses %}landing landing-children padded-main{% endblock %}
|
{% block mainclasses %}landing landing-children padded-main{% endblock %}
|
||||||
|
|
||||||
@@ -31,3 +31,11 @@
|
|||||||
{% endfor %}
|
{% endfor %}
|
||||||
</section>
|
</section>
|
||||||
{% endblock %}
|
{% endblock %}
|
||||||
|
|
||||||
|
{% block endbody %}
|
||||||
|
<script type="application/javascript">
|
||||||
|
gtag('config', 'UA-157720658-3', {'content_group1': 'Hub Pages'});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
{% include 'component-feedback-widget.html.jinja' %}
|
||||||
|
{% endblock %}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
{% extends "template-base.html" %}
|
{% extends "base.html.jinja" %}
|
||||||
{% block head %}
|
{% block head %}
|
||||||
|
|
||||||
<meta http-equiv="refresh" content="0;url={{currentpage.redirect_url}}" />
|
<meta http-equiv="refresh" content="0;url={{currentpage.redirect_url}}" />
|
||||||
@@ -11,9 +11,8 @@
|
|||||||
import os.path
|
import os.path
|
||||||
|
|
||||||
STATUSES = {
|
STATUSES = {
|
||||||
":not_enabled:": "template-status_not_enabled.html",
|
":not_enabled:": "component-status_not_enabled.html.jinja",
|
||||||
":enabled:": "template-status_enabled.html",
|
":removed:": "component-status_removed.html.jinja",
|
||||||
":removed:": "template-status_removed.html",
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,28 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
# meant to be run from the root directory of the repo
|
|
||||||
|
|
||||||
## Show pull request data in build results
|
|
||||||
echo "ghprbAuthorRepoGitUrl is: " ${ghprbAuthorRepoGitUrl}
|
|
||||||
echo "ghprbSourceBranch is: " ${ghprbSourceBranch}
|
|
||||||
echo "ghprbPullId is: " ${ghprbPullId}
|
|
||||||
|
|
||||||
gitForkWithoutSuffix=${ghprbAuthorRepoGitUrl%.git}
|
|
||||||
|
|
||||||
if [ -n "$ghprbPullId" ];
|
|
||||||
then
|
|
||||||
echo '{"github_forkurl": "'"$gitForkWithoutSuffix"'", "github_branch": "'"$ghprbSourceBranch"'", "github_pr_id": "'"$ghprbPullId"'", "is_pr_build": true}' > pr_vars.json
|
|
||||||
dactyl_vars="pr_vars.json"
|
|
||||||
else
|
|
||||||
dactyl_vars=""
|
|
||||||
fi
|
|
||||||
|
|
||||||
set -e
|
|
||||||
|
|
||||||
tool/conflictmarkers.sh
|
|
||||||
|
|
||||||
## Remove output directory if it exists (so the build is clean)
|
|
||||||
rm -rf out
|
|
||||||
## Build all languages, then run the link checker once
|
|
||||||
tool/build_all_langs.sh --vars "$dactyl_vars"
|
|
||||||
dactyl_link_checker -q
|
|
||||||
@@ -1,64 +0,0 @@
|
|||||||
# {{title}}
|
|
||||||
|
|
||||||
{{description}}
|
|
||||||
|
|
||||||
**Warning:** {{spec.info.title}} is early alpha software. API methods and data formats are likely to change often in ways that break backwards compatibility.
|
|
||||||
|
|
||||||
{% if type is defined %}- **Type:** {{type|title}}
|
|
||||||
{% elif oneOf is defined %}- **Possible Types:**
|
|
||||||
{% for option in oneOf -%}
|
|
||||||
{% if option.enum is defined %}
|
|
||||||
- One of the following {% if option.type is defined %}{{option.type|title}}s{% else %}values{% endif %}:
|
|
||||||
{% for suboption in option.enum %}
|
|
||||||
- `{{suboption}}`
|
|
||||||
{% endfor -%}
|
|
||||||
{% else %}
|
|
||||||
- {{option.type|title}}
|
|
||||||
{% endif -%}
|
|
||||||
{% endfor -%}
|
|
||||||
{% elif anyOf is defined %}- **Possible Types:**
|
|
||||||
{% for option in anyOf -%}
|
|
||||||
{% if option.enum is defined %}
|
|
||||||
- Any of the following {% if option.type is defined %}{{option.type|title}}s{% else %}values{% endif %}:
|
|
||||||
{% for suboption in option.enum %}
|
|
||||||
- `{{suboption}}`
|
|
||||||
{% endfor -%}
|
|
||||||
{% else %}
|
|
||||||
- {{option.type|title}}
|
|
||||||
{% endif -%}
|
|
||||||
{% endfor -%}
|
|
||||||
{% elif allOf is defined %}- **Possible Types:**
|
|
||||||
{% for option in allOf -%}
|
|
||||||
{% if option.enum is defined %}
|
|
||||||
- Must qualify as all of the following {% if option.type is defined %}{{option.type|title}}s{% else %}values{% endif %}:
|
|
||||||
{% for suboption in option.enum %}
|
|
||||||
- `{{suboption}}`
|
|
||||||
{% endfor -%}
|
|
||||||
{% else %}
|
|
||||||
- {{option.type|title}}
|
|
||||||
{% endif -%}
|
|
||||||
{% endfor -%}
|
|
||||||
{% endif -%}
|
|
||||||
{% if enum is defined %}- **Possible Values:**
|
|
||||||
{% for option in enum %}
|
|
||||||
- `{{option}}`
|
|
||||||
{% endfor %}{% endif %}
|
|
||||||
{% if pattern is defined %}- **Pattern:** `{{pattern}}`
|
|
||||||
{% endif -%}
|
|
||||||
{% if example is defined %}- **Example:** `{{example}}`
|
|
||||||
{% endif -%}
|
|
||||||
|
|
||||||
{% if properties is defined %}
|
|
||||||
This type can contain the following fields:
|
|
||||||
|
|
||||||
| Field | Type | Required? | Description |
|
|
||||||
|-------|------|-----------|-------------|
|
|
||||||
{%- for name,field in properties.items() %}
|
|
||||||
| `{{name}}` | {{field.type|title}}{% if "items" in field.keys() and "title" in field["items"].keys() %} of [{{field["items"].title}}]({{type_link(field["items"].title)}}){% endif %} {% if field["title"] is defined %}([{{field.title}}]({{type_link(field.title)}})){% endif %} | {{"Required" if name in required else "Optional"}} | {{field.description}} |
|
|
||||||
{%- endfor %}
|
|
||||||
|
|
||||||
{% if additionalProperties is defined and additionalProperties == True %}This type MUST NOT contain any additional fields.{% endif %}
|
|
||||||
|
|
||||||
{% elif type == "array" and items is defined %}
|
|
||||||
Each member of the array is a ***TODO*** {{items}}
|
|
||||||
{% endif %}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
# {{api_title}} Data Types
|
|
||||||
|
|
||||||
**Warning:** {{spec.info.title}} is early alpha software. API methods and data formats are likely to change often, in ways that break backwards compatibility.
|
|
||||||
|
|
||||||
The following data types are defined for this API:
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
|------|------|-------------|
|
|
||||||
{%- for key,schema in schemas %}
|
|
||||||
| `{{schema.title}}` | {{schema.type|title}}{% if "items" in schema.keys() and "title" in schema["items"].keys() %} of [{{schema["items"].title}}]({{type_link(schema["items"].title)}}){% endif %} {% if schema["title"] is defined %}([{{schema.title}}]({{type_link(schema.title)}})){% endif %} | {% if schema.description is defined %}{{schema.description}}{% endif %} |
|
|
||||||
{%- endfor %}
|
|
||||||
@@ -1,107 +0,0 @@
|
|||||||
# {{summary}}
|
|
||||||
|
|
||||||
{{description}}
|
|
||||||
|
|
||||||
**Warning:** {{spec.info.title}} is early alpha software. API methods and data formats are likely to change often in ways that break backwards compatibility.
|
|
||||||
|
|
||||||
## Request Format
|
|
||||||
|
|
||||||
```
|
|
||||||
{{method|upper}} {{path}}
|
|
||||||
{%- if method in ["post","put","delete"] and requestBody is defined %}
|
|
||||||
|
|
||||||
{{ x_example_request_body }}
|
|
||||||
{% endif %}
|
|
||||||
```
|
|
||||||
|
|
||||||
{% if path_params|length %}
|
|
||||||
This API method uses the following path parameters:
|
|
||||||
|
|
||||||
| Field | Value | Required? | Description |
|
|
||||||
|---|---|---|---|
|
|
||||||
{%- for param in path_params %}
|
|
||||||
| `{{param.name}}` | {% if param.schema is defined %}{% if param.schema.oneOf is defined %}(Varies){% else %}{{param.schema.type|title}}{% endif %} {% if param.schema["title"] is defined %}([{{param.schema.title}}]({{type_link(param.schema.title)}})){% endif %}{% else %}(Unspecified){% endif %} | {{"Required" if param.required else "Optional"}} | {{param.description}} |
|
|
||||||
{%- endfor %}
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% if query_params|length %}
|
|
||||||
This API method uses the following query parameters:
|
|
||||||
|
|
||||||
| Field | Value | Required? | Description |
|
|
||||||
|---|---|---|---|
|
|
||||||
{%- for param in query_params %}
|
|
||||||
| `{{param.name}}` | {% if param.schema is defined %}{% if param.schema.oneOf is defined %}(Varies){% else %}{{param.schema.type|title}}{% if "items" in param.schema.keys() and "title" in param.schema["items"].keys() %} of [{{param.schema["items"].title}}]({{type_link(param.schema["items"].title)}}){% endif %}{% endif %} {% if param.schema["title"] is defined %}([{{param.schema.title}}]({{type_link(param.schema.title)}})){% endif %}{% else %}(Unspecified){% endif %} | {{"Required" if param.required else "Optional"}} | {{param.description}} |
|
|
||||||
{%- endfor %}
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% if requestBody is defined %}
|
|
||||||
{{requestBody.description}}
|
|
||||||
|
|
||||||
{% if requestBody.content is defined %}
|
|
||||||
|
|
||||||
{% for mediatype,thisbody in requestBody.content.items() %}
|
|
||||||
{% if thisbody.schema is defined %}
|
|
||||||
**Media type:** {{mediatype|replace("*","\*")}}
|
|
||||||
|
|
||||||
{% if thisbody.schema.title is defined %}
|
|
||||||
Formatted as a [{{thisbody.schema.title}}]({{type_link(thisbody.schema.title)}})
|
|
||||||
{% endif %}
|
|
||||||
{% if thisbody.schema.properties is defined %}
|
|
||||||
The request uses the following fields:
|
|
||||||
|
|
||||||
| Field | Type | Required? | Description |
|
|
||||||
|-------|------|-----------|-------------|
|
|
||||||
{%- for name,field in thisbody.schema.properties.items() %}
|
|
||||||
| `{{name}}` | {{field.type|title}}{% if "items" in field.keys() and "title" in field["items"].keys() %} of [{{field["items"].title}}]({{type_link(field["items"].title)}}){% endif %} {% if field["title"] is defined %}([{{field.title}}]({{type_link(field.title)}})){% endif %} | {{"Required" if name in required else "May be omitted"}} | {% if field.description is defined %}{{field.description}}{% endif %} |
|
|
||||||
{%- endfor %}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
{% endif %}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
## Response Formats
|
|
||||||
|
|
||||||
{% for response_code, response in responses.items() %}
|
|
||||||
### {{response_code}} {{HTTP_STATUS_CODES[response_code]}}
|
|
||||||
|
|
||||||
{{ response.description}}
|
|
||||||
|
|
||||||
{% if response.content is defined %}
|
|
||||||
{% for mediatype,thisbody in response.content.items() %}
|
|
||||||
{% if thisbody.schema is defined %}
|
|
||||||
**Media type:** {{mediatype|replace("*","\*")}}
|
|
||||||
|
|
||||||
{% if thisbody.schema.title is defined %}
|
|
||||||
Formatted as a [{{thisbody.schema.title}}]({{type_link(thisbody.schema.title)}})
|
|
||||||
{% endif %}
|
|
||||||
{% if thisbody.schema.properties is defined %}
|
|
||||||
The response uses the following fields:
|
|
||||||
|
|
||||||
| Field | Type | Required? | Description |
|
|
||||||
|-------|------|-----------|-------------|
|
|
||||||
{%- for name,field in thisbody.schema.properties.items() %}
|
|
||||||
| `{{name}}` | {{field.type|title}}{% if "items" in field.keys() and "title" in field["items"].keys() %} of [{{field["items"].title}}]({{type_link(field["items"].title)}}){% endif %} {% if field["title"] is defined %}([{{field.title}}]({{type_link(field.title)}})){% endif %} | {{"Required" if name in required else "May be omitted"}} | {% if field.description is defined %}{{field.description}}{% endif %} |
|
|
||||||
{%- endfor %}
|
|
||||||
{% endif %}{# TODO: handle allOf, etc. #}
|
|
||||||
|
|
||||||
{% if thisbody.examples is defined and thisbody.examples|length > 0 %}
|
|
||||||
#### Example Response(s)
|
|
||||||
|
|
||||||
{% for body_name,body_sample in thisbody.examples %}
|
|
||||||
_{{body_name}}_
|
|
||||||
|
|
||||||
```
|
|
||||||
{{body_sample|pprint}}
|
|
||||||
```
|
|
||||||
{% endfor %}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# {{info.title}} {{info.version}} {{tag.name|title}} Methods
|
|
||||||
|
|
||||||
{{tag.description}}
|
|
||||||
|
|
||||||
**Warning:** {{info.title}} is early alpha software. API methods and data formats are likely to change often in ways that break backwards compatibility.
|
|
||||||
|
|
||||||
| Summary | Path |
|
|
||||||
|:--------|:-----|
|
|
||||||
{%- set reflinks = [] -%}
|
|
||||||
{%- for path,method,endpoint in endpoints_by_tag(tag.name) %}
|
|
||||||
{%- set _ = reflinks.append("["+endpoint.summary+"]: "+method_link(path, method, endpoint) ) %}
|
|
||||||
| [{{endpoint.summary}}][] | [`{{method|upper}} {{path}}`][{{endpoint.summary}}] |
|
|
||||||
{%- endfor %}
|
|
||||||
|
|
||||||
{% for reflink in reflinks -%}
|
|
||||||
{{reflink}}
|
|
||||||
{% endfor %}
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
# {{info.title}} {{info.version}} Methods
|
|
||||||
|
|
||||||
{{info.description}}
|
|
||||||
|
|
||||||
**Warning:** {{spec.info.title}} is early alpha software. API methods and data formats are likely to change often in ways that break backwards compatibility.
|
|
||||||
|
|
||||||
{% if tags %}
|
|
||||||
View API methods by category:
|
|
||||||
|
|
||||||
{% for tag in tags %}
|
|
||||||
- [{{tag.name|title}} Methods](#{{slugify(tag.name)|lower}}-methods)
|
|
||||||
{% endfor %}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% for tag in tags %}
|
|
||||||
{% if endpoints_by_tag(tag.name)|list|length %}
|
|
||||||
## {{tag.name|title}} Methods
|
|
||||||
|
|
||||||
{{tag.description}}
|
|
||||||
|
|
||||||
| Summary | Path |
|
|
||||||
|:--------|:-----|
|
|
||||||
{%- set reflinks = [] -%}
|
|
||||||
{%- for path,method,endpoint in endpoints_by_tag(tag.name) %}
|
|
||||||
{%- set _ = reflinks.append("["+endpoint.summary+"]: "+method_link(path, method, endpoint) ) %}
|
|
||||||
| [{{endpoint.summary}}][] | [`{{method|upper}} {{path}}`][{{endpoint.summary}}] |
|
|
||||||
{%- endfor %}
|
|
||||||
|
|
||||||
{% for reflink in reflinks -%}
|
|
||||||
{{reflink}}
|
|
||||||
{% endfor %}
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
|
|
||||||
{% if endpoints_by_tag("Uncategorized")|list|length %}
|
|
||||||
## Uncategorized Methods
|
|
||||||
|
|
||||||
| Name | Path | Summary |
|
|
||||||
|:-----|:-----|:--------|
|
|
||||||
{%- set reflinks = [] -%}
|
|
||||||
{%- for path,method,endpoint in endpoints_by_tag("Uncategorized") %}
|
|
||||||
{%- set _ = reflinks.append("["+endpoint.operationId+"]: "+method_link(path, method, endpoint) ) %}
|
|
||||||
| [{{endpoint.operationId}}][] | [`{{method|upper}} {{path}}`][{{endpoint.operationId}}] | {{endpoint.summary}} |
|
|
||||||
{%- endfor %}
|
|
||||||
|
|
||||||
{% for reflink in reflinks -%}
|
|
||||||
{{reflink}}
|
|
||||||
{% endfor %}
|
|
||||||
|
|
||||||
{% endif %}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head></head>
|
|
||||||
<body>
|
|
||||||
<center>
|
|
||||||
<h1>Ripple Developer Resources</h1>
|
|
||||||
<p>(PDF format is experimental only)</p>
|
|
||||||
<img class="large_logo" src="assets/img/ripple_logo_large.png">
|
|
||||||
</center>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
{% extends "template-base.html" %}
|
|
||||||
|
|
||||||
{% block right_sidebar %}
|
|
||||||
<div class="command-list-wrapper">
|
|
||||||
<div class="toc-header">
|
|
||||||
<h4>API Methods</h4>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<ul class="command-list" id='command_list'>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
{% endblock %}
|
|
||||||
|
|
||||||
{% block main %}
|
|
||||||
<section class="container-fluid pt-3 p-md-3">
|
|
||||||
<div id='command_wrapper'>
|
|
||||||
<div id='command_table'>
|
|
||||||
<div id='io_wrapper'>
|
|
||||||
<div id='input' class='io'>
|
|
||||||
<h2>REST Request</h2>
|
|
||||||
<div id='test_warning' class='devportal-callout warning d-none'>
|
|
||||||
<strong>Test accounts only!</strong>
|
|
||||||
<p>Never submit account secrets to a server you do not control, unless you are prepared to lose ownership of the account!</p>
|
|
||||||
</div>
|
|
||||||
<div style="clear:both;"></div>
|
|
||||||
<h3 id='selected_command' title='Reference information'></h3>
|
|
||||||
<p id='description'></p>
|
|
||||||
<div id="invalid" class="devportal-callout warning d-none">
|
|
||||||
<strong>Error</strong>
|
|
||||||
Invalid JSON
|
|
||||||
</div>
|
|
||||||
<div id='rest_url_wrapper'>
|
|
||||||
<p><span id='rest_host'>{{ currentpage.rest_host }}</span><span id='rest_url'></span></p>
|
|
||||||
</div>
|
|
||||||
<div id='request_body'></div>
|
|
||||||
<div id='request_options'>
|
|
||||||
<a class="btn btn-primary api my-2" id='request_button'>Send request</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div id='output' class='io'>
|
|
||||||
<h2>Response</h2>
|
|
||||||
<div>
|
|
||||||
<img class="throbber d-none" src="assets/img/xrp-loader-96.png" />
|
|
||||||
<span id='rest_responsecode'></span>
|
|
||||||
</div>
|
|
||||||
<div id='response_body'></div>
|
|
||||||
<div id='tooltip'></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
{% endblock %}
|
|
||||||
{% block endbody %}
|
|
||||||
<script type='text/javascript'>
|
|
||||||
// Set some constants for the REST tool script
|
|
||||||
var URL_BASE = '{{ currentpage.rest_host }}';
|
|
||||||
var DOC_BASE = '{{ currentpage.doc_page }}';
|
|
||||||
</script>
|
|
||||||
<script type='text/javascript' src='assets/vendor/codemirror-js-json-lint.min.js'></script>
|
|
||||||
<script type='text/javascript' src='assets/vendor/cm-javascript.min.js'></script>
|
|
||||||
<script type='text/javascript' src='assets/js/jquery.autosize.input.min.js'></script>
|
|
||||||
<script type='text/javascript' src='assets/js/apitool-rest.js'></script>
|
|
||||||
<script type='text/javascript' src='assets/{{ currentpage.methods_js }}'></script>
|
|
||||||
|
|
||||||
<script type="application/javascript">
|
|
||||||
gtag('config', 'UA-157720658-3', {'content_group1': 'API Tools'});
|
|
||||||
</script>
|
|
||||||
{% endblock %}
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
<span class="status enabled" title="This feature is enabled on the production XRP Ledger as the result of an amendment."><i class="fa fa-flag"></i></span>
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
<div class="container-fluid">
|
|
||||||
<nav class="top-nav navbar navbar-expand-lg navbar-dark row">
|
|
||||||
<a href="{% if target.prefix %}{{target.prefix}}{% else %}/{% endif %}" class="navbar-brand"><img src="{{currentpage.prefix}}assets/img/XRPLedger_DevPortal-white.svg" class="logo" height="44" alt="{{target.display_name}}" /></a>
|
|
||||||
<button class="navbar-toggler collapsed" type="button" data-toggle="collapse" data-target="#navbarHolder" aria-controls="navbarHolder" aria-expanded="false" aria-label="Toggle navigation">
|
|
||||||
<span class="navbar-toggler-icon"></span>
|
|
||||||
</button>
|
|
||||||
<div class="collapse navbar-collapse justify-content-end" id="navbarHolder">
|
|
||||||
<ul class="nav navbar-nav">
|
|
||||||
{% macro dropdown(top_page) %}
|
|
||||||
{% if top_page.children|selectattr('top_nav_omit', 'undefined_or_ne', True)|list|length %}
|
|
||||||
<li class="nav-item dropdown">
|
|
||||||
<a class="nav-link dropdown-toggle" href="#" id="topnav_{{top_page.html}}" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">{{top_page.name}}</a>
|
|
||||||
<div class="dropdown-menu" aria-labelledby="topnav_{{top_page.html}}">
|
|
||||||
{% if not top_page.top_nav_omit %}<a class="dropdown-item top-level-1{% if currentpage == top_page %} active{% endif %}" href="{{top_page.html}}">{% if top_page.top_nav_name is defined %}{{top_page.top_nav_name}}{% else %}{{top_page.name}}{% endif %}</a>{% endif %}
|
|
||||||
{% for link in top_page.children %}
|
|
||||||
{% if not link.top_nav_omit %}
|
|
||||||
<a class="dropdown-item {% if link.top_nav_level is undefined %}top-level-1{% else %}top-level-{{link.top_nav_level}}{% endif %}{% if currentpage == link %} active{% endif %}" href="{{link.html}}">{% if link.top_nav_name is defined %}{{link.top_nav_name}}{% else %}{{link.name}}{% endif %}</a>
|
|
||||||
{% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
</div>
|
|
||||||
</li>
|
|
||||||
{% elif not top_page.top_nav_omit %}
|
|
||||||
<li class="nav-item">
|
|
||||||
<a class="nav-link" href="{{top_page.html}}">{{top_page.name}}</a>
|
|
||||||
</li>
|
|
||||||
{% endif %}
|
|
||||||
{% endmacro %}
|
|
||||||
|
|
||||||
{% for page in (pages|first).children %}
|
|
||||||
{{ dropdown(page) }}
|
|
||||||
{% endfor %}
|
|
||||||
|
|
||||||
{% include 'template-github-edit.html' %}
|
|
||||||
|
|
||||||
<li class="nav-item dropdown" id="navbar-search">
|
|
||||||
<a class="nav-link dropdown-toggle" data-toggle="dropdown" id="topnav-search-dropdown-toggle"><i class="fa fa-search"></i><span class="sr-only">{% trans %}Open Search{% endtrans %}</span></a>
|
|
||||||
<div class="dropdown-menu">
|
|
||||||
<form class="navbar-form navbar-right" role="search">
|
|
||||||
<div class="form-inline">
|
|
||||||
<div class="input-group">
|
|
||||||
<label class="input-group-prepend" for="topsearchbar"><i class="fa fa-search input-group-text"></i><span class="sr-only">{% trans %}Search site...{% endtrans %}</span></label>
|
|
||||||
<input id="topsearchbox" name="q" type="text" class="form-control" placeholder="{% trans %}Search site...{% endtrans %}">
|
|
||||||
<div class="input-group-append d-none d-lg-flex">
|
|
||||||
<button type="button" class="btn btn-default" data-toggle="dropdown" data-target="topnav-search-dropdown-toggle"><i class="fa fa-times"></i><span class="sr-only">{% trans %}Close Search{% endtrans %}</span></button>
|
|
||||||
</div>
|
|
||||||
</div><!--/.input-group-->
|
|
||||||
</div>
|
|
||||||
</form>
|
|
||||||
</div><!--/.dropdown-menu-->
|
|
||||||
</li><!--/.dropdown-->
|
|
||||||
|
|
||||||
<li class="nav-item wrap-button">
|
|
||||||
<a class="btn btn-outline-secondary nav-link" href="get-started.html">{% trans %}Get Started{% endtrans %}</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
</ul><!-- /.navbar-nav -->
|
|
||||||
|
|
||||||
<div class="nav navbar-nav language-selector">
|
|
||||||
<div class="dropdown">
|
|
||||||
<a class="nav-link dropdown-toggle with-caret" id="language_selector_header_btn" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
|
|
||||||
{{(config.languages|selectattr('code', 'eq', target.lang)|first).display_name}}
|
|
||||||
</a>
|
|
||||||
<div class="dropdown-menu smaller-dropdown" aria-labelledby="language_selector_header_btn">
|
|
||||||
{% for lang in config.languages %}
|
|
||||||
<a class="dropdown-item" href="{{lang.prefix}}{{currentpage.html}}">{{lang.display_name}}</a>
|
|
||||||
{% endfor %}
|
|
||||||
</div><!--/.dropdown-menu-->
|
|
||||||
</div><!--/.dropdown-->
|
|
||||||
</div><!--/.language-selector-->
|
|
||||||
</div><!--/#navbarHolder-->
|
|
||||||
</nav>
|
|
||||||
</div>
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
{% extends "template-base.html" %}
|
|
||||||
|
|
||||||
{% block main %}
|
|
||||||
<article class="use-case pt-3 p-md-3">
|
|
||||||
<div class="content">
|
|
||||||
{{ content }}
|
|
||||||
</div>
|
|
||||||
</article>
|
|
||||||
{% endblock %}
|
|
||||||
|
|
||||||
{% block right_sidebar %}
|
|
||||||
<div class="card" id="use-case-related">
|
|
||||||
<div class="card-header">
|
|
||||||
<h4>Useful Background</h4>
|
|
||||||
</div>
|
|
||||||
<div class="card-body">
|
|
||||||
<div class="curated-links">
|
|
||||||
<ul>
|
|
||||||
{% for link in currentpage.useful_background %}
|
|
||||||
{% set linkpage = pages|selectattr("html", 'defined_and_equalto', link)|first %}
|
|
||||||
<li><a href="{{linkpage.html}}">{{linkpage.name}}</a></li>
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
</div><!--/.curated-links-->
|
|
||||||
</div><!--/.card-body-->
|
|
||||||
</div>
|
|
||||||
{% endblock %}
|
|
||||||
|
|
||||||
{% block endbody %}
|
|
||||||
<script type="application/javascript">
|
|
||||||
gtag('config', 'UA-157720658-3', {'content_group1': 'Use Cases'});
|
|
||||||
</script>
|
|
||||||
{% endblock %}
|
|
||||||
Reference in New Issue
Block a user