-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Unify spec titles, remove version numbers. Fix duplicate markdown headers. We've changed filenames and the folder structure for all but Metadata and SASL because those specs have pending PRs/updates and I don't want to stomp over them with these. We've also unified the initial-page-titles for specs. Mentioned in example-spec.md, but essentially: "Introduction" is for the first section of a multi-section spec, "Description" is for the main body section when a spec only contains one section, and "Motivation" is used when the spec author wants to split out the introduction/description from the motivation of the spec I guess. Makes all our spec appear much more nicely on the website, I assure ya'.
- Loading branch information
1 parent
b1664ee
commit df2f2f2
Showing
36 changed files
with
130 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,16 @@ | ||
--- | ||
title: IRCv3 chathistory Batch Type | ||
title: "`chathistory` Batch Type" | ||
layout: spec | ||
redirect_from: | ||
- /specs/extensions/batch/chathistory-3.3.html | ||
copyrights: | ||
- | ||
name: "Sadie Powell" | ||
period: "2015" | ||
email: "[email protected]" | ||
--- | ||
## `chathistory` Batch Type | ||
|
||
## Description | ||
|
||
This document describes the format of the `chathistory` batch type. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: React client tag | ||
title: "`react` client tag" | ||
layout: spec | ||
work-in-progress: true | ||
copyrights: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Reply client tag | ||
title: "`reply` client tag" | ||
layout: spec | ||
work-in-progress: true | ||
copyrights: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: IRCv3 typing client tag | ||
title: "`typing` client tag" | ||
layout: spec | ||
copyrights: | ||
- | ||
|
@@ -10,6 +10,7 @@ copyrights: | |
period: "2020" | ||
email: "[email protected]" | ||
--- | ||
|
||
## Introduction | ||
|
||
This specification defines a client-only message tag to indicate the current typing status of users in channels and private messages. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: IRCv3.2 Metadata | ||
title: Metadata | ||
layout: spec | ||
deprecated: true | ||
copyrights: | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,18 @@ | ||
--- | ||
title: IRCv3 SASL DH-AES Authentication Mechanism | ||
title: SASL DH-AES Authentication Mechanism | ||
layout: spec | ||
redirect_from: | ||
- /specs/documentation/sasl-dh-aes.html | ||
deprecated: "This mechanism has been deemed unsafe and has been deprecated. Please refer to the [SASL Mechanisms](http://ircv3.net/docs/sasl-mechs.html) page for mechanisms that the IRCv3 WG now recommends." | ||
copyrights: | ||
- | ||
name: "Mantas Mikulėnas" | ||
period: "2013-2015" | ||
email: "[email protected]" | ||
--- | ||
|
||
## Description | ||
|
||
This specification documents the `DH-AES` SASL mechanism currently implemented | ||
by some IRC clients and services. | ||
|
||
|
7 changes: 6 additions & 1 deletion
7
documentation/sasl-dh-blowfish.md → deprecated/sasl-dh-blowfish.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,18 @@ | ||
--- | ||
title: IRCv3 SASL DH-BLOWFISH Authentication Mechanism | ||
title: SASL DH-BLOWFISH Authentication Mechanism | ||
layout: spec | ||
redirect_from: | ||
- /specs/documentation/sasl-dh-blowfish.html | ||
deprecated: "This mechanism has been deemed unsafe and has been deprecated. Please refer to the [SASL Mechanisms](http://ircv3.net/docs/sasl-mechs.html) page for mechanisms that the IRCv3 WG now recommends." | ||
copyrights: | ||
- | ||
name: "Mantas Mikulėnas" | ||
period: "2013-2015" | ||
email: "[email protected]" | ||
--- | ||
|
||
## Description | ||
|
||
This specification documents the `DH-BLOWFISH` SASL mechanism currently | ||
implemented by various IRC clients and services. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,8 @@ | ||
--- | ||
title: IRCv3.1 `tls` Extension | ||
title: "`tls` Extension" | ||
layout: spec | ||
redirect_from: | ||
- /specs/extensions/tls-3.1.html | ||
deprecated: true | ||
copyrights: | ||
- | ||
|
@@ -12,7 +14,8 @@ copyrights: | |
period: "2014" | ||
email: "[email protected]" | ||
--- | ||
## The tls Client Capability | ||
|
||
## Description | ||
|
||
The tls client capability indicates that the server supports the STARTTLS command. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 6 additions & 1 deletion
7
extensions/account-notify-3.1.md → extensions/account-notify.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,17 @@ | ||
--- | ||
title: IRCv3.1 `account-notify` Extension | ||
title: "`account-notify` Extension" | ||
layout: spec | ||
redirect_from: | ||
- /specs/extensions/account-notify-3.1.html | ||
copyrights: | ||
- | ||
name: "William Pitcock" | ||
period: "2010" | ||
email: "[email protected]" | ||
--- | ||
|
||
## Description | ||
|
||
The account-notify client capability allows a client to be notified | ||
when a client's account name changes. This capability MUST be | ||
referred to as 'account-notify' at capability negotiation time. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,17 @@ | ||
--- | ||
title: IRCv3.2 `account-tag` Extension | ||
title: "`account-tag` Extension" | ||
layout: spec | ||
redirect_from: | ||
- /specs/extensions/account-tag-3.2.html | ||
copyrights: | ||
- | ||
name: "Mantas Mikulėnas" | ||
period: "2013-2015" | ||
email: "[email protected]" | ||
--- | ||
|
||
## Description | ||
|
||
The `account-tag` capability causes the server to add a [message tag][] containing | ||
the command sender's services account to commands sent to the client that has | ||
requested this capability. It supersedes the `identify-msg` extension. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,17 @@ | ||
--- | ||
title: IRCv3.1 `away-notify` Extension | ||
title: "`away-notify` Extension" | ||
layout: spec | ||
redirect_from: | ||
- /specs/extensions/away-notify-3.1.html | ||
copyrights: | ||
- | ||
name: "Keith Buck" | ||
period: "2012" | ||
email: "[email protected]" | ||
--- | ||
|
||
## Description | ||
|
||
The away-notify client capability allows a client to specify that it | ||
would like to be notified when users are marked/unmarked as away. This | ||
capability is referred to as 'away-notify' at capability negotiation | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,8 @@ | ||
--- | ||
title: IRCv3.2 `batch` Extension | ||
title: "`batch` Extension" | ||
layout: spec | ||
redirect_from: | ||
- /specs/extensions/batch-3.2.html | ||
copyrights: | ||
- | ||
name: "William Pitcock" | ||
|
@@ -15,7 +17,8 @@ copyrights: | |
period: "2014" | ||
email: "[email protected]" | ||
--- | ||
## The `batch` client capability | ||
|
||
## Introduction | ||
|
||
This extension describes a capability which causes a new verb to be sent to | ||
clients when the IRC server wishes to designate that a series of events are | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,8 @@ | ||
--- | ||
title: IRCv3 Client Capability Negotiation | ||
title: Client Capability Negotiation | ||
layout: spec | ||
redirect_from: | ||
- /specs/core/capability-negotiation.html | ||
- /specs/core/capability-negotiation-3.1.html | ||
- /specs/core/capability-negotiation-3.2.html | ||
- /specs/extensions/cap-notify-3.2.html | ||
|
@@ -35,6 +36,7 @@ copyrights: | |
period: "2017-2019" | ||
email: "[email protected]" | ||
--- | ||
|
||
## What Client Capability Negotiation attempts to solve | ||
|
||
Client Capability Negotiation allows IRC clients and servers to negotiate new features | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: IRCv3 chathistory extension | ||
title: "`chathistory` Extension" | ||
layout: spec | ||
work-in-progress: true | ||
copyrights: | ||
|
@@ -15,6 +15,7 @@ copyrights: | |
period: "2020" | ||
email: "[email protected]" | ||
--- | ||
|
||
## Notes for implementing work-in-progress version | ||
|
||
This is a work-in-progress specification. | ||
|
@@ -23,7 +24,7 @@ Software implementing this work-in-progress specification MUST NOT use the unpre | |
|
||
The `chathistory` batch type is already ratified and SHOULD be used unprefixed. | ||
|
||
## Description | ||
## Introduction | ||
This document describes the format of the `chathistory` extension. This enables clients to request messages that were previously sent if they are still available on the server. | ||
|
||
The server as mentioned in this document may refer to either an IRC server or an IRC bouncer. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,8 @@ | ||
--- | ||
title: IRCv3.2 `echo-message` Extension | ||
title: "`echo-message` Extension" | ||
layout: spec | ||
redirect_from: | ||
- /specs/extensions/echo-message-3.2.html | ||
copyrights: | ||
- | ||
name: "Attila Molnar" | ||
|
@@ -11,6 +13,7 @@ copyrights: | |
period: "2014" | ||
email: "[email protected]" | ||
--- | ||
|
||
## Description | ||
|
||
This client capability MUST be named `echo-message`. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,17 @@ | ||
--- | ||
title: IRCv3.1 `extended-join` Extension | ||
title: "`extended-join` Extension" | ||
layout: spec | ||
redirect_from: | ||
- /specs/extensions/extended-join-3.1.html | ||
copyrights: | ||
- | ||
name: "Kiyoshi Aman" | ||
period: "2011" | ||
email: "[email protected]" | ||
--- | ||
|
||
## Description | ||
|
||
The extended-join capability extends the JOIN message to include the | ||
account name, or a placeholder if the user hasn't identified with | ||
services. This capability MUST be referred to as 'extended-join' at | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,8 @@ | ||
--- | ||
title: IRCv3.2 `invite-notify` Extension | ||
title: "`invite-notify` Extension" | ||
layout: spec | ||
redirect_from: | ||
- /specs/extensions/invite-notify-3.2.html | ||
copyrights: | ||
- | ||
name: "Adam" | ||
|
@@ -11,6 +13,7 @@ copyrights: | |
period: "2014" | ||
email: "[email protected]" | ||
--- | ||
|
||
## Description | ||
|
||
The `invite-notify` client capability allows a client to specify that it | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Labeled responses | ||
title: Labeled Responses | ||
layout: spec | ||
copyrights: | ||
- | ||
|
@@ -11,6 +11,7 @@ copyrights: | |
period: "2016-2020" | ||
email: "[email protected]" | ||
--- | ||
|
||
## Introduction | ||
|
||
This specification adds a new message tag sent by clients and repeated by servers to correlate responses with a specific request. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: IRCv3 Message IDs | ||
title: Message IDs | ||
layout: spec | ||
copyrights: | ||
- | ||
|
Oops, something went wrong.