Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to check abbreviations #26

Open
ajeanmahoney opened this issue Jan 8, 2024 · 0 comments
Open

Ability to check abbreviations #26

ajeanmahoney opened this issue Jan 8, 2024 · 0 comments
Assignees

Comments

@ajeanmahoney
Copy link
Collaborator

Each abbreviation used within the text should be expanded on first use unless it is listed as well known on the RFC Editor Abbreviations List. Once an abbreviation has been expanded, the abbreviation should be used thereafter (see the Web Portion of the Style Guide).

The user should be able to create a report of abbreviations used within the document. The report should list alphabetically each abbreviation with its expansion (if one was provided). The report should note the following:

  • Well-known abbreviations
  • Whether the given expansion matches the expansion on the RFC Editor Abbreviations List.
  • Any abbreviation that does not have an expansion and is not well known.
  • Whether the abbreviation is used before the definition is provided.
  • Whether the expansion, rather than the abbreviation, is used later in the document.
  • If there are multiple expansions.
  • If an abbreviation is only used once.
  • If there are multiple expansions and they do not match. (e.g., DPLPMTUD is expanded twice, but one expansion is "Datagram Packetization Layer Path MTU Discovery" and the other is "Datagram Packetization-Layer PMTUD")
  • If the expansion of the abbreviation within the text would result in redundant wording (e.g., expanding "SIP protocol" results in "Session Initiation Protocol protocol")

The report should be saveable as a text file.

6BBR - expanded as "6LoWPAN Backbone Router"
API - is well known and not expanded
BGP - is well known and is expanded as "Border Gateway Protocol"
IETF - WARNING used before the expansion "Internet Engineering Task Force"
DPLPMTUD - WARNING multiple expansions:
DPLPMTUD - expanded as "Datagram Packetization Layer Path MTU Discovery"
DPLPMTUD - expanded as "Datagram Packetization-Layer PMTUD". 
EB - expanded as "Enhanced Beacon"
"Enhanced Beacon" - WARNING: used 5 times after expansion of "EB"
ETX - expanded as "Expected Transmission Count"
ETX - WARNING only used once
LLN - expanded as "Low-Power Lossy Network". WARNING does not match Abbreviation List "Low-Power and Lossy Network"
SIP - WARNING redundant word after abbreviation: "SIP protocol"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants