Skip to content

Commit 4fc2283

Browse files
committed
Merged in [18914] from rjsparks@nostrum.com:
Update the submission instructions to encourage submission of v3 xml. Fixes ietf-tools#3232. - Legacy-Id: 18926 Note: SVN reference [18914] has been migrated to Git commit e6347ea
2 parents 481fc3f + e6347ea commit 4fc2283

4 files changed

Lines changed: 22 additions & 21 deletions

File tree

ietf/settings.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -550,6 +550,7 @@ def skip_unreadable_post(record):
550550
IDTRACKER_BASE_URL = "https://datatracker.ietf.org"
551551
RFCDIFF_BASE_URL = "https://www.ietf.org/rfcdiff"
552552
IDNITS_BASE_URL = "https://www.ietf.org/tools/idnits"
553+
XML2RFC_BASE_URL = "https://xml2rfc.tools.ietf.org/experimental.html"
553554

554555
# The name of the method to use to invoke the test suite
555556
TEST_RUNNER = 'ietf.utils.test_runner.IetfTestRunner'
@@ -754,6 +755,7 @@ def skip_unreadable_post(record):
754755
IANA_EVAL_EMAIL = "drafts-eval@icann.org"
755756
SESSION_REQUEST_FROM_EMAIL = 'IETF Meeting Session Request Tool <session-request@ietf.org>'
756757

758+
SECRETARIAT_SUPPORT_EMAIL = "support@ietf.org"
757759
SECRETARIAT_ACTION_EMAIL = "ietf-action@ietf.org"
758760
SECRETARIAT_INFO_EMAIL = "ietf-info@ietf.org"
759761

ietf/templates/submit/problem-reports-footer.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
</p>
88
<p>
99

10-
If you need to request manual posting of an Internet-Draft, please send the
11-
draft and the reason for manual posting to <a href="mailto:idsubmission@ietf.org">idsubmission@ietf.org</a>.
10+
If you run into problems submitting an Internet-Draft and need to request manual posting of an Internet-Draft, please send the
11+
draft and the reason for manual posting to <a href="mailto:{{settings.SECRETARIAT_SUPPORT_EMAIL}}">{{settings.SECRETARIAT_SUPPORT_EMAIL}}</a>.
12+
Be advised that manual processing always takes additional time.
1213

1314
</p>

ietf/templates/submit/tool_instructions.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,18 @@ <h2>I-D submission tool instructions</h2>
3838

3939
<h3>Upload screen</h3>
4040
<p>
41-
The Upload screen is the first screen that a user will see when he or she starts the I-D submission process. A user can submit four different formats of an I-D, plain text, XML, PDF, and postscript, at the same time. Failure to submit at least one of a plain-text or xml version will cause an error, and an error screen will be displayed.
41+
The Upload screen is the first screen that a user will see when he or she starts the I-D submission process. A user can submit four different formats of an I-D, plain text, XML, PDF, and postscript, at the same time. Failure to submit at least one of a plain-text or xml version will cause an error, and an error screen will be displayed. A single v3 .xml source is preferred. A single v2 .xml source will be accepted. If neither of those are available, a plain-text document may be provided.
4242
</p>
4343

4444
<p>
4545
By submitting your I-D, you are granting some rights to the IETF Trust. Before you submit your I-D,
46-
review the information on the NOTE WELL tab and <a href="https://tools.ietf.org/html/bcp78">BCP 78</a>,
46+
review the information on the NOTE WELL tab and <a href="{% url 'ietf.doc.views_doc.document_html' name='rfc5378' %}">BCP 78</a>,
4747
"Rights Contributors Provide to the IETF Trust".
4848
</p>
4949

5050
<p>
5151
Before you submit your I-D, it is recommended that you check it for nits
52-
using the <b><a href="https://tools.ietf.org/tools/idnits/">idnits tool</a></b>.
52+
using the <b><a href="{{settings.IDNITS_BASE_URL}}">idnits tool</a></b>.
5353
</p>
5454

5555
<p>
@@ -165,7 +165,7 @@ <h3>Problem report</h3>
165165
{% include "submit/problem-reports-footer.html" %}
166166

167167
<p>
168-
The specification for this tool can be found in <a href="https://www.ietf.org/rfc/rfc4228.txt?number=4228">RFC 4228</a>.
168+
The specification for this tool can be found in <a href="{% url 'ietf.doc.views_doc.document_html' name='rfc4228' %}">RFC 4228</a>.
169169
</p>
170170

171171
{% endblock %}

ietf/templates/submit/upload_submission.html

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,15 @@
2121
{% endif %}
2222

2323
{% if not form.shutdown or user|has_role:"Secretariat" %}
24-
<p>If you run into problems when submitting an Internet-Draft
25-
using this and the following pages, you may alternatively submit
26-
your draft by email to
27-
<a href="mailto:internet-drafts@ietf.org">internet-drafts@ietf.org</a>.
28-
However, be advised that manual processing always takes additional time.
29-
</p>
30-
3124
<p>
3225
By submitting your I-D, you are granting some rights to the IETF Trust. Before you submit your I-D,
33-
review the information on the NOTE WELL tab and <a href="https://tools.ietf.org/html/bcp78">BCP 78</a>,
26+
review the information on the NOTE WELL tab and <a href="{% url 'ietf.doc.views_doc.document_html' name='rfc5378' %}">BCP 78</a>,
3427
"Rights Contributors Provide to the IETF Trust".
3528
</p>
3629

3730
<p>
3831
Before you submit your I-D, it is recommended that you check it for nits
39-
using the <b><a href="https://tools.ietf.org/tools/idnits/">idnits tool</a></b>.
32+
using the <b><a href="{{settings.IDNITS_BASE_URL}}">idnits tool</a></b>.
4033
</p>
4134

4235
{% include "submit/problem-reports-footer.html" %}
@@ -45,14 +38,19 @@ <h2>Upload an Internet-Draft</h2>
4538

4639
<p>
4740
<i>
48-
Either a plain-text document or a valid .xml file which can be processed by the xml2rfc
49-
processor <b>must</b> be provided.
41+
The best way to submit an Internet-Draft is to provide a single v3 .xml source file.
42+
The datatracker will generate the .txt and other formats from that file.
43+
<br/>
44+
Source v3 .xml which include external files must be preprocessed through xml2rfc with
45+
the <tt>--expand</tt> option, to produce a completely expanded (standalone) .xml source
46+
file for upload.
5047
<br/>
51-
For v3 .xml sources which include external files, this requires them to be run through xml2rfc with
52-
the <tt>--expand</tt> option, to produce a completely expanded (standalone) .xml source file for
53-
upload.
48+
The <a href="{{settings.XML2RFC_BASE_URL}}">online conversion tool</a> can be used to
49+
convert v2 .xml documents to v3.
5450
<br/>
55-
If no .txt file is provided, one will be generated from the .xml file.
51+
A single v3 .xml source is preferred. A single v2 .xml source will be accepted. If
52+
neither of those are available, a plain-text document may be provided. One of these
53+
three options <b>must</b> be provided.
5654
<br/>
5755
Other file types are optional.
5856
</i>

0 commit comments

Comments
 (0)