TakeV/spacemacs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+misc/ietf
History
Robert O'Connor 66eebcf032 [ietf layer] Add RFC files to the auto-mode-alist to use irfc-mode
2019-04-13 18:59:54 +02:00
..
img
local/irfc Load irfc package locally as it is no longer hosted on melpa or elpa 2019-04-12 20:48:22 +02:00
config.el
packages.el [ietf layer] Add RFC files to the auto-mode-alist to use irfc-mode 2019-04-13 18:59:54 +02:00
README.org documentation formatting: Fri Apr 12 19:31:31 UTC 2019 2019-04-12 22:02:05 +02:00

README.org

ietf layer

/TakeV/spacemacs/media/commit/56ef7f516329f7934735b6985a25484b7c359c39/layers/+misc/ietf/img/ietf-logo.png

Description

The IETF layer collects various useful packages for participating in the Internet Engineering Task Force (https://www.ietf.org).

Features:

  • Fetching and opening IETF documents.
  • Viewing IETF documents.
  • Writing IETF documents.

Fetching and Opening IETF Documents

Support for fetching and downloading IETF documents is added through the ietf-docs package. The IETF docs package adds support for fetching and loading IETF documents based on the name of a document (usually under the emacs point). For example if the point is anwhere on the text RFC781 and one invokes the ietf-docs-open-at-point the package will fetch the document to a local cache (if not present) and view it. This works for the 3 standard document names, STDXXX, RFCXXX and draft-xxxx-yyy.

Viewing IETF Documents

Support for viewing IETF documents is added through the IRFC minor mode (irfc-mode). The IRFC minor mode improves the display and formatting of IETF documents using the well known IETF document structure. Additionally it creates hyperlink overlays for references within the document.

Writing IETF Documents

Support for writing IETF documents using org mode is added using the RFC Org Mode Exporter (ox-rfc) package.

Install

To use the ietf layer add it to your ~/.spacemacs

  (setq-default dotspacemacs-configuration-layers '(ietf))

By default fetched IETF documents are stored in a subdirectory of the spacemacs-cache-directory. To override this location you can set the ietf-docs-cache variable.

  (setq-default dotspacemacs-configuration-layers '(
    (ietf :variables
          ietf-docs-cache "~/Downloads/ietf-docs-cache")))

Key bindings

Key binding Description
SPC f I Opens IETF document based on the text at the point.