https://github.com/ietf-tools/rfc2html

Convert text-format RFCs and Internet-Drafts to html
https://github.com/ietf-tools/rfc2html

conversion ietf internet-draft python rfc

Last synced: 3 days ago
JSON representation

Convert text-format RFCs and Internet-Drafts to html

• Host: GitHub
• URL: https://github.com/ietf-tools/rfc2html
• Owner: ietf-tools
• License: bsd-3-clause
• Created: 2022-01-12T19:28:26.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T13:14:18.000Z (2 months ago)
• Last Synced: 2024-12-12T21:08:52.428Z (10 days ago)
• Topics: conversion, ietf, internet-draft, python, rfc
• Language: Python
• Homepage:
• Size: 90.8 KB
• Stars: 30
• Watchers: 8
• Forks: 23
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    



    

[![Release](https://img.shields.io/github/release/ietf-tools/rfc2html.svg?style=flat&maxAge=600)](https://github.com/ietf-tools/rfc2html/releases)

[![License](https://img.shields.io/github/license/ietf-tools/rfc2html)](https://github.com/ietf-tools/rfc2html/blob/main/LICENSE)

[![PyPI - Version](https://img.shields.io/pypi/v/rfc2html)](https://pypi.org/project/rfc2html/)

[![PyPI - Status](https://img.shields.io/pypi/status/rfc2html)](https://pypi.org/project/rfc2html/)

[![PyPI - Format](https://img.shields.io/pypi/format/rfc2html)](https://pypi.org/project/rfc2html/)

    

##### Htmlizing IETF Text Documents

    



- [Changelog](https://github.com/ietf-tools/rfc2html/blob/main/CHANGELOG.md)

- [Contributing](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md)

- [Release Procedure](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md#release-procedure)

---

### Usage

This module contains one single function, `markup(text)` which adds HTML markup

to what is assumed to be an IETF document (usually an [Internet-Draft] or an [RFC]):

```python

from rfc2html import markup

with open('rfc3344.txt') as file:

    text = file.read()

html = markup(text)

```

### History

As a historic artifact of being a document series which was started at the time when the easiest

way of distributing a *Request For Comments* was to type it up on a typewriter and [mimeographing]

it, RFCs and Internet-Drafts before RFC 8650 were published as plaintext documents with a

maximum line length of 72 characters. Some Internet-Drafts are still created only in this form.

This format isn't particularly appropriate in a web-centric world, howerver, so starting in

2002, [Henrik Levkowetz] started using scripts to convert the plaintext documents into HTML

documents with the same look-and-feel as the plaintext originals, but with internal and external

HTML links in order to facilitate browsing.

Henrik served the resulting documents at tools.ietf.org starting in 2004. These are now served

from the IETF [Datatracker].

This module began as a packaging of the htmlization code from version 1.113 of the htmlizing script.

[Internet-Draft]: https://en.wikipedia.org/wiki/Internet_Draft

[RFC]: https://en.wikipedia.org/wiki/Request_for_Comments

[mimeographing]: https://en.wikipedia.org/wiki/Mimeograph

[Henrik Levkowetz]: mailto:[email protected]

[Datatracker]: https://datatracker.ietf.org/