From 5efe15998bfb58aea3056eff9e24cb280822d21c Mon Sep 17 00:00:00 2001 From: Landon Curt Noll Date: Tue, 7 May 2024 22:21:16 -0700 Subject: [PATCH] clarify and improve FAQs related to the author_handle Added "FAQ 6.13: How may I find my author handle?". Improved author handle information in FAQ 5.5, 6.5, and 6.6. Ran `make www` to perform test the above under macOS. --- faq.html | 50 ++++++++++++++++++++++++++++++++++-------- faq.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++--------- 2 files changed, 98 insertions(+), 19 deletions(-) diff --git a/faq.html b/faq.html index 0f4efeb4a..24556d38f 100644 --- a/faq.html +++ b/faq.html @@ -461,6 +461,7 @@ other inconsistencies with the original entry?
  • 6.10 - How does someone make a change to a file and submit that change as a GitHub pull request?
  • 6.11 - Am I allowed to use IOCCC content?
  • 6.12 - What is Mastodon and why does IOCCC use it?
    • +
  • 6.13 - How may I find my author handle?

    • The IOCCC FAQ

    @@ -2154,8 +2155,11 @@ then please submit a pull requestinform the IOCCC judges.

    Authors of IOCCC winning entries are kept in JSON files of the form:

        author/author_handle.json
    -

    where author_handle is an author handle. See FAQ 6.5 for more -information about author handles.

    +

    where author_handle is an author handle.

    +

    See FAQ 6.5 for more information about author handles.

    +

    See FAQ 6.6 for information about the contents of these JSON file and +how they are used.

    +

    See FAQ 6.13 for how to find your own author_handle.

    The contents of these JSON files contain the best known information about authors of IOCCC entries. See FAQ 6.6 for information about the contents of these JSON file and how they are used.

    @@ -2286,16 +2290,22 @@ exaggeration.

    IOCCC. Each author has exactly one author_handle.

    For each author_handle, there will be a JSON file of the form:

        author/author_handle.json
    +

    See FAQ 5.5 for information about how to update +and/or correct IOCCC author information.

    See FAQ 6.6 for information about the contents of these JSON file and how they are used.

    +

    See FAQ 6.13 for how to find your own author_handle.

    Because the author_handle is used to form a JSON filename, the string must be POSIX safe string plus the use of + (for technical reasons beyond this -answer). In particular, the author_handle must be an ASCII string that -matches this regexp:

    +answer). In particular, the author_handle must be an ASCII string or +32 characters or less that matches this regexp:

        ^[0-9A-Za-z][0-9A-Za-z._+-]*$"

    Default author_handle’s do not have multiple consecutive _ (underscore) characters. Nevertheless, multiple consecutive _ (underscore) characters are -allowed. Contest submitters who wish to override their default author_handle may do so.

    +allowed. Contest submitters who wish to override their default author_handle +may do so, long as the ASCII string matches the regexp above AND +so long as the length does not exceed the 32 ASCII characters (not including +the terminating NUL byte).

    The author_handle is derived from 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 author_handle string, those who submit an entry to @@ -2314,8 +2324,6 @@ year.

    in the case of 2005/anon.

    Anonymous author_handle’s match this regexp:

        Anonymous_[0-9][0-9][0-9][0-9][.0-9]*$
    -

    See FAQ 5.5 for information about how to update -and/or correct IOCCC author information.

    FAQ 6.6: What is a author_handle.json file and how are they used?

    @@ -2336,7 +2344,7 @@ of the author’s JSON file for ways to contact them.

    Each author of an IOCCC winning entry has their own author_handle.json file of the form:

        author/author_handle.json
    -

    where author_handle is an author handle. See FAQ 6.5 for more +

    where author_handle is an author handle. See FAQ 6.5 for more information about an author handles.

    author_handle.json JSON file contents

    The syntax of a author_handle.json follows the So-called JSON spec. @@ -2639,7 +2647,7 @@ names such as winner when they should use author. Sorry (tm Ca

    • Entry
    -

    An entry is a submission that won the IOCCC.

    +

    An entry is a submission that won the IOCCC.

    An entry has one or more authors.

    An entry includes all of the files needed to compile it, plus sample input files, a Makefile, an .entry.json file @@ -2880,6 +2888,30 @@ and topics like science, technology, fosstodon.org folk made the IOCCC feel welcome.

    While using Mastodon is free, the IOCCC judges are pleased to support the Fosstodon Hub.

    +
    +
    +

    FAQ 6.13: How may I find my author handle?

    +
    +
    +

    If you are an author of a winning entry, you may find your own author_handle +by going to your entry in the authors.html web page and viewing the string +that follows the author_handle: line.

    +

    If you are not someone who has won a previous IOCCC, you will be able to select +a potential author_handle when you form your submission tarball (see FAQ 0.0).

    +

    Helpful Hint: If an author clicks on their author_handle: +line link, you will be taken to that author’s author_handle.json file.

    +

    For example, Brian Westley can view his +author entry and see that his author_handle is Brian_Westley. +Clicking on the author_handle shows the contents of +the Brian_Westley.json file.

    +

    IMPORTANT NOTE: An author who has won a previous IOCCC is encouraged to reuse their +author_handle so that new winning entries can be associated with the same author.

    +

    See FAQ 5.5 for information about how to update +and/or correct IOCCC author information.

    +

    See FAQ 6.5 for more information about author handles.

    +

    See FAQ 6.6 for information about the contents of these JSON file and +how they are used.

    +

    See FAQ 6.9 for more information on terms such as author, entry, and submission.

    Jump to: top

    ^[0-9A-Za-z][0-9A-Za-z._+-]*$" @@ -2786,7 +2798,10 @@ matches this regexp: Default `author_handle`'s do not have multiple consecutive `_` (underscore) characters. Nevertheless, multiple consecutive `_` (underscore) characters are -allowed. Contest submitters who wish to override their default `author_handle` may do so. +allowed. Contest submitters who wish to override their default `author_handle` +may do so, long as the ASCII string matches the regexp above AND +so long as the length does not exceed the 32 ASCII characters (not including +the terminating NUL byte). The `author_handle` is derived from the name of the author. While there is a algorithm that maps the name of the author (which can contain any UTF-8 @@ -2823,9 +2838,6 @@ Anonymous `author_handle`'s match this regexp: Anonymous_[0-9][0-9][0-9][0-9][.0-9]*$ ``` -See [FAQ 5.5](#fix_author) for information about how to update -and/or correct IOCCC author information. -
    @@ -2855,7 +2867,7 @@ of the form: author/author_handle.json ``` -where _author_handle_ is an author handle. See [FAQ 6.5](#author_handle) for more +where _author_handle_ is an author handle. See [FAQ 6.5](#author_handle_faq) for more information about an author handles. #### author_handle.json JSON file contents @@ -3382,7 +3394,7 @@ names such as _winner_ when they should use _author_. Sorry (tm Canada)! :-) - Entry -An _entry_ is a submission that won the IOCCC. +An _entry_ is a _submission_ that won the IOCCC. An _entry_ has one or more _authors_. @@ -3740,6 +3752,41 @@ While using Mastodon is free, the [IOCCC judges](judges.html) are pleased to [support the Fosstodon Hub](https://hub.fosstodon.org/support/). +
    +
    +### FAQ 6.13: How may I find my author handle? +
    +
    + +If you are an _author_ of a winning _entry_, you may find your own _author_handle_ +by going to your entry in the [authors.html](authors.html) web page and viewing the string +that follows the _author_handle_: line. + +If you are not someone who has won a previous IOCCC, you will be able to select +a potential _author_handle_ when you form your _submission_ tarball (see [FAQ 0.0](#submit)). + +**Helpful Hint**: If an _author_ clicks on their _author_handle:_ +line link, you will be taken to that author's `author_handle.json` file. + +For example, [Brian Westley](authors.html#Brian_Westley) can view his +author entry and see that his _author_handle_ is **Brian_Westley**. +Clicking on the _author_handle_ shows the contents of +the [Brian_Westley.json](%%REPO_URL%%/author/Brian_Westley.json) file. + +**IMPORTANT NOTE**: An `author` who has won a previous IOCCC is encouraged to reuse their +`author_handle` so that new winning entries can be associated with the same author. + +See [FAQ 5.5](#fix_author) for information about how to update +and/or correct IOCCC author information. + +See [FAQ 6.5](#author_handle_faq) for more information about author handles. + +See [FAQ 6.6](#author_json) for information about the contents of these JSON file and +how they are used. + +See [FAQ 6.9](#terms) for more information on terms such as _author_, _entry_, and _submission_. + +
    Jump to: [top](#)