fix: Reword I-D announcement emails to make first sentence more useful #6193
Conversation
| URL: {{ settings.IETF_ID_ARCHIVE_URL }}{{ submission.name }}-{{ submission.rev }}.txt | ||
| Status: {{ settings.IDTRACKER_BASE_URL }}{% url 'ietf.doc.views_doc.document_main' name=submission.name %}{% if submission.xml_version == "3" %} | ||
| HTML: {{ settings.IETF_ID_ARCHIVE_URL }}{{ submission.name }}-{{ submission.rev }}.html{% endif %} | ||
| HTMLized: {{ settings.IDTRACKER_BASE_URL }}{% url 'ietf.doc.views_doc.document_html' name=submission.name %} |
There was a problem hiding this comment.
What is sthe difference between HTML and HTMLized? Can we find a better word to make that more obvious?
There was a problem hiding this comment.
For modern documents (anything submitted in xmlrfc), HTML is the html rendering from xml2rfc. HTMLized is the representation of the text rendering as html with some heursitic links created. We can HTMLize documents that are submitted only as text. We cannot make v3 HTML them.
What the datatracker /doc/html page shows looks (mostly) like the htmlized version, whether it eats .txt and htmlizes it or uses css to format the v3 HTML to look like the HTMLized.
And yes, this is not easy to explain.
There was a problem hiding this comment.
Is it time to just drop the HTMLized?
Can we add it only if txt was submitted?
I guess the bigger question is when would we want to provide both?
There was a problem hiding this comment.
I think we should do a pass over all email announcements and make sure we link to the metadata page in the datatracker in most cases, rather than including per-rendering links (or using names baking in renderings like .txt).
There was a problem hiding this comment.
Is it time to just drop the HTMLized
No. Your question isn't really just about "in the announcement of new Internet-Draft versions" its a thing that we have to deal with in general, including the pre-v3 RFCs. The /doc/html pages use that format so that we can provide the same kind of view for older and newer documents. Unless we somehow convinced the community that the v3 html rendering's CSS change to be what is produced at /doc/html, we need two terms for the two ways of looking at things.
This conversation should move out of the ticket - probably onto tools-discuss@
| Pages : {{ submission.pages }} | ||
| Date : {{ submission.submission_date|date:"Y-m-d" }} | ||
| Title: {{ submission.title }} | ||
| Author{{ submission.authors|pluralize:",s" }}: {% if submission.authors|length == 1 %} {% endif %}{% for author in submission.authors %}{{ author.name }}{% if not forloop.last %} |
There was a problem hiding this comment.
Why the extra space here when there is only one author?
There was a problem hiding this comment.
Because with multiple authors the string before the colon is Authors, i.e., one character longer.
There was a problem hiding this comment.
Consider the discussion of pluralizing cherry at https://docs.djangoproject.com/en/4.2/ref/templates/builtins/#pluralize
Codecov Report
@@ Coverage Diff @@
## main #6193 +/- ##
==========================================
- Coverage 88.68% 88.67% -0.01%
==========================================
Files 290 290
Lines 40300 40300
==========================================
- Hits 35742 35738 -4
- Misses 4558 4562 +4 |
|
I'm merging this - we can improve the pluralization in the template in the next release. |
Fixes #6092
Also makes some other tweaks to the layout of related emails.