IETF Author Tools UI
Home Page: https://author-tools.ietf.org
License: Other
Archived: This project is now part of IETF Author Tools repository.
docker-compose up
Visit http://localhost:8080/
See contributing guide.
When I convert a rather old XML file to XML, it does what I expect: converts v2 to v3. However, it doesn't tell me that's what it's doing. If we want to encourage people to switch to v3, it should probably announce that it has done the conversion and say "please use the new format from now on".
Related to that, it converts draft-foobar-15.xml into draft-foobar-15.xml.xml, which is just plain annoying. Maybe draft-foobar-15.xml3 would be a better choice?
It seems like a click just about anywhere on the home page will open the file upload dialog. That's a little much. Using a <label> element for this sort of thing is good practice, but you generally only enclose the content that is a direct label. This text encloses all of the introductory stuff.
This seems like a pretty obvious choice of name, even if it is just an alias like dt.i.o.
It would have been very helpful to me -- and I can't be the only one -- if author-tools.ietf.org had a prominent link to authors.ietf.org. Something along the lines of "documentation and examples can be found at authors.ietf.org".
Improve current "experimental notice" to provide enough information on how to submit bug reports and comments.
Reference: https://mailarchive.ietf.org/arch/msg/tools-discuss/RP2CJ2sUnEJ3DB691eZkGfai7_k/
I tested author-tools.ietf.org with RFC 8881 (rfc8881.xml -> html) and received a 413 error. When I tried to download the file, I received an html file containing the 413 error.
https://www.rfc-editor.org/info/rfc8881
RFC 8881 is a very long document. Its PDF (which I also couldn't get to generate) is 560 pages long.
I uploaded:
https://www.sandelman.ca/tmp/cbor-network-addresses.mkd
and it said there were errors, but it didn't tell me what they were.
This is a real gap. Unfortunately, xml2rfc had the v2 RFC link but never got the v3.
When ietf-tools/author-tools#15 is complete, ietf-at-ui should have a web UI to verify Internet Drafts similar to rendering UI.
Author tools provide idnits service as an API call but don't provide a separate view for that.
When two drafts are provided in iddiff, the first draft should be on the left side.
Relates to #61
Would be nice if the warnings are displayed, perhaps optionally.
For example, with input file https://www.ietf.org/archive/id/draft-ietf-httpbis-http2bis-07.xml
click "HTML", there are zero warnings.
However, on the command line, the warnings are:
Warning: rfc2629-xhtml.ent is no longer needed as the special processing of non-ASCII characters has been superseded by direct support for non-ASCII characters in RFCXML.
Warning: rfc2629-xhtml.ent is no longer needed as the special processing of non-ASCII characters has been superseded by direct support for non-ASCII characters in RFCXML.
Warning:rfc2629-xhtml.ent is no longer needed as the special processing of non-ASCII characters has been superseded by direct support for non-ASCII characters in RFCXML.
Warning: rfc2629-xhtml.ent is no longer needed as the special processing of non-ASCII characters has been superseded by direct support for non-ASCII characters in RFCXML.
draft-ietf-httpbis-http2bis-07.xml(16): Warning: Setting consensus="true" for IETF STD document (this is not the schema default, but is the only value permitted for this type of document)
draft-ietf-httpbis-http2bis-07.xml(687): Warning: Found SVG with width or height specified, which will make the artwork not scale. Specify a viewBox only to let the artwork scale.
Created file draft-ietf-httpbis-http2bis-07.html
I uploaded XML file, which I've placed at https://www.sandelman.ca/tmp/cbor-network-addresses.xml
and it produced the output:
blob:https://author-tools.ietf.org/0dde6e40-be53-41f7-8715-3c6e12b83894
which contains:
"Universität Bremen TZI"
it looks like UTF-8 rendered as Latin-1 here.
I enter the .xmL file and it appears to process it but does produce .txt output.
When I save the results of iddiff, it is automatically named index.htm. That is unhelpful and might even be problematic if saved into a general folder. Could we have a constructed name as with old rfcdiff?
The red box can be closed but just comes back on reload.
From #24
It might be better to hide the "Experimental" warning after x number of seconds.
A few sentences at /doc about how to use the page would be useful. Something like "To try an endpoint, click the down arrow and fill in the fields."
To fully replace rfcdiff, the UI for Diff needs to allow two input files. It's common to use rfcdiff for comparing files that are not just versions n and n-1 of the same I-D.
When replying to reviewers of my draft (e.g.: IESG review) i am providing them with a URL showing the diff cause by me replying to their comments/DISCUSS, e.g.:
This does not work for https://author-tools.ietf.org/iddiff.
Please also document the appropriate URL format on the web page https://author-tools.ietf.org/iddiff itself, as rfcdiff does as well.
Please note that this needs to support full URL parameters, because it may point to github commits instead of just datatracker urls.
Thanks a lot!
The look&feel should be a bit more in line with our other web presences in terms of colors, fonts, etc. Adding an IETF logo might also not be a bad idea.
From #24
It'll be better to have separate Bootstrap 5 template for IETF tools.
This is more of an FYI than an issue. When I extract ABNF from (e.g.) RFC3986, it all works, but the result is the concatenation of the fragments of ABNF throughout the document plus the complete ABNF from the appendix. The result is therefore full of duplicate lines and invalid.
There's not much you can do about that except document it...
Add a link to new bibxml service.
The formatting here is a little off:
Update idnits links in https://author-tools.ietf.org/about.html to point to https://github.com/ietf-tools/idnits/
Please change the "Validate" button to read "Validate (idnits)" since most of us know it as "idnits"
If run the version of xml2rfc on tools.ietf.org, a v2 file with VSPACE , it works. If I run it on author-tools, it doesn't (it ignores the VSPACE).
The rfc part is:
The VSPACE text:
Input address:
6000 15th Avenue
Leets, WA US
I worked around this by changing to:
Input address:
This tool works great. It's much faster than rfcdiff and the conversion options are convenient. However, it doesn't create a resource that can be shared. This is understandable for cases where files are uploaded, but less so when the inputs are draft names.
Add a new idnits view similar with configuration options similar to https://www6.ietf.org/tools/idnits
Hi.
When one goes to https://author-tools.ietf.org/about.html#howto-report-bugs, there are three entries for bugs and feature requests involving the web site, bugs and feature requests involving the API, and "General discussions about IETF Author Tools and other IETF tools...". As an aid to the easily confused, if the intention is that bugs in some of the tools be reported to the latter address, it would be helpful to edit that last category to say so, e.g., change the sentence to read "Bug reports, feature requests, and general discussions about...". For those reporting actual bugs, providing a mechanism for moving reports about problems with tools to go through some sort of tracker would seem (at least to me) to be a good idea.
thanks.
This is great, but when I use Extract (from Firefox 101.0.1 on Windows 10) the little busy indicator continues rotating indefinitely and I can't do a second Extract without exiting the page and starting again.
Same issue with Chrome.
It drives me a bit crazy that the Diff option on the web UI places the old version at the right and the new version at the left. In all previous history, the old version was at the left, and that just seems more natural.
A few suggestions in no particular order:
A link to https://github.com/cabo/kramdown-rfc2629 or https://mmark.miek.nl/ might be helpful for someone looking to understand what the tool does. Same for RFC 7991/2629.
Remove the experimental notice auto disappearance feature, since that moves the text on the website this distract users.
This "experimental notice" will be completely removed when the service is moved to a production state.
iddiff UI doesn't provide GET URLs for comparisons by document name or URL anymore.
URLs are still functioning.
Using the "draft name" option, I was able to enter "RFC9000", with or without a space. This worked quite well, but it wasn't clear that it would from the labels on the fields. Consider improving the cues here.
Providing only the second URL / document in iddiff view doesn't generate a shareable link.
This is just a suggestion, but it might be easier for people to understand this page works if it was structured something like:
[ select ... ] [_____________________]
Convert to:
[ text ] [ html ] [ xml ] [ pdf ]
Add a separate webpage with version information showing tool version information using ietf-at API's /api/version API call.
This depends on ietf-tools/author-tools#14 for additional version information.
ietf-tools/author-tools#7 has added datatracker based API authentication.
ietf-at-ui must be able to use ietf-at with a datatracker API key for a special robot user.
This is more of a question for the community. Do people prefer the display format provided by "Diff with latest" or the older format provided by "iddiff"?
My personal answer is that the old format is more practical, even if less beautiful.
The web service is giving me "API key is invalid" for a valid xml file (converting to html). It converts correctly, but very slowly, on the old web service at xml2rfc.tools.ietf.org
Consider the following scenario
I am trying to report a bug in the xml2rfc processor (Cf. ietf-tools/xml2rfc#887). To make the problem clear, I should attach either the original RFCXML file, or an excerpt of it. Unfortunately, neither of those is possible - an XML file is not accepted as an attachment and changing the file extension to ".txt" produces a "something went wrong" message.
Trying to simply paste a small excerpt of the XML into the body of the issue results in its being processed (by a processor that has different rules than xml2rfc) unless one thinks / knows enough to explicitly mark it as code.
This is bad news and fairly user-hostile.
I also have no idea what caused this text to go into right-justification (with some supplemental misfeatures) as I was typing but have not been able to figure out how to get it back out of it. That "feature" does not show up on preview, so I'm attaching (I hope) a screenshot. .:
There is no way to run idnits on a text file as we can only input an XML/markdown but sometimes as a reviewer or shepherd, I get a temporary version of the document in text format on which I would still like to run the tool.
This was possible with tools site.
I think the name "IETF @" is confusing. I get that the "@" is "AT" as in "author tools", but I'd really prefer another name that is less clever and more descriptive.
From: #24
When collaborating with co-authors, I often send them a diff file during document development. Could "Diff with latest" offer the ability to save the result (as is possible with iddiff)?
Small gripe about idiff, I thought it was weird that when I populate the "draft name" fields and then hit return, the form gets reset. The common assumption is that return is going to be an alias for the default button, "compare" in this case.
rfcdiff allows the user a number of choices of output format. Can we have the same for iddiff please? (As far as I can see, the RFC Editor uses the Html wdiff option routinely, and for some applications it's much better than side-by-side.)
For what it's worth, this is the only reason I still use rfcdiff (see the previous issue ietf-tools/author-tools#429).
Generate HTML supports UTF-8. Generate text file does not supports UTF-8. My name is generated as "Preu� Mattsson". I feel discriminated. Why is anything else than UTF-8 even allowed?
John Preuß Mattsson
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.
