Preferred citation format #2738

fulldecent · 2020-06-18T03:05:03Z

For anybody that took the time to publish an EIP, and then well-known authors are citing your work as "EIP-xxx. The Ethereum Editors. 2017.," this PR is for you!

This PR provides a recommended citation text for each EIP. It is based on the IEEE citation format.

Also, this includes full data for the semantic web for scrapers. (The original Web 3.0, ahem.)

And all conformances are documented to authoritative sources.

Enjoy!

fulldecent · 2020-06-18T03:05:11Z

Label: META

MicahZoltu · 2020-07-17T02:35:24Z

Is it possible to review these changes in rendered form?

lightclient · 2020-07-17T05:04:03Z

You should be able to by installing Jekyll and the running bundle exec jekyll serve.

MicahZoltu · 2020-07-17T07:08:53Z

Bleh, that would require me to not only clone this repository, but also install Ruby. 😢

fulldecent · 2020-07-17T13:32:33Z

If you have commit access here I'll make screenshots

lightclient · 2020-07-17T14:32:12Z

but also install Ruby

😰

MicahZoltu · 2020-07-17T14:36:08Z

Meh, I'll see it when the merge goes through. If it breaks everything I'm rolling back though!

That being said, this being a meta change rather than an EIP I would prefer to get input from other editors first. I don't do research citations so this change is fine with me mostly because I don't care. If all of the other editors feel the same then I'll merge it.

MicahZoltu · 2020-07-17T14:37:22Z

Fastest way to get this through is probably to get it on the next EIP meeting agenda. Seems getting agreement on meta changes outside of that is hard.

axic · 2020-07-17T16:55:57Z

_layouts/eip.html

+    "discussionUrl": "{{ page["discussions-to"] | uri_escape }}",
+{% endif %}    
+    "inLanguage": "en-US",
+    "license": "https://creativecommons.org/publicdomain/zero/1.0/",


While it is the recommended one for EIPs, I think this should be a copy of the license section of each EIP. Is it possible to omit this field to facilitate a quick merge?

While it is the recommended one for EIPs

Not just recommended, required. Currently, all EIPs MUST be CC0 (which is why I indicated in that other thread that merging a GPL EIP would require winning holy war to get EIP-1 changed).

@axic please advise if this fixes the issue or if I should remove it for faster merge.

We can always merge then add stuff later, not a big deal.

Ok, it says "must be in public domain", so CC0 or any other statement of public domain is valid. However, that line was added to EIP-1 after a bunch of EIPs were merged lacking a license statement, see #2062.

I think conceptually this PR is doing two things, so would prefer to deal with it separately, especially as there might be more discussion points around the schema.

To be clear this is what the current EIP-1 states:

Copyright Waiver - All EIPs must be in the public domain. See the bottom of this EIP for an example copyright waiver.

It does not say it must be CC0, so using CC0 in the license line in my opinion is not 100% correct.

Great point. Due to an underspecification on schema.org, I have found that linking to the other part of the page is legal. Maybe it shouldn't be. That's their fault.

Fixed in 0f70b6b

Is this agreeable?

axic · 2020-07-17T16:56:25Z

_layouts/eip.html

+    "@context": "http://schema.org",
+    "@type": "Article",
+    "author": "{% include authorlist.html authors=page.author %}",
+    "name": "EIP-{{ page.eip | xml_escape }}: {{ page.title | xml_escape }}{% if page.status != "Final" %} [DRAFT]{% endif %}",


I think this is misleading because it would treat superseded EIPs as drafts too.

Good point. Fixed at c99546e

axic · 2020-07-17T16:56:42Z

_layouts/eip.html

+{% if page["discussions-to"] != undefined %}
+    "discussionUrl": "{{ page["discussions-to"] | uri_escape }}",
+{% endif %}    
+    "inLanguage": "en-US",


This should be also mandated in EIP-1.

That language be English?

I agree. But I'm hoping to get this PR merged this year so I avoided touching EIP-1. I hope this PR is mergeable as-is and then updates to EIP-1 can be considered separately and next.

axic · 2020-07-17T17:01:24Z

_layouts/eip.html

+Article schema specification:
+https://schema.org/Article
+{% endcomment %}
+<script type="application/ld+json">


I think actually this PR should be split into two PRs: the citation addendum above and this JSON schema. They serve two different purposes.

There was some discussion about the JSON schema arguing which is the best one, but I can't seem to find the discussion unfortunately.

I still haven't found the discussion, just that I had a local branch adding TechArticle.

Also _includes/head.html already contains a jsonld section so it would be in conflict with this one.

Can you just pull the jsonld part out to a different conversation? Or perhaps pull out the citation into a new one, given we discussed jsonld here.

This is in the current header:

<script type="application/ld+json"> { "@type": "WebSite", "url": "{{site.url}}", "name": "{{site.title}}", "description": "{{site.description}}", "@context": "https://schema.org" } </script>

This was my incomplete version:

<script type="application/ld+json"> { "@context": "https://schema.org", "@type": "TechArticle", "url": "{{site.url}}", "name": "{{page.title | jsonify}}", "description": "{{site.description | jsonify}}", "headline": "", "articleBody": "", "datePublished": "", "author": { "@type": "Person", "name": "" }, "publisher": { "@type": "Organization", "name": "Ethereum Improvement Proposals (EIPs)", "logo": { "@type": "imageObject", "url": "http://example.com/images/logo.png" } }, "image": { "@type": "imageObject", "url": "http://example.com/images/image.png" } </script>

Removed JSON-LD at fc1ecca

don't see any controversy left here. good to merge?

MicahZoltu · 2020-07-18T03:01:17Z

I still recommend bringing it up at the EIP meeting. I'm pretty reluctant to merge meta changes without broader discussion among the editors and that seems to be the best way to achieve that.

MicahZoltu · 2020-07-18T03:03:19Z

_layouts/eip.html

+  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>


CI seems to be unhappy with this:

{% if page.status == "Draft" or page.status = "Last Call" %}

Thank you, corrected at 34d4dd6

fulldecent · 2020-07-18T19:00:22Z

EIPIP is not authoritative and does not have decision makers. Therefore it is ineffectual and that is why I left.

This current matter affects nobody, it is merely a HTML coding update, I believe it can be accepted with input only by a single person with commit access rather than requiring votes, socializing or other consensus measures.

I have stopped contributing any material changes here precisely because this repository has no project scope, no actual editors, and no delegation of authority. Therefore improvements are impossible to be accepted.

In light of this, again, this PR is a mere coding update, a correction.

MicahZoltu · 2020-07-19T04:57:14Z

The purpose of my desire to get it into the meeting isn't to get consensus, it is just to get it in front of the eyes of all of the editors since it seems many of them don't watch GitHub closely. If no one voices any concerns (e.g., everyone just shrugs) then I'll have no problem merging this.

Souptacular · 2020-07-29T16:00:41Z

This looks good to me @fulldecent!

MicahZoltu · 2020-07-30T03:33:18Z

Sounds like this got green lit in the EIPIP meeting, so going to merge.

* Add preferred citation format * Add [DRAFT] * Fix DRAFT * Update license to a link inside the article * remove json-id * Update eip.html

fulldecent added 2 commits June 17, 2020 22:56

Add preferred citation format

10fb2c5

Add [DRAFT]

fb1bab4

This was referenced Jun 18, 2020

SEO with structured data ethereum/ethereum-org-website#718

Merged

Request: do SEO optimization for eips.ethereum.org ethereum/ethereum-org-website#343

Closed

Style Guide -- EIP123 or EIP-123? #1464

Closed

lightclient mentioned this pull request Jun 30, 2020

EIPIP Meeting 11 Agenda ethcatherders/EIPIP#21

Closed

axic reviewed Jul 17, 2020

View reviewed changes

fulldecent added 3 commits July 17, 2020 14:36

Fix DRAFT

c99546e

Update license to a link inside the article

0f70b6b

remove json-id

fc1ecca

fulldecent mentioned this pull request Jul 17, 2020

Add JSON-LD for EIPS #2796

Merged

MicahZoltu reviewed Jul 18, 2020

View reviewed changes

Update eip.html

34d4dd6

MicahZoltu mentioned this pull request Jul 21, 2020

EIPIP Meeting 13 Agenda ethcatherders/EIPIP#25

Closed

MicahZoltu merged commit 879793a into ethereum:master Jul 30, 2020

axic mentioned this pull request Aug 28, 2020

Add various example citation formats #2446

Closed

tkstanczak pushed a commit to tkstanczak/EIPs that referenced this pull request Nov 7, 2020

Preferred citation format (ethereum#2738)

3df4a23

* Add preferred citation format * Add [DRAFT] * Fix DRAFT * Update license to a link inside the article * remove json-id * Update eip.html

Arachnid pushed a commit to Arachnid/EIPs that referenced this pull request Mar 6, 2021

Preferred citation format (ethereum#2738)

9317015

* Add preferred citation format * Add [DRAFT] * Fix DRAFT * Update license to a link inside the article * remove json-id * Update eip.html

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Preferred citation format #2738

Preferred citation format #2738

fulldecent commented Jun 18, 2020

fulldecent commented Jun 18, 2020

MicahZoltu commented Jul 17, 2020

lightclient commented Jul 17, 2020

MicahZoltu commented Jul 17, 2020

fulldecent commented Jul 17, 2020

lightclient commented Jul 17, 2020 •

edited

Loading

MicahZoltu commented Jul 17, 2020

MicahZoltu commented Jul 17, 2020

axic Jul 17, 2020

MicahZoltu Jul 17, 2020

fulldecent Jul 17, 2020

axic Jul 17, 2020

axic Jul 17, 2020

fulldecent Jul 17, 2020

axic Jul 17, 2020

fulldecent Jul 17, 2020

axic Jul 17, 2020

fulldecent Jul 17, 2020

axic Jul 17, 2020

axic Jul 17, 2020

axic Jul 17, 2020

fulldecent Jul 17, 2020

fulldecent Jul 17, 2020

MicahZoltu commented Jul 18, 2020

MicahZoltu Jul 18, 2020

fulldecent Jul 18, 2020

fulldecent commented Jul 18, 2020

MicahZoltu commented Jul 19, 2020

Souptacular commented Jul 29, 2020

MicahZoltu commented Jul 30, 2020

Preferred citation format #2738

Preferred citation format #2738

Conversation

fulldecent commented Jun 18, 2020

fulldecent commented Jun 18, 2020

MicahZoltu commented Jul 17, 2020

lightclient commented Jul 17, 2020

MicahZoltu commented Jul 17, 2020

fulldecent commented Jul 17, 2020

lightclient commented Jul 17, 2020 • edited Loading

MicahZoltu commented Jul 17, 2020

MicahZoltu commented Jul 17, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MicahZoltu commented Jul 18, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fulldecent commented Jul 18, 2020

MicahZoltu commented Jul 19, 2020

Souptacular commented Jul 29, 2020

MicahZoltu commented Jul 30, 2020

lightclient commented Jul 17, 2020 •

edited

Loading