NonGNU ELPA - rfc-mode
rfc-mode
- Description
- RFC document browser and viewer
- Latest
- rfc-mode-1.4.0.tar, 2022-Nov-23, 320 KiB
- Maintainer
- Nicolas Martyanoff <nicolas@n16f.net>
- Website
- https://github.com/galdor/rfc-mode
- Browse ELPA's repository
- CGit or Gitweb
- Badge
To install this package, run in Emacs:
M-x package-install RET rfc-mode RET
Full description
rfc-mode
Introduction
The rfc-mode Emacs major mode is a browser and reader for RFC documents.
Installation
The package should be installed from MELPA.
Start by loading the mode:
elisp
(require 'rfc-mode)
Then set the location containing all RFC documents (the default value is the
rfc directory in the home directory):
elisp
(setq rfc-mode-directory (expand-file-name "~/rfc/"))
RFC documents and their index will be directly downloaded from https://www.rfc-editor.org when required. Alternatively, the entire RFC collection can be downloadeded from https://www.rfc-editor.org/retrieve/bulk to ensure full access without the need for an internet connection.
Call rfc-mode-browse to choose a RFC document to read, or rfc-mode-read to
enter the reference of the RFC document yourself.
Screenshots
Browser
Reader
Contact
If you have an idea or a question, email me at nicolas@n16f.net.
Old versions
| rfc-mode-1.3.0.tar.lz | 2022-Oct-12 | 282 KiB |
News
Table of Contents
1 Next Version
Work in progress.
2 1.4.0
I should have released minor versions for bug fixes, but it seems everyone is
using the master branch from MELPA, and so am I. So major only it is. I will
release a minor version if a severe issue is found of course.
2.1 Features
rfc-mode-readnow supports a numeric prefix argument, so you can simply typeC-u 1 2 3 4 M-x rfc-mode-readto read RFC number 1234. Also, if you callrfc-mode-readwhen point is on a number, you will be offered that number as default. Thanks to Daniel Martín.rfc-mode-goto-sectionnow makes sure the title of the section is at the top of the page, avoiding annoying edge cases where a section is at the end of a page (thanks to Štěpán Němec).
2.2 Misc
- Make the dependency on Helm optional (thanks to Jonas Bernoulli).
- Code cleaning and simplifications (thanks to Stefan Monnier, Jonas Bernoulli and Basil L. Contovounesios).
3 1.3.0
This release improves navigation and introduce section detection, thanks to Daniel Martín.
3.1 Features
imenuintegration. If you use a graphical user interface, the menu bar will show a new menu, "RFC Contents", with links to the different parts of an RFC document.- RFC links can now be navigated using the mouse, or by pressing
<Tab>~/~<S-Tab>. - Pressing
gin arfc-modebuffer lets you navigate to an RFC section by name. - You can navigate to previous and next RFC sections by pressing
pandn, respectively.
3.2 Misc
- Derive
rfc-modefromspecial-mode. - Make
rfc-mode-readdisplay the document in a separate window, without switching buffers. This follows the typical Emacs convention for displaying help buffers, likehelp-modeorman-modefollow.
4 1.2.0
This new release is driven by suggestions from Stefan Monnier and some issues which were open on Github. Thanks everyone!
4.1 Features
- Let the module load without Helm since some features can be used without it.
- Auto load
rfc-mode-read. - Improved accuracy for section title detection.
- Offer the possibility to keep original buffer names with
rfc-mode-use-original-buffer-names.
4.2 Fixes
- Compute the index path dynamically so that
rfc-mode-directorycan be modified after the module has been loaded.
4.3 Misc
- Follow Emacs conventions in docstrings.
- Derive
rfc-modefromtext-mode. - Use
expand-file-nameinstead ofconcat.
5 1.1.1
5.1 Features
- Automatically download missing files.
6 1.1.0
6.1 Fixes
- Require missing modules.
- Fix invalid escape sequence.
6.2 Misc
- Make some functions private.
7 1.0.1
7.0.1 Fixes
- Various fixes for checkdoc.
8 1.0.0
First public version.
8.1 Features
- Helm-based RFC browser.
- RFC document reader with highlighting.