EIPs/_layouts/eip.html
Alex Beregszaszi 1bfcf0c138
Add description field to the EIP header (#3706)
* Add description field to the EIP header

* Update 2718

* Move description rendering to below the title

* Remove the simple summary from the template

This has been removed from EIP-1 on 15-09-2019 in the PR https://github.com/ethereum/EIPs/pull/2186.

* Update title/description/abstract with new recommendation

* Mention length limit of description
2021-08-18 07:05:10 +08:00

101 lines
4.6 KiB
HTML

---
layout: default
---
{% if page.status == "Draft" %}
<div class="draft">
⚠️ This EIP is not recommended for general use or implementation as it is likely to change.
</div>
{% elsif page.status == "Review" %}
<div class="review">
📖 This EIP is in the review stage. It is subject to changes and feedback is appreciated.
</div>
{% elsif page.status == "Last Call" %}
<div class="lastcall">
📢 This EIP is in the last call for review stage. The authors wish to finalize the EIP and appreciate feedback.
</div>
{% elsif page.status == "Stagnant" %}
<div class="stagnant">
🚧 This EIP had no activity for at least 6 months.
</div>
{% elsif page.status == "Withdrawn" %}
<div class="withdrawn">
🛑 This EIP has been withdrawn.
</div>
{% endif %}
<div class="home">
<h1 class="page-heading">
EIP-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }}
<a href="{{site.github.repository_url}}/blob/master/{{page.path}}"><svg role="img" aria-label="Source" xmlns="https://www.w3.org/2000/svg" width="14" height="16" viewBox="0 0 14 16"><title>Source</title><path fill-rule="evenodd" d="M9.5 3L8 4.5 11.5 8 8 11.5 9.5 13 14 8 9.5 3zm-5 0L0 8l4.5 5L6 11.5 2.5 8 6 4.5 4.5 3z"/></svg></a>
</h1>
<h3>{{ page.description | xml_escape }}</h3>
<table>
<tr><th>Author</th><td>{% include authorlist.html authors=page.author %}</td></tr>
{% if page["discussions-to"] != undefined %}
<tr><th>Discussions-To</th><td><a href="{{ page["discussions-to"] | uri_escape }}">{{ page["discussions-to"] | xml_escape }}</a></td></tr>
{% endif %}
<tr><th>Status</th><td>{{ page.status | xml_escape }}
{% if page.review-period-end != undefined %}
<tr><th>Review period ends</th><td>{{ page.review-period-end | xml_escape }}</td></tr>
{% endif %}
</td></tr>
<tr><th>Type</th><td>{{ page.type | xml_escape }}</td></tr>
{% if page.category != undefined %}
<tr><th>Category</th><td>{{ page.category | xml_escape }}</td></tr>
{% endif %}
<tr><th>Created</th><td>{{ page.created | xml_escape }}</td></tr>
{% if page.updated != undefined %}
<tr><th>Updated</th><td>{{ page.updated | xml_escape }}</td></tr>
{% endif %}
{% if page.requires != undefined %}
<tr><th>Requires</th><td>{% include eipnums.html eips=page.requires %}</td></tr>
{% endif %}
{% if page.replaces != undefined %}
<tr><th>Replaces</th><td>{% include eipnums.html eips=page.replaces %}</td></tr>
{% endif %}
{% if page["superseded-by"] != undefined %}
<tr><th>Superseded by</th><td>{% include eipnums.html eips=page.superseded-by %}</td></tr>
{% endif %}
{% if page.resolution != undefined %}
<tr><th>Resolution</th><td><a href="{{page.resolution | uri_escape }}">{{ page.resolution | xml_escape }}</a></td></tr>
{% endif %}
</table>
<div class="toc">
<h2>Table of Contents</h2>
{% include toc.html html=content sanitize=true h_max=3 %}
</div>
{% include anchor_headings.html html=content anchorClass="anchor-link" beforeHeading=true %}
<h2>Citation</h2>
<p>Please cite this document as:</p>
{% comment %}
IEEE specification for reference formatting:
https://ieee-dataport.org/sites/default/files/analysis/27/IEEE%20Citation%20Guidelines.pdf
{% endcomment %}
<p>{% include authorlist.html authors=page.author %}, "EIP-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status == "Last Call" %} [DRAFT]{% endif %}," <em>Ethereum Improvement Proposals</em>, no. {{ page.eip | xml_escape }}, {{ page.created | date: "%B %Y" }}. [Online serial]. Available: https://eips.ethereum.org/EIPS/eip-{{ page.eip | xml_escape }}.</p>
</div>
{% comment %}
Article schema specification:
https://schema.org/TechArticle
{% endcomment %}
<script type="application/ld+json">
{
"@context": "http://schema.org",
"@type": "TechArticle",
"headline": "EIP-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status == "Last Call" %} [DRAFT]{% endif %}",
"author": "{{ page.author }}",
"name": "EIP-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status == "Draft" or page.status == "Last Call" %} [DRAFT]{% endif %}",
"dateCreated": "{{ page.created | date: "%Y-%m-%d" }}",
"datePublished": "{{ page.created | date: "%Y-%m-%d" }}",
{% if page["discussions-to"] != undefined %}
"discussionUrl": "{{ page["discussions-to"] | uri_escape }}",
{% endif %}
"inLanguage": "en-US",
"license": "#copyright",
"copyrightYear": "{{ page.created | date: "%Y" }}"
}
</script>