Typo fixes in author/README.md

This commit is contained in:
Cody Boone Ferguson committed 2023-06-30 07:40:49 -07:00
1 parent 828ddef5eb
commit f460eef70a
1 file changed
+27 -26
+27 -26
View File
@@ -2,7 +2,7 @@
The `author/` directory contains a JSON file for each author of at The `author/` directory contains a JSON file for each author of at
least one winning IOCCC entry. For each author, there is a JSON least one winning IOCCC entry. For each author, there is a JSON
file of the form: file with the following name format:
``` ```
author/author_handle.json author/author_handle.json
@@ -19,15 +19,15 @@ an IOCCC unique string that matches this regex:
^[0-9a-z][0-9a-z_]*$ ^[0-9a-z][0-9a-z_]*$
``` ```
The `author_handle`, by default derived from the name of the author. The `author_handle`, by default, is derived from the name of the author.
While there is a algorithm that maps the name of the author While there is a algorithm that maps the name of the author
(which can contain any UTF-8 characters) into a default (which can contain any UTF-8 characters) into a default
`author_handle` string, those who submit an entry to the IOCCC `author_handle` string, those who submit an entry to the IOCCC
are free to choose a different `author_handle` string. are free to choose a different `author_handle` string.
An `author` who has won a previous IOCCC is encouraged to An `author` who has won a previous IOCCC is encouraged to reuse their
reuse their author_handle so that new winners an be associated author_handle so that new winning entries will be associated with the same
with the same author. author or authors.
### anonymous author_handle's ### anonymous author_handle's
@@ -70,15 +70,15 @@ There must be the following JSON members:
"location_name" : "Formal location name", "location_name" : "Formal location name",
``` ```
- "full_name" value is the author's formal full name. - `"full_name"` value is the author's formal full name.
- "sort_word" value is the author's last name, mapped into lower case ASCII, as JSON encoded string - `"sort_word"` value is the author's last name, mapped into lower case ASCII, as a JSON encoded string
- "location_code" value is an 2 UPPER CASE ISO 3166 code selected by the author - `"location_code"` value is a 2 UPPER CASE ISO 3166 code selected by the author
- "location_name" value is the formal name corresponding to the "location_code", in JSON encoded string form - `"location_name"` value is the formal name corresponding to the `"location_code"`, in JSON encoded string form
A "sort_word" hat is used to determine the position within the `winners.html` file, A `"sort_word"` that is used to determine the position within the `winners.html` file,
a `author` and the `winners` they submitted are to be listed. an `author` and the `winners` they submitted are to be listed.
A `sort_word` match this regexp: A `sort_word` matches this regexp:
```re ```re
^[a-z][0-9a-z]* ^[a-z][0-9a-z]*
@@ -97,17 +97,17 @@ And there must be the following JSON members:
"affiliation" : "an affiliation group", "affiliation" : "an affiliation group",
``` ```
- "email" value is the author's email address as a JSON encoded string, or `null` if not given - `"email"` value is the author's email address as a JSON encoded string, or `null` if not given
- "url;" value is the author's home page URL as a JSON encoded string, or `null` if not given - `"url"` value is the author's home page URL as a JSON encoded string, or `null` if not given
- "alt_url" value is the author's alternate URL as a JSON encoded string, or `null` if not given - `"alt_url"` value is the author's alternate or second URL as a JSON encoded string, or `null` if not given
- "deprecated_twitter_handle" value is the author's twitter handle as a JSON encoded string, starting with "_@_", or `null` if not given - `"deprecated_twitter_handle"` value is the author's twitter handle as a JSON encoded string, starting with "_@_", or `null` if not given
- "mastodon" value is the author's Mastodon handle in "_@user@server_" form as a JSON encoded string, or `null` if not given - `"mastodon"` value is the author's Mastodon handle in "_@user@server_" form as a JSON encoded string, or `null` if not given
- "mastodon_url" value is the URL as a JSON encoded string of the author's Mastodon page, cor `null` if not given - `"mastodon_url"` value is the URL as a JSON encoded string of the author's Mastodon page, or `null` if not given
- "github" value is the GitHub username as a JSON encoded string, starting with "_@_", or `null` if not given - `"github"` value is the author's GitHub username as a JSON encoded string, starting with "_@_", or `null` if not given
- "affiliation" is the author's affiliation as a JSON encoded string, or `null` if not given - `"affiliation"` is the author's affiliation as a JSON encoded string, or `null` if not given
If an author does not have one of the previous set of values, or wishes to not disclose it / keep it anonymous, If an author does not have one of the previous set of values, or wishes to not disclose it / keep it anonymous,
then the JSON value of `null`. For example: then the JSON value can be `null`. For example:
```json ```json
"email" : null, "email" : null,
@@ -122,14 +122,14 @@ then the JSON value of `null`. For example:
NOTE: The JSON value of `null` is NOT enclosed in double quotes. NOTE: The JSON value of `null` is NOT enclosed in double quotes.
The "winning_entry_set" is an array of JSON members that indicate The `"winning_entry_set"` is an array of JSON members that indicate
the each of the IOCCC winning entries for whom the author is the author. :-) each of the IOCCC winning entries that the author is the author of. :-)
```json ```json
{ "winner_id" : "YYYY_dirname" } { "winner_id" : "YYYY_dirname" }
``` ```
The "YYYY_dirname" is a winner ID in JSON encoded string form. The `"YYYY_dirname"` is a winner ID in JSON encoded string form.
Here "YYYY" is the IOCCC year, and "dirname" is the directory name Here "YYYY" is the IOCCC year, and "dirname" is the directory name
of the winning entry under the given year directory. of the winning entry under the given year directory.
@@ -146,7 +146,7 @@ For example:
### author_handle.json example ### author_handle.json example
Here is a factious author_handle.json example: Here is a fictitious author_handle.json example:
```json ```json
{ {
@@ -173,7 +173,8 @@ Here is a factious author_handle.json example:
} }
``` ```
Here is factious author_handle.json example where all entries that may be withheld, and null: Here is fictitious author_handle.json example where all entries that may be
withheld are null:
```json ```json
{ {