[Docutils-develop] [docutils:feature-requests] Re: #61 Support for :BCP: role, similar

[Günter M. <mi...@us...>]

Thank you for the patch.
Any patch that can be applied with `git apply` or `git am -3` is fine.
Separate patches for the different commits may be better, you can generate a "commit patch" with `git format-patch` (or via some GUI tools). (Mind that due to SVN limitations, SVN will set the author to the "sponsor" running `git-svn dcommit`.)

Small things:

There is no need to translate the short alias `'bcp'`. Similar to `'rfc'` and `'pep'` it may be mapped to `'bcp-reference'` or omitted in the language files. (The difference is an info message if converting a foreign language document with `--verbose`).

In "docs/ref/rst/roles.txt": changing the anchor to `.. _rfc-role:` allows simpler referencing with `` `RFC role`_``.

In test/test_language.py: Why do you raise SystemExit? It is current praxis to let the test suite run on (if possible) and collect all problems.

Large question: How about the following (instead or in addition to a new bcp role)?

There are many more similar document sets (Debian enhancement proposals  or Django enhancement proposals, ..., maybe sometimes also Docutils enhancement proposals),
but not all of them are important for everyone.
One idea would be to allow deriving custom "RFC-like" roles from "rfc-reference" using the [role](https://docutils.sourceforge.io/docs/ref/rst/directives.html#custom-interpreted-text-roles) directive with the base-URL given as customization option (similar to "language" for roles derived from [code](https://docutils.sourceforge.io/docs/ref/rst/roles.html#code)).
A 'bcp' role could then created with 
~~~
.. role:: bcp(rfc-reference)
   :base-url: https://datatracker.ietf.org/doc/html/bcp
~~~
This allows more flexibility. We could also use a placeholder for the actual number.


---

** [feature-requests:#61] Support for :BCP: role, similar**

**Status:** open
**Group:** Default
**Created:** Tue Apr 09, 2019 08:46 AM UTC by Roberto Polli
**Last Updated:** Sun Jan 02, 2022 06:59 AM UTC
**Owner:** nobody


## I wish

- support for referencing IETF Best Current Practices, eg:  :BCP:`47`role 
- the processing is similar to :RFC:

## Notes

- sphinx people suggests that goes in docutils. see  https://github.com/sphinx-doc/sphinx/issues/6255 


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.